调用DescribeDBInstanceAttribute接口获取实例属性_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDBInstanceAttribute	系统规定参数。取值：DescribeDBInstanceAttribute。
RegionId	String	是	cn-hangzhou	实例所在地域。
DBInstanceName	String	是	pxc-********	实例名。
ResourceGroupId	String	否	rg-aekzaxhezhs5***	资源组ID。

返回数据

名称	类型	示例值	描述
RequestId	String	9B2F3840-5C98-475C-B269-2D5C3A31797C	请求ID。
DBInstance	Object		数据库实例信息。
Type	String	ReadWrite	实例类型： ReadWrite：主实例； ReadOnly：只读实例。
Status	String	Running	实例状态，详情请参见实例状态表。
RightsSeparationStatus	String	disabled	三权分立状态： disabled：未开启； enabled：开启； processing：处理中； unknown：未知，可能是实例无法连接导致。
DBNodeCount	Integer	2	实例节点数量。
Expired	String	false	是否过期： true：过期； false：正常。
CreateTime	String	2021-08-31T08:56:25.000+0000	创建时间。
PayType	String	Postpaid	实例付费方式，取值： Postpaid：按量付费； Prepaid：包年包月。
Port	String	3306	内网连接端口。
LockMode	String	Unlock	实例锁定模式： Unlock：正常； ManualLock：手动触发锁定； LockByExpiration：实例过期自动锁定； LockByRestoration：实例回滚前的自动锁定； LockByDiskQuota：实例空间满自动锁定； LockReadInstanceByDiskQuota：只读实例空间满自动锁定。
Description	String	test instance	实例描述。
ConnectionString	String	pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com	内网连接信息。
StorageUsed	Long	17042505728	已经使用的存储，单位为B。
ExpireDate	String	2022-08-31T16:00:00.000+0000	到期时间。格式为yyyy-MM-ddTHH:mm:ss.sss+0000（UTC时间）。
CommodityCode	String	drds_polarxpost_public_cn	实例商品种类，固定取值为drds_polarxpost_public_cn。
MaintainStartTime	String	06:00	实例可维护开始时间，此处为UTC时间，加8小时才是控制台上显示的可维护时间段。
DBInstanceType	String	ReadWrite	实例类型： ReadWrite：主实例； ReadOnly：只读实例。
DBNodeClass	String	polarx.x4.large.2e	实例节点规格。
LatestMinorVersion	String	polarx-kernel_5.4.11-16301083_xcluster-20210805	当前实例支持的最新内核版本。
MaintainEndTime	String	06:00	实例可维护结束时间，此处为UTC时间，加8小时为控制台上显示的可维护时间段。
DBType	String	polarx	数据库类型，固定取值为polarx。
RightsSeparationEnabled	Boolean	false	三权分立状态： false：未开启 true：开启
VPCId	String	vpc-xxxxx	VPC ID。
MinorVersion	String	polarx-kernel_5.4.11-16301083_xcluster-20210805	当前内核版本。
RegionId	String	cn-hangzhou	实例所在地域。
Network	String	VPC	实例的网络类型，仅支持取值VPC，表示专有网络。
DBVersion	String	5.5	数据库版本。
VSwitchId	String	vsw-********	交换机ID。
ZoneId	String	cn-hangzhou-a	实例所在可用区。
Engine	String	polarx	数据库类型，固定取值为polarx。
KindCode	Integer	18	实例引擎版本，内部参数。
Id	String	pxc-zkralxpc5d****	主实例的ID，如果没有返回此参数则表示该实例是主实例。
DBNodes	Array of DBNode		数据库节点信息。
ComputeNodeId	String	pxc-i-********	计算节点名称。
NodeClass	String	polarx.x4.large.2e	节点规格。
DataNodeId	String	pxc-xdb-xxxxxx	存储节点名称。
ZoneId	String	cn-hangzhou-a	节点所在可用区名称。
Id	String	pxi-*********	逻辑节点ID。
RegionId	String	cn-hangzhou	节点所在地域ID。
ConnAddrs	Array of ConnAddr		连接地址信息。
Type	String	VPC	连接的种类，VPC为内网连接，PUBLIC为公网连接。
VSwitchId	String	vsw-*********	交换机ID。
Port	Long	3306	连接端口号。
VPCId	String	vpc-xxxxxx	VPC ID。
ConnectionString	String	polardbx-xxx.aliyuncs.com	连接地址。
VpcInstanceId	String	pxc-zkralxpc5d****	vpc 内部CloudInstanceId，可以忽略
ReadDBInstances	Array of String	pxr-*********	只读实例名称。
ResourceGroupId	String	rg-*********	资源组ID。
TagSet	Array of TagSet		标签集合。
Key	String	key2	标签名称。
Value	String	value2	标签值。
CnNodeCount	Integer	2	CN节点数量。
DnNodeCount	Integer	2	DN节点数量。
CnNodeClassCode	String	polarx.x4.xlarge.2e	CN节点规格： polarx.x4.medium.2e：2核8G polarx.x4.large.2e：4核16G polarx.x8.large.2e：4核32G polarx.x4.xlarge.2e：8核32G polarx.x8.xlarge.2e：8核64G polarx.x4.2xlarge.2e：16核64G polarx.x8.2xlarge.2e：16核128G polarx.x4.4xlarge.2e：32核128G polarx.x8.4xlarge.2e：32核256G polarx.st.8xlarge.2e：60核470G polarx.st.12xlarge.2e：90核720G
DnNodeClassCode	String	mysql.x8.large.25	DN节点规格： mysql.n2.medium.25：2核4G mysql.n4.medium.25：2核8G mysql.x8.medium.25：2核16G mysql.n2.large.25：4核8G mysql.n4.large.25：4核16G mysql.x8.large.25：4核32G mysql.n2.xlarge.25：8核16G mysql.n4.xlarge.25：8核32G mysql.x8.xlarge.25：8核64G mysql.n4.2xlarge.25：16核64G mysql.x8.2xlarge.25：16核128G mysql.x4.4xlarge.25：32核128G mysql.x8.4xlarge.25：32核256G mysql.st.8xlarge.25：60核470G mysql.st.12xlarge.25：90核720G
Series	String	enterprise	实例系列，取值如下： enterprise：企业版 standard：标准版
LTSVersions	Array of String	X.X.X.X	LTS版本号。
TopologyType	String	3azones	拓扑类型： 3azones：三可用区； 1azone：单可用区。
PrimaryZone	String	cn-shenzhen-e	主可用区。
SecondaryZone	String	cn-shenzhen-a	次可用区。
TertiaryZone	String	cn-shenzhen-e	第三可用区。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDBInstanceAttribute
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&ResourceGroupId=rg-aekzaxhezhs5***
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceAttributeResponse>
    <RequestId>9B2F3840-5C98-475C-B269-2D5C3A31797C</RequestId>
    <DBInstance>
        <Type>ReadWrite</Type>
        <Status>Running</Status>
        <RightsSeparationStatus>disabled</RightsSeparationStatus>
        <DBNodeCount>2</DBNodeCount>
        <Expired>false</Expired>
        <CreateTime>2021-08-31T08:56:25.000+0000</CreateTime>
        <PayType>Postpaid</PayType>
        <Port>3306</Port>
        <LockMode>Unlock</LockMode>
        <Description>test instance</Description>
        <ConnectionString>pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com</ConnectionString>
        <StorageUsed>17042505728</StorageUsed>
        <ExpireDate>2022-08-31T16:00:00.000+0000</ExpireDate>
        <CommodityCode>drds_polarxpost_public_cn</CommodityCode>
        <MaintainStartTime>06:00</MaintainStartTime>
        <DBInstanceType>ReadWrite</DBInstanceType>
        <DBNodeClass>polarx.x4.large.2e</DBNodeClass>
        <LatestMinorVersion>polarx-kernel_5.4.11-16301083_xcluster-20210805</LatestMinorVersion>
        <MaintainEndTime>06:00</MaintainEndTime>
        <DBType>polarx</DBType>
        <RightsSeparationEnabled>false</RightsSeparationEnabled>
        <VPCId>vpc-xxxxx</VPCId>
        <MinorVersion>polarx-kernel_5.4.11-16301083_xcluster-20210805</MinorVersion>
        <RegionId>cn-hangzhou</RegionId>
        <Network>VPC</Network>
        <DBVersion>5.5</DBVersion>
        <VSwitchId>vsw-********</VSwitchId>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <Engine>polarx</Engine>
        <KindCode>18</KindCode>
        <Id>pxc-zkralxpc5d****</Id>
        <DBNodes>
            <ComputeNodeId>pxc-i-********</ComputeNodeId>
            <NodeClass>polarx.x4.large.2e</NodeClass>
            <DataNodeId>pxc-xdb-xxxxxx</DataNodeId>
            <ZoneId>cn-hangzhou-a</ZoneId>
            <Id>pxi-*********</Id>
            <RegionId>cn-hangzhou</RegionId>
        </DBNodes>
        <ConnAddrs>
            <Type>VPC</Type>
            <VSwitchId>vsw-*********</VSwitchId>
            <Port>3306</Port>
            <VPCId>vpc-xxxxxx</VPCId>
            <ConnectionString>polardbx-xxx.aliyuncs.com</ConnectionString>
            <VpcInstanceId>pxc-zkralxpc5d****</VpcInstanceId>
        </ConnAddrs>
        <ReadDBInstances>pxr-*********</ReadDBInstances>
        <ResourceGroupId>rg-*********</ResourceGroupId>
        <TagSet>
            <Key>key2</Key>
            <Value>value2</Value>
        </TagSet>
        <CnNodeCount>2</CnNodeCount>
        <DnNodeCount>2</DnNodeCount>
        <CnNodeClassCode>polarx.x4.xlarge.2e</CnNodeClassCode>
        <DnNodeClassCode>mysql.x8.large.25</DnNodeClassCode>
        <Series>enterprise</Series>
        <LTSVersions>X.X.X.X</LTSVersions>
        <TopologyType>3azones</TopologyType>
        <PrimaryZone>cn-shenzhen-e</PrimaryZone>
        <SecondaryZone>cn-shenzhen-a</SecondaryZone>
        <TertiaryZone>cn-shenzhen-e</TertiaryZone>
    </DBInstance>
</DescribeDBInstanceAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "DBInstance" : {
    "Type" : "ReadWrite",
    "Status" : "Running",
    "RightsSeparationStatus" : "disabled",
    "DBNodeCount" : 2,
    "Expired" : "false",
    "CreateTime" : "2021-08-31T08:56:25.000+0000",
    "PayType" : "Postpaid",
    "Port" : "3306",
    "LockMode" : "Unlock",
    "Description" : "test instance",
    "ConnectionString" : "pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com",
    "StorageUsed" : 17042505728,
    "ExpireDate" : "2022-08-31T16:00:00.000+0000",
    "CommodityCode" : "drds_polarxpost_public_cn",
    "MaintainStartTime" : "06:00",
    "DBInstanceType" : "ReadWrite",
    "DBNodeClass" : "polarx.x4.large.2e",
    "LatestMinorVersion" : "polarx-kernel_5.4.11-16301083_xcluster-20210805",
    "MaintainEndTime" : "06:00",
    "DBType" : "polarx",
    "RightsSeparationEnabled" : false,
    "VPCId" : "vpc-xxxxx",
    "MinorVersion" : "polarx-kernel_5.4.11-16301083_xcluster-20210805",
    "RegionId" : "cn-hangzhou",
    "Network" : "VPC",
    "DBVersion" : "5.5",
    "VSwitchId" : "vsw-********",
    "ZoneId" : "cn-hangzhou-a",
    "Engine" : "polarx",
    "KindCode" : 18,
    "Id" : "pxc-zkralxpc5d****",
    "DBNodes" : [ {
      "ComputeNodeId" : "pxc-i-********",
      "NodeClass" : "polarx.x4.large.2e",
      "DataNodeId" : "pxc-xdb-xxxxxx",
      "ZoneId" : "cn-hangzhou-a",
      "Id" : "pxi-*********",
      "RegionId" : "cn-hangzhou"
    } ],
    "ConnAddrs" : [ {
      "Type" : "VPC",
      "VSwitchId" : "vsw-*********",
      "Port" : 3306,
      "VPCId" : "vpc-xxxxxx",
      "ConnectionString" : "polardbx-xxx.aliyuncs.com",
      "VpcInstanceId" : "pxc-zkralxpc5d****"
    } ],
    "ReadDBInstances" : [ "pxr-*********" ],
    "ResourceGroupId" : "rg-*********",
    "TagSet" : [ {
      "Key" : "key2",
      "Value" : "value2"
    } ],
    "CnNodeCount" : 2,
    "DnNodeCount" : 2,
    "CnNodeClassCode" : "polarx.x4.xlarge.2e",
    "DnNodeClassCode" : "mysql.x8.large.25",
    "Series" : "enterprise",
    "LTSVersions" : [ "X.X.X.X" ],
    "TopologyType" : "3azones",
    "PrimaryZone" : "cn-shenzhen-e",
    "SecondaryZone" : "cn-shenzhen-a",
    "TertiaryZone" : "cn-shenzhen-e"
  }
}

错误码

访问错误中心查看更多错误码。