調用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	雲裝置識別碼。	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	應用狀態原因資訊。	建立中
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	應用描述資訊。	測試應用
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": "建立中",
    "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": "測試應用"
  },
  "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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。