查询网关实体列表(超云)
最近更新时间: 2026-10-11 00:12:04
1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.com。
查询网关实体列表(超云)
增加返回值:
MultiCloudStatus 是否禁用绑定
MultiCloudStatusMsg 禁用提示
默认接口请求频率限制:20次/秒。
接口更新时间:2026-01-14 21:07:06。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeGatewayInstancesByMultiCloud |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| SearchWord | 否 | 否 | String | 搜索词 示例值: gateway-instance-1 |
| Offset | 否 | 否 | Int64 | 偏移量 示例值: 500 |
| Limit | 否 | 否 | Int64 | 限制数目 示例值: 100 |
| IdList | 否 | 否 | Array of String | 无 示例值: ["gw-ins-zyepxrlv"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TsfPageGatewayInstance | 网关实体分页列表 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见公共错误码。
5. 示例
示例1 查询网关实体列表(超云)
输入示例
{
"SearchWord": "gateway-instance-1",
"Offset": 500,
"Limit": 100,
"IdList": [
"gw-ins-zyepxrlv"
]
}
输出示例
{
"Response": {
"RequestId": "9d1dabb1-acd2-43c4-beb0-f91bd76f1cbc",
"Result": {
"TotalCount": 121,
"Content": [
{
"ServiceId": "service-a793m94v",
"NamespaceId": "namespace-6yogzqvl",
"Type": "unit",
"ServiceIdList": [
"service-zyfsgepxrlvshk",
"service-ypdgsapiv06uss"
],
"CreatedTime": "2026-01-01 10:11:12",
"ProgramIdList": "program-y9no5eza",
"Id": "gw-ins-yppiv06u",
"ConsulInstanceCount": "10",
"IdList": [
"gw-ins-zyepxrlv",
"gw-ins-yppiv06u"
],
"ServiceName": "service-brjay",
"NamespaceName": "namespace-brlambda",
"MultiCloudStatus": "running",
"MultiCloudStatusMsg": "running in cache",
"RouteScope": "LOCAL"
}
]
}
}
}