DescribeDbInstanceDbs - PolarDB - Alibaba Cloud Documentation Center

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	DescribeDbInstanceDbs	The operation that you want to perform. Set the value to DescribeDbInstanceDbs.
DbInstanceId	String	Yes	pc-****************	The ID of the instance in which the storage-layer databases are deployed.
DrdsInstanceId	String	Yes	drds************	The ID of the PolarDB-X 1.0 instance.
AccountName	String	No	test	The name of the privileged account of the PolarDB-X 1.0 instance. You do not need to specify this parameter if you have no privileged account.
Password	String	No	pwd_111111	The password of the privileged account. You do not need to specify this parameter if you have no privileged account.
DbInstType	String	No	POLARDB	The engine type of the storage-layer databases. Valid values: POLARDB and RDS.

Response parameters


Parameter	Type	Example	Description
Databases	Array of Database		Indicates the information about the storage-layer databases.
Database
DbName	String	db_test	Indicates the name of a storage-layer database.
Description	String	test	Indicates the description of the storage-layer database.
Status	Integer	1	Indicates the state of the storage-layer database. Valid values: 0: The database is being created. 1: The database is available. 3: The database is being deleted.
RequestId	String	E9F3D991-08DE-4B74-BE0E-06B809******	Indicates the ID of the request.
Success	Boolean	true	Indicates whether the request is successful.
Total	String	1	Indicates the total number of storage-layer databases.

Examples

Sample requests

http(s)://drds.cn-hangzhou.aliyuncs.com/?Action=DescribeDbInstanceDbs
&DbInstanceId=pc-****************
&DrdsInstanceId=drds************
&<Common request parameters>

Sample success responses

XML format

<Databases>
    <Database>
        <Status>1</Status>
        <Description>test</Description>
        <DbName>db_test</DbName>
    </Database>
</Databases>
<total>1</total>
<RequestId>E9F3D991-08DE-4B74-BE0E-06B809******</RequestId>
<Success>true</Success>

JSON format

{
    "Databases": {
        "Database": [
        {
        "Status": 1,
        "Description": "test",
        "DbName": "db_test"
        }
        ]
    },
    "total":1,
    "RequestId": "E9F3D991-08DE-4B74-BE0E-06B809******",
    "Success": true
}

Error codes


HttpCode	Error code	Error message	Description
400	ActionUnauthorized	The specified action is not available for you	The error message returned because you are not granted permissions to perform this operation. Grant the required permissions to the Resource Access Management (RAM) user that you want to use to perform this operation.

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