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.
Atualizado em 2023-05-29 GMT+08:00

Consulta da lista de APIs que não estão vinculadas a uma aplicação

Função

Esta API é usada para consultar a lista de APIs autodesenvolvidas que não foram vinculadas a uma aplicação em um ambiente especificado.

URI

A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.

Tabela 1 Método de solicitação HTTP/HTTPS e URI

Método de solicitação

URI

GET

/v1.0/apigw/app-auths/unbinded-apis[?page_size, page_no, app_id, env_id, api_id, api_name, group_id]

  • Uma combinação de diferentes condições de consulta pode ser adicionada no final do URI usando pontos de interrogação (?) e E comercial (&).
  • As condições de consulta incluem: app_id, api_id, api_name, group_id, env_id, page_size e page_no.

A tabela a seguir lista os parâmetros no URI.

Tabela 2 Descrição do parâmetro

Parâmetro

Obrigatório

Tipo

Descrição

app_id

Sim

String

ID de aplicação

env_id

Sim

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

page_size

Não

Integer

Número de registros exibidos em cada página. O valor padrão é 20.

page_no

Não

Integer

Número da página. O valor padrão é 1.

Solicitação

N/D

Resposta

Tabela 3 Descrição do parâmetro

Parâmetro

Tipo

Descrição

total

Integer

Número de APIs que correspondem às condições de consulta

size

Integer

Comprimento da lista de API retornada

apis

Dicionário

Lista de APIs

Tabela 4 Descrição do parâmetro de apis

Parâmetro

Tipo

Descrição

id

String

ID da API

name

String

Nome da API

group_id

String

ID do grupo de APIs ao qual a API pertence

group_name

String

Nome do grupo de APIs ao qual a API pertence

remark

String

Descrição da API

run_env_name

String

Nome do ambiente no qual a API foi publicada

run_env_id

String

ID do ambiente no qual a API foi publicada

publish_id

String

ID do registro de publicação

auth_type

String

Modo de autenticação de segurança

req_uri

String

Endereço de acesso

Exemplo de resposta:

{
	"total": 1,
	"size": 1,
	"apis": [{
		"id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9",
		"name": "API_group_list_query",
		"remark": "API group list query",
		"group_id": "73c58022-f20d-495a-a188-85d718647f09",
		"group_name": "api_group_001",
		"run_env_name": "RELEASE",
		"run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
		"publish_id": "65e6fe53-1ac3-4481-ba36-9f0bc6f22057",
		"auth_type": "APP",
		"req_uri": "/test"
	}]
}

Códigos de status

Tabela 5 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