Queries an overview of the instances that are deployed in ApsaraDB for MyBase dedicated clusters in a specified region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeMyBaseInstanceOverView

The operation that you want to perform. Set the value to DescribeMyBaseInstanceOverView.

RegionId String Yes cn-hangzhou

The ID of the region. For more information, see Region IDs.

Response parameters

Parameter Type Example Description
Regions Array of RegionModel

Details about the specified regions.

RegionModel
EngineCount String 2

The total number of database engine types in the specified region.

Region String hangzhou

TotalCount Integer 2

The total number of instances in the region.

TypeModels Array of TypeModel

Details about the instances.

TypeModel
Count Integer 2

The total number of instances.

InstanceDateType String local

The storage type of the instance. Valid values:

  • local: local SSD
  • essd: enhanced SSD (ESSD)
InstanceEngineCount String 2

The number of database engine types.

InstanceModels Array of InstanceModel

Details about the returned instances.

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

The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

DBInstanceId String rm-t4n0h1x2zffj9****

The ID of the instance.

DBInstanceStatus String CREATING

The status of the instance. Valid values:

  • CREATING: The instance is being created.
  • ACTIVATION: The instance is running.
  • EXPIRED: The instance has expired but is still running.
  • DELETING: The instance is being deleted.
  • RESTARTING: The instance is restarting.
  • CLASS_CHANGING: The configuration is being updated.
  • TRANSING: The instance is being migrated.
  • SLAVE_INS_TRANSING: A secondary node of the instance is being migrated.
  • VERSION_TRANSING: The version of the instance is being upgraded or downgraded.
  • DATABASE_TRANSING: A database is being migrated.
  • GUARD_CREATING: A disaster recovery instance is being created.
  • BACKUP_RECOVERING: The instance is being restored from the backup.
  • SUBINS_CREATING: A temporary instance is being created.
  • DATA_IMPORTING: Data is being imported into the instance.
  • DATABASE_IMPORTING: A database is being imported into the instance.
  • NET_SWITCHING: The network type of the instance is being switched between the VPC and the Internet.
  • GUARD_SWITCHING: A switchover is being performed on the instance.
  • LINK_SWITCHING: The link is being changed for the instance.
  • CREATE_FAILURE: The instance failed to be created.
  • START_FAILURE: The instance failed to start.
  • LOCKING: The instance is locked.
  • BACKUPING: The instance is being backed up and is also running.
  • DELETED: The instance is deleted. The resources of the instance do not exist in ApsaraDB Operations and Maintenance System.
  • DESTROYED: The instance is released. The resources of the instance do not exist in ApsaraDB Operations and Maintenance System.
  • EXCEPTION: The instance is abnormal.
  • STOPED: The instance stops running.
ExpireTime String 2021-08-16T16:30:19Z

The time when the instance expires. The time follows the ISO 8601 standard in the yyyy-MM-ddT HH:mm:ssZ format. The time is displayed in UTC.

PayType String PREPAY

The billing method of the instance. The value is

PREPAY. This value indicates the pay-as-you-go billing method.

ZoneId String ap-southeast-1a

The zone ID of the instance.

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeMyBaseInstanceOverView
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<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 format

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

Error codes

HttpCode Error code Error message Description
400 InvalidAction The specified action is not valid. The error message returned because the specified operation is invalid.

For a list of error codes, visit the API Error Center.