Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ API Gateway/ Referencia de la API/ Las API de gateway compartido (para usuarios existentes)/ Consulta de información de suscripción en KooGallery/ Consulta de la lista de grupos de API comprados

Actualización más reciente 2023-03-29 GMT+08:00

Ver PDF

Consulta de la lista de grupos de API comprados

Función

Esta API se utiliza para consultar la lista de grupos de API comprados.

URI

La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.

**Tabla 1** Método de solicitud de HTTP/HTTPS y URI
Método de solicitud	URI
GET	/v1.0/apigw/purchases/groups[?page_size, page_no, id, group_id, group_name]

Se puede agregar una combinación de diferentes condiciones de consulta al final del URI utilizando signos de interrogación (?) y ampersands (&).
Las condiciones de consulta incluyen id, group_id, group_name, page_size y page_no.

En la siguiente tabla se enumeran los parámetros del URI.

**Tabla 2** Descripción de parámetro
Parámetro	Obligatorio	Tipo	Descripción
id	No	String	ID de suscripción
group_id	No	String	ID de grupo de API
group_name	No	String	Nombre del grupo de API
page_size	No	Integer	Número de registros mostrados en cada página. El valor predeterminado es 20.
page_no	No	Integer	Número de página. El valor predeterminado es 1.

Solicitud

N/A

Respuesta

**Tabla 3** Descripción de parámetro
Parámetro	Tipo	Descripción
total	Integer	Número total de grupos de API que coinciden con las condiciones de consulta
size	Integer	Número de grupos de API devueltos
purchases	Dictionary	Lista de grupos de API

**Tabla 4** Descripción del parámetro de las compras
Parámetro	Tipo	Descripción
id	String	ID de suscripción
group_id	String	ID de grupo de API
group_name	String	Nombre del grupo de API
group_remark	String	Descripción del grupo de API
order_time	Timestamp	Hora en que se realiza el pedido
start_time	Timestamp	Hora en que el pedido entra en vigor
expire_time	Timestamp	Hora en que expira el pedido
group_domains	[]String	Lista de nombres de dominio de grupo de API. No se devolverá ningún valor al consultar la lista de grupos de API comprados.
quota_left	Integer	Cuota de invocación de API restante
quota_used	Integer	Cuota de invocación de API usada
app_key	String	Generated AppKey
app_secret	String	Generated AppSecret

Ejemplo de respuesta:

{
	"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": "******"
	}]
}