查询自定义路由规则 ListCustomRoute--云手机-火山引擎

文档中心

立即注册

导航

查询自定义路由规则 ListCustomRoute

最近更新时间：2025.07.01 16:02:28首次发布时间：2025.07.01 16:02:28

查询一个或多个已创建的自定义路由规则的详细信息。
您可以通过指定业务 ID（ProductId）来查询其下的所有路由规则，也可以通过多种过滤条件组合查询。

注意事项

本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListCustomRoute&Version=2025-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListCustomRoute`	接口名称。当前 API 的名称为 `ListCustomRoute`。
Version	String	是	`2025-05-01`	接口版本。当前 API 的版本为 `2025-05-01`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1749281594201xxxxxx`	业务 ID，指定要查询的路由规则所属的业务范围。
CustomRouteId	String	否	`cr-xxxx`	按路由规则 ID 过滤，用于精确查询某一条特定的路由规则。可通过 `ListCustomRoute` 接口获取。
CustomRouteName	String	否	`custom_route_test`	按路由规则名称过滤。
Zone	String	否	`gdsz-ctcucm-01`	按区域过滤。查询指定区域下的所有路由规则。可通过 `ListDc` 接口获取。
DstIP	String	否	`172.12.34.5`	按代理服务器 IP 过滤。查询指向特定代理服务器 IP 的路由规则。
MaxResults	Integer	否	`10`	分页查询时用于设置的每页返回的条目数。最大值为 100，默认值为 10。
NextToken	String	否	`wyc87CUcfU1pIlpAinyljWVCLc0mqRLetP99DZs-v3yv4x5DRq9FGdWtT**********xlc8mJ1VRIATB_Dv1Tcn0YJdiq1k9XzjGDLArAgX6g3CzaFNGy7gUqkOb2U-k`	分页查询凭证，用于标记查询数据的起始位置。初次查询时无需设置，服务器将根据筛选条件返回一部分数据，并返回一个 NextToken 凭证值记录这批数据的结尾位置，作为下次查询的起始位置。后续查询中，将上一次查询时返回的 NextToken 作为参数传入，服务器会从该位置继续返回后续数据。注意重复调用本接口进行接续查询时，不可修改原始筛选条件，否则会影响查询数据的连贯性和准确性。如需修改筛选条件，请将本参数置空，从第一条数据开始重新查询。接口返回的 NextToken 有效期为 2 小时，若传入过期或无效的值，服务器将从第一条数据开始重新查询并返回。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
NextToken	String	`wyc87CUcfU1pIlpAinyljWVCLc0mqRLetP99DZs-v3yv4x5DRq9FGdWtT**********xlc8mJ1VRIATB_Dv1Tcn0YJdiq1k9XzjGDLArAgX6g3CzaFNGy7gUqkOb2U-k`	本次调用返回的查询凭证，若返回空置即表示该页为末页。注意 NextToken 有效期为 2 小时，若下次请求时使用了过期凭证，则将从第一条数据开始重新查询。
Row	Array of CustomRoute	`-`	详细查询结果。

CustomRoute

参数	类型	示例值	描述
Zone	String	`gdsz-ctcucm-01`	路由规则所属的区域。
DstIP	String	`172.12.34.5`	路由指向的代理服务器 IP 地址。
CreateAt	Long	`1682928000000`	创建时间。Unix 时间戳，单位为秒。
UpdateAt	Long	`1682928300000`	最后更新时间。Unix 时间戳，单位为秒。
ProxyPort	Integer	`1086`	代理服务端口。
ProxyCipher	String	`aes-256-cfb`	代理加密算法（仅 ss 协议）。
CustomRouteId	String	`cr-****`	路由规则 ID。
ProxyProtocol	String	`ss`	代理协议类型，如 ss 或 socks5。
CustomRouteName	String	`custom_route_test`	路由规则名称。

请求示例

POST https://open.volcengineapi.com?Action=ListCustomRoute&Version=2025-05-01
{
    "ProductId": "1749281594201xxxxxx",
    "CustomRouteId": "cr-xxxx",
    "CustomRouteName": "custom_route_test",
    "Zone": "gdsz-ctcucm-01",
    "DstIP": "172.12.34.5",
    "MaxResults": 10,
    "NextToken": "wyc87CUcfU1pIlpAinyljWVCLc0mqRLetP99DZs-v3yv4x5DRq9FGdWtT**********xlc8mJ1VRIATB_Dv1Tcn0YJdiq1k9XzjGDLArAgX6g3CzaFNGy7gUqkOb2U-k"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ListCustomRoute",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "NextToken": "wyc87CUcfU1pIlpAinyljWVCLc0mqRLetP99DZs-v3yv4x5DRq9FGdWtT**********xlc8mJ1VRIATB_Dv1Tcn0YJdiq1k9XzjGDLArAgX6g3CzaFNGy7gUqkOb2U-k",
        "Row": [
            {
                "Zone": "gdsz-ctcucm-01",
                "DstIP": "172.12.34.5",
                "CreateAt": 1682928000000,
                "UpdateAt": 1682928300000,
                "ProxyPort": 1086,
                "ProxyCipher": "aes-256-cfb",
                "CustomRouteId": "cr-****",
                "ProxyProtocol": "ss",
                "CustomRouteName": "custom_route_test"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。