解绑端口映射规则 UnbindPortMappingRule--云手机-火山引擎

文档中心

立即注册

导航

云手机

解绑端口映射规则 UnbindPortMappingRule

最近更新时间：2024.07.15 19:38:17首次发布时间：2024.04.01 17:22:51

此接口用于实例解绑端口映射规则，您可通过 ProductId 、PodIdList、PortMappingRuleIdList 参数，解绑端口映射规则。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UnbindPortMappingRule`	接口名称。当前 API 的名称为 `UnbindPortMappingRule`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`169634752xxxxxxxxxx`	云手机业务 ID，可在云手机控制台 > 业务管理 > 业务详情中获取。
PodIdList	Array of String	是	`["734799243xxxxxxxxxx"]`	实例 ID 列表。可通过调用 ListPod 接口获取。
PortMappingRuleIdList	Array of String	是	`["735023356xxxxxxxxxx","735023357xxxxxxxxxx"]`	端口映射规则 ID 列表，需确保规则 ID 全局唯一；可通过调用 CreatePortMappingRule 接口获取。

返回参数

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

参数	类型	示例值	描述
SuccessPodIdList	Array of String	`["734799243xxxxxxxxxx"]`	设置成功实例 ID 列表。
ErrorPodInfoList	Array of ErrorInfo	`-`	设置失败实例信息列表。

ErrorInfo

参数	类型	示例值	描述
PodId	String	`735023357xxxxxxxxxx`	实例 ID。
ErrorCode	Integer	`8062001`	错误码。
ErrorMessage	String	`xxxx`	错误信息。

请求示例

POST https://open.volcengineapi.com?Action=UnbindPortMappingRule&Version=2023-10-30
{
  "ProductId": "169634752xxxxxxxxxx",
  "PodIdList": [
    "734799243xxxxxxxxxx"
  ],
  "PortMappingRuleIdList": [
    "735023356xxxxxxxxxx",
    "735023357xxxxxxxxxx"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "Action": "UnbindPortMappingRule",
    "Region": "cn-north-1",
    "RequestId": "20240325113112EE747A4E94XXXXXXXXXX",
    "Service": "ACEP",
    "Version": "2023-10-30"
  },
  "Result": {
    "SuccessPodIdList": [
      "734799243xxxxxxxxxx"
    ],
    "ErrorPodInfoList": [
      {
        "PodId": "735023357xxxxxxxxxx",
        "ErrorCode": 8062001,
        "ErrorMessage": "xxxx"
      }
    ]
  }
}

错误码

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