All Products
Search

This Product

    Data Management:DescribeSandboxInstances

    Document Center

    Data Management:DescribeSandboxInstances

    Last Updated:Jun 10, 2026

    Mengkueri instans sandbox yang dibuat dalam sebuah akun.

    Deskripsi operasi

    Operasi ini hanya tersedia di Database Backup (DBS) API versi 2021-01-01.

    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

    dbs:DescribeSandboxInstances

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    BackupPlanId

    string

    Yes

    ID jadwal pencadangan. Anda dapat memanggil operasi DescribeBackupPlanList untuk memperoleh ID jadwal pencadangan.

    Catatan

    Jika instans Anda adalah instans ApsaraDB RDS for MySQL, Anda dapat mengonfigurasi akses otomatis ke sumber data untuk menambahkan instans tersebut ke DBS secara otomatis dan memperoleh ID jadwal pencadangan.

    1hxxxx8xxxxxa
    InstanceId

    string

    No

    ID instans sandbox. Anda dapat memanggil operasi CreateSandboxInstance untuk memperoleh ID instans sandbox.

    1jxxxxnxxx1xc
    PageSize

    string

    No

    Jumlah entri yang dikembalikan di setiap halaman. Nilai yang valid:

    • 30. Ini adalah nilai default.

    • 50

    • 100

    30
    PageNumber

    string

    No

    Nomor halaman yang akan dikembalikan. Nilai harus berupa bilangan bulat yang lebih besar dari 0. Nilai default: 1.

    1

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Data

    string

    Parameter respons.

    • connectionString: string koneksi instans sandbox, dalam format alamat IP:Nomor port. Parameter ini menunjukkan endpoint instans sandbox jika nilai parameter SandboxType adalah Sandbox. Parameter ini menunjukkan alamat mount Network File System (NFS) jika nilai parameter SandboxType adalah NFS.

    • restoreSeconds: waktu yang dibutuhkan untuk membuat instans sandbox. Satuan: detik.

    • restoreTime: titik waktu di mana instans sandbox dipulihkan. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddThh:mm:ssZ. Waktu ditampilkan dalam UTC.

    • instanceId: ID instans sandbox.

    • backupSetId: ID set pencadangan.

    • createTime: titik waktu ketika instans sandbox dibuat. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddThh:mm:ssZ. Waktu ditampilkan dalam UTC.

    • backupPlanId: ID jadwal pencadangan.

    • vpcId: ID virtual private cloud (VPC).

    • vpcSwitchId: ID VSwitch.

    • sandboxSpecification: spesifikasi instans sandbox.

    • status: status instans sandbox. Nilai yang valid: running, check_pass, dan stop.

    { "number": 1, "size": 1, "content": [ { "connectionString": "172.26.178.229:3306", "restoreSeconds": 15, "restoreTime": "2021-08-11T07:26:24Z", "instanceId": "1jxxxxx9xxxms", "backupSetId": "1hxxxx8xxxxxa_20210811152624", "createTime": "2021-08-12T07:40:29Z", "backupPlanId": "1hxxxx8xxxxxa", "vpcId": "vpc-bp1dxxxxxjy0xxxxx1xxp", "sandboxSpecification": "MYSQL_1C_1M_SD", "status": "running", "vpcSwitchId": "vsw-bp1bxxxxxumxxxxxwxx2w" } ], "totalElements": 1 }
    RequestId

    string

    ID permintaan.

    4F1888AC-1138-4995-B9FE-D2734F61C058
    ErrCode

    string

    Kode kesalahan yang dikembalikan jika permintaan gagal.

    Param.NotFound
    Success

    string

    Menunjukkan apakah permintaan berhasil.

    true
    ErrMessage

    string

    Pesan kesalahan yang dikembalikan jika permintaan gagal.

    The specified parameter %s value is not valid.
    Code

    string

    Kode kesalahan yang dikembalikan jika permintaan gagal.

    Param.NotFound
    Message

    string

    Pesan kesalahan yang dikembalikan jika permintaan gagal.

    The specified parameter %s value is not valid.

    Contoh

    Respons sukses

    JSONformat

    {
  "Data": " {     \"number\": 1,     \"size\": 1,     \"content\": [       {         \"connectionString\": \"172.26.178.229:3306\",         \"restoreSeconds\": 15,         \"restoreTime\": \"2021-08-11T07:26:24Z\",         \"instanceId\": \"1jxxxxx9xxxms\",         \"backupSetId\": \"1hxxxx8xxxxxa_20210811152624\",         \"createTime\": \"2021-08-12T07:40:29Z\",         \"backupPlanId\": \"1hxxxx8xxxxxa\",         \"vpcId\": \"vpc-bp1dxxxxxjy0xxxxx1xxp\",         \"sandboxSpecification\": \"MYSQL_1C_1M_SD\",         \"status\": \"running\",         \"vpcSwitchId\": \"vsw-bp1bxxxxxumxxxxxwxx2w\"       }     ],     \"totalElements\": 1   }",
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "Param.NotFound",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid.",
  "Code": "Param.NotFound",
  "Message": "The specified parameter %s value is not valid."
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    403 Request.Forbidden Have no Permissions

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.