PolarDB-X 1.0-API参考-1.0（2019版本）-存储管理-DescribeDrdsDBCluster

更新时间：2022-04-16 14:55:49

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDrdsDBCluster	系统规定参数。取值为DescribeDrdsDBCluster。
DbInstanceId	String	是	pc-*****************	PolarDB集群ID。
DbName	String	是	drds_test	DRDS数据库名称。
DrdsInstanceId	String	是	drds*********	DRDS实例ID。

返回数据

名称	类型	示例值	描述
DbInstance	Struct		PolarDB的实例信息。
RequestId	String	60A77FD6-0DE4-4A34-B6FB-9C2673******	请求ID。
Success	Boolean	true	请求结果。

示例

请求示例

http(s)://drds.aliyuncs.com/?Action=DescribeDrdsDBCluster
&DbInstanceId=pc-*****************
&DbName=test
&DrdsInstanceId=drds*********
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>60A77FD6-0DE4-4A34-B6FB-9C2673******</RequestId>
<DbInstance>
    <DbInstType>POLARDB</DbInstType>
    <EngineVersion>8.0</EngineVersion>
    <DBInstanceStatus>1</DBInstanceStatus>
    <Port>3306</Port>
    <PayType>Postpaid</PayType>
    <Endpoints>
        <Endpoint>
            <ReadWeight>85</ReadWeight>
            <NodeIds>pi-*****************</NodeIds>
            <EndpointId>pc-*****************</EndpointId>
        </Endpoint>
        <Endpoint>
            <ReadWeight>15</ReadWeight>
            <NodeIds>pi-*****************,pi-*****************</NodeIds>
            <EndpointId>pe-*****************</EndpointId>
        </Endpoint>
    </Endpoints>
    <DBInstanceId>pc-*****************</DBInstanceId>
    <DBNodes>
        <DBNode>
            <DBNodeStatus>Running</DBNodeStatus>
            <ZoneId>cn-hangzhou-i</ZoneId>
            <DBNodeRole>Reader</DBNodeRole>
            <DBNodeId>pi-*****************</DBNodeId>
        </DBNode>
        <DBNode>
            <DBNodeStatus>Running</DBNodeStatus>
            <ZoneId>cn-hangzhou-i</ZoneId>
            <DBNodeRole>Writer</DBNodeRole>
            <DBNodeId>pi-*****************</DBNodeId>
        </DBNode>
        <DBNode>
            <DBNodeStatus>Running</DBNodeStatus>
            <ZoneId>cn-hangzhou-i</ZoneId>
            <DBNodeRole>Reader</DBNodeRole>
            <DBNodeId>pi-*****************</DBNodeId>
        </DBNode>
    </DBNodes>
    <NetworkType>VPC</NetworkType>
    <ReadMode>CUSTOM</ReadMode>
    <ExpireTime/>
    <RemainDays>0</RemainDays>
    <Engine>POLARDB</Engine>
</DbInstance>
<Success>true</Success>

JSON 格式

{
    "RequestId": "60A77FD6-0DE4-4A34-B6FB-9C2673******",
    "DbInstance": {
        "DbInstType": "POLARDB",
        "EngineVersion": "8.0",
        "DBInstanceStatus": 1,
        "Port": 3306,
        "PayType": "Postpaid",
        "Endpoints": {
            "Endpoint": [
                {
                    "ReadWeight": 85,
                    "NodeIds": "pi-*****************",
                    "EndpointId": "pc-*****************"
                },
                {
                    "ReadWeight": 15,
                    "NodeIds": "pi-*****************,pi-*****************",
                    "EndpointId": "pe-*****************"
                }
            ]
        },
        "DBInstanceId": "pc-*****************",
        "DBNodes": {
            "DBNode": [
                {
                    "DBNodeStatus": "Running",
                    "ZoneId": "cn-hangzhou-i",
                    "DBNodeRole": "Reader",
                    "DBNodeId": "pi-*****************"
                },
                {
                    "DBNodeStatus": "Running",
                    "ZoneId": "cn-hangzhou-i",
                    "DBNodeRole": "Writer",
                    "DBNodeId": "pi-*****************"
                },
                {
                    "DBNodeStatus": "Running",
                    "ZoneId": "cn-hangzhou-i",
                    "DBNodeRole": "Reader",
                    "DBNodeId": "pi-*****************"
                }
            ]
        },
        "NetworkType": "VPC",
        "ReadMode": "CUSTOM",
        "ExpireTime": "",
        "RemainDays": 0,
        "Engine": "POLARDB"
    },
    "Success": true
}

PolarDB-X 1.0-API参考-1.0（2019版本）-存储管理-DescribeDrdsDBCluster

请求参数

返回数据

示例

错误码

相关阅读

推荐文章