接口功能介绍

查询实例详情

接口约束

用户通过鉴权认证

URI

GET /DDS2/v2/openApi/describeDBInstanceAttribute

路径参数 无

Query参数

参数	是否必填	参数类型	说明	示例	下级对象
prodInstId	是	String	文档数据库对外的实例标识	60d420bffb394*************************

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
project-id	否	String	项目id	0
regionId	是	String	资源池id	bb9fdb42056f11eda1610242ac110002

请求体body参数 无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	响应码取值范围：800为成功，900为失败	800
message	String	响应信息	查询MongoDB实例详情成功
returnObj	Object	返回对象		returnObj
error	String	错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。
表 returnObj

参数	参数类型	说明	示例	下级对象
subnet	String	子网信息	subnet-test
backup	Object	备份节点信息		backup
vpcName	String	vpc名称	vpc-001-test
vpcId	String	vpcid	vpc-brgeuyks6f
prodInstName	String	实例名称	test001
prodType	Integer	0:单机 2:副本集(三节点) 4:副本集(五节点) 6:副本集(七节点) 10:分片集群	0
userId	Integer	用户id	111
enableSSL	Integer	enableSSL表示是否开启ssl连接，1表示开启，0表示未开启	0
securityGroupId	String	安全组id	sg-0sfcsg
diskSize	Integer	存储空间大小/G	100
createTime	String	实例创建时间	2022-10-10 00:00:00
prodRunningStatus	Integer	实例的运行状态: 0:运行正常 1:重启中 2:备份操作中 3:恢复操作中 4:转换 SSL 6:修改参数组中 7:已冻结 8:已注销 9:施工中 11:扩容中 12:主备切换中	0
diskRate	String	磁盘使用率	10%
host	String	主节点host	67
prodInstId	String	实例id	60d420bffb394*************************
machineSpec	String	实例规格	64C500G
cpuType	Integer	cpu类型，10-Kunpeng，20-Haiguang，30-Intel，40-AMD，50-Feiteng，60-Longxin，70-Zhaoxin	30
hostSeries	String	性能类型，S系列-通用型，C系列-计算增强型，M系列-内存优化型	S7
diskType	String	磁盘类型	SAS
nodeInfoVOS	Object	节点信息		nodeInfoVOS
表 backup

参数	参数类型	说明	示例
usepercent	String	磁盘空间使用率	10%
size	String	磁盘空间大小	100G
used	String	磁盘空间使用大小	10G
表 nodeInfoVOS

参数	参数类型	说明	示例
elasticIp	String	弹性ip	127.0.0.1
node	String	该mongodb的标签，规定为“set_ + 三个尾部ip + 端口号”	set_1098350_1
role	String	角色	master
alive	Integer	取自mongodb中的ok属性	0
vpcIpv6	String	vpc内部的ipv6地址
port	String	访问该mongodb的端口	888
resId	Integer	唯一标志该mongodb	67
outerElasticIpId	String	eipId	eip-qa0lwiyqe7
allowBeMaster	Boolean	允许切换成为备用节点	true
memory	Integer	内存	12
usedSpace	String	已使用空间	null
type	String	组件类型	null
azDisplayName	String	可用区展示名	az1
azId	String	可用区id
ipv6Bind	Byte	绑定ipv6带宽标记位, 0表示未绑定, 1表示绑定
uuid	String	机器uuid
diskSize	String	存储空间
host	String	机器节点的vpc ip地址
prodInstSetName	String	实例set名称
cpuCount	Integer	cpu核数
realIp	String	实际管理ip
ipv6Cidrs	String	ipv6 网段
prodType	Byte	节点类型（分片集群才有该值）
regionId	String	资源池id
prodInstId	String	实例id

枚举参数

无

请求示例

请求url

/v2/openApi/describeDBInstanceAttribute?prodInstId=60d420bffb394*************************

请求头header

project-id=0
regionId=bb9fdb42056f11eda1610242ac110002

请求体body

无

响应示例

{
  "statusCode": 800,
  "message": "查询MongoDB实例详情成功",
  "returnObj": {
    "subnet": "subnet-test",
    "backup": {
      "usepercent": "1%",
      "size": "110G",
      "used": "33M"
    },
    "vpcName": "vpc-001-test",
    "prodInstName": "dds-788-zyh-dev",
    "prodType": 2,
    "enableSSL": 0,
    "securityGroupId": "sg-0sfcsg",
    "diskSize": 110,
    "createTime": 1689134096000,
    "port": "8039",
    "prodRunningStatus": 0,
    "diskRate": null,
    "nodeInfoVOS": [
      {
        "realIp": null,
        "allowBeMaster": true,
        "outerElasticIpId": "eip-qa0lwiyqe7",
        "memory": null,
        "role": "secondary",
        "alive": 1,
        "usedSpace": null,
        "vpcIpv6": "",
        "type": null,
        "resId": 15379513,
        "elasticIp": "100.124.1.203",
        "node": "DDS_1",
        "diskSize": null,
        "port": "8039",
        "azDisplayName": "西北-内蒙演示3",
        "azId":"1",
        "host": "192.168.***.***",
        "prodInstSetName": null,
        "prodInstId": "60d420bffb394*************************",
        "cpuCount": null
      }
    ],
    "vpcId": "vpc-brgeuyks6f",
    "host": "192.168.***.***",
    "tenantId": 0,
    "prodInstId": "60d420bffb394*************************",
    "diskType": "SATA",
    "machineSpec": "1C4G"
  }
}

状态码

请参考状态码

错误码

请参考错误码

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

文档数据库服务

文档数据库服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

文档数据库服务

文档数据库服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码