文档中心 > DescribeDBInstanceAttribute
DescribeDBInstanceAttribute

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

调用DescribeDBInstanceAttribute接口查询一个MongoDB实例详情。

请求参数

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

返回参数 {#resultMapping .section}

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

示例 {#demo .section}

请求示例

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

正常返回示例

{    "RequestId":"fbc62a7e-437d-4a5e-922b-7d84e9932d0e",    "Result": {        "RunStatus": "ACTIVE",        "HostIp": "[\"172.16.0.12\"]",        "CpuCount": "1",        "StatusDescription": "running",        "ClusterNodes": 0,        "CreateTime": "2019-07-05 11:01:11",        "RegionName": "廊坊",        "Disk": "60",        "InstanceId": "75e71cd4-6da9-42fe-99d6-fcf36faecc6c",        "EnginePort": 27017,        "Memory": "2",        "EndTime": "2019-08-06 00:00:00",        "EngineEdition": "SE",        "EngineVersion": "3.6",        "InstanceName": "mongodb1562295679721",        "Engine": "mongodb"
    }
}

错误码 { .section}

HttpCode错误码错误信息描述
400Param.RequiredFieldIsNullThe specified params is null who Required field.必填参数传入为空.
400InstancesUnavailable.InstanceNullThe instance is Unavailable, Please check the instance.本实例不可用,请检查实例是否正确..
500Unknown.InnerExceptionSome Exception open in Inner.内部错误.