文档中心 > DescribeDBInstances
DescribeDBInstances

最近更新时间:2021-03-12

调用DescribeDBInstances接口查询MongoDB实例列表。

请求参数

名称类型是否必选示例值描述
ActionStringDescribeDBInstances系统规定参数,取值:DescribeDBInstances
RegionIdStringcb249298-8029-456a-xxxxxxxxxxxx地域ID。
EngineStringmongodb数据库类型。
AccessKeyIdString8hiE6GNfZFxxxxxxxxxxxx紫光云颁发给用户的访问服务所用的秘钥ID。
SignatureStringuC0wRWKW%2F8%2BFc%2xxxxxxxxxxxx紫光云颁发给用户的访问服务所用的签名ID。

返回参数 {#resultMapping .section}

名称类型示例值描述
RequestIdStringrm-uf6wjk5xxxxxxxxxx请求ID。
Result|DescribeDBInstances的参数。
MemoryString2实例内存,单位:G
RegionNameString廊坊实例所在地域名称。
EnginePortInteger27017内网连接端口。
EndTimeString2019-08-05 00:00:00实例到期时间。
CreateTimeString2019-09-04 16:17:16实例开始时间。
CpuCountString1CPU数目,单位:核
DiskString60实例存储空间,单位:GB。
InstanceNameStringmongodb1562228246481实例名称。
EngineStringmongodb数据库类型。
HostIpString172.16.0.115实例内网IP。
InstanceIdString0a9f6840-104c-4f2f-a169-9xxxxxxxxxxxx实例Id。
EngineEditionStringSE数据库实例系列。SE、HA
EngineVersionString3.6数据库版本。3.6
RunStatusStringrunning数据库运行状态。

示例 {#demo .section}

请求示例

http(s)://api.unicloud.com/dbaas?Action=DescribeDBInstances
&DBInstanceId=dbac8bbd-1e79-484a-xxxxxxxxxxxxxxxxxx
&AccessKeyId=BVhcZHCdcxxxxxxxxx
&Signature=8u5EeU%2FHO%2FcMixxxxxxxxx
&<公共请求参数>

正常返回示例

{    "RequestId": "588524d0-ddaa-407b-b068-4cfd9d02cbdc",    "Result": [
        {            "Memory": 2,            "RegionName": "廊坊",            "RunStatus": "creating",            "HostIp": null,            "CpuCount": 1,            "CreateTime": 1574066575000,            "InstanceId": "557eec32-5c8e-xxxx-xxxx-881f752c677f",            "EnginePort": 27017,            "EngineVersion": "3.6",            "EndTime": 1576771200000,            "EngineEdition": "SE",            "Disk": 70,            "InstanceName": "mongodb1574066575282",            "Engine": "mongodb"
        },
        {            "Memory": 2,            "RegionName": "廊坊",            "RunStatus": "running",            "HostIp": "172.16.0.93",            "CpuCount": 1,            "CreateTime": 1574066203000,            "InstanceId": "b8df93d3-66ec-xxxx-xxxx-7f9b3af7e5b8",            "EnginePort": 27017,            "EngineVersion": "3.6",            "EndTime": 1576771200000,            "EngineEdition": "SE",            "Disk": 70,            "InstanceName": "mongodb1574066203365",            "Engine": "mongodb"
        },
        {            "Memory": 2,            "RegionName": "廊坊",            "RunStatus": "running",            "HostIp": "172.16.0.115",            "CpuCount": 1,            "CreateTime": 1574062936000,            "InstanceId": "5f21208c-054e-xxxx-xxxx-c8ad1d4cb1e7",            "EnginePort": 27017,            "EngineVersion": "3.6",            "EndTime": 1576771200000,            "EngineEdition": "SE",            "Disk": 60,            "InstanceName": "mongodb1574062936289",            "Engine": "mongodb"
        }
    ]
}

错误码 { .section}

HttpCode错误码错误信息描述
400Param.RegionId.ErrorThe parameter of RegionId is unknown.地域id校验错误.
400Param.RequiredFieldIsNullThe specified params is null who Required field.必填参数传入为空.
400Param.DataBaseTypeUnknownThe parameter of Engine is unknown.数据库类型非可识别类型.
500Unknown.InnerExceptionSome Exception open in Inner.内部错误.