doc-exports/docs/rds/api-ref/rds_04_0002.html

Querying the Storage Type of a Database

Function

This API is used to query the storage type of a specified DB engine version.

• Before calling an API, you need to understand the API in Authentication.
• Before calling this API, obtain the required region and endpoint.

URI

• URI format

  GET https://{Endpoint}/v3/{project_id}/storage-type/{database_name}?version_name={version_name}&ha_mode={ha_mode}

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
  database_name	Yes	Specifies the DB engine name. Its value can be any of the following and is case-insensitive: MySQL PostgreSQL SQLServer
  version_name	Yes	Specifies the database version. For details about how to obtain the database version, see section Querying Version Information About a DB Engine. MySQL databases support 5.7, 8.0 and 8.4. PostgreSQL databases support 12, 13, 14, 15, 16 and 17. Microsoft SQL Server databases only support 2017_SE, 2017_EE, 2019_SE, 2019_EE, 2022_SE and 2022_EE.
  ha_mode	No	Specifies the HA mode. The value options are as follows: single ha replica

Request

• Request parameters

  None

• Example

  GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/storage-type/mysql?version_name=5.7&ha_mode=ha

Response

• Normal response

  Table 2 Parameter description

  Name	Type	Description
  storage_type	Array of objects	Indicates the DB instance specifications information list. For details, see Table 3.

  Table 3 storage_type field data structure description

  Name	Type	Description
  name	String	Indicates the storage type. Its value can be any of the following: CLOUDSSD: cloud SSD storage. ESSD: extreme SSD storage.
  az_status	Map<String, String>	Indicates the specification status in an AZ. Its value can be any of the following: normal: indicates that the specifications in the AZ are available. unsupported: indicates that the specifications are not supported by the AZ. sellout: indicates that the specifications in the AZ are sold out.
  support_compute_group_type	List<String>	Indicates the performance specifications. Its value can be any of the following: normal: general-enhanced. Suitable for websites and web applications that require high database computing and network performance. general: general-purpose. Suitable for scenarios that have high requirements on cost-effectiveness. dedicated: Suitable for core database scenarios such as e-commerce, gaming, finance, government, and enterprise applications. For the MySQL DB engine: dedicated For PostgreSQL and SQL Server DB engines: dedicated, which is only supported for cloud SSDs

• Example normal response

  {
  	"storage_type": [{
  			"name": "CLOUDSSD",
  			"az_status": {
  				"az1": "normal",
  				"az2": "normal",
  			},
                          "support_compute_group_type": [
                                  "normal",
                                  "general",
                                  "dedicated"
                          ]
  		},
  		{
  			"name": "ESSD",
  			"az_status": {
  				"az1": "normal",
  				"az2": "normal"
  			},
                          "support_compute_group_type": [
                                  "normal",
                                  "general",
                                  "dedicated"
                          ]
  		}
  	]        
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: API v3 (Recommended)