1. 接口描述
域名: cmem.api.qcloud.com
接口名: DescribeCmem
查询实例列表
可调用地域:广州、上海、北美
2. 输入参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
limit | 否 | Int | 页面大小,默认为20 最大100 |
offset | 否 | Int | 偏移量,默认为0 |
vpcId | 否 | Int | VPC网络ID,可选值为 -1、0以及正常的vpcId,其中-1表示所有网络,0表示基础网络 |
subnetId | 否 | Int | VPC网络子网ID,默认值为-1,-1表示忽略此参数 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 错误码,0: 成功,其他值: 失败 |
totalCount | Int | 符合除limit和offset参数以外的条件的总实例数,可以结合limit和offset用于翻页查询 |
message | String | 错误信息 |
data | Array | 返回数组 |
data.cmemId | Int | Memcached ID |
data.cmemName | String | 实例名称 |
data.expire | Int | 是否开启expire过期,0未开启,1已开启 |
data.status | Int | status等于1时可以进行改名、清空、开启expire等操作 |
data.autoRenew | Int | 自动续费标识 0未开启,1已开启 |
data.wanIp | String | 实例Ip |
data.port | Int | 实例服务端口 |
4. 示例
输入
https://cmem.api.qcloud.com/v2/index.php?Action=DescribeCmem &<公共请求参数> &limit=10 &offset=0
输出
{
"code": 0,
"message": "",
"totalCount": 1,
"data": [
{
"cmemId": 104017148,
"cmemName": "test",
"expire": 1,
"status": 1,
"autoRenew": 0,
"wanIp": "10.66.152.150",
"port": 9101,
"projectId": 0
}
]
}