DescribeCdnDomainConfigs - 查詢網域名稱配置 -

調用DescribeCdnDomainConfigs擷取加速網域名稱的配置資訊，一次可查詢多個功能配置資訊。

介面說明

說明

單使用者調用頻率：100 次/秒。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cdn:DescribeCdnDomainConfigs

get

*Domain

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

無

請求參數

名稱	類型	必填	描述	樣本值
DomainName	string	是	加速網域名稱，僅支援查詢單個網域名稱。	example.com
FunctionNames	string	否	功能函數名稱，多個用英文逗號（,）分隔。更多功能名稱，請參見網域名稱配置功能參數。	aliauth
ConfigId	string	否	功能配置 ID。ConfigId 查詢和使用，請參見 ConfigId 使用說明。	6295

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	C80705BF-0F76-41FA-BAD1-5B59296A4E59
DomainConfigs	object
DomainConfig	array<object>	網域名稱配置。
	object
Status	string	配置狀態。取值： success：成功。 testing：測試中。 failed：失敗。 configuring：配置中。	success
ParentId	string	規則條件 ID，非必填項。通過配置網域名稱配置功能參數中的功能函數 condition（規則引擎），可以建立出規則條件（規則條件可以通過識別使用者請求中攜帶的各種參數來匹配和過濾使用者請求），每一個規則條件被建立以後都會產生一個對應的 ConfigId ，ConfigId 可以被當作 ParentId 參數被其他功能函數引用，這樣規則條件就可以與功能配置一起組合形成更靈活的配置。具體配置操作請參考大量設定網域名稱或下文 ParentId 配置樣本說明。	222728944812032
ConfigId	string	配置 ID。	6295
FunctionName	string	功能函數名稱。	aliauth
FunctionArgs	object
FunctionArg	array<object>	各個功能函數所對應的參數配置。
	object
ArgName	string	參數名稱，functionName 的配置項（可配置多個配置項）。	auth_type
ArgValue	string	參數值，functionName 的配置項的取值。	req_auth

ParentId 配置樣本

parentId 為**-1**：表示刪除該配置裡面已有的規則條件。

   "functionArgs": [{
     "argName": "功能參數 A", 
     "argValue": "功能參數 A 對應的值"
    }, 
  {
    "argName": "功能參數 B", 
    "argValue": "功能參數 B 對應的值"
     }], 
 "functionName": "功能名稱",
 "parentId": "選填項，對應引用規則條件的 configid"
}]

不使用 parentId 的情況下，配置樣本如下：使用函數origin_request_header添加回源 HTTP 要求頭的時候引用了configid=222728944812032的規則條件，請求參數如下：

        "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 的情況下，配置樣本如下：使用函數origin_request_header添加回源 HTTP 要求頭的時候引用了configid=222728944812032的規則條件，請求參數如下：

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

樣本

正常返回樣本

JSON格式

{
  "RequestId": "C80705BF-0F76-41FA-BAD1-5B59296A4E59",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ParentId": "222728944812032",
        "ConfigId": "6295",
        "FunctionName": "aliauth",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "auth_type",
              "ArgValue": "req_auth"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。