Queries the structure of storage instances for a Distributed Relational Database Service (DRDS) database.

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 GetDrdsDbRdsRelationInfo

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

DbName String Yes testDb

The name of the DRDS database.

DrdsInstanceId String Yes drdshbga948vbpd2

The ID of the DRDS instance.

Response parameters

Parameter Type Example Description
Data Array of Data

The structure information about the storage instances of the DRDS database. Each entry corresponds to a primary storage instance.

RdsInstanceId String rm-bp16ad920ndxxxx02

The ID of the storage instance.

ReadOnlyInstanceInfo List []

The IDs of the read-only storage instances.

UsedInstanceId String rm-bp1l8xi1dd9xxxxbj

The ID of the storage instance that is in use. If the specified instance in the request is a primary DRDS instance, the value of this parameter is the ID of the primary storage instance. If the specified instance in the request is a read-only DRDS instance, the value of this parameter is the ID of the secondary storage instance.

UsedInstanceType String RDS

The type of the storage instance that is in use.

RequestId String 82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetDrdsDbRdsRelationInfo
&DbName=testDb
&DrdsInstanceId=drdshbga948vbpd2
&<Common request parameters>

Sample success responses

XML format 

<RequestId>82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75</RequestId>
<Data>
    <UsedInstanceId>rm-bp1l8xi1dd9xxxxbj</UsedInstanceId>
    <UsedInstanceType>RDS</UsedInstanceType>
    <RdsInstanceId>rm-bp16ad920ndxxxx02</RdsInstanceId>
    <ReadOnlyInstanceInfo>[]</ReadOnlyInstanceInfo>
</Data>
<Success>true</Success>

JSON format 

{"RequestId":"82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75","Data":[{"UsedInstanceId":"rm-bp1l8xi1dd9xxxxbj","UsedInstanceType":"RDS","RdsInstanceId":"rm-bp16ad920ndxxxx02","ReadOnlyInstanceInfo":"[]"}],"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 and the request failed.

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