调用该接口关闭边缘实例部署单。

限制条件

单阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。

说明 RAM用户共享主账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CloseEdgeInstanceDeployment

系统规定参数。取值:CloseEdgeInstanceDeployment。

InstanceId String PgEfYupSn6Pvhfkx****

边缘实例ID。在边缘计算控制台边缘实例页面中,鼠标悬浮在目标边缘实例名称上获取ID。

您也可以调用QueryEdgeInstance接口获取。

IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。公共实例不传此参数,企业版实例需传入。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见 公共参数文档

返回数据

名称 类型 示例值 描述
Code String Success

接口返回码。Success表示成功,其它表示错误码。详情请参见错误码

ErrorMessage String request parameter error

调用失败时,返回的出错信息。

RequestId String 3C969586-3DD1-41A7-9B8E-E8B134CA6600

阿里云为该请求生成的唯一标识符。

Success Boolean true

表示是否调用成功。true表示调用成功,false表示调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CloseEdgeInstanceDeployment
&InstanceId=PgEfYupSn6Pvhfkx****
&<公共请求参数>

正常返回示例

XML 格式

<CloseEdgeInstanceDeploymentResponse>
      <RequestId>3C969586-3DD1-41A7-9B8E-E8B134CA6600</RequestId>
      <Code>Success</Code>
      <Success>true</Success>
</CloseEdgeInstanceDeploymentResponse>

JSON 格式

{
  "RequestId": "3C969586-3DD1-41A7-9B8E-E8B134CA6600",
  "Code": "Success",
  "Success": true
}

错误码

访问错误中心查看更多错误码。