Queries an overview of the hosts 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 DescribeMyBaseHostOverView

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

Region String Yes cn-hangzhou

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

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 the types of database engines that run in the region.

HostGroupCount Integer 2

The number of dedicated clusters in the region.

Region String hangzhou

The queried region.

TotalCount Integer 3

The total number of hosts in the region.

TypeModels Array of TypeModel

Details about hosts in the region.

TypeModel
Count Integer 2

The number of hosts.

HostDateType String EXPIRED

The status of a host. Valid values:

  • RUNNING: The host is running.
  • RECENTLY_CREATED: The host is being created.
  • RECENTLY_EXPIRED: The host is about to expire.
  • EXPIRED: The host has expired.
HostEngineCount String 2

The number of the types of database engines that are used on the hosts in the region.

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

The ID of the request.

Examples

Sample requests

http(s)://cddc.aliyuncs.com/?Action=DescribeMyBaseInstanceOverView
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeMyBaseHostOverViewReponse>
  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ESTG2</RequestId>
  <Regions>
        <RegionModel>
              <TotalCount>3</TotalCount>
              <Region>hangzhou</Region>
              <HostGroupCount>2</HostGroupCount>
              <EngineCount>2</EngineCount>
              <TypeModels>
                    <TypeModel>
                          <HostDateType>EXPIRED</HostDateType>
                          <HostEngineCount>2</HostEngineCount>
                          <Count>2</Count>
                    </TypeModel>
              </TypeModels>
        </RegionModel>
  </Regions>
</DescribeMyBaseHostOverViewReponse>

JSON format

{
    "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ESTG2",
    "Regions": {
        "RegionModel": [
            {
                "TotalCount": "3",
                "Region": "hangzhou",
                "HostGroupCount": "2",
                "EngineCount": "2",
                "TypeModels": {
                    "TypeModel": [
                        {
                            "HostDateType": "EXPIRED",
                            "HostEngineCount": "2",
                            "Count": "2"
                        }
                    ]
                }
            }
        ]
    }
}

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.