Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda> API Gateway> Referência de API> APIs de gateway dedicadas (V2)> Gerenciamento de política de controle de acesso> Consulta de políticas de controle de acesso
Atualizado em 2023-05-29 GMT+08:00
Ver PDF

Consulta de políticas de controle de acesso

Função

Esta API é usada para consultar todas as políticas de controle de acesso.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/acls

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento.

instance_id

Sim

String

ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG.
Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

offset

Não

Long

Deslocamento a partir do qual a consulta é iniciada. Se o valor estiver menor que 0, ele é automaticamente convertido para 0.

Padrão: 0

limit

Não

Integer

Número de itens exibidos em cada página. Um valor menor ou igual a 0 será automaticamente convertido em 20, e um valor maior que 500 será automaticamente convertido em 500.

Mínimo: 1

Máximo: 500

Padrão: 20

id

Não

String

ID da política de controle de acesso.

name

Não

String

Nome da política de controle de acesso.

acl_type

Não

String

Tipo.

  • PERMIT (lista branca)

  • DENY (lista negra)

entity_type

Não

String

Tipos de objeto.

  • IP

  • DOMAIN

precise_search

Não

String

Nome do parâmetro (name) para correspondência exata.

Parâmetros de solicitação

Tabela 3 Parâmetros do cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token.

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

size

Integer

Comprimento da lista de recursos retornados.

total

Long

Número de recursos que atendem às condições de consulta.

acls

Array of ApiAclInfoWithBindNum objects

Lista de políticas de controle de acesso.
Tabela 5 ApiAclInfoWithBindNum

Parâmetro

Tipo

Descrição

acl_name

String

Nome da política de controle de acesso.

acl_type

String

Tipo.

  • PERMIT (lista branca)

  • DENY (lista negra)

acl_value

String

Objetos de controle de acesso.

bind_num

Integer

Quantidade de APIs.

entity_type

String

Tipo de objeto.

  • IP

  • DOMAIN

  • DOMAIN_ID

id

String

ID da política de controle de acesso.

update_time

String

Hora da atualização.

Código de status: 400

Tabela 6 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 401

Tabela 7 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 403

Tabela 8 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 404

Tabela 9 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 10 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Exemplo de solicitações

Nenhum

Exemplo de respostas

Código de status: 200

OK

{
  "total" : 1,
  "size" : 1,
  "acls" : [ {
    "bind_num" : 0,
    "id" : "7eb619ecf2a24943b099833cd24a01ba",
    "acl_name" : "acl_demo",
    "entity_type" : "IP",
    "acl_type" : "PERMIT",
    "acl_value" : "192.168.1.5,192.168.10.1",
    "update_time" : "2020-08-04T08:42:43Z"
  } ]
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Código de status: 401

Não autorizado

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de status: 403

Proibido

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de status: 404

Não encontrado

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}

Código de status: 500

Erro do servidor interno

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de status

Código de status

Descrição

200

OK

400

Solicitação inválida

401

Não autorizado

403

Proibido

404

Não encontrado

500

Erro do servidor interno

Códigos de erro

Consulte Códigos de erro.