Kueri Konfigurasi Domain CDN di Staging melalui API sebelum Deployment - CDN - Alibaba Cloud - CDN

Mengkueri konfigurasi lingkungan staging. Anda dapat mengkueri beberapa konfigurasi fitur sekaligus.

Deskripsi operasi

Catatan

Jumlah maksimum panggilan operasi ini oleh setiap pengguna per detik adalah 30.

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

cdn:DescribeCdnDomainStagingConfig

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DomainName	string	Yes	Nama domain yang dipercepat. Anda hanya dapat menentukan satu nama domain dalam setiap permintaan.	example.com
FunctionNames	string	No	Daftar nama fitur, dipisahkan dengan koma (,). Untuk fitur yang dapat dikonfigurasi, lihat Daftar fitur. Jika daftar fitur yang Anda tentukan kosong, tanggapan akan mengembalikan konfigurasi kosong.	aliauth

Elemen respons

Element	Type	Description	Example
	object
DomainName	string	Nama domain yang dipercepat.	example.com
RequestId	string	ID permintaan.	C80705BF-0F76-41FA-BAD1-5B59296A4E59
DomainConfigs	array<object>	Konfigurasi nama domain.
	array<object>
Status	string	Status konfigurasi. Nilai valid: testing: Konfigurasi sedang divalidasi. configuring: Konfigurasi sedang berlangsung. success: Konfigurasi berhasil. failed: Konfigurasi gagal.	success
ParentId	string	ID kondisi aturan. Ini adalah parameter opsional. Anda dapat membuat kondisi aturan dengan mengonfigurasi fungsi condition (mesin aturan) di Parameter fitur konfigurasi domain. Kondisi aturan dapat mencocokkan dan memfilter permintaan pengguna dengan mengidentifikasi berbagai parameter yang dibawa dalam permintaan. Setelah kondisi aturan dibuat, ConfigId yang sesuai akan dihasilkan. ConfigId dapat digunakan sebagai parameter ParentId dan direferensikan oleh fungsi lain. Dengan cara ini, kondisi aturan dapat dikombinasikan dengan konfigurasi fitur untuk membentuk konfigurasi yang lebih fleksibel. Untuk operasi konfigurasi spesifik, lihat Konfigurasi batch nama domain atau contoh konfigurasi ParentId di bawah ini.	222728944812032
ConfigId	string	ID konfigurasi.	6xx5
FunctionName	string	Nama fitur.	aliauth
FunctionArgs	array<object>	Deskripsi setiap fitur.
	object
ArgName	string	The configuration name.	auth_type
ArgValue	string	The configuration value.	req_auth

Contoh konfigurasi ParentId

Jika parentId diatur ke -1, kondisi aturan yang ada dalam konfigurasi akan dihapus.

[{
   "functionArgs": [{
     "argName": "功能参数 A", 
     "argValue": "功能参数 A 对应的值"
    }, 
  {
    "argName": "功能参数 B", 
    "argValue": "功能参数 B 对应的值"
     }], 
 "functionName": "功能名称",
 "parentId": "选填项，对应引用规则条件的 configid"
}]

Contoh berikut menunjukkan konfigurasi yang tidak menggunakan parentId:

Ketika fungsi origin_request_header digunakan untuk menambahkan header permintaan HTTP back-to-origin yang mereferensikan kondisi aturan dengan configid=222728944812032, parameter permintaan adalah sebagai berikut:

[{
        "functionArgs": [{
            "argName": "header_operation_type",
            "argValue": "add"
        }, {
            "argName": "header_name",
            "argValue": "Accept-Encoding"
        }, {
            "argName": "header_value",
            "argValue": "gzip"
        }, {
            "argName": "duplicate",
            "argValue": "off"
        }],
        "functionName": "origin_request_header"
}]

Contoh berikut menunjukkan konfigurasi yang menggunakan parentId:

[{
        "functionArgs": [{
            "argName": "header_operation_type",
            "argValue": "add"
        }, {
            "argName": "header_name",
            "argValue": "Accept-Encoding"
        }, {
            "argName": "header_value",
            "argValue": "gzip"
        }, {
            "argName": "duplicate",
            "argValue": "off"
        }],
        "functionName": "origin_request_header",
        "parentId": "222728944812032"
}]

Contoh

Respons sukses

JSONformat

{
  "DomainName": "example.com",
  "RequestId": "C80705BF-0F76-41FA-BAD1-5B59296A4E59",
  "DomainConfigs": [
    {
      "Status": "success",
      "ParentId": "222728944812032",
      "ConfigId": "6xx5",
      "FunctionName": "aliauth",
      "FunctionArgs": [
        {
          "ArgName": "auth_type",
          "ArgValue": "req_auth"
        }
      ]
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.