查询数据库规格 - ShowGaussMySqlFlavors
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
gaussdbformysql:instance:listSpec
List
-
-
gaussdb:instance:list
-
URI
GET /v3/{project_id}/flavors/{database_name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认值: 不涉及。 |
|
database_name |
是 |
String |
参数解释: 数据库引擎名称。 约束限制: 不涉及。 取值范围: gaussdb-mysql。 默认值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
availability_zone_mode |
是 |
String |
参数解释: 可用区模式。 约束限制: 不涉及。 取值范围:
默认值: 单可用区。 |
|
version_name |
否 |
String |
参数解释: 数据库版本号。 约束限制: 目前仅支持兼容MySQL 8.0。 取值范围: 8.0。 默认值: 8.0。 |
|
spec_code |
否 |
String |
参数解释: 资源规格编码。例如:gaussdb.mysql.xlarge.x86.4。
更多规格说明请参考数据库实例规格。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
|
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围:
默认值: en-us。 |
响应参数
状态码: 202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
flavors |
Array of MysqlFlavorsInfo objects |
参数解释: 实例规格信息列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vcpus |
String |
参数解释: CPU大小。例如:1表示1U。 取值范围: 不涉及。 |
|
ram |
String |
参数解释: 内存大小,单位为GB。 取值范围: 不涉及。 |
|
type |
String |
参数解释: 规格类型。 取值范围:
|
|
id |
String |
参数解释: 规格ID,规格的唯一标识。 取值范围: 不涉及。 |
|
spec_code |
String |
参数解释: 资源规格编码,同创建指定的spec_code。例如:gaussdb.mysql.xlarge.x86.4。
更多规格说明请参考数据库实例规格。 取值范围: 不涉及。 |
|
version_name |
String |
参数解释: 数据库版本号。 取值范围: 8.0。 |
|
instance_mode |
String |
参数解释: 实例类型。目前仅支持Cluster。 取值范围: Cluster。 |
|
az_status |
Map<String,String> |
参数解释: 规格所在AZ的状态。 取值范围:
|
状态码: 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误消息。 |
状态码: 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误消息。 |
请求示例
查询TaurusDB数据库实例指定规格的详细信息。
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.x86.4&availability_zone_mode=single
响应示例
状态码: 202
Success.
{
"flavors" : [ {
"vcpus" : "4",
"ram" : "16",
"type" : "x86",
"id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
"spec_code" : "gaussdb.mysql.xlarge.x86.4",
"instance_mode" : "Cluster",
"version_name" : "8.0",
"az_status" : {
"az1" : "normal",
"az2" : "normal"
}
} ]
}
状态码
请参见状态码。
错误码
请参见错误码。