1. 接口描述
本接口(DescribeServiceGroups)用于查询(网络)参数模板协议端口组列表。
接口请求域名:vpc.api.qcloud.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 DescribeServiceGroups。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
serviceGroupId | 否 | String | 协议端口组 ID,支持模糊搜索。 |
serviceGroupName | 否 | String | 协议端口组名称,支持模糊搜索。 |
offset | 否 | int | 初始行的偏移量,默认为0。 |
limit | 否 | int | 每页行数,默认为20。 |
注意:serviceGroupId 和 serviceGroupName 作为查询条件为逻辑与关系。
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 数字错误码, 0表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 错误信息。 |
codeDesc | String | 英文错误码。 |
data | Object | 返回的数据结构。 |
data 结构
参数名称 | 类型 | 描述 |
---|---|---|
data.totalCount | Int | 返回的协议端口组总数。 |
data.data | Array | 协议端口组详情列表。 |
data.data 结构
参数名称 | 类型 | 描述 |
---|---|---|
data.data.n.serviceGroupId | String | 协议端口组 ID |
data.data.n.serviceGroupName | String | 协议端口组名称 |
data.data.n.serviceGroup | Array | 协议端口组成员 |
data.data.n.createTime | String | 创建时间 |
data.data.n.serviceGroup 结构
参数名称 | 类型 | 描述 |
---|---|---|
data.data.n.serviceGroup.n | String | 协议端口组成员 |
4. 错误码表
错误码数值 | 原因 |
---|---|
29257 | 后台错误,请求失败。 |
29258 | 引用资源不存在。 |
29259 | 关联对象因规则展开过大拒绝您的关联。 |
29260 | 参数模板总数或成员数使用超限。 |
29254 | 鉴权失败。 |
9003 | 参数错误。 |
9005 | 系统忙或有相关资源正在被编辑。 |
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=DescribeServiceGroups &<公共请求参数> &serviceGroupName=a
输出
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"totalCount": 1,
"data": [
{
"serviceGroupId": "ppmg-6piqsucc",
"serviceGroupName": "aaaa",
"serviceGroup": [
{
"serviceId": "ppm-fa2766v5",
"serviceName": "test"
}
],
"createTime": "2017-07-11 14:58:11"
}
]
}
}