Consulta da lista de chaves de assinatura
Função
Esta API é usada para consultar as informações sobre todas as chaves de assinatura.
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/signs[?page_size, page_no, id, name] |
- Uma combinação de diferentes condições de consulta pode ser adicionada no final do URI usando pontos de interrogação (?) e E comercial (&).
- As condições de consulta incluem: id e name.
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Não |
String |
ID da chave de assinatura |
name |
Não |
String |
Nome da chave de assinatura |
precise_search |
Não |
String |
Nome do parâmetro (name) para correspondência exata |
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
total |
Integer |
Número de chaves de assinatura que correspondem às condições de consulta |
size |
Integer |
Comprimento da lista de chaves de assinatura devolvida |
signs |
Dicionário |
Lista de chaves de assinatura |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID da chave de assinatura |
name |
String |
Nome da chave de assinatura |
sign_key |
String |
Chave de assinatura |
sign_secret |
String |
Segredo de assinatura |
create_time |
Timestamp |
Hora em que a chave de assinatura é criada |
update_time |
Timestamp |
Hora em que a chave de assinatura foi atualizada pela última vez |
bind_num |
Integer |
Número de APIs às quais a chave de assinatura foi vinculada |
Exemplo de resposta:
{ "total": 2, "size": 2, "signs": [{ "name": "signature01", "sign_key": "abcd_1234", "sign_secret": "******", "id": "3a793b65a9034bdfae08924f149bfb4a", "create_time": "2018-02-06T12:17:36Z", "update_time": "2018-02-07T02:00:27.964766Z", "bind_num":1 }, { "name": "sada", "sign_key": "asdasdasdasda", "sign_secret": "******", "id": "51ce490901f4411fa54eb06d33bd7218", "create_time": "2018-02-06T11:53:08Z", "update_time": "2018-02-06T11:53:08Z", "bind_num":1 }] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
400 |
Solicitação inválida |
401 |
Não autorizado |
500 |
Erro do servidor interno |