调用ListTransitRouters接口查询云企业网实例下转发路由器实例的实例类型、实例的状态、转发路由器实例ID、是否开启了组播功能等信息。
接口说明
在您调用本接口查询云企业网实例下转发路由器实例的信息时,您可以按需填写参数 RegionId 和 TransitRouterId,关于这两个参数的关系,请参见以下说明:
- 如果您未输入 RegionId 和 TransitRouterId 的值,则表示您要查询云企业网实例下所有转发路由器实例的信息。
- 如果您只输入了 RegionId 的值,则表示您要查询云企业网实例指定地域下的转发路由器实例的信息。
- 如果您只输入了 TransitRouterId 的值,则表示您要查询云企业网实例中指定的转发路由器实例的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:ListTransitRouters | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNumber | integer | 否 | 列表的页码。默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时每页显示的条目数。取值范围:1~50。默认值:10。 | 10 |
CenId | string | 是 | 云企业网实例 ID。 | cen-j3jzhw1zpau2km**** |
TransitRouterId | string | 否 | 转发路由器实例 ID。 | tr-uf654ttymmljlvh2x**** |
RegionId | string | 否 | 转发路由器实例所属地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
Tag | object [] | 否 | 标签信息。 一次最多支持输入 20 个标签信息。 | |
Key | string | 否 | 资源的标签键。 一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以 一次最多支持输入 20 个标签的标签键。 | TagKey |
Value | string | 否 | 资源的标签值。 标签值可以为空或输入不超过 128 个字符的字符串,不能以 每一个标签键对应一个标签值,一次最多支持输入 20 个标签键对应的标签值。 | TagValue |
Status | string | 否 | 转发路由器实例的状态。
| Active |
Type | string | 否 | 转发路由器实例的类型。
| Enterprise |
TransitRouterName | string | 否 | 转发路由器实例的名称。 名称长度为 1~128 个字符不能以 | testname |
FeatureFilter | object [] | 否 | 转发路由器功能筛选字段。 | |
Key | string | 否 | 转发路由器功能筛选字段键值。 目前支持字段:
| Multicast |
Value | array | 否 | 转发路由器功能筛选字段值列表。 当键值为 Multicast 时,只支持填入 1 个字段,支持字段内容为:
| |
string | 否 | 转发路由器功能筛选字段值。 当键值为 Multicast 时支持字段为:
| Enabled |
返回参数
示例
正常返回示例
JSON
格式
{
"PageSize": 10,
"RequestId": "68521297-5FA6-46CB-B4EB-658F1C68C8CC",
"PageNumber": 1,
"TotalCount": 1,
"TransitRouters": [
{
"CreationTime": "2021-03-15T09:39Z",
"Type": "Enterprise",
"Status": "Active",
"TransitRouterId": "tr-bp1su1ytdxtataupl****",
"TransitRouterDescription": "testdesc",
"TransitRouterName": "testname",
"CenId": "cen-j3jzhw1zpau2km****",
"AliUid": 1210123456123456,
"RegionId": "cn-hangzhou",
"SupportMulticast": false,
"TransitRouterCidrList": [
{
"Cidr": "192.168.1.0/24",
"Name": "CIDRname",
"Description": "CIDRdesc",
"TransitRouterCidrId": "cidr-46p5ceg21e8152****",
"PublishCidrRoute": true
}
],
"Tags": [
{
"Key": "TagKey",
"Value": "TagValue"
}
]
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameterCombination.TransitRouter | Region ID is required if no TransitRouterId or CenId specified. | 至少需要传入Region,TransitRouterId 或CenId三者中的一个。 |
400 | InvalidOperation.UnsupportFilterValue | The specified FeatureFilter Value is not supported by this operation. | 参数中指定的FeatureFilter Value不合法。 |
400 | InvalidOperation.UnsupportFilter | The specified FeatureFilter is not supported by this operation. | 参数中指定的FeatureFilter不合法。 |
400 | IllegalParam.TagValue | The tag values are not valid. | 参数中指定的tag value不合法。 |
400 | IllegalParam.TagKey | The tag keys are not valid. | 参数中指定的tag key不合法。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-10-18 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-01-09 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
|