DescribeApisecExamples - Web Application Firewall: Central de Documentação do Alibaba Cloud

Consulta informações de amostra de segurança de API.

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

yundun-waf:DescribeApisecExamples

list

*All Resource

*

acs:ResourceGroupId

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância WAF. Nota Você pode chamar a operação DescribeInstance para consultar o ID da instância WAF.	waf_elasticity-cn-0xldbqtm005
RegionId	string	Não	A região onde a instância WAF está implantada. Valores válidos: cn-hangzhou: China continental. ap-southeast-1: fora da China continental.	cn-hangzhou
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q
ApiId	string	Sim	O ID da API.	867ade***24ee6e205b8da82b8f84
ExampleType	string	Não	O tipo da amostra. Valores válidos: sensitive: tipo de informação sensível. risk: tipo de risco. Valores válidos: risk : Tipo de risco. sensitive : Tipo de informação sensível.	sensitive
RequestSensitiveTypeList	array	Não	A lista de tipos de informações sensíveis da solicitação.
	string	Não	O tipo de informação sensível da solicitação.	1001
ResponseSensitiveTypeList	array	Não	A lista de tipos de informações sensíveis da resposta.
	string	Não	O tipo de informação sensível da resposta.	1001
AbnormalTag	string	Não	O tipo de risco.	LackOfSpeedLimit
NextToken	string	Não	O token de paginação.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	Não	O número de entradas por página em uma consulta paginada. Valores válidos: 1 a 5. Valor padrão: 5. Este parâmetro é usado para paginação.	5
ClusterId	string	Não	O ID do cluster de nuvem híbrida. Nota Este parâmetro se aplica apenas a cenários de nuvem híbrida. Você pode chamar a operação DescribeHybridCloudClusters para consultar informações do cluster de nuvem híbrida.	176

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Examples	array<object>	A lista de amostras.
	array<object>	As informações da amostra.
Protocol	string	O tipo de protocolo. Valores válidos: http: protocolo HTTP. https: protocolo HTTPS.	http
ApiUrl	string	O caminho completo da solicitação.	http://www.test.com/api/v1/hello.php?token=TkJGQw
PocPayload	string	A solicitação de verificação.	curl -X GET -H 'Accept: /' -H 'Connection: keep-alive' -H 'User-agent: Mozilla/5.0 (Windows NT 10.0; WOW64)' -H 'Host: www.test.com' -H 'Accept-encoding: gzip, deflate' -H 'Eagleeye-rpcid: 0.1' 'http://www.test.com/api/v1/hello.php?token=TkJGQw'
RequestSensitiveData	array<object>	A lista de dados sensíveis da solicitação.
	object	Os dados sensíveis da solicitação.
SensitiveCode	string	O código que indica o tipo de dados sensíveis na solicitação.	1000
SensitiveDataList	array	A lista de dados sensíveis.
	string	A entrada de dados sensíveis.	90.88.49.19
ResponseSensitiveData	array<object>	A lista de dados sensíveis da resposta.
	object	Os dados sensíveis da resposta.
SensitiveCode	string	O código que indica o tipo de dados sensíveis na resposta.	1000
SensitiveDataList	array	A lista de dados sensíveis.
	string	A entrada de dados sensíveis.	90.88.49.19
Request	string	O conteúdo da solicitação de amostra, que é uma string de caracteres convertida de um formato JSON construído com uma série de parâmetros. Os seguintes campos estão incluídos: method: o método da solicitação. host: o nome de domínio da solicitação. header: o cabeçalho da solicitação. server_port: a porta do serviço. body: o conteúdo do corpo da solicitação. url: o caminho da solicitação. server_protocol: o protocolo do servidor. Nota Se o conteúdo de body exceder 16 KB, apenas o conteúdo parcial será retornado.	{ "method": "GET", "host": "www.test.com", "header": { "Accept": "/", "Connection": "keep-alive" }, "server_port": "80", "body": "-", "url": "/api/v1/hello.php?token=TkJGQw", "server_protocol": "HTTP/1.1" }
Response	string	O conteúdo da resposta de amostra, que é uma string convertida de um objeto JSON construído com uma série de parâmetros. Os seguintes campos estão incluídos: status: o código de status. header: o cabeçalho da resposta. body: o conteúdo do corpo da resposta. Nota Se o conteúdo de body exceder 16 KB, apenas o conteúdo parcial será retornado.	{ "header": { "Connection": "keep-alive", "Content-Encoding": "gzip", "Content-Type": "text/html; charset=UTF-8" }, "body": "xxxx", "status": 200 }
NextToken	string	O token de paginação.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	O número de entradas por página em uma consulta paginada. Valores válidos: 1 a 5. Valor padrão: 5. Este parâmetro é usado para paginação.	5
TotalCount	integer	O número total de resultados.	5

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Examples": [
    {
      "Protocol": "http",
      "ApiUrl": "http://www.test.com/api/v1/hello.php?token=TkJGQw",
      "PocPayload": "curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: Mozilla/5.0 (Windows NT 10.0; WOW64)' -H 'Host: www.test.com' -H 'Accept-encoding: gzip, deflate' -H 'Eagleeye-rpcid: 0.1' 'http://www.test.com/api/v1/hello.php?token=TkJGQw'",
      "RequestSensitiveData": [
        {
          "SensitiveCode": "1000",
          "SensitiveDataList": [
            "90.88.49.19"
          ]
        }
      ],
      "ResponseSensitiveData": [
        {
          "SensitiveCode": "1000",
          "SensitiveDataList": [
            "90.88.49.19"
          ]
        }
      ],
      "Request": "{\n  \"method\": \"GET\",\n  \"host\": \"www.test.com\",\n  \"header\": {\n    \"Accept\": \"*/*\",\n    \"Connection\": \"keep-alive\"\n  },\n  \"server_port\": \"80\",\n  \"body\": \"-\",\n  \"url\": \"/api/v1/hello.php?token=TkJGQw\",\n  \"server_protocol\": \"HTTP/1.1\"\n}",
      "Response": "{\n  \"header\": {\n    \"Connection\": \"keep-alive\",\n    \"Content-Encoding\": \"gzip\",\n    \"Content-Type\": \"text/html; charset=UTF-8\"\n  },\n  \"body\": \"xxxx\",\n  \"status\": 200\n}"
    }
  ],
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "MaxResults": 5,
  "TotalCount": 5
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.