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 autorização de aplicações> Consulta de aplicações vinculadas a uma API
Atualizado em 2023-05-29 GMT+08:00
Ver PDF

Consulta de aplicações vinculadas a uma API

Função

Esta API é usada para consultar as aplicações que foram vinculadas a uma API especificada.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apps

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

api_id

Não

String

ID da API.

app_name

Não

String

Nome de aplicação.

app_id

Não

String

ID de aplicação.

env_id

Não

String

ID do ambiente.

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.

auths

Array of ApiAuthInfo objects

Lista de APIs.
Tabela 5 ApiAuthInfo

Parâmetro

Tipo

Descrição

id

String

ID do registro de autorização.

api_id

String

ID da API.

api_name

String

Nome da API.

group_name

String

Nome do grupo de APIs ao qual a API pertence.

api_type

Integer

Tipo de API.

api_remark

String

Descrição da API.

env_id

String

ID do ambiente no qual uma aplicação foi autorizada a chamar a API.

auth_role

String

Autorizador.

auth_time

String

Tempo de autorização.

app_name

String

Nome de aplicação.

app_remark

String

Descrição de aplicação.

app_type

String

Tipo de aplicação.

O valor padrão é apig. Outros tipos não são suportados atualmente.

Valores de enumeração:

  • apig

  • roma

app_creator

String

Criador da aplicação.

  • USER: a aplicação é criada por um locatário.

  • MARKET: a aplicação é alocada pelo KooGallery. Este valor não é suportado atualmente.

publish_id

String

ID do registro de publicação da API.

group_id

String

ID do grupo de APIs ao qual a API pertence.

auth_tunnel

String

Tipo de canal de autorização.

  • NORMAL: canal normal

  • GREEN: canal verde

O valor padrão é NORMAL. Este parâmetro não é suportado atualmente.

Valores de enumeração:

  • NORMAL

  • GREEN

auth_whitelist

Array of strings

Lista branca para o canal verde.

auth_blacklist

Array of strings

Lista negra para o canal verde.

visit_param

String

Parâmetros de acesso.

roma_app_type

String

Tipo de aplicação de ROMA.

  • subscrição: aplicação de subscrição

  • integração: aplicação de integração

Atualmente, este parâmetro não é suportado.

env_name

String

Nome do ambiente no qual a aplicação foi autorizada a chamar a API.

app_id

String

ID de aplicaçã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,
  "auths" : [ {
    "api_id" : "5f918d104dc84480a75166ba99efff21",
    "app_name" : "app_demo",
    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "env_name" : "RELEASE",
    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "group_name" : "api_group_001",
    "api_type" : 1,
    "api_name" : "Api_http",
    "app_id" : "356de8eb7a8742168586e5daf5339965",
    "auth_time" : "2020-08-04T04:02:22Z",
    "app_creator" : "USER",
    "id" : "dd29b33ae4394e3b924b582c6b40880b",
    "api_remark" : "Web backend API",
    "auth_role" : "PROVIDER",
    "app_type" : "apig",
    "auth_tunnel" : "NORMAL"
  } ]
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:app_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.3002",
  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 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.