DescribeDBInstanceAttribute - 查询实例属性 - 云原生数据库 PolarDB

调用DescribeDBInstanceAttribute接口获取实例属性。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeDBInstanceAttribute

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所在地域。	cn-hangzhou
DBInstanceName	string	是	实例名。	pxc-********
ResourceGroupId	string	否	资源组 ID。	rg-aekzaxhezhs5***

返回参数

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

示例

正常返回示例

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-*********"
    ],
    "ColumnarReadDBInstances": [
      "xxx"
    ],
    "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",
    "DifferentDNSpec": false,
    "ColumnarInstanceName": "xxxx",
    "CanNotCreateColumnar": true,
    "GdnInstanceName": "",
    "GdnMemberList": [
      {
        "Role": "",
        "MemberName": "",
        "Status": ""
      }
    ],
    "SpecCategory": "",
    "GdnRole": "",
    "PrimaryInstanceId": "",
    "StorageType": "",
    "CpuType": "",
    "EngineVersion": "",
    "DnStorageSpace": "",
    "AiGatewayEnabled": ""
  }
}

错误码

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

变更历史

更多信息，参考变更详情。