查询数据库磁盘类型

功能介绍

获取指定数据库引擎版本对应的磁盘类型。

• 调用接口前，您需要了解API 认证鉴权。

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

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

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的项目ID。 获取方法请参见获取项目ID。
  database_name	是	数据库引擎名。支持如下数据库引擎，不区分大小写： MySQL PostgreSQL SQLServer
  version_name	是	数据库引擎版本号，获取方法请参见查询数据库引擎的版本。 对于MySQL引擎，需转化为其大版本号，例如5.6、5.7、8.0。
  ha_mode	否	主备模式，取值如下： single：单机模式。 ha：主备模式。 replica：只读模式。

请求消息

• 请求参数

  无。

• URI样例

  GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/storage-type/mysql?version_name=5.7&ha_mode=ha

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  storage_type	Array of objects	实例规格信息列表。 详情请参见表3。
  dsspool_info	Array of objects	实例dsspool规格信息列表。 详情请参见表4。 说明： 仅支持DeC用户查询。

  表3 storage_type字段数据结构说明

  名称	参数类型	说明
  name	String	磁盘类型名称，可能取值如下： ULTRAHIGH：表示超高IO型磁盘。 LOCALSSD：表示本地SSD。 CLOUDSSD：表示SSD云盘，仅支持通用型和独享型规格实例。 ESSD：表示极速型SSD，仅支持独享型规格实例。
  az_status	Map<String, String>	规格所在az的状态，包含以下状态： normal：在售。 unsupported：暂不支持该规格。 sellout：售罄。
  support_compute_group_type	List<String>	性能规格，包含以下状态： normal：通用增强型。 normal2：通用增强Ⅱ型。 armFlavors：鲲鹏通用增强型。 dedicicateNormal ：x86独享型。 armLocalssd：鲲鹏通用型。 normalLocalssd：x86通用型。 general：通用型。 dedicated 对于MySQL引擎：独享型。 对于PostgreSQL和SQL Server引擎：独享型，仅云盘SSD支持。 rapid 对于MySQL引擎：独享型（已下线）。 对于PostgreSQL和SQL Server引擎：独享型，仅极速型SSD支持。 bigmem：超大内存型。

  表4 dsspool_info字段数据结构说明

  名称	参数类型	说明
  az_name	String	dsspool所在az名称。
  free_capacity_gb	String	专属存储可用容量。
  dsspool_volume_type	String	专属存储磁盘类型。
  dsspool_id	String	专属存储ID。
  dsspool_status	String	dsspool的状态，包含以下状态： available，可用。 deploying，正在部署。 enlarging，正在扩容。 frozen，冻结。 sellout，售罄。

• 正常响应样例

  {
  	"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": []
  }

  DeC用户查询响应样例

  {
  	"storage_type": [
  		{
  			"name": "COMMON",
  			"az_status": {
  				"az1xahz": "normal",
  				"az3xahz": "normal"
  			},
                          "support_compute_group_type": [
                                  "normal",
                                  "normal2"
                          ]
  		},
  		{
  			"name": "ULTRAHIGH",
  			"az_status": {
  				"az1xahz": "normal",
  				"az3xahz": "normal"
  			},
                          "support_compute_group_type": [
                                  "normal",
                                  "normal2"
                          ]
  		}
  	],
  	"dsspool_info": [
  		{
  			"az_name": "az1xahz",
  			"free_capacity_gb": "8656",
  			"dsspool_volume_type": "ULTRAHIGH",
  			"dsspool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
  			"dsspool_status": "available"
  		}
  	]
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。