doc-exports/docs/rds/api-ref/rds_04_0002.html
Wang , Deng Ke 21e968a153 rds api 2.0.38sp24 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2023-01-12 13:50:31 +00:00

17 KiB

Querying the Storage Type of a Database

Function

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

URI

  • URI format

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

  • 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.

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.

    dsspool_info

    Array of objects

    Indicates the dsspool specifications information list.

    For details, see Table 4.

    NOTE:

    Only Dedicated Cloud (DeC) users are supported.

    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:

    • COMMON: SATA storage.
    • ULTRAHIGH: 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
    • normal2: general-enhanced II
    • armFlavors: Kunpeng general-enhanced
    • highPerformancePrivilegeEdition: Ultra-high I/O (advanced)
    Table 4 dsspool_info field data structure description

    Name

    Type

    Description

    az_name

    String

    Indicates the name of the AZ where dsspool is located.

    free_capacity_gb

    String

    Indicates the available capacity of dsspool.

    dsspool_volume_type

    String

    Indicates the dsspool volume type.

    dsspool_id

    String

    Indicates the dsspool ID.

    dsspool_status

    String

    Indicates the dsspool status. Its value can be any of the following:

    • available
    • deploying
    • enlarging
    • frozen
    • sellout
  • Example normal response
    {
    	"storage_type": [{
    			"name": "COMMON",
    			"az_status": {
    				"az1": "normal",
    				"az2": "normal",
    			},
                            "support_compute_group_type": [
                                    "normal",
                                    "normal2",
                                    "armFlavors"
                            ]
    		},
    		{
    			"name": "ULTRAHIGH",
    			"az_status": {
    				"az1": "normal",
    				"az2": "normal"
    			},
                            "support_compute_group_type": [
                                    "normal",
                                    "normal2",
                                    "armFlavors"
                            ]
    		}
    	]
            "dsspool_info": []
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.