All Products
Search
Document Center

Cloud Backup:DescribePolicyBindings

Last Updated:Jun 11, 2026

Anda dapat mengkueri sumber data yang dilampirkan ke kebijakan, atau kebijakan yang dilampirkan ke sumber data.

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

hbr:DescribePolicyBindings

list

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

NextToken

string

No

Token yang digunakan untuk mengambil halaman hasil berikutnya.

caeba0bbb2be03f84eb48b699f0a

MaxResults

integer

No

Jumlah hasil yang dikembalikan untuk setiap kueri.

Nilai yang valid: 10 hingga 100. Nilai default: 10.

10

PolicyId

string

No

ID kebijakan.

po-000************hky

DataSourceIds

array

No

Daftar ID sumber data.

string

No

ID sumber data.

i-uf6************68n

SourceType

string

No

Tipe sumber data. Nilai yang valid:

  • UDM_ECS: Pencadangan instans ECS.

UDM_ECS

Filters

array<object>

No

Filter kueri.

object

No

Filter kueri.

Key

string

No

Kunci filter. Nilai yang valid:

  • PolicyId: ID kebijakan pencadangan

  • DataSourceId: ID instans ECS

  • DataSourceType: tipe sumber data

DataSourceType

Operator

string

No

Metode pencocokan. Nilai default adalah IN. Parameter ini menentukan operator yang digunakan untuk mencocokkan kunci dan nilai. Nilai yang valid:

  • EQUAL: sama dengan

  • NOT_EQUAL: tidak sama dengan

  • GREATER_THAN: lebih besar dari

  • GREATER_THAN_OR_EQUAL: lebih besar dari atau sama dengan

  • LESS_THAN: lebih kecil dari

  • LESS_THAN_OR_EQUAL: lebih kecil dari atau sama dengan

  • BETWEEN: di antara. Nilainya adalah array JSON dalam format [lower_bound,upper_bound].

  • IN: dalam suatu set. Nilainya adalah array.

IN

Values

array

No

Nilai yang akan dicocokkan dalam filter.

string

No

Nilai yang akan dicocokkan dalam filter.

UDM_ECS

Elemen respons

Element

Type

Description

Example

object

DescribePolicyBindingsResponse

PolicyBindings

array<object>

Daftar pengikatan kebijakan.

array<object>

Detail pengikatan kebijakan.

CreatedTime

integer

Waktu saat pengikatan kebijakan dibuat. Nilai ini adalah stempel waktu UNIX. Satuan: detik.

1661399570

UpdatedTime

integer

Waktu saat pengikatan kebijakan terakhir diperbarui. Nilai ini adalah stempel waktu UNIX. Satuan: detik.

1653611573

PolicyBindingId

string

ID pengikatan kebijakan.

pd-000************slc

PolicyBindingDescription

string

Deskripsi pengikatan kebijakan.

po-000************eslc-i-uf6************y5g

PolicyId

string

ID kebijakan.

po-000************56y

DataSourceId

string

ID sumber data.

i-8vb************5ly

Disabled

boolean

Menunjukkan apakah kebijakan dijeda untuk sumber data.

  • true: Kebijakan dijeda.

  • false: Kebijakan tidak dijeda.

true

Source

string

  • Jika SourceType diatur ke OSS, parameter ini menentukan prefiks objek yang akan dicadangkan. Jika Anda tidak menentukan parameter ini, seluruh bucket akan dicadangkan.

  • Jika SourceType diatur ke ECS_FILE atau File, parameter ini menentukan jalur file yang akan dicadangkan. Jika Anda tidak menentukan parameter ini, semua direktori akan dicadangkan.

backup/

Include

string

Parameter ini diperlukan hanya jika SourceType diatur ke ECS_FILE atau File. Parameter ini menentukan tipe file yang akan dicadangkan. Semua file dengan tipe yang ditentukan akan dicadangkan. Parameter ini mendukung maksimum 255 karakter.

