全部產品
Search

搜尋本產品

    ENS：DescribeDisks - 查詢磁碟資訊

    文件中心

    ENS：DescribeDisks - 查詢磁碟資訊

    更新時間：Mar 20, 2026

    調用DescribeDisks查詢一個或多個已建立的磁碟資訊。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ens:DescribeDisks

    get

    *Disk

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    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

    否

    磁碟狀態。

    • In-use：使用中

    • Available：待掛載

    • Attaching：掛載中

    • Detaching：卸載中

    • Creating：建立中

    • ReIniting：重設中

    • Deleting：釋放中

    • Deleted：已釋放

    • Expiring：即將到期

    Available
    Type

    string

    否

    磁碟屬性

    • system：系統硬碟

    • data：資料盤

    system
    Category

    string

    否

    磁碟種類。

    • 高效雲端硬碟：cloud_efficiency

    • 全閃雲端硬碟：cloud_ssd

    • 本地 HDD 盤：local_hdd

    • 本地碟 SSD：local_ssd

    local_ssd
    DiskChargeType

    string

    否

    計費類型。

    • prepay：預付費

    • postpay：隨用隨付

    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

    否

    磁碟購買方式。

    • 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

    • 本地 HDD 盤：local_hdd

    • 本地碟 SSD：local_ssd

    local_ssd
    CreationTime

    string

    建立時間。時間格式以 ISO8601 為標準，並使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

    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：不支援。不可以獨立存在，且不可以在可用性區域內自由掛載和卸載。

    以下類型Block Storage的 Portable 屬性都為 false，生命週期與執行個體等同：

    • 本地 HDD 盤

    • 本地 SSD 盤

    • 訂用帳戶資料盤

    true
    SnapshotId

    string

    快照 ID。

    s-bp67acfmxazb4p****
    SerialId

    string

    序號。

    123
    Encrypted

    boolean

    是否加密雲端硬碟。取值範圍：

    • true：是

    • false：否

    false
    EncryptedKeyId

    string

    雲端硬碟使用的 KMS 金鑰識別碼。

    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

    分頁查詢時每頁的行數，最大值為 50，預設值為 10。

    50
    RequestId

    string

    請求 ID。

    CEF72CEB-54B6-4AE8-B225-F876FF7BA984
    TotalCount

    integer

    分頁查詢時分頁總頁數。

    13

    樣本

    正常返回樣本

    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": "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 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.

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

    變更歷史

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