Consulta todas as chaves de API e seus detalhes em um projeto especificado.
Descrição da operação
Descrição da solicitação\n- Você pode usar o parâmetro allowedStore para filtrar as chaves de API retornadas e retornar apenas as chaves de API com permissão de gravação em um Logstore ou Metricstore especificado.\n- Se você não especificar o parâmetro allowedStore, todas as chaves de API do projeto serão retornadas.\n- A permissão log:ListApiKeys é considerada sensível. Conceda-a com cautela.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
log:ListApiKeys |
list |
*Project
|
Nenhuma | Nenhuma |
Sintaxe da solicitação
GET /apikeys HTTP/1.1
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| allowedStore |
string |
Não |
O Logstore ao qual o acesso de gravação é permitido. |
test |
| size |
integer |
Não |
O tamanho da página. |
10 |
| offset |
integer |
Não |
O offset. |
1 |
| project |
string |
Não |
O nome do projeto. |
test |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Os dados da resposta. |
||
| apiKeys |
array<object> |
A lista de chaves de API. |
|
|
object |
As informações da chave de API. |
||
| apiKeyName |
string |
O nome da chave de API. |
demo-apikey-001 |
| apiKey |
string |
A chave de API em texto simples. |
|
| status |
string |
O status. |
Enabled |
| description |
string |
A descrição. |
test |
| allowedStores |
array |
A lista de Logstores aos quais o acesso de gravação é permitido. |
|
|
string |
O nome do Logstore. |
test |
|
| createTime |
integer |
A hora de criação. |
1788420000 |
| updateTime |
integer |
A hora de atualização. |
1788420000 |
| count |
integer |
O número de chaves de API na página atual. |
10 |
| total |
integer |
A contagem total. |
20 |
Exemplos
Resposta de sucesso
JSON formato
{
"apiKeys": [
{
"apiKeyName": "demo-apikey-001",
"apiKey": "",
"status": "Enabled",
"description": "test",
"allowedStores": [
"test"
],
"createTime": 1788420000,
"updateTime": 1788420000
}
],
"count": 10,
"total": 20
}
Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.