调用DescribeMyBaseInstanceOverView接口查看专属集群的实例概览信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeMyBaseInstanceOverView

系统规定参数,取值:DescribeMyBaseInstanceOverView

Region String cn-hangzhou

地域ID。详情请参考地域ID

RegionId String cn-hangzhou

地域ID。详情请参考地域ID

返回数据

名称 类型 示例值 描述
Regions Array of RegionModel

查询地域内相关信息。

RegionModel
EngineCount String 2

查询地域内数据库引擎类型统计总数。

Region String hangzhou

地域。

TotalCount Integer 2

查询地域下实例总数。

TypeModels Array of TypeModel

实例详情列表。

TypeModel
Count Integer 2

实例的总数。

InstanceDateType String local

实例存储类型,取值为:

  • local:本地盘
  • essd:云盘类型
InstanceEngineCount String 2

数据库引擎类型的数量。

InstanceModels Array of InstanceModel

实例信息列表。

InstanceModel
CreatedTime String 2021-07-16T16:30:19Z

实例创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)

DBInstanceId String rm-t4n0h1x2zffj9****

实例ID。

DBInstanceStatus String CREATING

实例状态。取值:

  • CREATING:创建中。
  • ACTIVATION:运行中。
  • EXPIRED:实例到期,但仍在运行中。
  • DELETING:删除中。
  • RESTARTING:重启中
  • CLASS_CHANGING:配置变更中。
  • TRANSING:迁移中。
  • SLAVE_INS_TRANSING:实例备库迁移中。
  • VERSION_TRANSING:升降版本中。
  • DATABASE_TRANSING:迁移数据库中。
  • GUARD_CREATING:生产灾备实例中。
  • BACKUP_RECOVERING:备份恢复中。
  • SUBINS_CREATING:临时实例创建中。
  • DATA_IMPORTING:数据导入中。
  • DATABASE_IMPORTING:数据库导入中。
  • NET_SWITCHING:内外网切换中。
  • GUARD_SWITCHING:容灾切换中。
  • LINK_SWITCHING:链路切换中。
  • CREATE_FAILURE:创建失败。
  • START_FAILURE:启动失败。
  • LOCKING:锁定中。
  • BACKUPING:备份中,同时处于运行中。
  • DELETED:删除状态,杜康资源不存在。
  • DESTROYED:销毁状态,杜康资源不存在。
  • EXCEPTION:异常。
  • STOPED:停机中
ExpireTime String 2021-08-16T16:30:19Z

到期时间,格式为yyyy-MM-ddT HH:mm:ssZ(UTC时间)

PayType String PREPAY

支付方式。取值为

DHGPAY(专属集群按量付费)。

ZoneId String ap-southeast-1a

实例所在可用区ID。

RequestId String D6E068C3-25BC-455A-85FE-45F0B22ESTG2

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeMyBaseInstanceOverView
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<DescribeMyBaseInstanceOverViewResponse>
  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ESTG2</RequestId>
  <Regions>
        <RegionModel>
              <TotalCount>2</TotalCount>
              <Region>hangzhou</Region>
              <EngineCount>2</EngineCount>
              <TypeModels>
                    <TypeModel>
                          <InstanceEngineCount>2</InstanceEngineCount>
                          <Count>2</Count>
                          <InstanceDateType>local</InstanceDateType>
                          <InstanceModels>
                                <InstanceModel>
                                      <CreatedTime>2021-07-16T16:30:19Z</CreatedTime>
                                      <ZoneId>ap-southeast-1a</ZoneId>
                                      <DBInstanceStatus>CREATING</DBInstanceStatus>
                                      <DBInstanceId>rm-t4n0h1x2zffj9****</DBInstanceId>
                                      <PayType>PREPAY</PayType>
                                      <ExpireTime>2021-08-16T16:30:19Z</ExpireTime>
                                </InstanceModel>
                          </InstanceModels>
                    </TypeModel>
              </TypeModels>
        </RegionModel>
  </Regions>
</DescribeMyBaseInstanceOverViewResponse>

JSON格式

{
    "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ESTG2",
    "Regions": {
        "RegionModel": [
            {
                "TotalCount": "2",
                "Region": "hangzhou",
                "EngineCount": "2",
                "TypeModels": {
                    "TypeModel": [
                        {
                            "InstanceEngineCount": "2",
                            "Count": "2",
                            "InstanceDateType": "local",
                            "InstanceModels": {
                                "InstanceModel": [
                                    {
                                        "CreatedTime": "2021-07-16T16:30:19Z",
                                        "ZoneId": "ap-southeast-1a",
                                        "DBInstanceStatus": "CREATING",
                                        "DBInstanceId": "rm-t4n0h1x2zffj9****",
                                        "PayType": "PREPAY",
                                        "ExpireTime": "2021-08-16T16:30:19Z"
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidAction The specified action is not valid. 指定的操作无效

访问错误中心查看更多错误码。