Todos os produtos
Search

Este produto

    Web Application Firewall:DescribeApisecApiResources

    Central de documentação

    Web Application Firewall:DescribeApisecApiResources

    Última atualização: Sep 23, 2026

    Consulta a lista de ativos 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:DescribeApisecApiResources

    get

    *Todos os recursos.

    *
    • acs:ResourceGroupId
    		 Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    InstanceId

    string

    Sim

    O ID da instância do WAF.

    Nota

    Você pode chamar DescribeInstance para obter o ID da instância atual do WAF.

    waf_v2_public_cn-u***gr20j
    ApiId

    string

    Não

    O ID da API.

    867ade***24ee6e205b8da82b8f84
    ApiFormat

    string

    Não

    A operação da API.

    /auth/login
    MatchedHost

    string

    Não

    O nome de domínio ou endereço IP ao qual a operação da API pertence.

    a.aliyun.com
    SensitiveType

    string

    Não

    O tipo de dados confidenciais na resposta.

    Nota

    Você pode chamar DescribeApisecRules para obter os tipos de dados confidenciais suportados.

    1004
    ApiStatus

    string

    Não

    O status da API. Valores válidos:

    • NewbornInterface: Novo.

    • OfflineInterface: Inativo.

    • normal: Normal.

    OfflineInterface
    StartTime

    string

    Não

    A hora de início da consulta, no formato de carimbo de data/hora UNIX (UTC). Unidade: segundos.

    1681833600
    EndTime

    string

    Não

    A hora de término da consulta, no formato de carimbo de data/hora UNIX (UTC). Unidade: segundos.

    1683388800
    OrderKey

    string

    Não

    O nome do campo usado para classificação. Valores válidos:

    • allCnt: volume total de acessos nos últimos 30 dias.

    • botCnt: volume de acessos de bots nos últimos 30 dias.

    • crossBorderCnt: volume de acessos transfronteiriços nos últimos 30 dias.

    • abnormalNum: número de riscos associados à API.

    • eventNum: número de eventos associados à API.

    • farthestTs: hora da primeira descoberta.

    • lastestTs: hora do acesso mais recente.

    allCnt
    OrderWay

    string

    Não

    A ordem de classificação. Valores válidos:

    • desc: Ordem decrescente (padrão).

    • asc: Ordem crescente.

    desc
    PageNumber

    integer

    Não

    O número da página a ser retornada em uma consulta paginada. Valor padrão: 1, que indica a primeira página.

    1
    PageSize

    integer

    Não

    O número de entradas a serem retornadas em cada página em uma consulta paginada. Valor padrão: 10, que indica 10 entradas por página.

    10
    Follow

    integer

    Não

    Especifica se a API é seguida. Valores válidos:

    • 1: Seguida.

    • 0: Não seguida.

    0
    ApiType

    string

    Não

    O objeto de serviço. Valores válidos:

    • PublicAPI: Serviço público.

    • ThirdpartAPI: Colaboração de terceiros.

    • InternalAPI: Escritório interno.

    innerAPI
    ApiTag

    string

    Não

    A finalidade comercial da API.

    Nota

    Você pode chamar DescribeApisecRules para obter as finalidades comerciais suportadas.

    SendMail
    SensitiveLevel

    string

    Não

    O nível de sensibilidade da API. Valores válidos:

    • L1: Alta sensibilidade.

    • L2: Média sensibilidade.

    • L3: Baixa sensibilidade.

    • N: Não sensível.

    L3
    ApiMethod

    string

    Não

    O método de solicitação da API. Valores válidos:

    • GET: Solicitação GET.

    • POST: Solicitação POST.

    • HEAD: Solicitação HEAD.

    • PUT: Solicitação PUT.

    • DELETE: Solicitação DELETE.

    • CONNECT: Solicitação CONNECT.

    • PATCH: Solicitação PATCH.

    • OPTIONS: Solicitação OPTIONS.

    POST
    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 DescribeHybridCloudClusters para obter informações do cluster de nuvem híbrida.

    740
    Note

    string

    Não

    As observações.

    loginApi
    RequestSensitiveType

    string

    Não

    O tipo de informações confidenciais na solicitação.

    Nota

    Você pode chamar DescribeApisecRules para obter os tipos de informações confidenciais suportados.

    1004,1005
    AuthFlag

    string

    Não

    Especifica se a API possui um campo de autenticação. Valores válidos:

    • 0: Possui autenticação.

    • 1: Não possui autenticação.

    0
    RegionId

    string

    Não

    A região onde a instância do WAF reside. Valores válidos:

    • cn-hangzhou: a parte continental da China.

    • ap-southeast-1: fora da parte continental da China.

    cn-hangzhou
    ResourceManagerResourceGroupId

    string

    Não

    O ID do grupo de recursos do Alibaba Cloud.

    rg-acfm***q

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    O resultado da solicitação.

    Data

    array<object>

    A lista de ativos de API.

    object

    Os detalhes do ativo.

    AbnormalNum

    integer

    O número de riscos associados à API.

    2
    AccountEventNum

    integer

    O número de eventos de segurança da conta associados ao ativo.

    1
    AllCnt

    integer

    O número total de solicitações de acesso nos últimos 30 dias.

    1683388800
    ApiFormat

    string

    A operação da API.

    /v1/etl/finddatabyvid
    ApiId

    string

    O ID da API.

    197b52abcd81d6a8bd4***e477
    ApiInfo

    string

    Informações relacionadas à API, que é uma string JSON construída a partir de uma série de parâmetros. Os parâmetros incluem:

    • param_num: o número de parâmetros da API.

    • request_method: o método de solicitação.

    • protocol: o protocolo de solicitação.

    • api_url: a URL da solicitação.

    • poc_payload: a solicitação.

    • request: o exemplo de solicitação.

    • response: o exemplo de resposta.

    • param: os parâmetros da solicitação.

    Nota

    Este valor é retornado apenas quando o parâmetro de solicitação ApiId é especificado.

    { "request": {"referer": "-","content_type": "-","cookie": "-","method": "GET","param": [],"host": "test.cn"}, "protocol": "https", "api_url": "https://test.cn:443/index.php", "param": [], "response": {"param": [], "sensitive_type": {}, "header": {},"body": "", "status": 405 }, "request_method": "GET", "poc_payload": "curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'", "param_num": 0 }
    ApiMethod

    string

    O método de solicitação da API. Valores válidos:

    • GET: Solicitação GET.

    • POST: Solicitação POST.

    • HEAD: Solicitação HEAD.

    • PUT: Solicitação PUT.

    • DELETE: Solicitação DELETE.

    • CONNECT: Solicitação CONNECT.

    • PATCH: Solicitação PATCH.

    • OPTIONS: Solicitação OPTIONS.

    POST
    ApiSensitive

    string

    Informações confidenciais relacionadas à API, que é uma string JSON construída a partir de uma série de parâmetros. Os parâmetros incluem:

    • request_sensitive_list: a lista de tipos de dados confidenciais nas solicitações.

    • response_sensitive_list: a lista de tipos de dados confidenciais nas respostas.

    • sensitive_list: a lista de tipos de dados confidenciais.

    • sensitive_level: o nível de confidencialidade.

    { "sensitive_list": ["1003","1005"], "sensitive_level": "L2", "request_sensitive_list": ["1003"], "response_sensitive_list": ["1005"] }
    ApiSensitiveRequest

    string

    Os dados confidenciais nas solicitações da API.

    ["1002","1005"]
    ApiSensitiveResponse

    string

    Os dados confidenciais nas respostas da API.

    ["1002","1005"]
    ApiStatus

    string

    O status da API. Valores válidos:

    • NewbornInterface: Novo.

    • OfflineInterface: Inativo.

    • normal: Normal.

    NewbornInterface
    ApiTag

    string

    A finalidade comercial da API.

    Nota

    Chame DescribeApisecRules para obter as finalidades comerciais suportadas.

    SendMail
    ApiType

    string

    O objeto de serviço. Valores válidos:

    • PublicAPI: Serviço público.

    • ThirdpartAPI: Colaboração de terceiros.

    • InternalAPI: Escritório interno.

    PublicAPI
    AuthFlag

    string

    Especifica se a API possui um campo de autenticação. Valores válidos:

    • 0: Possui autenticação.

    • 1: Não possui autenticação.

    1
    BotCnt

    integer

    O número de solicitações de acesso de bots nos últimos 30 dias.

    2
    CrossBorderCnt

    integer

    O número de solicitações de acesso transfronteiriço nos últimos 30 dias.

    2
    EventNum

    integer

    O número de eventos de segurança associados à API.

    2
    Examples deprecated

    array

    A lista de exemplos de API.

    string

    Informações de exemplo, que é uma string JSON construída a partir de uma série de parâmetros. Os parâmetros incluem:

    • param_num: o número de parâmetros da API.

    • request_method: o método de solicitação.

    • protocol: o protocolo de solicitação.

    • api_url: a URL da solicitação.

    • poc_payload: a solicitação.

    • request: o exemplo de solicitação.

    • response: o exemplo de resposta.

    • param: os parâmetros da solicitação.

    Nota

    Este valor é retornado apenas quando o parâmetro de solicitação ApiId é especificado.

    { "request": {"referer": "-","content_type": "-","cookie": "-","method": "GET","param": [],"host": "test.cn"}, "protocol": "https", "api_url": "https://test.cn:443/index.php", "param": [], "response": {"param": [], "sensitive_type": {}, "header": {},"body": "", "status": 405 }, "request_method": "GET", "poc_payload": "curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'", "param_num": 0 }
    FarthestTs

    integer

    A hora em que o ativo de API foi descoberto pela primeira vez. O valor é um carimbo de data/hora UNIX (UTC), em segundos.

    1683388800
    Follow

    integer

    Especifica se a API é seguida. Valores válidos:

    • 1: Seguida.

    • 0: Não seguida.

    1
    LastestTs

    integer

    A hora do acesso mais recente do ativo de API. O valor é um carimbo de data/hora UNIX (UTC), em segundos.

    1683388800
    MatchedHost

    string

    O nome de domínio ou endereço IP ao qual a operação da API pertence.

    a.aliyun.com
    Note

    string

    As observações.

    loginApi
    Resources

    array

    A lista de objetos protegidos associados ao ativo.

    string

    O objeto protegido associado ao ativo.

    ***.top-waf
    RequestId

    string

    O ID da solicitação.

    2EFCFE18-78F8-5079-B312-07***48B
    TotalCount

    integer

    O número total de entradas retornadas.

    5

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "Data": [
    {
      "AbnormalNum": 2,
      "AccountEventNum": 1,
      "AllCnt": 1683388800,
      "ApiFormat": "/v1/etl/finddatabyvid",
      "ApiId": "197b52abcd81d6a8bd4***e477",
      "ApiInfo": "{\n    \"request\": {\"referer\": \"-\",\"content_type\": \"-\",\"cookie\": \"-\",\"method\": \"GET\",\"param\": [],\"host\": \"test.cn\"},\n    \"protocol\": \"https\",\n    \"api_url\": \"https://test.cn:443/index.php\",\n    \"param\": [],\n    \"response\": {\"param\": [], \"sensitive_type\": {}, \"header\": {},\"body\": \"\", \"status\": 405 },\n    \"request_method\": \"GET\",\n    \"poc_payload\": \"curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'\",\n    \"param_num\": 0\n}",
      "ApiMethod": "POST",
      "ApiSensitive": "{\n    \"sensitive_list\": [\"1003\",\"1005\"],\n    \"sensitive_level\": \"L2\",\n    \"request_sensitive_list\": [\"1003\"],\n    \"response_sensitive_list\": [\"1005\"]\n}",
      "ApiSensitiveRequest": "[\"1002\",\"1005\"]",
      "ApiSensitiveResponse": "[\"1002\",\"1005\"]",
      "ApiStatus": "NewbornInterface",
      "ApiTag": "SendMail",
      "ApiType": "PublicAPI",
      "AuthFlag": "1",
      "BotCnt": 2,
      "CrossBorderCnt": 2,
      "EventNum": 2,
      "Examples": [
        "{\n    \"request\": {\"referer\": \"-\",\"content_type\": \"-\",\"cookie\": \"-\",\"method\": \"GET\",\"param\": [],\"host\": \"test.cn\"},\n    \"protocol\": \"https\",\n    \"api_url\": \"https://test.cn:443/index.php\",\n    \"param\": [],\n    \"response\": {\"param\": [], \"sensitive_type\": {}, \"header\": {},\"body\": \"\", \"status\": 405 },\n    \"request_method\": \"GET\",\n    \"poc_payload\": \"curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'\",\n    \"param_num\": 0\n}"
      ],
      "FarthestTs": 1683388800,
      "Follow": 1,
      "LastestTs": 1683388800,
      "MatchedHost": "a.aliyun.com",
      "Note": "loginApi",
      "Resources": [
        "***.top-waf"
      ]
    }
  ],
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "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.