退订云机资源 DeleteDevices--云手机-火山引擎

文档中心

立即注册

导航

退订云机资源 DeleteDevices

最近更新时间：2024.05.09 10:30:31首次发布时间：2023.09.15 14:04:30

在指定业务下，退订云机资源。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	DeleteDevices
Version	Query	String	是	公共参数，OpenAPI 接口版本	2023-08-01
X-iPaaS-Idempotent-Token	Query	String	是	幂等 Token	可通过调用 AcquireIdempotentToken 接口获取

Body 参数

字段	类型	必填	说明
ProductId	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
DeviceIdList	String[]	是	待退订的云机 ID 列表

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
OrderNo	String	生成的云机资源退订订单号
InstanceNo	Array of String	对应火山引擎费用中心资源实例 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=DeleteDevices
&Version=2023-08-01
&X-iPaaS-Idempotent-Token=iPaaS.Idempotent.Token
&<通过header传入的公共请求参数>

{
    "DeviceIdList": ["h-1774479484xxxxxx"]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DeleteDevices",
        "Region": "cn-north-1",
        "RequestId": "2021122810471701021216810313006DA3",
        "Service": "iPaaS",
        "Version": "2023-08-01"
    },
    "Result": {
        "OrderNo": "",
        "InstanceNo": [""]
    }
}