调用该接口获取边缘实例详情。

限制说明

  • 单阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
    说明 子账号共享主账号配额。
  • 单客户端出口IP的最大QPS限制为100,即来自单个客户端出口IP,调用阿里云接口的每秒请求总数不能超过100。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:GetEdgeInstance
InstanceId String 边缘实例ID。
公共请求参数 - 公共请求参数,请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 接口返回码。
Data Struct 调用成功时,返回的数据。详情请参见下表Data。
表 1. Data
参数 类型 描述
InstanceId String 实例ID。
Name String 实例名称。
Tags String 实例标签,标签由key:value组成,多个标签以英文逗号隔开,如k1:v1,k2:v2
Spec Integer 产品规格。
  • 10:轻量版。
  • 20:标准版。
  • 30:专业版。
BizEnable Boolean 边缘实例是否开启。
  • true:开启。
  • false:关闭。
LatestDeploymentStatus Integer 实例最近一次的部署单状态。
  • 0:未开始(init)。
  • 1:正在进行(processing)。
  • 2:成功(success)。
  • 3:失败(failure)。
LatestDeploymentType String 最近一次的实例部署单类型。
  • deploy:部署。
  • reset:重置。
GmtCreate String 实例创建时间。
GmtModified String 实例最后一次更新时间。
RoleArn String 授权角色的全局资源描述符。
RoleName String 授权角色名称。
RoleAttachTime String 角色绑定时间。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=GetEdgeInstance
&InstanceId=F3APY0tPLhmgGtx0****
&公共参数

返回示例

  • JSON格式
    {
      "RequestId": "16645053-546B-4D7C-832E-E519B0E23CF1",
      "Data": {
        "GmtCreate": "2019-06-26 12:33:25",
        "BizEnable": true,
        "InstanceId": "F3APY0tPLhmgGtx0****",
        "LatestDeploymentType": "deploy",
        "GmtModified": "2019-06-26 16:16:22",
        "Spec": 30,
        "Tags": "k1:v1,k2:v2",
        "Name": "测试实例new",
        "LatestDeploymentStatus": 2
      },
      "Code": "Success",
      "Success": true
    }
  • XML格式
    <?xml version="1.0" encoding="UTF-8"?>
    <GetEdgeInstanceResponse>
      <RequestId>16645053-546B-4D7C-832E-E519B0E23CF1</RequestId>
      <Data>
        <GmtCreate>2019-06-26 12:33:25</GmtCreate>
        <BizEnable>true</BizEnable>
        <InstanceId>F3APY0tPLhmgGtx0****</InstanceId>
        <LatestDeploymentType>deploy</LatestDeploymentType>
        <GmtModified>2019-06-26 16:16:22</GmtModified>
        <Spec>30</Spec>
        <Tags>k1:v1,k2:v2</Tags>
        <Name>测试实例new</Name>
        <LatestDeploymentStatus>2</LatestDeploymentStatus>
      </Data>
      <Code>Success</Code>
      <Success>true</Success>
    </GetEdgeInstanceResponse>