退订后付费云机资源 UnsubscribeHostResource--云手机-火山引擎

文档中心

立即注册

导航

云手机

退订后付费云机资源 UnsubscribeHostResource

最近更新时间：2024.05.08 17:02:42首次发布时间：2024.04.16 14:13:34

此接口用于后付费云机资源退订。通过 ProductId、HostIdList、Force 参数完成退订操作。

使用说明

若退订成功，则返回参数中 ExceptionList 为 null。
支持批量退订操作，若退订失败，则返回参数中 ExceptionList 会返回具体错误信息。
在批量退订情况下，若部分资源退订成功，部分资源退订失败，则会返回退订失败的资源 ID ResourceSetIdList，并且 Err 中会返回相应的错误。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

ProductId String 是 177500569***840 业务 ID。您可在云手机控制台 > 业务管理 > 业务详情中获取。

HostIdList Array of String 是 ["host-73561748***2524"] 云机 ID 列表。可通过 ListHost 接口获取。

参数	类型	是否必选	示例值	描述
ProductId	String	是	`177500569***840`	业务 ID。您可在云手机控制台 > 业务管理 > 业务详情中获取。
HostIdList	Array of String	是	`["host-73561748***2524"]`	云机 ID 列表。可通过 ListHost 接口获取。
Force	Boolean	否	`true`	是否允许强制退订。取值如下： `false`：（默认）不允许强制退订。 `true`：允许强制退订。说明节点资源存在实例时依然可以退订，并主动删除相关实例数据。

Force

Boolean

否

true

是否允许强制退订。取值如下：

false：（默认）不允许强制退订。
true：允许强制退订。

说明

节点资源存在实例时依然可以退订，并主动删除相关实例数据。

返回参数

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

参数	类型	示例值	描述
ExceptionList	Array of UnsubscribeResourceException	`-`	退订失败列表。

UnsubscribeResourceException

参数	类型	示例值	描述
Err	String	`InvalidId`	错误信息。
HostIdList	Array of String	`["host-7356203***987855113"]`	云机 ID 列表。
ResourceSetIdList	Array of String	`null`	资源设置 ID 列表。

请求示例 1

POST https://open.volcengineapi.com?Action=UnsubscribeHostResource&Version=2023-10-30&ProductId=177500569***840&HostIdList=["host-73561748***2524"]&Force=true

返回示例 1

退订成功的返回示例：

{
    "ResponseMetadata": {
        "Action": "UnsubscribeHostResource",
        "Region": "cn-north-1",
        "RequestId": "202404111***0B8D0FDD5F395E",
        "Service": "ACEP",
        "Version": "2023-10-30"
    },
    "Result": {
        "ExceptionList": null
    }
}

请求示例 2

POST https://open.volcengineapi.com?Action=UnsubscribeHostResource&Version=2023-10-30&ProductId=177500569***840&HostIdList=["host-73561748***2524"]&Force=true

返回示例 2

退订失败的返回示例：

{
  "ResponseMetadata": {
    "Action": "UnsubscribeHostResource",
    "Region": "cn-north-1",
    "RequestId": "202404121118***00DB848F4CFFC046",
    "Service": "ACEP",
    "Version": "2023-10-30"
  },
  "Result": {
    "ExceptionList": [
      {
        "HostIdList": [
          "host-7356203***987855113"
        ],
        "ResourceSetIdList": null,
        "Err": "InvalidId"
      }
    ]
  }
}

错误码

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