获取端口映射列表 ListPortMapping--云手机-火山引擎

文档中心

立即注册

导航

获取端口映射列表 ListPortMapping

最近更新时间：2024.05.09 17:19:39首次发布时间：2021.11.15 11:41:06

获取指定实例的源端口和目标端口的映射关系。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListPortMapping
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25
product_id	Query	String	是	业务 ID	可在「云手机控制台-业务管理-业务详情」中获取
instance_id_in	Query	String	否	筛选条件，实例 ID列表，多个 ID 使用英文逗号分隔	可通过调用 ListInstance 接口获取
isp	Query	Integer	否	筛选条件，网络运营商	可选项： 1（移动） 2（联通） 4（电信） 8（BGP）
port_mapping_id	Query	String	否	筛选条件，端口映射关系 ID
protocol_enum	Query	Integer	否	协议类型	可选项： 1（UDP） 2（TCP）
security_group_id	Query	Integer	否	筛选条件，安全组 ID	可通过调用 ListSecurityGroup 接口获取
security_rule_id	Query	Integer	否	筛选条件，安全组规则 ID	可通过调用 ListSecurityGroup 接口获取
state_in	Query	String	否	筛选条件，访问规则配置状态列表	多个状态使用英文逗号分隔
state	Query	Integer	否	筛选条件，访问规则配置状态	可选项： 1（Init，初始化） 11（Applying，配置中） 12（Withdrawing，解除中） 101（ApplySucceed，配置成功） 102（WithdrawSucceed，解除成功） -1（ApplyErr，配置失败） -2（WithdrawErr，解除失败）
offset	Query	Integer	否	分页偏移量	例：0
count	Query	Integer	否	单页数量	例：10

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
total	Int64	返回的端口映射关系数量
row	Array of objects	查询到的端口映射信息，参考以下 `List<PortMapping>` 结构说明

List<PortMapping> 结构说明

字段	类型	说明
product_id	String	业务 ID
port_mapping_id	String	端口映射关系 ID
state	Integer	访问规则配置状态
instance_id	String	实例 ID
security_group_id	Integer	安全组 ID
security_rule_id	Integer	安全组规则 ID
instance_port	Integer	实例源端口号
public_ip	String	公网 IP
public_port	Integer	公网端口号
proxy_ip	String	内网代理 IP
proxy_port	Integer	内网代理端口号
connect_ip	String	连接云手机的 IP（pubic_ip 或 proxy_ip 二选一）
connect_port	Integer	连接云手机的端口号（pubic_port 或 proxy_port 二选一）
isp	Integer	运营商： 1（移动） 2（联通） 4（电信） 8（BGP）
protocol	String	协议类型 udp tcp
protocol_enum	Integer	协议类型： 1（UDP） 2（TCP）
description	String	描述

示例

请求示例

GET https://open.volcengineapi.com?Action=ListPortMapping
&Version=2020-10-25
&product_id=1625003308995xxxxxx
&instance_id_in=i-1724163532xxxxxx, i-1724163533xxxxxx,
&protocol_enum=2
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListPortMapping",
        "Region": "cn-north-1",
        "RequestId": "202202181045230102121971511B064B6F",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "row": [
            {
                "product_id": "1625003308995xxxxxx",
                "port_mapping_id": "pment-578xxxx",
                "state": 101,
                "instance_id": "i-1724163532xxxxxx",
                "security_group_id": 1994,
                "security_rule_id": 1449,
                "instance_port": 5555,
                "public_ip": "111.xxx.xxx.xxx",
                "public_port": 1707,                
                "proxy_ip": "10.x.xxx.x",
                "proxy_port": 15555,
                "connect_ip": "111.xxx.xxx.xxx",
                "connect_port": 1707,
                "isp": 1,
                "protocol": "tcp",
                "protocol_enum": 2,
                "description": ""
            },
            {
                "product_id": "1625003308995xxxxxx",
                "port_mapping_id": "pment-578xxxx",
                "state": 101,
                "instance_id": "i-1724163533xxxxxx",
                "security_group_id": 1994,
                "security_rule_id": 1449,
                "instance_port": 6667,
                "public_ip": "111.xxx.xxx.xxx",
                "public_port": 10003,
                "proxy_ip": "10.x.xxx.x",
                "proxy_port": 16667,
                "connect_ip": "111.xxx.xxx.xxx",
                "connect_port": 1707,
                "isp": 4,
                "protocol": "tcp",
                "protocol_enum": 2,
                "description": ""
            }
        ],
        "total": 2
    }
}