调用DescribeDedicatedClusterInstanceList查看专属集群实例的列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDedicatedClusterInstanceList

要执行的操作,取值:DescribeDedicatedClusterInstanceList

RegionId String cn-hangzhou

地域ID,您可以调用DescribeRegions进行查询。

ZoneId String cn-hangzhou-h

可用区ID,您可以调用DescribeRegions接口查询。

InstanceId String dds-t4n**********

MongoDB的实例ID。

说明 多个ID用英文逗号(,)分开。
InstanceStatus String 1

实例的当前状态。取值的详情,请参见取值详情表

InstanceNetType String 1

实例的网络类型。取值:

  • 0:公网。
  • 1:内网。
  • 2:专有网络VPC。

默认值为1。

Engine String MongoDB

数据库类型,固定为MongoDB。

EngineVersion String 4.2

数据库版本号。当前仅支持4.2

ClusterId String dhg-****************

专属集群ID。

说明 多个ID用英文逗号(,)分开。
DedicatedHostName String ch-****************

专属主机名称。

说明 多个名称用英文逗号(,)分开。
PageNumber Integer 1

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

PageSize Integer 30

每页记录数,取值: 3050100,默认值为30

返回数据

名称 类型 示例值 描述
Instances Array of dbInstance

实例信息列表。

dbInstance
CharacterType String normal

MongoDB实例的类型。当前仅支持normal

normal:副本集实例。

ClusterId String dhg-2x7*************

实例所属的专属集群ID。

ClusterName String TestCluster

实例所属的专属集群名称。

CreateTime String 2020-10-09T06:12:04Z

实例创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ。

CustomId String 123456789

后端运维平台的实例ID。

Engine String MongoDB

数据库引擎。固定为MongoDB

EngineVersion String 4.2

数据库版本。固定为4.2版本。

InstanceClass String mdb.shard.2x.small.s

实例的规格。详情请参见实例规格表中的副本集实例部分。

InstanceId String dds-t4n*************

MongoDB实例ID。

InstanceName String TestInstance

MongoDB实例名称。

InstanceNodeList Array of InstanceNodes

实例节点的列表。

InstanceNodes
DedicatedHostName String ch-t4n**************

专属集群的主机ID。

InsName String xr-dhgi-mongo-21

分片名。

NodeId Integer 4068

节点ID。

NodeIp String 192.168.0.2

节点的IP地址。

NodeType String normal

节点的类型。

Port Integer 3002

节点对应的端口号。

Role String master

节点的角色。返回值:

  • master:主节点
  • slave:从节点
ZoneId String cn-hangzhou-h

可用区ID。

InstanceStatus String 1

实例的状态。关于状态的更多信息,请参见实例状态表

MaintainEndTime String 22:00Z

实例可运维时间段的结束时间,格式为HH:mmZ(UTC时间)。

MaintainStartTime String 18:00Z

实例可运维时间段的开始时间,格式为HH:mmZ(UTC时间)。

Region String 华东1(杭州)

实例所在地域。

RegionId String cn-hangzhou

实例所在地域的ID。

StorageType String CLOUD_ESSD

存储空间的类型。

VpcId String vpc-bpxxxxxxxx

专有网络VPC的ID。

VswitchId String vsw-bpxxxxxxxx

专有网络的交换机ID。

ZoneId String cn-hangzhou-h

实例所属的可用区ID。

PageNumber Integer 1

页码。

PageSize Integer 25

每页记录数。

RequestId String A10B8ECB-0BA0-4EC6-93A5-C65FDEDA07CB

请求ID。

TotalCount Integer 1

查询结果中实例的数量。

示例

请求示例

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

正常返回示例

XML 格式

<Instances>
    <dbInstance>
        <StorageType>CLOUD_ESSD</StorageType>
        <EngineVersion>4.2</EngineVersion>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <InstanceId>dds-t4n*************</InstanceId>
        <ClusterId>dhg-2x7*************</ClusterId>
        <CreateTime>2020-10-09T06:12:04Z</CreateTime>
        <InstanceClass>mdb.shard.2x.small.s</InstanceClass>
        <CharacterType>normal</CharacterType>
        <VswitchId>vsw-bpxxxxxxxx</VswitchId>
        <InstanceName>TestInstance</InstanceName>
        <MaintainEndTime>22:00Z</MaintainEndTime>
        <VpcId>vpc-bpxxxxxxxx</VpcId>
        <InstanceStatus>1</InstanceStatus>
        <CustomId>123456789</CustomId>
        <ClusterName>TestCluster</ClusterName>
        <Region>华东1(杭州)</Region>
        <RegionId>cn-hangzhou</RegionId>
        <Engine>MongoDB</Engine>
        <MaintainStartTime>18:00Z</MaintainStartTime>
    </dbInstance>
    <dbInstance>
        <InstanceNodeList>
            <InstanceNodes>
                <Role>master</Role>
                <ZoneId>cn-hangzhou-h</ZoneId>
                <DedicatedHostName>ch-t4n**************</DedicatedHostName>
                <Port>3002</Port>
                <NodeType>normal</NodeType>
                <NodeId>4068</NodeId>
                <NodeIp>192.168.0.2</NodeIp>
                <InsName>xr-dhgi-mongo-21</InsName>
            </InstanceNodes>
        </InstanceNodeList>
    </dbInstance>
</Instances>
<TotalCount>1</TotalCount>
<PageSize>25</PageSize>
<RequestId>A10B8ECB-0BA0-4EC6-93A5-C65FDEDA07CB</RequestId>
<PageNumber>1</PageNumber>

JSON 格式

{
    "Instances":{
        "dbInstance":[
            {
                "StorageType":"CLOUD_ESSD",
                "EngineVersion":"4.2",
                "ZoneId":"cn-hangzhou-h",
                "InstanceId":"dds-t4n*************",
                "ClusterId":"dhg-2x7*************",
                "CreateTime":"2020-10-09T06:12:04Z",
                "InstanceClass":"mdb.shard.2x.small.s",
                "CharacterType":"normal",
                "VswitchId":"vsw-bpxxxxxxxx",
                "InstanceName":"TestInstance",
                "MaintainEndTime":"22:00Z",
                "VpcId":"vpc-bpxxxxxxxx",
                "InstanceStatus":"1",
                "CustomId":"123456789",
                "ClusterName":"TestCluster",
                "Region":"华东1(杭州)",
                "RegionId":"cn-hangzhou",
                "Engine":"MongoDB",
                "MaintainStartTime":"18:00Z"
            },{
                "InstanceNodeList":{
                    "InstanceNodes":[
                        {
                            "Role":"master",
                            "ZoneId":"cn-hangzhou-h",
                            "DedicatedHostName":"ch-t4n**************",
                            "Port":"3002",
                            "NodeType":"normal",
                            "NodeId":"4068",
                            "NodeIp":"192.168.0.2",
                            "InsName":"xr-dhgi-mongo-21"
                        }
                    ]
                }
            }
        ]
    },
    "TotalCount":"1",
    "PageSize":"25",
    "RequestId":"A10B8ECB-0BA0-4EC6-93A5-C65FDEDA07CB",
    "PageNumber":"1"
}

错误码

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