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 aplicações/ Consulta de uma lista de aplicações

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

Ver PDF

Consulta de uma lista de aplicações

Função

Esta API é usada para consultar uma lista de aplicações que correspondem às condições especificadas.

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/apps[?page_size, page_no, id, name, app_key, creator]

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: id, name, app_key, creator, 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
id	Não	String	ID de aplicação
name	Não	String	Nome de aplicação
status	Não	Integer	Status de aplicação
app_key	Não	String	AppKey
creator	Não	String	Criador de aplicações, que pode ser: USER: a aplicação é criada pelo usuário da API. MARKET: a aplicação é alocada pelo marketplace.
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.
precise_search	Não	String	Nome do parâmetro (name) para correspondência exata

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
apps	Dicionário	Lista de aplicações

**Tabela 4** Descrição do parâmetro de aplicações
Parâmetro	Tipo	Descrição
id	String	ID de aplicação
name	String	Nome de aplicação
status	Integer	Status de aplicação
app_key	String	AppKey
app_secret	String	AppSecret
register_time	Timestamp	Hora em que a aplicação é registrada
remark	String	Descrição da aplicação
update_time	Timestamp	Hora em que a aplicação foi atualizada pela última vez
creator	String	Criador de aplicações, que pode ser: USER: a aplicação é criada pelo usuário da API. MARKET: a aplicação é alocada pelo marketplace.
app_type	String	Tipo de aplicação. O valor padrão é apig.
bind_num	Integer	Número de APIs às quais a aplicação foi vinculada

Exemplo de resposta:

{
	"total": 2,
	"size": 2,
	"apps": [{
		"id": "98efd77d-10b5-4eca-8170-ed30a4a286a4",
		"name": "app_002",
		"status": 1,
		"app_key": "f627fbaa-2c8b-4f58-a690-f478f54d3fe2",
		"app_secret": "******",
		"remark": "Second app",
		"register_time": "2017-12-28T12:32:50Z",
		"update_time": "2017-12-28T12:32:50Z",
		"creator": "MARKET",
                "app_type": "apig",
                "bind_num": 2
	},
	{
		"id": "14b399ac-967f-4115-bb62-c0346b4537e9",
		"name": "app_001",
		"status": 1,
		"app_key": "d49b1cbf-cc81-4a5f-b2a0-61b568e376eb",
		"app_secret": "******",
		"remark": "First app",
		"register_time": "2017-12-28T12:26:54Z",
		"update_time": "2017-12-28T12:29:35.571Z",
		"creator": "USER",
                "app_type": "apig",
                "bind_num": 2
	}]
}