创建自定义路由规则 AddCustomRoute--云手机-火山引擎

文档中心

导航

创建自定义路由规则 AddCustomRoute

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

本接口用于创建一条自定义路由规则。
通过本接口，您可以将指定业务（ProductId）下所有云手机实例的网络流量重定向至您指定的代理服务器。云手机平台将作为代理客户端，使用您提供的代理协议（如 Shadowsocks、Socks5）和认证信息，与您的代理服务器建立连接，并将所有出站流量经此代理转发。

使用说明

创建完自定义路由规则后，

新创建实例如需使用某规则，需在调用 CreatePod 或 CreatePodOneStep 接口创建实例时为实例绑定规则，具体参看 CustomRouteId 参数说明。
已有实例如需使用某规则，需调用 UpdatePod 接口更新实例配置，具体参看 CustomRouteId参数说明。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1749281594201******`	业务 ID，指定该路由规则将应用于哪个业务下的云手机实例。
CustomRouteName	String	否	`custom_route_test`	自定义路由名称，用于标识该路由的用途，建议使用有意义的名称，方便后续管理。
Zone	String	是	`gdsz-ctcucm-01`	区域 ID。指定云手机实例所在的区域。代理服务器（DstIP）通常应与云手机位于同一区域，以获得最佳网络性能。
DstIP	String	是	`172.12.34.5`	代理服务器 IP 地址，部署了代理服务的服务器 IP 地址。云手机的所有流量将通过此服务器转发。建议使用与云手机同区域（Zone）的 ECS 实例作为代理服务器以降低延迟。
ProxyProtocol	String	是	`ss`	代理协议类型。指定 DstIP 上部署的代理服务所使用的协议。当前支持以下协议： ss：Shadowsocks 协议。 socks5：SOCKS5 协议。平台将根据此参数选择合适的连接方式。
ProxyPort	Integer	是	`1086`	代理服务端口。DstIP 上代理服务监听的端口号。
ProxyUserName	String	否	`user1`	代理认证用户名。 `ProxyProtocol` 设为 ss 时无需填写。 `ProxyProtocol` 设为 socks5 时选填，填写您的 SOCKS5 服务器的用户名。
ProxyPassword	String	否	`paasword`	代理认证密码。 `ProxyProtocol` 设为 ss 时必填，请提供与您 Shadowsocks 服务端配置一致的连接密码； `ProxyProtocol` 设为 socks5 时选填，填写您的 SOCKS5 服务器的密码。
ProxyCipher	String	否	`chacha20-ietf-poly1305`	代理加密算法。当 `ProxyProtocol` 为 ss 时，此项为必填；对于 SOCKS5 协议，此项无需填写。您选择的加密算法必须与 Shadowsocks 服务端配置完全一致。支持的算法列表如下： aes-128-gcm aes-192-gcm aes-256-gcm chacha20-ietf-poly1305 xchacha20-ietf-poly1305 aes-128-cfb aes-192-cfb aes-256-cfb aes-128-ctr aes-192-ctr aes-256-ctr rc4-md5 chacha20 chacha20-ietf xchacha20

返回参数

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

参数	类型	示例值	描述
CustomRouteId	String	`cr-****`	自定义路由ID。新创建的路由规则的唯一标识符，可用于后续的更新或删除操作。
DstIP	String	`172.12.34.5`	代理服务器 IP 地址。

请求示例

POST https://open.volcengineapi.com?Action=AddCustomRoute&Version=2025-05-01
{
    "ProductId": "1749281594201******",
    "CustomRouteName": "custom_route_test",
    "Zone": "gdsz-ctcucm-01",
    "DstIP": "172.12.34.5",
    "ProxyProtocol": "ss",
    "ProxyPort": 1086,
    "ProxyUserName": "user1",
    "ProxyPassword": "paasword",
    "ProxyCipher": "chacha20-ietf-poly1305"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "AddCustomRoute",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "CustomRouteId": "cr-****",
        "DstIP": "172.12.34.5"
    }
}

错误码

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