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.
Actualización más reciente 2023-03-29 GMT+08:00

Consulta de la lista de APIs compradas

Función

Esta API se utiliza para consultar la lista de APIs compradas.

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/apis[?page_size, page_no, api_id, api_name, 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: api_id, api_name, 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

api_id

No

String

ID de API

api_name

No

String

Nombre de la API

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 API que coinciden con las condiciones de consulta

size

Integer

Número de las API devueltas

apis

Dictionary

Lista de API

Tabla 4 Descripción del parámetro de apis

Parámetro

Tipo

Descripción

id

String

ID de API

name

String

Nombre de la API

purchase_id

String

ID de suscripción

remark

String

Descripción de la API

req_uri

String

Dirección de acceso

Ejemplo de respuesta:

{
	"total": 3,
	"size": 3,
	"apis": [{
		"id": "cb498965-8acf-4c98-bd08-4033ef1fcfb4",
		"name": "Environment_list_query",
		"purchase_id": "730f8a84-c8db-45ba-a6a5-2669ceb08574",
		"remark": "Environment list query",
		"req_uri": "/envs"
	},
	{
		"id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9",
		"name": "API_group_list_query",
		"purchase_id": "2ae11f50-3938-4560-8b76-58e89bb3f825",
		"remark": "API group list query",
		"req_uri": "/groups"
	},
	{
		"id": "6632a062-9dcf-4f18-9646-3cabb925a290",
		"name": "API_list_query",
		"purchase_id": "2ae11f50-3938-4560-8b76-58e89bb3f825",
		"remark": "API list query",
		"req_uri": "/apis"
	}]
}

Códigos de estado

Tabla 5 Códigos de estado

Código de estado

Descripción

200

OK

400

Bad Request

401

Unauthorized

500

Server Internal Error