Consulta de detalles de un grupo de API
Función
Esta API se utiliza para consultar los detalles de un grupo de API.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
Método de solicitud |
URI |
---|---|
GET |
/v1.0/apigw/api-groups/{id} |
En la siguiente tabla se muestra el parámetro en el URI.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
Sí |
String |
ID de grupo de API |
Solicitud
N/A
Respuesta
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 |
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 |
on_sell_status |
Integer |
Indica si el grupo de API aparece en la lista KooGallery. El valor puede ser:
|
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:
|
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 001", "register_time": "2017-12-28T11:44:53Z", "update_time": "2017-12-28T11:49:01.048601Z", "call_limits": 1000, "time_interval": 1, "time_unit": "SECOND", "on_sell_status": 2 }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |