查询端口映射列表 ListPortMappingRule--云手机-火山引擎

文档中心

立即注册

导航

查询端口映射列表 ListPortMappingRule

最近更新时间：2025.11.03 17:38:00首次发布时间：2024.07.15 19:38:17

查询业务下已创建的端口映射规则列表信息。

注意事项

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

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListPortMappingRule&Version=2023-10-30

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListPortMappingRule`	接口名称。当前 API 的名称为 `ListPortMappingRule`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1724308507550xxxxxx`	云手机业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
PortMappingRuleId	String	否	`rule01`	筛选条件，端口映射规则 ID。
Protocol	String	否	`tcp`	筛选条件，端口映射的协议类型，取值如下： `tcp`：TCP 协议类型。 `udp`：UDP 协议类型。
VolcRegion	String	否	`inner`	资源所在的物理区域，包含以下选项： `inner`：中国大陆（默认值） `cn-hongkong-pop`：中国香港
Offset	Long	否	`0`	查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 `Offset` 为 10，则表示从第 11 条记录开始。默认值为 0。说明可与 `Count` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。
Count	Long	否	`10`	单次查询返回的最大记录数，用于控制每次查询返回的数据量。例如，若 `Count` 为 100，则表示在查询数据时，系统将每次返回 100 条记录。说明可与 `Offset` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。

返回参数

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

参数	类型	示例值	描述
Total	Long	`1`	查询结果总量。
Row	Array of PortMappingRuleDetail	`-`	查询到的端口映射列表

PortMappingRuleDetail

参数	类型	示例值	描述
Isp	Integer	`1`	运营商信息。取值如下： 1：移动 2：联通 4：电信 7：三条运营商线路各开一个 8：BGP
CreateAt	Long	`1700103037`	创建时间。
Protocol	String	`tcp`	端口映射的协议类型，取值如下： `tcp`：TCP 协议类型。 `udp`：UDP 协议类型。
Direction	String	`Inbound`	方向类型。取值如下： Inbound：入向 Bidirectional：双向
ProductId	String	`16084569356xxxxxxxx`	业务 ID。
TotalPods	Integer	`2`	已绑定实例数。
SourcePort	Integer	`6567`	源端口号。
UpdateTime	Long	`1700103037`	更新时间。
PortMappingRuleId	String	`rule01`	端口映射规则 ID。
VolcRegion	String	`inner`	资源所在的物理区域，包含以下取值： `inner`：中国大陆 `cn-hongkong-pop`：中国香港

请求示例

GET https://open.volcengineapi.com?Action=ListPortMappingRule&Version=2023-10-30&ProductId=1724308507550xxxxxx&PortMappingRuleId=rule01&Protocol=tcp&VolcRegion=inner&Offset=0&Count=10

返回示例

{
    "ResponseMetadata": {
        "Action": "ListPortMappingRule",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Total": 1,
        "Row": [
            {
                "Isp": 1,
                "CreateAt": 1700103037,
                "Protocol": "tcp",
                "Direction": "Inbound",
                "ProductId": "16084569356xxxxxxxx",
                "TotalPods": 2,
                "SourcePort": 6567,
                "UpdateTime": 1700103037,
                "PortMappingRuleId": "rule01",
                "VolcRegion": "inner"
            }
        ]
    }
}

错误码

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