DescribeCdnDomainConfigs - CDN: Central de Documentação do Alibaba Cloud

Obtém as configurações de um nome de domínio acelerado. Você pode consultar as configurações de vários recursos em uma única chamada.

Descrição da operação

Nota

O limite de taxa para um único usuário é de 100 chamadas por segundo.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cdn:DescribeCdnDomainConfigs

get

*Domain

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DomainName	string	Sim	O nome de domínio acelerado. Você pode consultar apenas um nome de domínio por vez.	example.com
FunctionNames	string	Não	Os nomes dos recursos. Separe vários nomes de recursos com vírgulas (,). Para obter mais informações sobre os nomes dos recursos, consulte Parâmetros para configurações de nome de domínio.	aliauth
ConfigId	string	Não	O ID da configuração do recurso. Para obter mais informações sobre como consultar e usar um ConfigId, consulte Uso do ConfigId.	6295

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	C80705BF-0F76-41FA-BAD1-5B59296A4E59
DomainConfigs	object
DomainConfig	array<object>	As configurações do nome de domínio.
	array<object>
Status	string	The status of the configuration. Valid values: success: The configuration is successful. testing: The configuration is being tested. failed: The configuration failed. configuring: The configuration is in progress.	success
ParentId	string	The ID of the rule condition. This parameter is optional. You can create a rule condition by configuring the condition feature (rules engine) in Parameters for domain name configurations. A rule condition can match and filter user requests by detecting various parameters in the requests. After a rule condition is created, a corresponding ConfigId is generated. The ConfigId can be referenced by other features as the ParentId parameter. This way, you can combine rule conditions and feature configurations to create more flexible configurations. For more information about the configuration procedure, see Configure domain names in batches or the ParentId configuration example in this topic.	222728944812032
ConfigId	string	The configuration ID.	6295
FunctionName	string	The name of the feature.	aliauth
FunctionArgs	object
FunctionArg	array<object>	The parameter settings for each feature.
	object
ArgName	string	The parameter name. This is a configuration item of functionName. You can configure multiple configuration items.	auth_type
ArgValue	string	The parameter value. This is the value of the configuration item for functionName.	req_auth

Exemplo de configuração de ParentId

Se parentId estiver definido como -1, as condições de regra existentes na configuração serão excluídas.

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

O exemplo a seguir mostra como usar o recurso origin_request_header para adicionar um cabeçalho de solicitação HTTP de busca na origem sem usar parentId. Os parâmetros da solicitação são os seguintes:

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

O exemplo a seguir mostra uma configuração que usa parentId. Neste exemplo, o recurso origin_request_header é usado para adicionar um cabeçalho de solicitação HTTP de busca na origem e referenciar a condição de regra com um configid de 222728944812032. Os parâmetros da solicitação são os seguintes:

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

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.