You need to enable JavaScript to run this app.
云手机

云手机

请输入
  • 文档首页
    • 云手机服务端 OpenAPI 文档网络配置与管理端口映射管理创建端口映射规则 CreatePortMappingRule
复制全文
我的收藏
端口映射管理
创建端口映射规则 CreatePortMappingRule
复制全文
我的收藏
创建端口映射规则 CreatePortMappingRule

此接口用于在指定云手机业务下创建端口映射规则。

使用说明

  • 每个业务下最多可创建 100 个端口映射规则。
  • 支持更新为多条端口映射。

请求说明

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

请求参数

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

Query

参数

类型

是否必选

示例值

描述

Action

String

是

CreatePortMappingRule

接口名称。当前 API 的名称为 CreatePortMappingRule。

Version

String

是

2025-05-01

接口版本。当前 API 的版本为 2025-05-01。

Body

参数

类型

是否必选

示例值

描述

ProductId

String

是

1591495366954xxxxxx

云手机业务 ID，可在云手机控制台 > 业务管理 > 业务详情中获取。

PortMappingRuleId

String

否

rule01

端口映射规则 ID，需确保规则 ID 全局唯一；如不指定，由系统随机生成。

Protocol

String

否

tcp

端口映射规则适用的的协议类型，取值如下：

  • tcp：（默认） TCP 协议类型。
  • udp：UDP 协议类型。
  • all：同时适用于 TCP 和 UDP 两种协议类型。

SourcePort

Integer

是

6567

源端口号，您可根据自身业务需求，自定义配置端口号。

Isp

Integer

否

1

运营商信息。取值如下：

  • 1：移动（默认）。
  • 2：联通。
  • 4：电信。
  • 7：三条运营商线路各开一个。
  • 8：BGP，香港地区。当 VolcRegion 设为 cn-hongkong-pop 时生效。

注意

当前在中国大陆内，该参数仅在华北/石家庄、华东/扬州、华南/广州等部分机房节点支持设置，若有涉及，请联系技术支持团队确认。

Direction

String

否

Inbound

方向类型。取值如下：

  • Inbound：入向（默认）
  • Bidirectional：双向

注意

当前在中国大陆内，该参数仅在华北/石家庄、华东/扬州、华南/广州等部分机房节点支持设置，若有涉及，请联系技术支持团队确认。

VolcRegion

String

否

inner

资源所在的物理区域，包含以下选项：

  • inner：中国大陆（默认值）
  • cn-hongkong-pop：中国香港

返回参数

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

参数

类型

示例值

描述

PortMappingRuleId

String

rule01

端口映射的规则 ID。

Protocol

String

tcp

端口映射的协议类型。

SourcePort

Integer

5667

源端口号。

CreateAt

Long

1700103037

端口映射规则创建时间，Unix 时间戳，单位为秒。

请求示例 

POST https://open.volcengineapi.com?Action=CreatePortMappingRule&Version=2025-05-01
{
    "ProductId": "1591495366954xxxxxx",
    "PortMappingRuleId": "rule01",
    "Protocol": "tcp",
    "SourcePort": 6567,
    "Isp": 1,
    "Direction": "Inbound",
    "VolcRegion": "inner"
}

返回示例 

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "CreatePortMappingRule",
        "Version": "2025-05-01",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": {
        "SourcePort": 5667,
        "PortMappingRuleId": "rule01",
        "Protocol": "tcp",
        "CreateAt": 1700103037
    }
}

错误码

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

最近更新时间：2026.01.28 16:48:46
这个页面对您有帮助吗？
有用
有用
无用
无用