API参考—实例管理—DescribeDBInstances-阿里云开发者社区

开发者社区> PolarDB-X开源社区> 正文
登录阅读全文

API参考—实例管理—DescribeDBInstances

简介: 调用DescribeDBInstances接口查看实例列表详情。

调试

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

调试

请求参数

名称类型是否必选示例值描述
ActionStringDescribeDBInstances

系统规定参数。取值为DescribeDBInstances

RegionIdStringch-hangzhou

实例所属地域。

PageNumberInteger1

页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1

PageSizeInteger30

每页记录数,取值为3050100

默认值为30

ResourceGroupIdString-1

资源组ID。

返回数据

名称类型示例值描述
DBInstancesArray of DBInstance

实例信息。

ExpireDateString2020-08-29T06:09:30.000+0800

实例到期时间,格式为yyyy-MM-ddTHH:mm:ss.SSSZ,例如2020-08-29T06:09:30.000+0800表示该实例于北京时间(UTC+8)2020年8月29日上午6时9分30秒到期。

说明 仅包年包月实例支持该参数。

PageNumberInteger1

页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1

PageSizeInteger30

每页记录数,取值为3050100

默认值为30

RequestIdString91EA81C3-1622-47BF-BDCC-0D7BA1******

请求ID。

示例

请求示例


http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=ch-hangzhou
&<公共请求参数>

正常返回示例

XML 格式


<code>200</code>
<data>
    <RequestId>91EA81C3-1622-47BF-BDCC-0D7BA1******</RequestId>
    <PageSize>2</PageSize>
    <PageNumber>1</PageNumber>
    <DBInstances>
        <Status>Running</Status>
        <Description/>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <NodeCount>2</NodeCount>
        <VPCId>vpc-*********************</VPCId>
        <CreateTime>2020-07-29T06:09:30.000+0800</CreateTime>
        <Expired>false</Expired>
        <PayType>Prepaid</PayType>
        <DBType>polarx</DBType>
        <LockMode>Unlock</LockMode>
        <StorageUsed>6784286720</StorageUsed>
        <NodeClass>polarx.x4.large.2d</NodeClass>
        <DBVersion>5.7</DBVersion>
        <Network>VPC</Network>
        <CommodityCode>drds_polarxpre_public_cn</CommodityCode>
        <Id>pxc-****************</Id>
        <RegionId>cn-hangzhou</RegionId>
        <ExpireTime>2020-08-29T06:09:30.000+0800</ExpireTime>
        <Engine>polarx</Engine>
    </DBInstances>
    <DBInstances>
        <Status>Running</Status>
        <Description>2test</Description>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <NodeCount>2</NodeCount>
        <VPCId>vpc-*********************</VPCId>
        <CreateTime>2020-07-29T06:09:30.000+0800</CreateTime>
        <Expired>false</Expired>
        <PayType>Prepaid</PayType>
        <DBType>polarx</DBType>
        <LockMode>Unlock</LockMode>
        <StorageUsed>6834618368</StorageUsed>
        <NodeClass>polarx.x4.large.2d</NodeClass>
        <DBVersion>5.7</DBVersion>
        <Network>VPC</Network>
        <CommodityCode>drds_polarxpre_public_cn</CommodityCode>
        <Id>pxc-****************</Id>
        <RegionId>cn-hangzhou</RegionId>
        <ExpireTime>2020-08-29T06:09:30.000+0800</ExpireTime>
        <Engine>polarx</Engine>
    </DBInstances>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>91EA81C3-1622-47BF-BDCC-0D7BA1******</requestId>
<successResponse>true</successResponse>

JSON 格式


{
    "code": "200",
    "data": {
        "RequestId": "91EA81C3-1622-47BF-BDCC-0D7BA1******",
        "PageSize": 2,
        "PageNumber": 1,
        "DBInstances": [{
            "Status": "Running",
            "Description": "",
            "ZoneId": "cn-hangzhou-h",
            "NodeCount": 2,
            "VPCId": "vpc-*********************",
            "CreateTime": "2020-07-29T06:09:30.000+0800",
            "Expired": false,
            "PayType": "Prepaid",
            "DBType": "polarx",
            "LockMode": "Unlock",
            "StorageUsed": 6784286720,
            "NodeClass": "polarx.x4.large.2d",
            "DBVersion": "5.7",
            "Network": "VPC",
            "CommodityCode": "drds_polarxpre_public_cn",
            "Id": "pxc-****************",
            "RegionId": "cn-hangzhou",
            "ExpireTime": "2020-08-29T06:09:30.000+0800",
            "Engine": "polarx"
        }, {
            "Status": "Running",
            "Description": "2test",
            "ZoneId": "cn-hangzhou-h",
            "NodeCount": 2,
            "VPCId": "vpc-*********************",
            "CreateTime": "2020-07-29T06:09:30.000+0800",
            "Expired": false,
            "PayType": "Prepaid",
            "DBType": "polarx",
            "LockMode": "Unlock",
            "StorageUsed": 6834618368,
            "NodeClass": "polarx.x4.large.2d",
            "DBVersion": "5.7",
            "Network": "VPC",
            "CommodityCode": "drds_polarxpre_public_cn",
            "Id": "pxc-****************",
            "RegionId": "cn-hangzhou",
            "ExpireTime": "2020-08-29T06:09:30.000+0800",
            "Engine": "polarx"
        }]
    },
    "httpStatusCode": "200",
    "requestId": "91EA81C3-1622-47BF-BDCC-0D7BA1******",
    "successResponse": true
}

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享:

阿里云原生分布式数据库PolarDB-X,是一款面向超高并发、海量存储、复杂查询场景设计的云原生分布式数据库系统。其采用 Shared-nothing 与计算存储分离架构,支持水平扩展、分布式事务、混合负载等能力,具备企业级、云原生、高可用、高度兼容 MySQL 系统及生态等特点。

官方博客
最新文章
相关文章
官网链接