Consulta de la lista de CMK
Función
Esta API le permite consultar la lista de todos los CMK.
URI
POST /v1.0/{project_id}/kms/list-keys
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. El token se puede obtener llamando a la API de IAM (valor de X-Subject-Token en el encabezado de respuesta). |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
limit |
No |
String |
Número de registros devueltos. Si el número de resultados recuperados es mayor que este valor, se devuelve true para el parámetro de respuesta truncado, lo que indica que se recuperan varias páginas de resultados. El valor no puede exceder el número máximo de claves. Ejemplo: 100 |
|
marker |
No |
String |
Posición de inicio de la consulta de paginación. Si truncado es verdadero en la respuesta, puede enviar solicitudes consecutivas para obtener más registros. Establezca el marcador en el valor de next_marker en la respuesta. Ejemplo: 10 |
|
enterprise_project_id |
No |
String |
ID del proyecto de empresa.
|
|
key_state |
No |
String |
Estado de clave, que coincide con la expresión regular ^[1-5]{1}$. Puede ser:
|
|
key_spec |
No |
String |
Tipo de algoritmo CMK, el valor predeterminado es "AES_256". Consultar todas las CMK (incluidas las asimétricas) debe especificar "ALL".
|
|
sequence |
No |
String |
Número de secuencia de 36 bytes de un mensaje de solicitud. Ejemplo: 919c82d4-8046-4722-9094-35c3c6524cff |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
keys |
Array of strings |
Lista de ID de CMK. |
|
key_details |
Array of KeyDetails objects |
Lista de detalles de clave. |
|
next_marker |
String |
Valor del marcador utilizado para obtener la siguiente página de resultados. Si truncado es false, next_marker se deja en blanco. |
|
truncated |
String |
Si hay una página siguiente de resultados:
|
|
total |
Integer |
Número total de claves. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
key_id |
String |
CMK ID. |
|
domain_id |
String |
ID de dominio de usuario. |
|
key_alias |
String |
Alias de clave. |
|
realm |
String |
Realm de clave. |
|
key_spec |
String |
Tipo de algoritmo CMK.
|
|
key_usage |
String |
Uso de CMK
|
|
key_description |
String |
Descripción de clave. |
|
creation_date |
String |
Hora en la que se creó la clave. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). |
|
scheduled_deletion_date |
String |
Hora en la que se programó que se eliminara la clave. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). |
|
key_state |
String |
Estado de clave, que coincide con la expresión regular ^[1-5]{1}$. Puede ser:
|
|
default_key_flag |
String |
Identificador de clave maestra. El valor es 1 para las claves maestras predeterminadas y 0 para las claves maestras no predeterminadas. |
|
key_type |
String |
Tipo de clave. |
|
expiration_time |
String |
Hora en que caduca el material clave. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). |
|
origin |
String |
Fuente de clave. Puede ser:
|
|
key_rotation_enabled |
String |
Estado de rotación de clave. El valor predeterminado es false, lo que indica que la rotación de clave está deshabilitada. |
|
sys_enterprise_project_id |
String |
ID del proyecto de empresa. Su valor predeterminado es 0.
|
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error |
Object |
Mensaje de error. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Información de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error |
Object |
Mensaje de error. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Información de error. |
Solicitudes de ejemplo
{
"limit" : "2",
"marker" : "1"
}Ejemplo de respuestas
Código de estado: 200
El procesamiento de la solicitud se ha realizado correctamente.
{
"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 estado: 400
Parámetros de solicitud no válidos.
{
"error" : {
"error_code" : "KMS.XXX",
"error_msg" : "XXX"
}
}Código de estado: 403
Error de autenticación.
{
"error" : {
"error_code" : "KMS.XXX",
"error_msg" : "XXX"
}
}Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
El procesamiento de la solicitud se ha realizado correctamente. |
|
400 |
Parámetros de solicitud no válidos. |
|
403 |
Error de autenticación. |
Códigos de error
Consulte Códigos de error.
