1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
更新部署组泳道信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyGroupLane。 |
| Version | 是 | String | 公共参数,本接口取值:2018-03-26。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| GroupId | 是 | String | 部署组ID。该参数可以通过调用 DescribeSimpleGroups 的返回值中的 GroupId 字段来获取或通过登录控制台-查看部署组页查看;也可以调用CreateGroup创建新的部署组。 示例值:group-ab2md7wa |
| LaneList.N | 是 | Array of LaneGroup | 泳道部署组列表。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Boolean | 操作结果。- true:成功- false:失败 示例值:true |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新部署组泳道信息
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyGroupLane
<公共请求参数>
{
"GroupId": "group-2vzee8vp",
"LaneList": [
{
"GroupId": "group-2vzee8vp",
"LaneId": "lane-yxld94dy",
"Entrance": true
},
{
"GroupId": "group-2vzee8vp",
"LaneId": "lane-alb9gjxv",
"Entrance": false
}
]
}
输出示例
{
"Response": {
"Result": true,
"RequestId": "794f1bce-97a8-447b-9059-e179b550f13d"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.LaneInfoDeleteConsulFailed | 泳道从consul删除失败。 |
| FailedOperation.LaneInfoGroupNotEmpty | 新增关联部署组不能为空。 |
| FailedOperation.LaneInfoReleaseConsulFailed | 泳道同步到consul失败。 |
| FailedOperation.LaneInfoReleaseMeshFailed | 泳道发布到mesh失败。 |
| FailedOperation.LaneRuleEnableConsulFailed | 全链路灰度规则启用失败。 |
| FailedOperation.LaneRuleMaxLimit | 用户全链路灰度规则最大100条。 |
| FailedOperation.ServiceInsertFailed | 服务数据库入库失败。 |
| InvalidParameter.LaneInfoAlreadyUsed | 已经绑定灰度规则,无法删除。 |
| InvalidParameter.LaneInfoNameAlreadyUsed | 存在同名的泳道。 |
| InvalidParameter.LaneInfoNameInvalid | 泳道名称格式有误。 |
| InvalidParameter.LaneInfoNameNotEmpty | 泳道名称不能为空。 |
| InvalidParameter.LaneInfoNameTooLong | 泳道名称不能超过60个字符。 |
| InvalidParameter.LaneInfoNotExist | 泳道不存在。 |
| InvalidParameter.LaneInfoNotExistEntrance | 泳道没有设置任何入口应用。 |
| InvalidParameter.LaneInfoRemarkTooLong | 泳道备注不能超过200个字符。 |
| InvalidParameter.LaneRuleInfoNotExist | 泳道规则中的泳道不存在。 |
| InvalidParameter.LaneRuleNameAlreadyUsed | 存在同名的泳道规则名称。 |
| InvalidParameter.LaneRuleNameInvalid | 泳道规则名称格式有误。 |
| InvalidParameter.LaneRuleNameNotEmpty | 泳道规则名称不能为空。 |
| InvalidParameter.LaneRuleNameTooLong | 泳道规则名称不能超过60个字符。 |
| InvalidParameter.LaneRuleNotExist | 泳道规则不存在。 |
| InvalidParameter.LaneRuleRemarkTooLong | 泳道规则备注不能超过200个字符。 |
| InvalidParameter.LaneRuleTagNameNotEmpty | 泳道规则标签名不能为空。 |
| InvalidParameter.LaneRuleTagNameTooLong | 泳道规则标签名不能超过32个字符。 |
| InvalidParameter.LaneRuleTagNotEmpty | 泳道规则必须设置至少一个标签。 |
| InvalidParameter.LaneRuleTagValueTooLong | 泳道规则标签值不能超过128个字符。 |
| InvalidParameter.LaneRuleTagValueTotalTooLong | 泳道规则总标签值不能超过200个字符。 |
| InvalidParameterValue.LaneInfoAlreadyUsed | 该泳道已关联全链路灰度发布规则,请先从规则中移除后删除 |
| InvalidParameterValue.LaneInfoNameAlreadyUsed | 存在同名的泳道。 |
| InvalidParameterValue.LaneInfoNameInvalid | 泳道名称格式有误。 |
| InvalidParameterValue.LaneInfoNameNotEmpty | 泳道名称不能为空。 |
| InvalidParameterValue.LaneInfoNameTooLong | 泳道名称不能超过60个字符。 |
| InvalidParameterValue.LaneInfoNotExist | 泳道不存在。 |
| InvalidParameterValue.LaneInfoNotExistEntrance | 泳道没有设置任何入口应用。 |
| InvalidParameterValue.LaneInfoRemarkTooLong | 泳道备注不能超过200个字符。 |
| InvalidParameterValue.LaneRuleInfoNotExist | 全链路灰度规则中的泳道不存在。 |
| InvalidParameterValue.LaneRuleNameAlreadyUsed | 存在同名的全链路灰度规则。 |
| InvalidParameterValue.LaneRuleNameInvalid | 全链路灰度规则名称格式有误。 |
| InvalidParameterValue.LaneRuleNameNotEmpty | 全链路灰度规则名称不能为空。 |
| InvalidParameterValue.LaneRuleNameTooLong | 全链路灰度规则名称不能超过60个字符。 |
| InvalidParameterValue.LaneRuleNotExist | 全链路灰度规则不存在。 |
| InvalidParameterValue.LaneRuleRemarkTooLong | 全链路灰度规则备注不能超过200个字符。 |
| InvalidParameterValue.LaneRuleTagNameNotEmpty | 全链路灰度规则标签名不能为空。 |
| InvalidParameterValue.LaneRuleTagNameTooLong | 全链路灰度规则标签名不能超过32个字符。 |
| InvalidParameterValue.LaneRuleTagNotEmpty | 全链路灰度规则必须设置至少一个标签。 |
| InvalidParameterValue.LaneRuleTagValueTooLong | 全链路灰度规则标签值不能超过128个字符。 |
| InvalidParameterValue.LaneRuleTagValueTotalTooLong | 全链路灰度规则总标签值不能超过200个字符。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。 |