調用ListDisks API查詢磁碟資訊-Simple Application Server-阿里雲 - Simple Application Server

查詢指定地區下一個或多個已建立的磁碟資訊。

介面說明

InstanceId、DiskIds和ResourceGroupId不是必需的請求參數，但是可以構建過濾器邏輯，參數之間為邏輯與（And）關係。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

swas-open:ListDisks

get

*Disk

acs:swas-open:{#regionId}:{#accountId}:disk/{#DiskId}

*Disk

acs:swas-open:{#regionId}:{#accountId}:disk/*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。	cn-hangzhou
InstanceId	string	否	指定的Simple Application Server的執行個體 ID。	2ad1ae67295445f598017499dc****
DiskIds	string	否	磁碟 ID。取值可以由多個磁碟 ID 組成一個 JSON 數組，最多支援 100 個 ID，ID 之間用半形逗號（,）隔開。	["d-bp14wq0149cpp2x**", "d-bp14wq0149cpp2y**"]
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：100 預設值：10	10
PageNumber	integer	否	磁碟列表的頁碼。預設值：1	1
DiskType	string	否	磁碟類型。可能值： System：系統硬碟。 Data：資料盤。預設全量查詢	system
Tag	array<object>	否	磁碟的標籤列表。
	object	否	標籤。
Key	string	否	磁碟的標籤鍵。標籤鍵長度的取值範圍：1~64。N 的取值範圍：1~20。	TestKey
Value	string	否	磁碟的標籤值。標籤值長度的取值範圍：1~64。N 的取值範圍：1~20。	TestValue
ResourceGroupId	string	否	指定的資源群組 ID。	rg-aek2bti7cf7****

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	磁碟總條數。	1
RequestId	string	請求 ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	分頁查詢時設定的每頁行數。	10
PageNumber	integer	磁碟列表的頁碼。	1
Disks	array<object>	磁碟資訊組成的數組。
	array<object>
CreationTime	string	建立時間。時間格式以 ISO8601 為標準，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。	2021-03-08T05:31:06Z
Status	string	磁碟狀態。可能值： ReIniting：初始化中。 Creating：建立中。 In_use：使用中。 Available：待掛載。 Attaching：掛載中。 Detaching：卸載中。	In_use
Device	string	磁碟掛載伺服器中的裝置名稱。	/dev/xvda
Size	integer	磁碟大小。單位：GB。	50
DiskName	string	磁碟名稱。	SystemDisk
DiskChargeType	string	磁碟的計費方式。	PrePaid
DiskType	string	磁碟類型。可能值： System：系統硬碟。 Data：資料盤。	System
Category	string	磁碟類型，可能值： ESSD：ESSD 雲端硬碟，效能層級 PL0。 SSD：SSD 雲端硬碟。 CLOUD_EFFICIENCY：高效雲端硬碟。	ESSD
DiskId	string	磁碟 ID。	d-bp14wq0149cpp2x****
InstanceId	string	磁碟對應的Simple Application Server的執行個體 ID。	2ad1ae67295445f598017499dc****
RegionId	string	地區 ID。	cn-hangzhou
Remark	string	磁碟備忘。	remark
Tags	array<object>	磁碟的標籤列表。
	object	標籤。
Key	string	磁碟的標籤鍵。	TestKey
Value	string	磁碟的標籤值。	TestValue
InstanceName	string	Simple Application Server名稱。	myInstance
ResourceGroupId	string	磁碟所屬的資源群組 ID。	rg-aek2bti7cf7****

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Disks": [
    {
      "CreationTime": "2021-03-08T05:31:06Z",
      "Status": "In_use",
      "Device": "/dev/xvda",
      "Size": 50,
      "DiskName": "SystemDisk",
      "DiskChargeType": "PrePaid",
      "DiskType": "System",
      "Category": "ESSD",
      "DiskId": "d-bp14wq0149cpp2x****",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "RegionId": "cn-hangzhou",
      "Remark": "remark",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "InstanceName": "myInstance",
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	An error occurred while processing your request.	內部錯誤，請重試。如果多次嘗試失敗，請提交工單。

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

變更歷史

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