查询一个或多个路由策略的详细信息。
接口说明
请求说明
RouteMapIds:可选参数,指定要查询的一个或多个路由策略 ID 列表。如果不提供,则默认查询所有。
Filter:可选参数,用于根据特定条件(如名称、方向等)过滤路由策略。
ResourceGroupId:可选参数,指定资源组 ID 以进一步筛选结果。
DryRun:可选布尔值,用于检查请求是否有效而不实际执行操作。
MaxResults 和 NextToken:分页参数,用于控制返回结果的数量及获取下一页数据。
注意:当同时使用RouteMapIds和Filter时,它们之间是“或”的关系,即满足任一条件即可被查询到。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cen:ListRouteMaps |
list |
RouteMap
RouteMap
|
无 | 无 |
请求语法
GET / HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ClientToken |
string |
否 |
客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。 |
02fb3da4-130e-11e9-8e44-001**** |
| RouteMapIds |
array |
否 |
要查询的路由策略 ID 列表。不提供则查询所有。 |
|
|
string |
否 |
要查询的路由策略 ID 列表。不提供则查询所有。 |
rm-0a1b2c3d4e5f6a7b8 |
|
| Filter |
array<object> |
否 |
过滤条件的信息。 一次最多支持输入 5 个过滤条件。 |
|
|
object |
否 |
过滤条件的信息。 一次最多支持输入 5 个过滤条件。 |
||
| Key |
string |
否 |
过滤条件。取值:
多个过滤条件之间默认是与的关系,即必须符合所有过滤条件,才视为匹配过滤条件。 一次最多支持输入 5 个过滤条件。 |
Priority |
| Value |
array |
否 |
过滤条件的值。 根据 Key 指定过滤值。一个 Key 支持指定多个过滤值,多个过滤值之间是或的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。 一个过滤条件最多支持输入 5 个过滤值。 |
|
|
string |
否 |
过滤条件的值。 根据 Key 指定过滤值。一个 Key 支持指定多个过滤值,多个过滤值之间是或的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。 一个过滤条件最多支持输入 5 个过滤值。 |
10 |
|
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-0a1b2c3d4e5f6a7b8 |
| DryRun |
boolean |
否 |
是否只预检此次请求。取值:
|
true |
| MaxResults |
integer |
否 |
分批次查询时每次显示的条目数。取值范围:1~100。 如果您不指定 MaxResults 参数的值,则表示您不需要分批次查询。调用接口后 MaxResults 的值表示列表条目总数。如果您指定 MaxResults 参数的值,则表示您需要分批次查询。调用接口后 MaxResults 的值表示当前查询批次下列表条目的数量。建议指定 MaxResults 参数的值为 20。 |
10 |
| NextToken |
string |
否 |
是否拥有下一次查询的令牌(Token)。取值:
|
dd20**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
创建路由策略的时间。 时间按照 ISO8601 标准表示,并使用 UTC 时间。格式为: |
||
| MaxResults |
integer |
分批次查询时,每次显示的条目数。默认值为 20。 |
20 |
| NextToken |
string |
是否拥有下一次查询的令牌(Token)。取值:
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| RequestId |
string |
请求 ID。 |
B2063B16-852B-5B66-B73D-4ED4D1A5E5C2 |
| RouteMaps |
array<object> |
路由策略的信息。 |
|
|
array<object> |
路由策略的信息。 |
||
| CreationTime |
string |
创建路由策略的时间。 时间按照 ISO8601 标准表示,并使用 UTC 时间。格式为: |
2026-03-28T02:29:19Z |
| Description |
string |
路由策略的描述信息。 |
desctest |
| Direction |
string |
路由策略的方向。取值如下:
|
Inbound |
| Name |
string |
路由策略的名称。 |
test |
| Priority |
integer |
路由策略的优先级。优先级数字越小,代表优先级越高。 |
10 |
| ResourceGroupId |
string |
资源组 ID。 |
rg-acfmydlzjd6dlhi |
| RouteMapId |
string |
路由策略 ID。 |
rm-y40mxdvf7joc12**** |
| Status |
string |
路由策略的状态。取值:
|
Active |
| Tag |
array<object> |
标签列表。 |
|
|
object |
标签信息。 |
||
| Key |
string |
标签键。 |
test |
| Value |
string |
标签值。 |
jg |
| Version |
integer |
路由策略配置版本号。 每次针对路由策略及相关路由策略规则变更后,版本号都会增长。 |
7 |
| TotalCount |
integer |
总条目数。 |
1 |
示例
正常返回示例
JSON格式
{
"MaxResults": 20,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "B2063B16-852B-5B66-B73D-4ED4D1A5E5C2",
"RouteMaps": [
{
"CreationTime": "2026-03-28T02:29:19Z",
"Description": "desctest",
"Direction": "Inbound",
"Name": "test",
"Priority": 10,
"ResourceGroupId": "rg-acfmydlzjd6dlhi",
"RouteMapId": "rm-y40mxdvf7joc12****",
"Status": "Active",
"Tag": [
{
"Key": "test",
"Value": "jg"
}
],
"Version": 7
}
],
"TotalCount": 1
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidOperation.UnsupportFilterValue | The specified FeatureFilter Value is not supported by this operation. | 参数中指定的FeatureFilter Value不合法。 |
| 400 | IllegalParam.NextToken | NextToken is illegal | 参数中指定的NextToken不合法。 |
| 400 | InvalidParameter.MaxResults | The specified MaxResults is invalid. | 参数中指定的MaxResults不合法。 |
| 400 | InvalidParameter.RouteMapIds | The specified RouteMapIds is invalid. | 输入的RouteMapIds参数不合法。 |
| 400 | InvalidParameter.Filter | The specified Filter is invalid. | 输入的Filter不合法。 |
| 400 | IllegalParam.TagKey | The tag keys are not valid. | 参数中指定的tag key不合法。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。