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

Consulta as configurações de recursos no ambiente de staging.

Descrição da operação

Nota

Cada conta pode chamar esta operação até 30 vezes 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:DescribeCdnDomainStagingConfig

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 especificar apenas um nome de domínio em cada solicitação.	example.com
FunctionNames	string	Não	A lista de nomes de recursos. Separe vários valores com vírgulas (,). Para mais informações, consulte Uma lista de recursos.	aliauth

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
DomainName	string	O nome de domínio acelerado.	example.com
RequestId	string	O ID da solicitação.	C80705BF-0F76-41FA-BAD1-5B59296A4E59
DomainConfigs	array<object>	As configurações do nome de domínio.
	array<object>
Status	string	O status da configuração. Valores válidos: testing configuring success failed	success
ParentId	string	O ID da condição da regra. Este parâmetro é opcional. Para criar uma condição de regra, você pode configurar o recurso condition descrito no tópico Parâmetros para configuração de recursos para nomes de domínio. Uma condição de regra pode identificar parâmetros incluídos nas solicitações e filtrar solicitações com base nos parâmetros identificados. Cada condição de regra possui um ConfigId. Você pode referenciar o ConfigId em vez do ParentId em outros recursos. Dessa forma, você pode combinar condições de regra e recursos para configurações flexíveis. Para mais informações, consulte BatchSetCdnDomainConfig ou o exemplo de configuração de ParentId neste tópico.	222728944812032
ConfigId	string	O ID da configuração.	6xx5
FunctionName	string	O nome do recurso.	aliauth
FunctionArgs	array<object>	A descrição de cada recurso.
	object
ArgName	string	The configuration name.	auth_type
ArgValue	string	The configuration value.	req_auth

Exemplo de configuração de ParentId

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

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

O código a seguir descreve uma configuração de exemplo caso parentId não seja utilizado.

Neste exemplo, o recurso origin_request_header é usado para adicionar cabeçalhos HTTP de origem, e a condição de regra cujo ID de configuração é 222728944812032 é referenciada.

[{
        "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 código a seguir descreve uma configuração de exemplo caso parentId seja utilizado.

No exemplo a seguir, o recurso origin_request_header é usado para adicionar cabeçalhos HTTP de origem, e a condição de regra que corresponde ao configid 222728944812032 é referenciada.

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

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

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.