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

Consulta as configurações do ambiente de staging. Você pode consultar várias configurações de recursos por vez.

Descrição da operação

Nota

O número máximo de vezes que cada usuário pode chamar esta operação por segundo é 30.

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, separados por vírgulas (,). Para os recursos que podem ser configurados, consulte Lista de recursos. Se a lista de recursos especificada estiver vazia, a resposta retornará configurações vazias.	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: A configuração está sendo validada. configuring: A configuração está em andamento. success: A configuração foi bem-sucedida. failed: A configuração falhou.	success
ParentId	string	O ID da condição de regra. Este é um parâmetro opcional. Você pode criar condições de regra configurando a função condition (mecanismo de regras) em Parâmetros de recursos de configuração de domínio. As condições de regra podem corresponder e filtrar solicitações de usuários identificando vários parâmetros contidos nas solicitações. Após a criação de uma condição de regra, um ConfigId correspondente é gerado. O ConfigId pode ser usado como o parâmetro ParentId e referenciado por outras funções. Dessa forma, as condições de regra podem ser combinadas com configurações de recursos para formar configurações mais flexíveis. Para operações de configuração específicas, consulte Configurar nomes de domínio em lote ou os exemplos de configuração de ParentId abaixo.	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	O nome da configuração.	auth_type
ArgValue	string	O valor da configuração.	req_auth

Exemplos de configuração de ParentId

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

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

O exemplo a seguir mostra uma configuração que não usa parentId:

Quando a função origin_request_header é usada para adicionar um cabeçalho de solicitação HTTP back-to-origin que referencia a condição de regra cujo configid=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"
}]

O exemplo a seguir mostra uma configuração que usa 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"
}]

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.