DescribeDisks でディスク情報を查询 - Edge Node Service (ENS)

1つ以上のディスクを説明します。

今すぐお試しください

この 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:DescribeDisks

get

*Disk

acs:ens::{#accountId}:disk/{#DiskId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EnsRegionId	string	任意	Edge Node Service (ENS) ノードの ID。	cn-kunming-telecom
DiskId	string	任意	ディスクの ID。	d-5soak1gqa507lyfzvz0xo****
DiskName	string	任意	ディスクの名前。	DiskName
PageNumber	string	任意	ページ番号。値は 0 より大きい数値である必要があります。デフォルト値：1。	1
PageSize	string	任意	1 ページあたりのエントリ数。最大値：50。デフォルト値：10。	10
Status	string	任意	ディスクのステータス。有効な値： In-use: 使用中。 Available: 利用可能。 Attaching: アタッチ中。 Detaching: デタッチ中。 Creating: 作成中。 ReIniting: 再初期化中。 Deleting: 削除中。 Deleted: 削除済み。 Expiring: 有効期限切れ。	Available
Type	string	任意	ディスクのタイプ。有効な値： system: システムディスク data: データディスク	system
Category	string	任意	ディスクのカテゴリ。有効な値： cloud_efficiency: Ultra ディスク cloud_ssd: 標準 SSD local_hdd: ローカル HDD local_ssd: ローカル SSD	local_ssd
DiskChargeType	string	任意	ディスクの課金方法。有効な値： PrePaid: サブスクリプション PostPaid: 従量課金	prepay
EnsRegionIds	string	任意	ノード ID のリスト。	["cn-suzhou-telecom","cn-chengdu-telecom"]
DiskIds	string	任意	ディスクの ID。	[\"d-wz99njena32z90ki****\"]
OrderByParams	string	任意	ソート順。値は JSON 文字列です。例：{"EnsRegionId":"desc"}。デフォルトでは、結果はノード ID の降順でソートされます。	{ "DiskNameSort":"desc","EnsRegionIdSort":"asc" }
DiskType	string	任意	ディスクの購入モデル。有効な値： ServiceDisk: エッジサービス用に作成されたディスク。 ResoureDisk: インスタンスと共に購入されたディスク。 PostPayDisk: 個別に購入されたディスク。	PostPayDisk
InstanceId	string	任意	ディスクがアタッチされているインスタンス。	i-5t77rb0yoz79m28ku60sx****
SnapshotId	string	任意	スナップショットの ID。	s-897654321****

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクト。
Code	integer	ステータスコード。値 0 は、正常な応答を示します。	0
Disks	object	ディスクに関する情報。
Disks	array<object>	ディスクのリスト。
	array<object>	ディスクの詳細。
Category	string	ディスクのカテゴリ。有効な値： `cloud_efficiency`: 高効率クラウドディスク `cloud_ssd`: SSD クラウドディスク `local_hdd`: ローカル HDD `local_ssd`: ローカル SSD	local_ssd
CreationTime	string	ディスクが作成された時刻。時刻は協定世界時 (UTC) で表示され、`YYYY-MM-DDThh:mm:ssZ` 形式の ISO 8601 標準に準拠します。	2021-11-11T14:34:55+08:00
DiskChargeType	string	ディスクの課金方法。有効な値： prepaid: サブスクリプション postpaid: 従量課金	prepaid
DiskId	string	ディスクの ID。	d-5svum1dx1w4a4spr54lgr****
DiskName	string	ディスクの名前。	fvt-ecs-5cf0****
EnsRegionId	string	ENS ノードの ID。	cn-guangzhou-10
InstanceId	string	ディスクがアタッチされているインスタンスの ID。	i-5t77rb0yoz79m28ku60sx****
InstanceName	string	ディスクがアタッチされているインスタンスの名前。	边缘prod环境串流机器-1063
Description	string	ディスクの説明。	disk-description
Size	integer	ディスクのサイズ。単位：MiB。	20
Status	string	ディスクのステータス。有効な値： `In-use`: 使用中。 `Available`: アタッチ可能。 `Attaching`: アタッチ中。 `Detaching`: デタッチ中。 `Creating`: 作成中。 `ReIniting`: 再初期化中。	Available
Type	string	ディスクのタイプ。有効な値： `1`: システムディスク `2`: データディスク	1
Portable	boolean	ディスクがデタッチ可能かどうかを示します。有効な値： `true`: ディスクは独立して存在でき、同じゾーン内のインスタンスにアタッチまたはデタッチできます。 `false`: ディスクは独立して存在できません。そのライフサイクルはインスタンスのライフサイクルに紐づけられています。 Portable プロパティは、次のディスクタイプでは false になります：ローカル HDD ローカル SSD サブスクリプションデータディスク	true
SnapshotId	string	ディスクの作成元となったスナップショットの ID。	s-bp67acfmxazb4p****
SerialId	string	ディスクのシリアル番号。	123
Encrypted	boolean	ディスクが暗号化されているかどうかを示します。有効な値： true: ディスクは暗号化されています。 false: ディスクは暗号化されていません。	false
EncryptedKeyId	string	ディスクに使用される Key Management Service (KMS) キーの ID。	05467897a-4262-4802-b8cb-00d3fb40****
DeleteWithInstance	boolean	インスタンスがリリースされるときにディスクもリリースされるかどうかを示します。有効な値： `true`: インスタンスがリリースされるときにディスクもリリースされます。 `false`: インスタンスがリリースされてもディスクはリリースされません。	false
Tags	object	ディスクのタグ。
Tags	array<object>	タグのリスト。
	object	タグの詳細。
Key	string	タグのキー。
Value	string	タグの値。
PageNumber	integer	返されたページのページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。最大値：50。デフォルト値：10。	50
RequestId	string	リクエストの ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCount	integer	返されたエントリの総数。	13

例

成功レスポンス

JSONJSON

{
  "Code": 0,
  "Disks": {
    "Disks": [
      {
        "Category": "local_ssd",
        "CreationTime": "2021-11-11T14:34:55+08:00",
        "DiskChargeType": "prepaid",
        "DiskId": "d-5svum1dx1w4a4spr54lgr****",
        "DiskName": "fvt-ecs-5cf0****",
        "EnsRegionId": "cn-guangzhou-10",
        "InstanceId": "i-5t77rb0yoz79m28ku60sx****",
        "InstanceName": "边缘prod环境串流机器-1063",
        "Description": "disk-description",
        "Size": 20,
        "Status": "Available",
        "Type": "1",
        "Portable": true,
        "SnapshotId": "s-bp67acfmxazb4p****",
        "SerialId": "123",
        "Encrypted": false,
        "EncryptedKeyId": "05467897a-4262-4802-b8cb-00d3fb40****",
        "DeleteWithInstance": false,
        "Tags": {
          "Tags": [
            {
              "Key": "",
              "Value": ""
            }
          ]
        }
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 13
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

変更履歴

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