Consulta da lista de CMKs
Função
Essa API permite consultar a lista de todas as CMKs.
URI
POST /v1.0/{project_id}/kms/list-keys
| Parâmetro | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
| project_id | Sim | String | ID do projeto. |
Parâmetros de solicitação
| Parâmetro | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
| X-Auth-Token | Sim | String | Token do usuário. O token pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho de resposta). |
| Parâmetro | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
| limit | Não | String | Número de registros retornados. Se o número de resultados recuperados for maior que esse valor, true será retornado para o parâmetro de resposta truncado, indicando que várias páginas de resultados foram recuperadas. O valor não pode exceder o número máximo de chaves. Exemplo: 100 |
| marker | Não | String | Posição inicial da consulta de paginação. Se truncado for verdadeiro na resposta, você poderá enviar solicitações consecutivas para obter mais registros. Defina marcador para o valor de next_marker na resposta. Exemplo: 10 |
| enterprise_project_id | Não | String | ID do projeto empresarial.
|
| key_state | Não | String | Estado da chave, que corresponde à expressão regular ^[1-5]{1}$. Pode ser:
|
| key_spec | Não | String | Tipo de algoritmo da CMK, o valor padrão é "AES_256". A consulta de todas as CMKs (incluindo assimétricas) precisa especificar "ALL".
|
| sequence | Não | String | Número de sequência de 36-byte de uma mensagem de solicitação. Exemplo: 919c82d4-8046-4722-9094-35c3c6524cff |
Parâmetros de resposta
Código de status: 200
| Parâmetro | Tipo | Descrição |
|---|---|---|
| keys | Array of strings | Lista de identificação da CMK. |
| key_details | Array of KeyDetails objects | Lista de detalhes principais. |
| next_marker | String | Valor do marcador utilizado para a obtenção da próxima página de resultados. Se truncado for falso, next_marker será deixado em branco. |
| truncated | String | Se há uma próxima página de resultados:
|
| total | Integer | Número total de chaves. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| key_id | String | ID de CMK. |
| domain_id | String | ID de domínio do usuário. |
| key_alias | String | Alias de chave. |
| realm | String | Realm da chave. |
| key_spec | String | Tipo de algoritmo da CMK.
|
| key_usage | String | Uso de CMK.
|
| key_description | String | Descrição da chave. |
| creation_date | String | Hora em que a chave foi criada. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970). |
| scheduled_deletion_date | String | Hora em que a chave foi agendada para ser excluída. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970). |
| key_state | String | Estado da chave, que corresponde à expressão regular ^[1-5]{1}$. Pode ser:
|
| default_key_flag | String | Identificador da chave principal. O valor é 1 para chaves principais padrão e 0 para chaves principais não padrão. |
| key_type | String | Tipo de chave. |
| expiration_time | String | Hora em que o material de chave expira. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970). |
| origin | String | Fonte de chave. Pode ser:
|
| key_rotation_enabled | String | Status de rotação da chave. O valor padrão é false, indicando que a rotação da chave está desativada. |
| sys_enterprise_project_id | String | ID do projeto empresarial. Seu valor padrão é 0.
|
Código de status: 400
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error | Object | Mensagem de erro. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Informação de erro. |
Código de status: 403
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error | Object | Mensagem de erro. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Informação de erro. |
Exemplo de solicitações
{
"limit" : "2",
"marker" : "1"
} Exemplo de respostas
Código de status: 200
Processamento da solicitação bem-sucedido.
{
"keys" : [ "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "2e258389-bb1e-4568-a1d5-e1f50adf70ea" ],
"key_details" : [ {
"key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
"domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd",
"key_alias" : "test",
"realm" : "cn-north-7",
"key_description" : "key_description",
"creation_date" : "1502799822000",
"scheduled_deletion_date" : "",
"key_spec" : "AES_256",
"key_usage" : "ENCRYPT_DECRYPT",
"key_state" : "2",
"default_key_flag" : "0",
"key_type" : "1",
"expiration_time" : "1501578672000",
"origin" : "kms",
"key_rotation_enabled" : "true",
"sys_enterprise_project_id" : "0",
"partition_type" : "1"
}, {
"key_id" : "2e258389-bb1e-4568-a1d5-e1f50adf70ea",
"domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd",
"key_alias" : "test",
"realm" : "realm",
"key_description" : "key_description",
"creation_date" : "1502799822000",
"scheduled_deletion_date" : "",
"key_spec" : "AES_256",
"key_usage" : "ENCRYPT_DECRYPT",
"key_state" : "2",
"default_key_flag" : "0",
"key_type" : "1",
"expiration_time" : "1501578672000",
"origin" : "kms",
"key_rotation_enabled" : "true",
"sys_enterprise_project_id" : "0",
"partition_type" : "1"
} ],
"next_marker" : "",
"truncated" : "false",
"total" : "2"
} Código de status: 400
Parâmetros de solicitação inválidos.
{
"error" : {
"error_code" : "KMS.XXX",
"error_msg" : "XXX"
}
} Código de status: 403
Autenticação falhou.
{
"error" : {
"error_code" : "KMS.XXX",
"error_msg" : "XXX"
}
} Códigos de status
| Código de status | Descrição |
|---|---|
| 200 | Processamento da solicitação bem-sucedido. |
| 400 | Parâmetros de solicitação inválidos. |
| 403 | Autenticação falhou. |
Códigos de erro
Consulte Códigos de erro.
