調用DescribeDisks查詢一個或多個已創建的磁盤信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ens:DescribeDisks | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| EnsRegionId | string | 否 | ENS 的節點 ID。 | cn-kunming-telecom |
| DiskId | string | 否 | 云盤 ID。 | d-5soak1gqa507lyfzvz0xo**** |
| DiskName | string | 否 | 磁盤名稱。 | DiskName |
| PageNumber | string | 否 | 查詢列表的頁碼。起始值為 1。 默認值：1。 | 1 |
| PageSize | string | 否 | 分頁查詢時設置的每頁行數，最大值為 50 行。 默認值：10。 | 10 |
| Status | string | 否 | 磁盤狀態。
| Available |
| Type | string | 否 | 磁盤屬性
| system |
| Category | string | 否 | 磁盤種類。
| local_ssd |
| DiskChargeType | string | 否 | 計費類型。
| prepay |
| EnsRegionIds | string | 否 | 節點列表。 | ["cn-suzhou-telecom","cn-chengdu-telecom"] |
| DiskIds | string | 否 | 磁盤 ID。 | [\"d-wz99njena32z90ki****\"] |
| OrderByParams | string | 否 | 排序使用：格式例子{"EnsRegionId":"desc"}。默認按節點 ID 降序排列。 | { "DiskNameSort":"desc","EnsRegionIdSort":"asc" } |
| DiskType | string | 否 | 磁盤購買方式。
| PostPayDisk |
| InstanceId | string | 否 | 云盤所掛載的實例。 | i-5t77rb0yoz79m28ku60sx**** |
| SnapshotId | string | 否 | 快照 ID。 | s-897654321**** |
返回參數
示例
正常返回示例
JSON格式
{
"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": "",
"Size": 20,
"Status": "Available",
"Type": "1",
"Portable": true,
"SnapshotId": "s-bp67acfmxazb4p****",
"SerialId": "123",
"Encrypted": false,
"EncryptedKeyId": "05467897a-4262-4802-b8cb-00d3fb40****",
"DeleteWithInstance": true
}
]
},
"PageNumber": 1,
"PageSize": 50,
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
"TotalCount": 13
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 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. | 指定的實例ID不存在。 |
| 400 | NoPermission | Permission denied. | 沒有足夠的權限，請聯系云賬號管理員授予您相應權限。 |
| 400 | CallInterface | Call Interface Happen Error. | 接口調用出錯。 |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-18 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-11-14 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-10-17 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-07-20 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-03-02 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2021-10-28 | 新增 OpenAPI | 查看變更詳情 |