全部產品
Search

搜尋本產品

    PolarDB：DescribeColdStorageInstance - 描述冷儲存執行個體

    文件中心

    PolarDB：DescribeColdStorageInstance - 描述冷儲存執行個體

    更新時間：Dec 11, 2025

    查詢冷儲存執行個體資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeColdStorageInstance

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    否

    PolarDB 叢集 ID。

    pc-wz9062015ly7526jc
    NextToken

    string

    否

    查詢憑證（token），取值為上一次 api 調用返回的 nexttoken 參數值。如果沒有下一個查詢，請不傳。

    c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==
    TableName

    string

    否

    資料表名。

    account_log
    DBName

    string

    否

    資料庫名稱。

    test_db
    EngineType

    string

    否

    支援引擎的類型，傳回值是由下列引擎類型的值做加法運算後得到的。

    • 1: 搜尋引擎

    • 2: 時序引擎

    • 4: 寬表引擎

    • 8: 檔案引擎

    說明

    例如：EngineType 值為 15，15=8+4+2+1，表示該執行個體支援搜尋引擎、時序引擎、寬表引擎和檔案引擎。EngineType 值為 6，6=4+2，表示該執行個體支援時序引擎和寬表引擎。

    2
    RegionId

    string

    否

    地區 ID。

    說明

    • 您可以調用 DescribeRegions 介面查看目標帳號下所有的叢集的地區資訊。

    • 若該參數留空，預設查詢當前帳號下所有地區內的計劃任務。

    cn-hangzhou
    MaxResults

    integer

    否

    • 如果您不指定 MaxResults 參數的值，則表示您不需要分批次查詢。調用介面後返回參數 MaxResults 的值表示列表條目總數。

    • 如果您指定 MaxResults 參數的值，則表示您需要分批次查詢，MaxResults 的值表示分批次查詢時每次顯示的條目數。取值範圍：1~100。調用介面後返回參數 MaxResults 的值表示當前查詢批次下列表條目的數量。建議指定 MaxResults 參數的值為 20。

    50
    ExpireTime

    integer

    否

    叢集到期時間。說明 僅付費方式為 Prepaid（訂用帳戶）的叢集會返回具體參數值，Postpaid（隨用隨付）叢集則返回空值。

    2020-11-14T16:00:00Z
    PageNumber

    string

    否

    頁碼

    1
    PageSize

    string

    否

    每頁大小

    1
    ObjectType

    string

    否

    物件類型：TABLE、PARTITION_TABLE、LOB

    TABLE

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    PageRecordCount

    integer

    本頁記錄數。

    1
    RequestId

    string

    請求 ID。

    C7A8EA8E-A140-5226-90D7-5BCB304D3DB6
    NextToken

    string

    查詢憑證（token），取值為上一次 api 調用返回的 nexttoken 參數值。如果沒有下一個查詢，請不傳。

    c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==
    OssClusterEnabled

    string

    是否開啟 oss 儲存空間：

    • true：開啟

    • false：關閉。

    true
    SupportOssCluster

    string

    當前叢集是否支援開啟冷存，不支援的叢集，頁面不會展示開關。

    true
    ObjectType

    string

    物件類型

    TABLE
    MaxResults

    integer

    本次讀取的最巨量資料量，預設值為 10。

    1000
    PageSize

    integer

    每頁條數

    30
    PageNumber

    integer

    當前頁碼

    1
    TotalRecord

    integer

    總記錄數

    1
    Tables

    array<object>

    冷儲存執行個體列表。

    array<object>

    冷儲存執行個體列表。

    OssClusterId

    string

    oss 叢集 id。

    pc-*****************
    Partion

    string

    冷儲存執行個體分區。

    202509
    Size

    string

    冷儲存執行個體的磁碟大小，單位為 gib。

    30
    DB

    string

    資料庫名。

    test_db
    Table

    string

    表名稱。

    user
    TableName

    string

    表名稱。

    test_table
    DBName

    string

    資料庫名稱。

    test_db
    Status

    string

    任務狀態。

    Running
    FieldName

    string

    LOB 欄位名。

    user
    ChildObjects

    array<object>

    子物件列表。

    object

    子物件。

    ObjectName

    string

    對象名稱

    img/1728554006462.png
    ObjectType

    string

    物件類型。

    File
    Size

    string

    磁碟大小，單位 GiB。

    10
    Status

    string

    任務狀態，取值範圍如下：

    • Scheduled：等待執行

    • Running：執行中

    • Succeed：執行成功

    • Cancelling：正在終止

    • Canceled：已終止

    • Waiting：等待預設時間

    如需查詢多個狀態則用英文逗號分隔，預設為空白，表示全選。

    Running
    OssClusterInfoList

    array<object>

    冷儲存執行個體的 oss 地址清單。

    object

    冷儲存執行個體的 oss 地址。

    OssClusterId

    string

    冷存執行個體 ID。

    pc-*****************
    Region

    string

    任務所在地區的地區 ID。

    cn-hangzhou
    Size

    string

    冷存表大小，單位 gb。

    50
    CreatedTime

    string

    叢集建立時間。

    2023-05-10T17:01:16Z

    樣本

    正常返回樣本

    JSON格式

    {
  "PageRecordCount": 1,
  "RequestId": "C7A8EA8E-A140-5226-90D7-5BCB304D3DB6",
  "NextToken": "c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==",
  "OssClusterEnabled": "true",
  "SupportOssCluster": "true",
  "ObjectType": "TABLE",
  "MaxResults": 1000,
  "PageSize": 30,
  "PageNumber": 1,
  "TotalRecord": 1,
  "Tables": [
    {
      "OssClusterId": "pc-*****************",
      "Partion": "202509",
      "Size": "30",
      "DB": "test_db",
      "Table": "user",
      "TableName": "test_table",
      "DBName": "test_db",
      "Status": "Running",
      "FieldName": "user",
      "ChildObjects": [
        {
          "ObjectName": "img/1728554006462.png",
          "ObjectType": "File",
          "Size": "10",
          "Status": "Running"
        }
      ]
    }
  ],
  "OssClusterInfoList": [
    {
      "OssClusterId": "pc-*****************",
      "Region": "cn-hangzhou",
      "Size": "50",
      "CreatedTime": "2023-05-10T17:01:16Z"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid. 指定的參數PageSize無效
    400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid. 指定的參數PageNumber無效
    400 Database.ConnectError db instance %s connect failed, please check instance status and database processlist 資料庫執行個體串連失敗，請檢查執行個體狀態和資料庫進程列表
    400 Account.QueryError Instance %s query account error 執行個體%s查詢帳戶錯誤
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的參數DBClusterId無效

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

    變更歷史

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