DescribeCdnDomainStagingConfig - CDN

Deskripsi operasi

Catatan

Anda dapat memanggil operasi ini hingga 30 kali per detik per akun.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

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. Pisahkan beberapa nilai dengan koma (,). Untuk informasi selengkapnya, lihat A list of features.	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 yang valid: testing configuring success failed	success
ParentId	string	ID kondisi aturan. Parameter ini bersifat opsional. Untuk membuat kondisi aturan, Anda dapat mengonfigurasi fitur condition yang dijelaskan dalam topik Parameters for configuring features for domain names. Kondisi aturan dapat mengidentifikasi parameter yang disertakan dalam permintaan dan menyaring permintaan berdasarkan parameter tersebut. Setiap kondisi aturan memiliki ConfigId. Anda dapat mereferensikan ConfigId sebagai pengganti ParentId pada fitur lain. Dengan cara ini, Anda dapat menggabungkan kondisi aturan dan fitur untuk konfigurasi yang fleksibel. Untuk informasi selengkapnya, lihat BatchSetCdnDomainConfig atau contoh konfigurasi ParentId dalam topik ini.	222728944812032
ConfigId	string	ID konfigurasi.	6xx5
FunctionName	string	Nama fitur.	aliauth
FunctionArgs	array<object>	Deskripsi setiap fitur.
	object
ArgName	string	Nama konfigurasi.	auth_type
ArgValue	string	Nilai konfigurasi.	req_auth

Contoh konfigurasi ParentId

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

[{
   "functionArgs": [{
     "argName": "Parameter A", 
     "argValue": "Value of parameter A"
    }, 
  {
    "argName": "Parameter B", 
    "argValue": "Value of parameter B"
     }], 
 "functionName": "Feature name",
 "parentId": "Optional. parentId corresponds to configid of the referenced rule condition"
}]

Kode berikut menjelaskan contoh konfigurasi jika parentId tidak digunakan.

Dalam contoh ini, fitur origin_request_header digunakan untuk menambahkan Header HTTP origin, dan kondisi aturan dengan ID konfigurasi 222728944812032 direferensikan.

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

Kode berikut menjelaskan contoh konfigurasi jika parentId digunakan.

Dalam contoh berikut, fitur origin_request_header digunakan untuk menambahkan Header HTTP origin, dan kondisi aturan yang sesuai dengan configid 222728944812032 direferensikan.

[{
        "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.