Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ Data Encryption Workshop/ Referencia de la API/ APIs/ API de gestión de claves/ Consulta de APIs/ Consulta de la lista de CMK
Actualización más reciente 2022-11-03 GMT+08:00
Ver PDF
Compartir

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

Tabla 1 Parámetros de path

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado 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).
Tabla 3 Parámetros de body de solicitud

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.

  • Si la función de proyecto de empresa no está habilitada, no es necesario establecer este parámetro.
  • Si la función de proyecto de empresa está habilitada, puede establecer este parámetro al crear un recurso. Si no se especifica este parámetro, el recurso que cree se colocará en el proyecto de empresa predeterminado (cuyo ID de proyecto es 0).
  • Si no tiene permiso para crear recursos en el proyecto de empresa predeterminado, se informará de un error.

key_state

No

String

Estado de clave, que coincide con la expresión regular ^[1-5]{1}$. Puede ser:

  • 1: para ser activado
  • 2: habilitado
  • 3: Dishabilitado
  • 4: pendiente de eliminación
  • 5: importación pendiente

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".

  • AES_256
  • RSA_2048
  • RSA_3072
  • RSA_4096
  • EC_P256
  • EC_P384
  • 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

Tabla 4 Parámetros de body de respuesta

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:

  • true: Hay una página siguiente.
  • false: Esta es la última página.

total

Integer

Número total de claves.
Tabla 5 KeyDetails

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.

  • AES_256
  • RSA_2048
  • RSA_3072
  • RSA_4096
  • EC_P256
  • EC_P384

key_usage

String

Uso de CMK

  • ENCRYPT_DECRYPT
  • SIGN_VERIFY

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:

  • 1: para ser activado
  • 2: habilitado
  • 3: Dishabilitado
  • 4: pendiente de eliminación
  • 5: importación pendiente

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:

  • kms: El material clave fue generado por KMS.
  • external: Se importó el material clave.

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.

  • Para los usuarios que han habilitado la función de proyecto de empresa, este valor indica que los recursos están en el proyecto de empresa predeterminado.
  • Para los usuarios que no han habilitado la función de proyecto de empresa, este valor indica que los recursos no están en el proyecto de empresa predeterminado.

Código de estado: 400

Tabla 6 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error

Object

Mensaje de error.
Tabla 7 ErrorDetail

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Información de error.

Código de estado: 403

Tabla 8 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error

Object

Mensaje de error.
Tabla 9 ErrorDetail

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.

Tema principal: Consulta de APIs