All Products
Search

This Product

    PolarDB:DescribeColdStorageInstance

    Document Center

    PolarDB:DescribeColdStorageInstance

    Last Updated:Jun 10, 2026

    Mengkueri instans penyimpanan dingin.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:DescribeColdStorageInstance

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    No

    ID kluster PolarDB.

    pc-wz9062015ly7526jc
    NextToken

    string

    No

    Token untuk mengambil halaman hasil berikutnya. Setel parameter ini ke nilai `NextToken` dari pemanggilan sebelumnya. Anda tidak perlu menentukan parameter ini untuk pemanggilan pertama.

    c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==
    TableName

    string

    No

    Nama tabel data.

    account_log
    DBName

    string

    No

    Nama basis data.

    test_db
    EngineType

    string

    No

    Jenis mesin yang didukung. Nilai yang dikembalikan adalah jumlah nilai dari jenis mesin yang didukung.

    • 1: Search engine

    • 2: LindormTSDB

    • 4: LindormTable

    • 8: File engine

    Catatan

    Misalnya, jika `EngineType` bernilai 15 (8 + 4 + 2 + 1), instans mendukung search engine, LindormTSDB, LindormTable, dan file engine. Jika `EngineType` bernilai 6 (4 + 2), instans mendukung LindormTSDB dan LindormTable.

    2
    RegionId

    string

    No

    ID region.

    Catatan

    • Jika Anda tidak menentukan parameter ini, operasi akan mengkueri tugas terjadwal di semua region dalam akun Anda.

    cn-hangzhou
    MaxResults

    integer

    No

    • Jika Anda tidak menentukan parameter MaxResults, kueri tidak akan dihalamankan. Nilai parameter MaxResults dalam respons menunjukkan jumlah total entri.

    • Jika Anda menentukan parameter MaxResults, kueri akan dihalamankan. MaxResults menentukan jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid: 1 hingga 100. Nilai parameter MaxResults dalam respons menunjukkan jumlah entri pada halaman saat ini. Nilai yang direkomendasikan adalah 20.

    50
    ExpireTime

    integer

    No

    Waktu kedaluwarsa kluster. Catatan: Parameter ini hanya dikembalikan untuk kluster berlangganan. Nilai kosong dikembalikan untuk kluster pay-as-you-go.

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

    string

    No

    Nomor halaman.

    1
    PageSize

    string

    No

    Jumlah entri per halaman.

    1
    ObjectType

    string

    No

    Jenis objek. Nilai yang valid: `TABLE`, `PARTITION_TABLE`, dan `LOB`.

    TABLE

    Elemen respons

    Element

    Type

    Description

    Example

    object

    PageRecordCount

    integer

    Jumlah entri pada halaman saat ini.

    1
    RequestId

    string

    ID permintaan.

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

    string

    Token untuk mengambil halaman hasil berikutnya. Jika parameter ini tidak dikembalikan, semua hasil telah dikembalikan.

    c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==
    OssClusterEnabled

    string

    Menunjukkan apakah bucket OSS diaktifkan.

    • true: diaktifkan

    • false: dinonaktifkan

    true
    SupportOssCluster

    string

    Menunjukkan apakah kluster mendukung penyimpanan dingin (cold storage). Jika kluster tidak mendukung penyimpanan dingin, tombol tidak ditampilkan di konsol.

    true
    ObjectType

    string

    Jenis objek.

    TABLE
    MaxResults

    integer

    Jumlah maksimum entri yang dikembalikan. Nilai default: 10.

    1000
    PageSize

    integer

    Jumlah entri per halaman.

    30
    PageNumber

    integer

    Nomor halaman.

    1
    TotalRecord

    integer

    Jumlah total entri.

    1
    Tables

    array<object>

    Daftar instans penyimpanan dingin.

    array<object>

    Sebuah instans penyimpanan dingin.

    OssClusterId

    string

    ID kluster berbasis OSS.

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

    string

    Partisi instans penyimpanan dingin.

    202509
    Size

    string

    Ukuran disk instans penyimpanan dingin. Satuan: GiB.

    30
    DB

    string

    Nama basis data.

    test_db
    Table

    string

    Nama tabel.

    user
    TableName

    string

    Nama tabel.

    test_table
    DBName

    string

    Nama basis data.

    test_db
    Status

    string

    Status tugas.

    Running
    FieldName

    string

    Nama bidang large object (LOB).

    user
    ChildObjects

    array<object>

    Daftar objek anak.

    object

    Objek anak.

    ObjectName

    string

    The name of the object.

    img/1728554006462.png
    ObjectType

    string

    The type of the object.

    File
    Size

    string

    The disk size in GiB.

    10
    Status

    string

    The status of the task. Valid values:

    • Scheduled: The task is waiting to be executed.

    • Running: The task is in progress.

    • Succeed: The task is successful.

    • Cancelling: The task is being canceled.

    • Canceled: The task is canceled.

    • Waiting: The task is waiting for a preset time.

    To query multiple statuses, separate them with commas (,). If you leave this parameter empty, all statuses are queried.

    Running
    OssClusterInfoList

    array<object>

    Daftar alamat OSS untuk instans penyimpanan dingin.

    object

    Alamat OSS dari sebuah instans penyimpanan dingin.

    OssClusterId

    string

    ID instans penyimpanan dingin.

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

    string

    ID region tempat tugas berada.

    cn-hangzhou
    Size

    string

    Ukuran tabel penyimpanan dingin. Satuan: GB.

    50
    CreatedTime

    string

    Waktu kluster dibuat.

    2023-05-10T17:01:16Z

    Contoh

    Respons sukses

    JSONformat

    {
  "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"
    }
  ]
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid.
    400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid.
    400 Database.ConnectError db instance %s connect failed, please check instance status and database processlist
    400 Account.QueryError Instance %s query account error
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.