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)/ Gestión de grupo de API/ Consulta de la lista de grupos de API

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

Ver PDF

Consulta de la lista de grupos de API

Función

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

Si la operación es realizada por un inquilino, se consultan todos los grupos del inquilino. Si la operación es realizada por un administrador del inquilino, se consultan los grupos de todos los inquilinos.

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/api-groups[?page_size, page_no, id, name]

Se puede agregar una combinación de diferentes condiciones de consulta al final del URI utilizando signos de interrogación (?) y ampersands (&).
Entre las condiciones de consulta se incluyen id, 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 grupo de API
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. Valor máximo 500
page_no	No	Integer	Número de página. El valor predeterminado es 1.
precise_search	No	String	Nombre del parámetro para la coincidencia exacta

Solicitud

N/A

Respuesta

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

**Tabla 4** Descripción del parámetro del grupo de API
Parámetro	Tipo	Descripción
id	String	ID de grupo de API
name	String	Nombre del grupo de API
status	Integer	Estado del grupo de API
sl_domain	String	Nombre de subdominio que APIG asigna automáticamente al grupo de API
sl_domains	Array of strings	Lista de nombres de subdominio que APIG asigna automáticamente al grupo de API
register_time	Timestamp	Hora en que se crea el grupo de API
update_time	Timestamp	Hora en la que se modificó por última vez el grupo de API
remark	String	Descripción del grupo de API
on_sell_status	Integer	Indica si el grupo de API aparece en la lista KooGallery. El valor puede ser: 1: listed 2: not listed 3: under approval
call_limits	Integer	Número total de veces que se puede acceder a todas las API del grupo de API. Establezca este parámetro considerando la capacidad de carga útil del servicio de backend. De forma predeterminada, no hay límite en el número de invocaciones a la API.
time_interval	Integer	Período de tiempo para limitar el número de invocaciones a la API
time_unit	String	Unidad de tiempo para limitar el número de invocaciones de API
url_domains	Array of UrlDomainsResp objects	Lista de nombres de dominio independientes enlazados al grupo de API

**Tabla 5** UrlDomainsResp
Parámetro	Tipo	Descripción
id	String	ID de dominio
domain	String	Nombre de dominio
cname_status	Integer	Estado de resolución de CNAME del nombre de dominio, que puede ser: 1: not resolved 2: resolving 3: resolved 4: resolution failed
ssl_id	String	ID de certificado de SSL
ssl_name	String	Nombre del certificado de SSL

Ejemplo de respuesta:

{
	"total": 2,
	"size": 2,
	"groups": [{
		"id": "02a8ab3c-b278-4de5-a096-852829671ae7",
		"name": "api_group_002",
		"status": 1,
		"sl_domain": "19e62eca-43d9-4ce2-a478-b3f48e67fb91.apigw.example.com",
                "sl_domains": ["19e62eca-43d9-4ce2-a478-b3f48e67fb91.apigw.example.com","19e62eca-43d9-4ce2-a478-b3f48e67fb91.apigw.example.cn"],
		"remark": "API group 002",
		"register_time": "2017-12-28T11:57:35Z",
		"update_time": "2017-12-28T11:57:35Z",
		"on_sell_status": 2
	},
	{
		"id": "73c58022-f20d-495a-a188-85d718647f09",
		"name": "api_group_001",
		"status": 1,
		"sl_domain": "c4c230d1-a8f2-4816-b9df-09ac5989180c.apigw.example.com",
                "sl_domains": ["c4c230d1-a8f2-4816-b9df-09ac5989180c.apigw.example.com","c4c230d1-a8f2-4816-b9df-09ac5989180c.apigw.example.cn"],
		"remark": "API group 001",
		"register_time": "2017-12-28T11:57:27Z",
		"update_time": "2017-12-28T11:57:27Z",
		"on_sell_status": 2
	}]
}