[\"*.doc\",\"*.xltm\"]

Exclude

string

Parameter ini diperlukan hanya jika SourceType diatur ke ECS_FILE atau File. Parameter ini menentukan tipe file yang akan dikecualikan dari pencadangan. Semua file dengan tipe yang ditentukan tidak akan dicadangkan. Parameter ini mendukung maksimum 255 karakter.

[\"*.doc\",\"*.xltm\"]

SpeedLimit

string

Parameter ini diperlukan hanya jika SourceType diatur ke ECS_FILE atau File. Parameter ini menentukan pengaturan pembentukan lalu lintas untuk pencadangan. Formatnya adalah {start}:{end}:{bandwidth}. Anda dapat menentukan beberapa pengaturan. Pisahkan dengan koma (,). Periode waktu tidak boleh tumpang tindih.

  • start: jam mulai.

  • end: jam berakhir.

  • bandwidth: kecepatan pembatasan. Satuan: KB/s.

0:24:10240

AdvancedOptions

object

Opsi lanjutan.

UdmDetail

object

The advanced options for ECS instance backup.

ExcludeDiskIdList

array

The list of disk IDs to exclude from the backup. This parameter is ignored if `DiskIdList` is not empty.

string

The ID of the disk to exclude from the backup.

d-bp1************apo

DiskIdList

array

The list of disk IDs to back up. If you want to back up all disks, leave this parameter empty.

string

The ID of the disk to back up.

d-bp1************apo

SnapshotGroup

boolean

Indicates whether to create a snapshot-consistent group. You can create a snapshot-consistent group only when all disks of the instance are Enhanced SSDs (ESSDs).

true

AppConsistent

boolean

Indicates whether to create an application-consistent snapshot. You can create an application-consistent snapshot only when all disks of the instance are ESSDs.

false

RamRoleName

string

This parameter is required only if AppConsistent is set to true. This parameter specifies the name of the RAM role that is required to create an application-consistent snapshot.

AliyunECSInstanceForHbrRole

PreScriptPath

string

This parameter is required only if AppConsistent is set to true. This parameter specifies the path of the pre-freeze script that is run before the application-consistent snapshot is created.

/tmp/prescript.sh

PostScriptPath

string

This parameter is required only if AppConsistent is set to true. This parameter specifies the path of the post-thaw script that is run after the application-consistent snapshot is created.

/tmp/postscript.sh

EnableFsFreeze

boolean

This parameter is required only if AppConsistent is set to true. This parameter indicates whether to use the `fsfreeze` command of the Linux operating system to put the file system in a read-only state before you create an application-consistent snapshot. The default value is true.

true

TimeoutInSeconds

integer

This parameter is required only if AppConsistent is set to true. This parameter specifies the timeout period for I/O freeze. The default value is 30 seconds.

30

EnableWriters

boolean

This parameter is required only if AppConsistent is set to true. Indicates whether to create an application-consistent snapshot:

  • true: Create an application-consistent snapshot.

  • false: Create a file system-consistent snapshot.

Default value: true.

true

DestinationKmsKeyId

string

The ID of a customer managed key (CMK) in the destination region. If you enable cross-region replication and specify this parameter, the cross-region backup is encrypted using the specified key.

4ed37b1e-da51-4187-aceb-9db4f9b7148b

OssDetail

object

The advanced options for OSS backup.

InventoryId

string

The name of the OSS inventory. If you specify this parameter, an OSS inventory is used for performance optimization.

  • The storage fees for inventory files are charged by OSS.

  • It takes time to generate an OSS inventory file. The backup job may fail before the inventory file is generated. You can wait for the next backup cycle to run.

inventory_test

InventoryCleanupPolicy

string

Indicates whether to delete the inventory file after a backup. This parameter is valid only when an OSS inventory is used. Valid values:

  • NO_CLEANUP: The inventory file is not deleted.

  • DELETE_CURRENT: The current inventory file is deleted.

  • DELETE_CURRENT_AND_PREVIOUS: All inventory files are deleted.

DELETE_CURRENT_AND_PREVIOUS

IgnoreArchiveObject

boolean

Indicates whether to exclude archive objects from the backup job statistics and the list of failed files.

true

FileDetail

object

The advanced options for file backup.

UseVSS

boolean

Indicates whether to enable the Volume Shadow Copy Service (VSS) feature. This feature is available only for Windows instances. Valid values:

  • true: Enable the VSS feature.

  • false: Disable the VSS feature.

false

AdvPolicy

boolean

Indicates whether to use an advanced policy. Valid values:

  • true: Use an advanced policy.

  • false: Do not use an advanced policy.

false

CommonNasDetail

object

The advanced options for on-premises NAS.

FullOnIncrementFail

boolean

Indicates whether to run a full backup if an incremental backup fails. Valid values:

  • true: Run a full backup.

  • false: Do not run a full backup.

true

FetchSliceSize

integer

The size of a backup shard, which is the number of files.

100000

ClientId

string

The backup client ID.

c-0001eg6mcvjs93f46s2d

ClusterId

string

The client group ID.

cl-000gkcofngi04j6k680a

CommonFileSystemDetail

object

The advanced options for large-scale file system backup.

FullOnIncrementFail

boolean

Indicates whether to run a full backup if an incremental backup fails. Valid values:

  • true: Run a full backup.

  • false: Do not run a full backup.

true

FetchSliceSize

integer

The size of a backup shard, which is the number of files.

100000

SourceType

string

Tipe sumber data. Nilai yang valid:

  • UDM_ECS: Pencadangan instans ECS

UDM_ECS

CrossAccountType

string

Tipe pencadangan lintas-akun. Nilai yang valid:

  • SELF_ACCOUNT: Mencadangkan data dalam akun yang sama.

  • CROSS_ACCOUNT: Mencadangkan data lintas akun.

CROSS_ACCOUNT

CrossAccountUserId

integer

ID akun sumber untuk pencadangan lintas-akun.

1480************

CrossAccountRoleName

string

Nama peran RAM yang dibuat di akun sumber untuk pencadangan lintas-akun.

hbrcrossrole

CreatedByTag

boolean

Menunjukkan apakah sumber data secara otomatis terikat ke kebijakan pencadangan berdasarkan tag.

false

HitTags

array<object>

Aturan tag yang cocok.

object

Key

string

The tag key.

env

Value

string

The tag value.

prod

Operator

string

The tag matching rule.

  • EQUAL: Matches the tag key and tag value.

  • NOT: Matches the tag key but not the tag value.

EQUAL

NextToken

string

Token yang digunakan untuk mengambil halaman pengikatan kebijakan berikutnya.

caeba0bbb2be03f84eb48b699f0a

MaxResults

integer

Jumlah hasil yang dikembalikan untuk setiap kueri.

Nilai yang valid: 10 hingga 100. Nilai default: 10.

10

TotalCount

integer

Jumlah total catatan.

38

Success

boolean

Menunjukkan apakah permintaan berhasil.

  • true: Permintaan berhasil.

  • false: Permintaan gagal.

true

Code

string

Kode pengembalian. Nilai 200 menunjukkan bahwa permintaan berhasil.

200

Message

string

Pesan yang dikembalikan. Jika permintaan berhasil, `successful` dikembalikan. Jika permintaan gagal, pesan kesalahan dikembalikan.

successful

RequestId

string

ID permintaan.

5225929A-4EBD-55EE-9FE1-4A130E582A76

Contoh

Respons sukses

JSONformat

{
  "PolicyBindings": [
    {
      "CreatedTime": 1661399570,
      "UpdatedTime": 1653611573,
      "PolicyBindingId": "pd-000************slc",
      "PolicyBindingDescription": "po-000************eslc-i-uf6************y5g",
      "PolicyId": "po-000************56y",
      "DataSourceId": "i-8vb************5ly",
      "Disabled": true,
      "Source": "backup/",
      "Include": "[\\\"*.doc\\\",\\\"*.xltm\\\"]",
      "Exclude": "[\\\"*.doc\\\",\\\"*.xltm\\\"]",
      "SpeedLimit": "0:24:10240",
      "AdvancedOptions": {
        "UdmDetail": {
          "ExcludeDiskIdList": [
            "d-bp1************apo\n"
          ],
          "DiskIdList": [
            "d-bp1************apo\n"
          ],
          "SnapshotGroup": true,
          "AppConsistent": false,
          "RamRoleName": "AliyunECSInstanceForHbrRole",
          "PreScriptPath": "/tmp/prescript.sh",
          "PostScriptPath": "/tmp/postscript.sh",
          "EnableFsFreeze": true,
          "TimeoutInSeconds": 30,
          "EnableWriters": true,
          "DestinationKmsKeyId": "4ed37b1e-da51-4187-aceb-9db4f9b7148b"
        },
        "OssDetail": {
          "InventoryId": "inventory_test",
          "InventoryCleanupPolicy": "DELETE_CURRENT_AND_PREVIOUS",
          "IgnoreArchiveObject": true
        },
        "FileDetail": {
          "UseVSS": false,
          "AdvPolicy": false
        },
        "CommonNasDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000,
          "ClientId": "c-0001eg6mcvjs93f46s2d",
          "ClusterId": "cl-000gkcofngi04j6k680a"
        },
        "CommonFileSystemDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000
        }
      },
      "SourceType": "UDM_ECS",
      "CrossAccountType": "CROSS_ACCOUNT",
      "CrossAccountUserId": 0,
      "CrossAccountRoleName": "hbrcrossrole",
      "CreatedByTag": false,
      "HitTags": [
        {
          "Key": "env",
          "Value": "prod",
          "Operator": "EQUAL"
        }
      ]
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 38,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "5225929A-4EBD-55EE-9FE1-4A130E582A76"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.