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/ Gestión de etiquetas/ Consulta de instancias CMK
Actualización más reciente 2022-11-03 GMT+08:00
Ver PDF
Compartir

Consulta de instancias CMK

Función

Esta API le permite consultar instancias CMK. Puede utilizar la función de filtrado de etiquetas para consultar la información detallada sobre un CMK especificado.

URI

POST /v1.0/{project_id}/kms/resource_instances/action

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 en una consulta. Si la acción es contar, no es necesario establecer este parámetro. Si action es filter, el valor por defecto de este parámetro es 10. El valor de límite está en los intervalos de 1 a 1,000.

offset

No

String

Ubicación del índice. La consulta comienza desde el siguiente recurso de la ubicación especificada. Cuando se consultan datos de una página, el valor del cuerpo de la respuesta de la página anterior se transfiere a este parámetro. (Si la acción es contar, no es necesario establecer este parámetro.) Si el valor de acción es filter, el valor predeterminado es 0. El valor de offset debe ser un número y no puede ser negativo.

action

No

String

Tipo de operación. Puede ser:

  • filter: Registro de filtro.
  • Count: Cuenta el número total de registros.

tags

No

Array of Tag objects

Lista de etiquetas, que es una colección de pares clave-valor.

  • key: clave de etiqueta. Un CMK puede tener un máximo de 10 teclas, y cada una de ellas es única y no puede estar vacía. Una clave no puede tener valores duplicados. Consta de hasta 36 caracteres.
  • value: Valor de la etiqueta. Cada valor de etiqueta puede contener un máximo de 43 caracteres. Los valores están en la relación AND.

matches

No

Array of TagItem objects

Campo a ser coincidido.

  • key: El campo que se va a hacer coincidir, por ejemplo, resource_name.
  • value: El valor que se va a hacer coincidir. Contiene un máximo de 255 caracteres y no puede estar vacío.

sequence

No

String

Número de secuencia de 36 bytes de un mensaje de solicitud. Ejemplo: 919c82d4-8046-4722-9094-35c3c6524cff
Tabla 4 Tag

Parámetro

Obligatorio

Tipo

Descripción

key

No

String

Clave. Una clave de etiqueta contiene un máximo de 36 caracteres Unicode. No se puede dejar en blanco. No puede contener caracteres ASCII (0-31), asteriscos (*), corchetes angulares (< y >), barras invertidas (), y signos iguales (=).

values

No

Array of strings

Conjunto de valores de etiqueta.
Tabla 5 TagItem

Parámetro

Obligatorio

Tipo

Descripción

key

No

String

Clave. Una clave de etiqueta contiene un máximo de 36 caracteres Unicode. No se puede dejar en blanco. No puede contener caracteres ASCII (0-31), asteriscos (*), corchetes angulares (< y >), barras invertidas (), y signos iguales (=).

value

No

String

Valor. Un valor de etiqueta puede contener un máximo de 43 caracteres Unicode y puede ser una cadena vacía. No puede contener caracteres ASCII (0-31), asteriscos (*), corchetes angulares (< y >), barras invertidas (), y signos iguales (=).

Parámetros de respuesta

Código de estado: 200

Tabla 6 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

resources

Array of ActionResources objects

Lista de recursos.

total_count

Integer

Número total de registros.
Tabla 7 ActionResources

Parámetro

Tipo

Descripción

resource_id

String

ID del recurso.

resource_detail

KeyDetails object

Detalles de clave.

resource_name

String

Especifica el nombre del recurso. Este parámetro es una cadena vacía por defecto.

tags

Array of TagItem objects

Lista de etiquetas. Si no hay ninguna etiqueta en la lista, se devuelve un array vacío.
Tabla 8 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.
Tabla 9 TagItem

Parámetro

Tipo

Descripción

key

String

Clave. Una clave de etiqueta contiene un máximo de 36 caracteres Unicode. No se puede dejar en blanco. No puede contener caracteres ASCII (0-31), asteriscos (*), corchetes angulares (< y >), barras invertidas (), y signos iguales (=).

value

String

Valor. Un valor de etiqueta puede contener un máximo de 43 caracteres Unicode y puede ser una cadena vacía. No puede contener caracteres ASCII (0-31), asteriscos (*), corchetes angulares (< y >), barras invertidas (), y signos iguales (=).

Código de estado: 400

Tabla 10 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error

Object

Mensaje de error.
Tabla 11 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 12 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error

Object

Mensaje de error.
Tabla 13 ErrorDetail

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Información de error.

Solicitudes de ejemplo

{
  "offset" : "100",
  "limit" : "100",
  "action" : "filter",
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ],
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  } ]
}

Ejemplo de respuestas

Código de estado: 200

El procesamiento de la solicitud se ha realizado correctamente.

{
  "resources" : [ {
    "resource_id" : "90c03e67-5534-4ed0-acfa-89780e47a535",
    "resource_detail" : [ {
      "key_id" : "90c03e67-5534-4ed0-acfa-89780e47a535",
      "domain_id" : "4B688Fb77412Aee5570E7ecdbeB5afdc",
      "key_alias" : "tagTest_xmdmi",
      "key_description" : "123",
      "creation_date" : 1521449277000,
      "scheduled_deletion_date" : "",
      "key_state" : 2,
      "default_key_flag" : 0,
      "key_type" : 1,
      "key_rotation_enabled" : false,
      "expiration_time" : "",
      "origin" : "kms",
      "sys_enterprise_project_id" : "0",
      "realm" : "test"
    } ],
    "resource_name" : "tagTest_xmdmi",
    "tags" : [ {
      "key" : "key",
      "value" : "testValue!"
    }, {
      "key" : "haha",
      "value" : "testValue"
    } ]
  } ],
  "total_count" : 1
}

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: Gestión de etiquetas