调用DescribeDBInstances接口查询MongoDB实例列表。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|
Action | String | 是 | DescribeDBInstances | 系统规定参数,取值:DescribeDBInstances。 |
RegionId | String | 是 | cb249298-8029-456a-xxxxxxxxxxxx | 地域ID。 |
Engine | String | 是 | mongodb | 数据库类型。 |
AccessKeyId | String | 是 | 8hiE6GNfZFxxxxxxxxxxxx | 紫光云颁发给用户的访问服务所用的秘钥ID。 |
Signature | String | 是 | uC0wRWKW%2F8%2BFc%2xxxxxxxxxxxx | 紫光云颁发给用户的访问服务所用的签名ID。 |
返回参数 {#resultMapping .section}
名称 | 类型 | 示例值 | 描述 |
---|
RequestId | String | rm-uf6wjk5xxxxxxxxxx | 请求ID。 |
Result | | | DescribeDBInstances的参数。 |
|
Memory | String | 2 | 实例内存,单位:G |
RegionName | String | 廊坊 | 实例所在地域名称。 |
EnginePort | Integer | 27017 | 内网连接端口。 |
EndTime | String | 2019-08-05 00:00:00 | 实例到期时间。 |
CreateTime | String | 2019-09-04 16:17:16 | 实例开始时间。 |
CpuCount | String | 1 | CPU数目,单位:核 |
Disk | String | 60 | 实例存储空间,单位:GB。 |
InstanceName | String | mongodb1562228246481 | 实例名称。 |
Engine | String | mongodb | 数据库类型。 |
HostIp | String | 172.16.0.115 | 实例内网IP。 |
InstanceId | String | 0a9f6840-104c-4f2f-a169-9xxxxxxxxxxxx | 实例Id。 |
EngineEdition | String | SE | 数据库实例系列。SE、HA |
EngineVersion | String | 3.6 | 数据库版本。3.6 |
RunStatus | String | running | 数据库运行状态。 |
示例 {#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 | 错误码 | 错误信息 | 描述 |
---|
400 | Param.RegionId.Error | The parameter of RegionId is unknown. | 地域id校验错误. |
400 | Param.RequiredFieldIsNull | The specified params is null who Required field. | 必填参数传入为空. |
400 | Param.DataBaseTypeUnknown | The parameter of Engine is unknown. | 数据库类型非可识别类型. |
500 | Unknown.InnerException | Some Exception open in Inner. | 内部错误. |