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/ Creación de un grupo de API

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

Ver PDF

Creación de un grupo de API

Función

Esta API se utiliza para crear un grupo de API. Un grupo de API es una unidad de gestión de API y la entrada a un servicio. Cuando se crea un grupo API, se devuelve un nombre de subdominio como entrada de acceso. Las API de un grupo de API deben estar correlacionadas entre sí.

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
POST	/v1.0/apigw/api-groups

Solicitud

**Tabla 2** Descripción de parámetro
Parámetro	Obligatorio	Tipo	Descripción
name	Sí	String	Nombre del grupo de API Un nombre de grupo de API consta de 3 a 64 caracteres, comenzando con una letra. Solo se permiten letras, dígitos y guiones bajos (_).
remark	No	String	Descripción del grupo de API La descripción no puede superar los 255 caracteres.

Ejemplo de solicitud:

{
	"name": "api_group_001",
	"remark": "API group 1"
}

Respuesta

**Tabla 3** Descripción de parámetro
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
is_default	Integer	Indica si el grupo de API es el grupo de API predeterminado. De forma predeterminada, el grupo de API no es el grupo de API predeterminado. El valor puede ser: 1: default API group 2: non-default API group

**Tabla 4** 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:

{
	"id": "7efb2b91-155a-4f6a-9f45-c5c95a6e4950",
	"name": "api_group_001",
	"status": 1,
	"sl_domain": "0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.com",
        "sl_domains": ["0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.com","0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.cn"],
	"remark": "API group 1",
	"register_time": "2017-12-28T11:44:53.831282304Z",
	"update_time": "2017-12-28T11:44:53.831283436Z",
	"on_sell_status": 2,
        "is_default": 2
}