Queries information about the storage instances of a PolarDB-X 1.0 instance.

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 Yes DescribeStorageInstanceSubDbInfo

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

DbName String Yes drds_flashback

The name of the database.

DrdsInstanceId String Yes drdshbga76p6****

The ID of the PolarDB-X 1.0 instance.

InstanceId String Yes rm-bp1x62vwa3wfl****

The ID of the ApsaraDB RDS for MySQL instance.

InstType String No null

The type of the PolarDB-X 1.0 instance. This parameter will take effect in the future.

Response parameters

Parameter Type Example Description
Data Struct

Indicates the returned data object.

Capacity Long 194560

Indicates the capacity of the ApsaraDB RDS for MySQL instance.

PayType String PostPaid

Indicate the billing method of the ApsaraDB RDS for MySQL instance. Valid values:

  • Prepaid: The instance uses the subscription billing method.
  • Postaid: The instance uses the pay-as-you-go billing method.
RdsInstanceId String rm-bp1x62vwa3wfl****

Indicates the ID of the ApsaraDB RDS for MySQL instance.

SubDbList Array of SubDb

Indicates the information about returned database shards.

SubDb
SubDbName String drds_flashback_b8cd_0005

Indicates the name of a database shard.

Use Long 0

Indicates whether the database shard is used.

WarningLevel Integer 0

Indicates the alert level configured for the database shard.

TipsType Integer 0

Indicates the type of a notification.

Use Long 2293

Indicates the storage usage of the ApsaraDB RDS for MySQL instance.

WarningLevel Integer 0

Indicates the alert level configured for the ApsaraDB RDS for MySQL instance.

RequestId String 78BA6289-5E03-4A31-8CB8-FC298DB63184

Indicates the unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeStorageInstanceSubDbInfo
&DbName=drds_flashback
&DrdsInstanceId=drdshbga76p6****
&InstanceId=rm-bp1x62vwa3wfl****
&<Common request parameters>

Sample success responses

XML format 

<RequestId>78BA6289-5E03-4A31-8CB8-FC298DB63184</RequestId>
<Data>
    <WarningLevel>0</WarningLevel>
    <Capacity>194560</Capacity>
    <Use>2293</Use>
    <PayType>PostPaid</PayType>
    <TipsType>0</TipsType>
    <RdsInstanceId>rm-bp1x62vwa3wfl****</RdsInstanceId>
    <SubDbList>
        <SubDb>
            <WarningLevel>0</WarningLevel>
            <Use>0</Use>
            <SubDbName>drds_flashback_b8cd_0005</SubDbName>
        </SubDb>
    </SubDbList>
</Data>
<Success>true</Success>

JSON format 

{"RequestId":"78BA6289-5E03-4A31-8CB8-FC298DB63184","Data":{"WarningLevel":"0","Capacity":"194560","Use":"2293","PayType":"PostPaid","TipsType":"0","RdsInstanceId":"rm-bp1x62vwa3wfl****","SubDbList":{"SubDb":[{"WarningLevel":"0","Use":"0","SubDbName":"drds_flashback_b8cd_0005"}]}},"Success":"true"}

Error codes

HttpCode Error code Error message Description
500 InternalError The request processing has failed due to some unknown error. The error message returned because an internal error has occurred.

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