查询泳道列表
最近更新时间: 2026-09-17 00:04:00
1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.cn。
查询泳道列表
默认接口请求频率限制：20次/秒。
接口更新时间：2024-09-14 11:55:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeLanes |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Limit | 否 | 否 | Int64 | 每页展示的条数 示例值： |
| Offset | 否 | 否 | Int64 | 翻页偏移量 示例值： |
| SearchWord | 否 | 否 | String | 搜索关键字 示例值： |
| LaneIdList | 否 | 否 | Array of String | 无 示例值： |
| DisableProgramAuthCheck | 否 | 否 | Bool | 无 示例值： |
3. 输出参数
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.LaneInfoNameNotEmpty | 泳道名称不能为空。 |
| InvalidParameter.LaneInfoNameTooLong | 泳道名称不能超过60个字符。 |
| InvalidParameter.LaneInfoNameInvalid | 泳道名称格式有误。 |
| InvalidParameter.LaneInfoNameAlreadyUsed | 存在同名的泳道。 |
| InvalidParameter.LaneInfoRemarkTooLong | 泳道备注不能超过200个字符。 |
| InvalidParameter.LaneInfoNotExistEntrance | 泳道没有设置任何入口应用。 |
| InvalidParameter.LaneInfoAlreadyUsed | 已经绑定灰度规则，无法删除。 |
| InvalidParameter.LaneRuleInfoNotExist | 泳道规则中的泳道不存在。 |
| InvalidParameter.LaneInfoNotExist | 泳道不存在。 |
| InvalidParameter.LaneRuleNotExist | 泳道规则不存在。 |
| InvalidParameter.LaneRuleNameTooLong | 泳道规则名称不能超过60个字符。 |
| InvalidParameter.LaneRuleNameAlreadyUsed | 存在同名的泳道规则名称。 |
| InvalidParameter.LaneRuleNameInvalid | 泳道规则名称格式有误。 |
| InvalidParameter.LaneRuleRemarkTooLong | 泳道规则备注不能超过200个字符。 |
| InvalidParameter.LaneRuleTagNotEmpty | 泳道规则必须设置至少一个标签。 |
| InvalidParameter.LaneRuleTagNameNotEmpty | 泳道规则标签名不能为空。 |
| InvalidParameter.LaneRuleTagNameTooLong | 泳道规则标签名不能超过32个字符。 |
| InvalidParameter.LaneRuleTagValueTooLong | 泳道规则标签值不能超过128个字符。 |
| InvalidParameter.LaneRuleTagValueTotalTooLong | 泳道规则总标签值不能超过200个字符。 |
| FailedOperation.LaneRuleEnableConsulFailed | 全链路灰度规则启用失败。 |
| FailedOperation.LaneInfoReleaseConsulFailed | 泳道同步到consul失败。 |
| FailedOperation.LaneInfoDeleteConsulFailed | 泳道从consul删除失败。 |
| FailedOperation.LaneInfoGroupNotEmpty | 新增关联部署组不能为空。 |
| InvalidParameter.LaneRuleNameNotEmpty | 泳道规则名称不能为空。 |
| FailedOperation.LaneRuleMaxLimit | 用户全链路灰度规则最大100条。 |
| InvalidParameterValue.LaneInfoNameNotEmpty | 泳道名称不能为空。 |
| InvalidParameterValue.LaneInfoNameTooLong | 泳道名称不能超过60个字符。 |
| InvalidParameterValue.LaneInfoNameInvalid | 泳道名称格式有误。 |
| InvalidParameterValue.LaneInfoNameAlreadyUsed | 存在同名的泳道。 |
| InvalidParameterValue.LaneInfoRemarkTooLong | 泳道备注不能超过200个字符。 |
| InvalidParameterValue.LaneInfoNotExistEntrance | 泳道没有设置任何入口应用。 |
| InvalidParameterValue.LaneInfoAlreadyUsed | 已经绑定灰度规则，无法删除。 |
| InvalidParameterValue.LaneRuleInfoNotExist | 全链路灰度规则中的泳道不存在。 |
| InvalidParameterValue.LaneInfoNotExist | 泳道不存在。 |
| InvalidParameterValue.LaneRuleNotExist | 全链路灰度规则不存在。 |
| InvalidParameterValue.LaneRuleNameNotEmpty | 全链路灰度规则名称不能为空。 |
| InvalidParameterValue.LaneRuleNameTooLong | 全链路灰度规则名称不能超过60个字符。 |
| InvalidParameterValue.LaneRuleNameAlreadyUsed | 存在同名的全链路灰度规则。 |
| InvalidParameterValue.LaneRuleNameInvalid | 全链路灰度规则名称格式有误。 |
| InvalidParameterValue.LaneRuleRemarkTooLong | 全链路灰度规则备注不能超过200个字符。 |
| InvalidParameterValue.LaneRuleTagNotEmpty | 全链路灰度规则必须设置至少一个标签。 |
| InvalidParameterValue.LaneRuleTagNameNotEmpty | 全链路灰度规则标签名不能为空。 |
| InvalidParameterValue.LaneRuleTagNameTooLong | 全链路灰度规则标签名不能超过32个字符。 |
| InvalidParameterValue.LaneRuleTagValueTooLong | 全链路灰度规则标签值不能超过128个字符。 |
| InvalidParameterValue.LaneRuleTagValueTotalTooLong | 全链路灰度规则总标签值不能超过200个字符。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
5. 示例
示例1 查询泳道列表
输入示例
https://tsf.api3.<no value>/?Action=DescribeLanes
&Limit=0
&Offset=10
&<公共请求参数>
输出示例
{
"Response": {
"Result": {
"Content": [
{
"Remark": "xx",
"Entrance": true,
"UpdateTime": 0,
"LaneId": "xx",
"NamespaceIdList": [
"xx"
],
"LaneGroupList": [
{
"ApplicationName": "xx",
"Entrance": true,
"NamespaceName": "xx",
"LaneGroupId": "xx",
"UpdateTime": 0,
"ClusterType": "xx",
"GroupName": "xx",
"LaneId": "xx",
"NamespaceId": "xx",
"GroupId": "xx",
"ApplicationId": "xx",
"CreateTime": 0
}
],
"LaneName": "xx",
"CreateTime": 0
}
],
"TotalCount": 0
},
"RequestId": "xx"
}
}