1. 接口描述
本接口(ModifyServiceGroup)用于编辑协议端口组。
接口请求域名:vpc.api.qcloud.com
2. 请求参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的Action字段为 ModifyServiceGroup
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
serviceGroupId | 是 | String | 协议端口组 ID。 |
serviceGroup | 是 | Array | 协议端口 ID 列表。 |
serviceGroup.n | 是 | String | 协议端口 ID 列表成员。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 数字错误码, 0 表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 字符串错误码。 |
data | Object | 返回信息。 |
data.taskId | Int | 请求任务 ID,由具体的异步操作接口提供,例如 15454。 |
4. 任务查询输出参数
通过 DescribeNetTaskResult 接口可以查询任务结果
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码, 0 表示任务查询成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 字符串错误码。 |
data | Object | 返回信息。 |
data.status | Int | 任务的当前状态。0:成功,1:失败,2:进行中。 |
data.output | Object | 任务执行中间状况详情。任务的最终成败以data.status为准。 |
data.data | Object/Array | 仅用于查询类任务,本接口请忽略字段。 |
data.output 结构
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 数字错误码。 |
message | String | 结果描述。 |
5. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 公共错误码。
错误码数值 | 原因 |
---|---|
29257 | 后台错误,请求失败。 |
29258 | 引用资源不存在。 |
29259 | 关联对象因规则展开过大拒绝您的关联。 |
29260 | 参数模板总数或成员数使用超限。 |
29254 | 鉴权失败。 |
9003 | 参数错误。 |
9005 | 系统忙或有相关资源正在被编辑。 |
6. 示例
执行一个参数模板的异步调用,然后使用 DescribeNetTaskResult 查询结果。
例如查询一个参数模板是否被云资源引用:
步骤1:
输入
https://vpc.api.qcloud.com/v2/index.php?Action=ModifyServiceGroup &<公共请求参数> &serviceGroupId=ppmg-a8ky2366&addressGroup.0=ppm-52ut9s88
输出
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"taskId": 297
}
}
步骤2:
输入
https://vpc.api.qcloud.com/v2/index.php?Action=DescribeNetTaskResult &<公共请求参数> &taskId=297
输出
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"status": 0,
"output": {
"code": 0,
"message": "OK"
}
}
}