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)/ Consulta de informações de assinatura no marketplace/ Consulta da lista de grupos de API comprados

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

Ver PDF

Consulta da lista de grupos de API comprados

Função

Esta API é usada para consultar a lista de grupos de APIs comprados.

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/purchases/groups[?page_size, page_no, id, group_id, group_name]

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, group_id, group_name, 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 da subscrição
group_id	Não	String	ID do grupo da API
group_name	Não	String	Nome do grupo 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 total de grupos de API que correspondem às condições de consulta
size	Integer	Número de grupos de API retornados
purchases	Dicionário	Lista de grupos da API

**Tabela 4** Parâmetro descrição das compras
Parâmetro	Tipo	Descrição
id	String	ID da subscrição
group_id	String	ID do grupo da API
group_name	String	Nome do grupo da API
group_remark	String	Descrição do grupo da API
order_time	Timestamp	Hora em que a ordem é colocada
start_time	Timestamp	Hora em que a ordem entra em vigor
expire_time	Timestamp	Hora em que a ordem expira
group_domains	[]String	Lista de nomes de domínio do grupo de API. Nenhum valor será retornado quando você consultar a lista de grupos de API comprados.
quota_left	Integer	Cota de chamada de API restante
quota_used	Integer	Cota de chamada da API usada
app_key	String	AppKey gerados
app_secret	String	AppSecret gerado

Exemplo de resposta:

{
	"total": 3,
	"size": 3,
	"purchases": [{
		"id": "615af8d9-f31d-4cdf-8807-b191dc969a07",
		"group_id": "f0585333-5722-4878-b7fa-31ae00b6ae3a",
		"group_name": "api_group_003",
		"group_remark": "API group 003",
		"group_domains": null,
		"quota_used": 0,
		"quota_left": 2000000000,
		"order_time": "2017-12-29T06:22:46Z",
		"start_time": "2018-01-01T00:00:00Z",
		"expire_time": "2019-01-01T00:00:00Z",
		"app_key": "0e242685-661d-4254-a8bb-be9a92b04785",
		"app_secret": "******"
	},
	{
		"id": "9d0bdab1-a553-4bc9-be8c-a2e6c08e4d13",
		"group_id": "02a8ab3c-b278-4de5-a096-852829671ae7",
		"group_name": "api_group_002",
		"group_remark": "API group 002",
		"group_domains": null,
		"quota_used": 0,
		"quota_left": 2000000000,
		"order_time": "2017-12-29T06:22:46Z",
		"start_time": "2018-01-01T00:00:00Z",
		"expire_time": "2019-01-01T00:00:00Z",
		"app_key": "0e242685-661d-4254-a8bb-be9a92b04785",
		"app_secret": "******"
	},
	{
		"id": "3f30d49b-220f-4b11-9e94-c2fd3c1cc587",
		"group_id": "73c58022-f20d-495a-a188-85d718647f09",
		"group_name": "api_group_001",
		"group_remark": "API group 001",
		"group_domains": null,
		"quota_used": 0,
		"quota_left": 2000000000,
		"order_time": "2017-12-29T06:16:03Z",
		"start_time": "2018-01-01T00:00:00Z",
		"expire_time": "2019-01-01T00:00:00Z",
		"app_key": "0e242685-661d-4254-a8bb-be9a92b04785",
		"app_secret": "******"
	}]
}