全部文档
当前文档
最近更新时间：2024-05-20 19:46:23
查询服务列表，允许您根据特定的条件查询资源，并支持对资源排序，默认每次查出10个服务
关于所有操作需要的通用参数，请参照通用请求-公共参数
英文名称 | 中文名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|---|
Action | 调用接口名称 | String | 是 | 取固定值：DescribeMongoDBInstances |
Version | API版本号 | String | 是 | 取固定值：2017-01-01 |
InstanceId | MongoDB服务ID | String | 是 | |
Name | 实例名称 | String | 否 | |
Vip | 服务IP地址 | String | 否 | |
VpcId | 虚拟专用网络ID | String | 否 | 只适用于VPC网络下的服务 |
VnetId | 虚拟专用网路EndpointID，或vpclbID | String | 否 | 只适用于VPC网络下的服务 |
Offset | 查询数据的起始位置 | Integer | 否 | 默认为0 |
Limit | 需要从起始位置开始查询的缓存服务的个数 | Sinteger | 否 | 取值范围为[1~100]，默认为10 |
OrderBy | 排序字段 | String | 否 | 可传值为{name,asc，name,desc，created,asc，created,desc}，默认按照创建时间降序，只有排序字段时，默认按照升序排列 |
IamProjectId | 项目ID | String | 否 | 默认查询用户关联的全部项目，若查询指定项目，需传入所查询的项目ID，用‘,’隔开 |
GET
关于所有操作返回的错误信息，请参照通用请求-通用错误信息
https://mongodb.${region}.api.ksyun.com/
api?Action=DescribeMongoDBInstances
&Version=2017-01-01
&OrderBy=name,asc
&IamProjectId=1,2,3HttpStatusCode=200
{
"RequestId": "T0E1S2T3S-AFQWOFJQOJF-WFWFWF-FDGD",
"MongoDBInstancesResult": [
{
"IamProjectId":"22",
"IamProjectName":"tes9t1",
"UserId": "73403574",
"Region": "cn-shanghai-3",
"Name": "dhhu-test",
"instanceId": "468428c3-8637-4444-a11e-4b5d985e419d",
"Status": "unknown",
"IP": "10.0.0.198,10.0.0.202,10.0.0.151",
"InstanceType": "HighIO",
"Version": null,
"InstanceClass": "1C2G",
"Storage": 10,
"Port": null,
"NetworkType": "VPC",
"VpcId": "3c12ccdf-9b8f-4d9b-8aa6-a523897e97a1",
"VnetId": "293c16a5-c757-405c-a693-3b2a3adead50",
"ProductId": "xxxxxxxx",
"ProductWhat": 1,
"PayType": "byMonth",
"CreateDate": "2017-01-20 18:13:14",
"ExpirationDate": null
},
{
"IamProjectId":"22",
"IamProjectName":"tes9t1",
"UserId": "73403574",
"Region": "cn-shanghai-3",
"Name": "lxb-test-002",
"instanceId": "cbc2273c-bd7e-4c8b-a2ca-43582b09ad26",
"Status": "unknown",
"IP": "10.0.0.167,10.0.0.175",
"InstanceType": "HighIO",
"Version": null,
"InstanceClass": "1C2G",
"Storage": 8,
"Port": null,
"NetworkType": "VPC",
"VpcId": "3c12ccdf-9b8f-4d9b-8aa6-a523897e97a1",
"VnetId": "293c16a5-c757-405c-a693-3b2a3adead50",
"ProductId": "xxxxxxxx",
"PayType": "byMonth",
"ProductWhat": 1,
"CreateDate": "2017-01-20 11:51:56",
"ExpirationDate": null
},
{
"IamProjectId":"22",
"IamProjectName":"tes9t1",
"UserId": "73403574",
"Region": "cn-shanghai-3",
"Name": "lxb-test-001",
"instanceId": "ce009fb8-1428-4052-839e-9c07d26e2431",
"Status": "unknown",
"IP": null,
"InstanceType": "HighIO",
"Version": null,
"InstanceClass": "1C2G",
"Storage": 8,
"Port": null,
"NetworkType": "Basic",
"VpcId": null,
"VnetId": null,
"PayType": "byMonth",
"ProductWhat": 2,
"CreateDate": "2017-01-20 11:38:22",
"ExpirationDate": null
}
],
"Offset": 0,
"Limit": 10,
"Total": 3
}纯净模式