DescribeDeviceService を使用したインスタンスと仮想デバイスのプロパティ查询 - ENS

特定のEdgeアプリケーション内のインスタンスと仮想デバイスのプロパティを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeDeviceService

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServiceId	string	任意	サービス ID	s-cxxxxx
InstanceId	string	任意	インスタンスの ID	i-5sg1owx0g4ojy66ab2tez77r2
RegionId	string	任意	Edge Node Service (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	応答のスキーマ
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 ノードのサーバー名	ens-nc2
Status	string	デバイスのステータス	Running
Type	string	デバイスのタイプ	ens.ac6.large
Mac	string	デバイスのメディアアクセス制御 (MAC) アドレス	AA:BB:77:88:99:03
ISP	string	インターネットサービスプロバイダー (ISP)	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	リージョンの ID	cn-jiaozuo-2
RegionId	string	ENS ノードの ID	cn-jiaozuo-2
RegionName	string	リージョン名	中国焦作-2

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。