DescribeDeviceService - 查询设备服务信息 - 边缘节点服务ENS

调用DescribeDeviceService查询边缘应用下的实例和虚拟设备网络状态等基本属性信息列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeDeviceService

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ServiceId	string	否	Service ID	s-cxxxxx
InstanceId	string	否	实例 ID。	i-5sg1owx0g4ojy66ab2tez77r2
RegionId	string	否	ENS 边缘节点 ID。	cn-chongqing-11
AppId	string	否	应用 ID。	a2bac6f4-75dc-455e-8389-2dc8e47526d3
EnsRegionId	string	否	无效参数。	cn-chongqing-10
OrderId	string	否	订单 ID。	2661b1dd-3453-418d-8182-bb34f79e8d3c

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	3A535110-3EE3-5EC5-B1ED-10B7067A1FC8
ResourceDetailInfos	array<object>	设备列表。
	object	设备信息。
RegionID	string	ENS 边缘节点 ID。	cn-jiaozuo-2
ID	string	云设备 ID。	h-uf6009zoaexs5pefypbo
IP	string	IP 地址。	120.27.219.219
Server	string	ENS 边缘节点的服务器 NC 名。	ens-nc2
Status	string	设备状态。	Running
Type	string	设备类型。	ens.ac6.large
Mac	string	设备 MAC 地址。	AA:BB:77:88:99:03
ISP	string	运营商信息。	cmcc
DeviceName	string	设备名称。	5JhF100NEgdBcpNren32
ImageID	string	镜像 ID。	m-2ze40oyhjorpyw61k7be
AppStatus	object	应用状态信息。
Phase	string	应用状态。枚举类型，取值范围：中间态 3 个 CREATING UPDATING DELETING 终态 4 个 CREATE_FAILED UPDATE_FAILED DELETE_FAILED RUNNING	CREATING
StatusDescrip	string	应用状态描述信息。	Creating
UpdateTime	string	最新的状态更新时间。	2021-01-26T05:04Z
AppMetaData	object	应用基本属性。
AppId	string	应用 ID。	97a32f2a-aa2c-436a-b19c-05b20d258618
AppName	string	应用名称。	iotx-api-admin
AppStableVersion	string	应用的稳定版版本号。	v1
AppType	string	应用类型。枚举类型，取值范围： Common：普通 Scheduler：调度单元	Common
ClusterName	string	应用集群名。	poc
CreateTime	string	应用创建时间。	2022-03-03T03:42:11
Description	string	应用描述信息。	Test application
ResourceInfos	array<object>	资源实例信息列表。
	array<object>	资源信息。
AppVersion	string	应用版本号。	v1
AreaCode	string	地域代码。	410800
AreaName	string	地域名称。	华中,河南省,焦作市
CreateTime	string	创建时间。	2019-10-02T08:26Z
DeviceInfos	array<object>	设备信息列表。
	array<object>	设备信息。
Name	string	设备名称。	test-api
Network	array<object>	网络信息列表。
	object	网络信息。
ContainerPorts	string	容器端口。	10000-10010
ExternalIp	string	公网 IP 地址。	39.105.62.120
HostPorts	string	机器端口范围。	80-8080
Protocol	string	网关协议。枚举类型，取值： TCP UDP	TCP
Status	string	状态。	Running
InstanceId	string	实例 ID。	i-5s9boobrmh5000kv4jmi0oeai
InstanceStatus	string	实例状态。	Running
InternalIps	array<object>	内网 IP 列表。
	object	IP 信息。
Ip	string	IP 地址。	10.0.2.3
PublicIps	array<object>	公网 ip。
	object	公网 ip。
Ip	string	IP 地址。	122.13.173.137
RegionCode	string	区域编码。	cn-jiaozuo-2
RegionId	string	ENS 边缘节点 ID。	cn-jiaozuo-2
RegionName	string	地域名称。	中国焦作-2

示例

正常返回示例

JSON格式

{
  "RequestId": "3A535110-3EE3-5EC5-B1ED-10B7067A1FC8",
  "ResourceDetailInfos": [
    {
      "RegionID": "cn-jiaozuo-2",
      "ID": "h-uf6009zoaexs5pefypbo",
      "IP": "120.27.219.219",
      "Server": "ens-nc2",
      "Status": "Running",
      "Type": "ens.ac6.large",
      "Mac": "AA:BB:77:88:99:03",
      "ISP": "cmcc",
      "DeviceName": "5JhF100NEgdBcpNren32",
      "ImageID": "m-2ze40oyhjorpyw61k7be"
    }
  ],
  "AppStatus": {
    "Phase": "CREATING",
    "StatusDescrip": "Creating",
    "UpdateTime": "2021-01-26T05:04Z"
  },
  "AppMetaData": {
    "AppId": "97a32f2a-aa2c-436a-b19c-05b20d258618",
    "AppName": "iotx-api-admin",
    "AppStableVersion": "v1",
    "AppType": "Common",
    "ClusterName": "poc",
    "CreateTime": "2022-03-03T03:42:11",
    "Description": "Test application"
  },
  "ResourceInfos": [
    {
      "AppVersion": "v1",
      "AreaCode": "410800",
      "AreaName": "华中,河南省,焦作市",
      "CreateTime": "2019-10-02T08:26Z",
      "DeviceInfos": [
        {
          "Name": "test-api",
          "Network": [
            {
              "ContainerPorts": "10000-10010",
              "ExternalIp": "39.105.62.120",
              "HostPorts": "80-8080",
              "Protocol": "TCP"
            }
          ],
          "Status": "Running"
        }
      ],
      "InstanceId": "i-5s9boobrmh5000kv4jmi0oeai",
      "InstanceStatus": "Running",
      "InternalIps": [
        {
          "Ip": "10.0.2.3"
        }
      ],
      "PublicIps": [
        {
          "Ip": "122.13.173.137"
        }
      ],
      "RegionCode": "cn-jiaozuo-2",
      "RegionId": "cn-jiaozuo-2\n",
      "RegionName": "中国焦作-2"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

变更历史

更多信息，参考变更详情。