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)/ Vinculação/desvinculação de políticas de limitação de solicitações/ Consulta de APIs não vinculadas com uma política de limitação de solicitações
Atualizado em 2023-05-29 GMT+08:00
Ver PDF
Compartilhar

Consulta de APIs não vinculadas com uma política de limitação de solicitações

Função

Esta API é usada para consultar as APIs autodesenvolvidas às quais uma política de limitação de solicitações não foi vinculada. Somente as APIs publicadas serão exibidas.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/unbinded-apis

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

throttle_id

Sim

String

ID da política de limitação de solicitação.

env_id

Não

String

ID do ambiente.

group_id

Não

String

ID do grupo da API.

api_id

Não

String

ID da API.

api_name

Não

String

Nome da API.

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.

apis

Array of ApiForThrottle objects

Lista de APIs.
Tabela 5 ApiForThrottle

Parâmetro

Tipo

Descrição

auth_type

String

Modo de autenticação da API.

group_name

String

Nome do grupo de APIs ao qual a API pertence.

publish_id

String

ID do registro de publicação da API.

throttle_apply_id

String

ID de um registro de vinculação de política de limitação de solicitação.

apply_time

String

Tempo de vinculação.

remark

String

Descrição da API.

run_env_id

String

ID do ambiente no qual a API foi publicada.

type

Integer

Tipo de API.

throttle_name

String

Nome da política de limitação de solicitações vinculada à API.

req_uri

String

Endereço de acesso da API.

run_env_name

String

Nome do ambiente no qual a API foi publicada.

group_id

String

ID do grupo de APIs ao qual a API pertence.

name

String

Nome da API.

id

String

ID da API.

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" : 2,
  "size" : 2,
  "apis" : [ {
    "run_env_name" : "RELEASE",
    "group_name" : "api_group_001",
    "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d",
    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "name" : "Api_mock",
    "remark" : "Mock backend API",
    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "id" : "3a955b791bd24b1c9cd94c745f8d1aad",
    "type" : 1,
    "auth_type" : "IAM",
    "req_uri" : "/test/mock"
  }, {
    "run_env_name" : "RELEASE",
    "group_name" : "APIGroup_d00511069",
    "publish_id" : "0c613568c8644a1b92172156f77a5759",
    "group_id" : "d7d0b9a54469424f942e16a6b6026936",
    "name" : "API_nevj",
    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "id" : "9e07bc00a1864ab4aafd4a23d19dd1c2",
    "type" : 1,
    "auth_type" : "APP",
    "req_uri" : "/fdasf"
  } ]
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:throttle_id. 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.3005",
  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist"
}

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.