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 compartilhadas de gateway (para usuários existentes)/ Gerenciamento de autorização de aplicações/ Consulta da lista de aplicações vinculadas a uma API

Atualizado em 2023-05-29 GMT+08:00

Ver PDF

Consulta da lista de aplicações vinculadas a uma API

Função

Esta API é usada para consultar a lista de aplicações vinculados a uma API especificada.

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/binded-apps[?page_size, page_no, api_id, app_name, app_id, env_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: api_id, app_name, app_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
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
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 aplicações que correspondem às condições de consulta
size	Integer	Comprimento da lista de aplicações retornada
auths	Dicionário	Lista de aplicações

**Tabela 4** Descrição do parâmetro de auths
Parâmetro	Tipo	Descrição
id	String	ID de autorização
api_id	String	ID da API
api_name	String	Nome da API
group_name	String	Grupo de APIs ao qual a API pertence
api_remark	String	Descrição da API
api_type	Integer	Tipo de API
envname	String	Ambiente no qual o acesso à API foi autorizado a uma aplicação
auth_role	String	Autorizador
auth_time	String	Tempo de autorização
appid	String	ID de aplicação
app_name	String	Nome de aplicação
app_creator	String	Criador de aplicações, que pode ser: USER: locatário MARKET: marketplace de API
publish_id	String	ID do registro de publicação
env_id	String	ID do ambiente
app_remark	String	Descrição de aplicação
app_type	String	Tipo de aplicação

Exemplo de resposta:

{
	"total": 1,
	"size": 1,
	"auths": [{
		"id": "cfa688d8-094b-445a-b270-6aeb0b70a84a",
		"api_id": "6632a062-9dcf-4f18-9646-3cabb925a290",
		"api_name": "API_list_query",
		"group_name": "api_group_001",
		"api_type": 1,
		"api_remark": "API list query",
		"envname": "RELEASE",
		"auth_role": "PROVIDER",
		"auth_time": "2017-12-28T12:46:43Z",
		"appid": "14b399ac-967f-4115-bb62-c0346b4537e9",
		"app_name": "app_001",
		"app_creator": "USER",
                "publish_id": "fe9d8ea9f9424594abc3bbe8d861c0f0",
                "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
                "app_remark": "",
                "app_type": "apig"
	}]
}