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
POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento. |
|
instance_id |
Sí |
String |
Gateway ID, que se puede obtener de la información de gateway en la consola APIG. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
name |
Sí |
String |
Nombre del grupo API. El valor puede contener de 3 a 255 caracteres, incluidas letras, dígitos y caracteres especiales (-_./():). Debe comenzar con una letra o un dígito. Mínimo: 3 Máximo: 255 |
|
remark |
No |
String |
Descripción del grupo API. Máximo: 1000 |
|
roma_app_id |
No |
String |
ID de la aplicación de integración a la que pertenece el grupo API. Este parámetro es necesario cuando la versión de grupo es V2. Actualmente, este parámetro no es compatible. |
|
version |
No |
String |
Versión de grupo.
El valor predeterminado es V1. Este parámetro no se admite actualmente. |
Parámetros de respuesta
Código de estado: 201
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
ID. |
|
name |
String |
Nombre del grupo API. |
|
status |
Integer |
Estado.
Valores de enumeración:
|
|
sl_domain |
String |
Nombre de subdominio que APIG asigna automáticamente al grupo de API. |
|
register_time |
String |
Hora de creación. |
|
update_time |
String |
Hora de la última modificación. |
|
on_sell_status |
Integer |
Indica si el grupo de API aparece en la lista KooGallery.
|
|
url_domains |
Array of UrlDomain objects |
Nombres de dominio independientes enlazados al grupo API. |
|
sl_domains |
Array of strings |
Nombres de subdominio asignados automáticamente. |
|
remark |
String |
Descripción. |
|
call_limits |
Integer |
Número total de veces que se puede acceder a todas las API del grupo de API. Tenga en cuenta la capacidad de carga útil del servicio de backend al establecer este parámetro. De forma predeterminada, no hay límite en el número de llamadas a la API. Actualmente, este parámetro no es compatible. |
|
time_interval |
Integer |
Período de tiempo para limitar el número de llamadas a la API. Actualmente, este parámetro no es compatible. |
|
time_unit |
String |
Unidad de tiempo para limitar el número de llamadas API. Actualmente, este parámetro no es compatible. |
|
is_default |
Integer |
Indica si el grupo API es el grupo predeterminado. |
|
version |
String |
Versión de grupo.
El valor predeterminado es V1. Este parámetro no se admite actualmente. |
|
roma_app_id |
String |
ID de la aplicación de integración a la que pertenece el grupo API. Este parámetro es necesario cuando la versión de grupo es V2. Actualmente, este parámetro no es compatible. |
|
roma_app_name |
String |
Nombre de la aplicación de integración a la que pertenece el grupo API. Actualmente, este parámetro no es compatible. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
ID de dominio. |
|
domain |
String |
Nombre de dominio. |
|
cname_status |
Integer |
Estado de resolución CNAME del nombre de dominio.
|
|
ssl_id |
String |
ID de certificado SSL. |
|
ssl_name |
String |
Nombre del certificado SSL. |
|
min_ssl_version |
String |
Versión mínima de SSL. Se admiten TLS 1.1 y TLS 1.2. Predeterminado: TLSv1.1 Valores de enumeración:
|
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Solicitudes de ejemplo
{
"name" : "api_group_001",
"remark" : "API group 1"
}
Ejemplo de respuestas
Código de estado: 201
Created
{
"update_time" : "2020-07-31T06:55:55.383169299Z",
"name" : "api_group_001",
"on_sell_status" : 2,
"remark" : "API group 1",
"sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
"sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
"id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"register_time" : "2020-07-31T06:55:55.383169068Z",
"status" : 1,
"is_default" : 2
}
Código de estado: 400
Bad Request
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}
Código de estado: 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.
