ListCustomResponseCodeRules - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Consulta a lista de configurações de códigos de resposta personalizados para um site.

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

esa:ListCustomResponseCodeRules

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SiteId	integer	Sim	O ID do site, que pode ser obtido chamando a API ListSites.	340035003106221
ConfigId	integer	Não	O ID da configuração.	436490043994112
ConfigType	string	Não	O tipo de configuração. Você pode usar este parâmetro para consultar configurações globais ou de regras. Valores válidos: global: consulta configurações globais. rule: consulta configurações de regras. Valores válidos: rule : Configuração de regra. global : Configuração global.	global
RuleName	string	Não	O nome da regra.	rule_example
SiteVersion	integer	Não	O número da versão da configuração do site. Para sites com o gerenciamento de versão de configuração ativado, você pode usar este parâmetro para especificar a versão do site para a qual a configuração entra em vigor. Valor padrão: 0.	0
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor máximo: 500. Valor padrão: 500.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	36af3fcc-43d0-441c-86b1-428951dc8225
Configs	array<object>	A lista de configurações de códigos de resposta personalizados.
	object	Os detalhes de uma configuração de código de resposta personalizado.
ConfigId	integer	O ID da configuração.	395386449776640
SiteVersion	integer	O número da versão da configuração do site. Para sites com o gerenciamento de versão de configuração ativado, você pode usar este parâmetro para especificar a versão do site para a qual a configuração entra em vigor. Valor padrão: 0.	0
Sequence	integer	A ordem de execução da regra. Um valor menor indica uma prioridade maior.	1
Rule	string	O conteúdo da regra, que usa expressões condicionais para corresponder às solicitações do usuário. Você não precisa definir este parâmetro ao adicionar uma configuração global. Dois cenários de uso são suportados: Corresponder a todas as solicitações recebidas: defina o valor como true. Corresponder a solicitações específicas: defina o valor como uma expressão personalizada, por exemplo: (http.host eq "video.example.com").	(http.host eq "video.example.com")
RuleEnable	string	O switch da regra. Você não precisa definir este parâmetro ao adicionar uma configuração global. Valores válidos: on: ativa a regra. off: desativa a regra.	on
RuleName	string	O nome da regra. Você não precisa definir este parâmetro ao adicionar uma configuração global.	rule_example
ConfigType	string	O tipo de configuração. Valores válidos: global: configuração global. rule: configuração de regra.	global
ReturnCode	string	O código de resposta.	200
PageId	string	A página de resposta.	0
PageNumber	integer	O número da página. Valor padrão: 1.	1
PageSize	integer	O tamanho da página. Valor padrão: 500. Valores válidos: 1 a 500.	20
TotalCount	integer	O número total de entradas.	10
TotalPage	integer	O número total de páginas.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "SiteVersion": 0,
      "Sequence": 1,
      "Rule": "(http.host eq \"video.example.com\")",
      "RuleEnable": "on",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "ReturnCode": "200",
      "PageId": "0"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 10,
  "TotalPage": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.FunctionName	The specified feature does not exist. Specify a valid feature name based on the related documentation.	The specified feature does not exist. Specify a valid feature name based on the related documentation.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.