Consulta de detalhes de um grupo de APIs
Função
Esta API é usada para consultar os detalhes de um grupo de APIs.
URI
A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.
Método de solicitação |
URI |
---|---|
GET |
/v1.0/apigw/api-groups/{id} |
A tabela a seguir lista o parâmetro no URI.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Sim |
String |
ID do grupo da API |
Solicitação
N/D
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do grupo da API |
name |
String |
Nome do grupo da API |
status |
Integer |
Status do grupo da API |
sl_domain |
String |
Nome do subdomínio que o APIG aloca automaticamente para o grupo da API |
sl_domains |
Array of strings |
Lista de nomes de subdomínio que o APIG aloca automaticamente para o grupo da API |
register_time |
Timestamp |
Hora em que o grupo da API é criado |
update_time |
Timestamp |
Hora em que o grupo da API foi modificado pela última vez |
remark |
String |
Descrição do grupo da API |
call_limits |
Integer |
Número total de vezes que todas as APIs no grupo da API podem ser acessadas. Defina esse parâmetro ao considerar a capacidade de carga útil do serviço de back-end. Por padrão, não há limite no número de chamadas de API. |
time_interval |
Integer |
Período de tempo para limitar o número de chamadas de API |
time_unit |
String |
Unidade de tempo para limitar o número de chamadas de API |
url_domains |
Array of UrlDomainsResp objects |
Lista de nomes de domínio independentes vinculados ao grupo da API |
on_sell_status |
Integer |
Indica se o grupo de APIs foi listado no marketplace. O valor pode ser:
|
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do domínio |
domain |
String |
Nome de domínio |
cname_status |
Integer |
Status de resolução CNAME do nome de domínio, que pode ser:
|
ssl_id |
String |
ID do certificado SSL |
ssl_name |
String |
Nome do certificado SSL |
Exemplo de resposta:
{ "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 status
Código de status |
Descrição |
---|---|
200 |
OK |
400 |
Solicitação inválida |
401 |
Não autorizado |
403 |
Proibido |
404 |
Não encontrado |
500 |
Erro do servidor interno |