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 autorizaciones/ Consulta de concesiones que pueden retirarse

Actualización más reciente 2022-11-03 GMT+08:00

Ver PDF

Consulta de concesiones que pueden retirarse

Función

Esta API le permite consultar concesiones que se pueden retirar.

URI

POST /v1.0/{project_id}/kms/list-retirable-grants

**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 de concesiones que pueden retirarse. 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 concesiones. 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
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
grants	Array of Grants objects	Lista de concesión.
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.

**Tabla 5** Concesiones
Parámetro	Tipo	Descripción
key_id	String	CMK ID.
grant_id	String	ID de concesión, que contiene 64 bytes.
grantee_principal	String	ID del concesionario, que contiene de 1 a 64 bytes y coincide con la expresión regular ^[a-zA-Z0-9]{1, 64}$. Ejemplo: 0d0466b00d0466b00d0466b00d0466b0
grantee_principal_type	String	Tipo de concesión. Valores: user, domain.
operations	Array of strings	Lista de operaciones concedidas. Valores: create-datakey, create-datakey-without-plaintext, encrypt-datakey, decrypt-datakey, describe-key, create-grant, retire-grant, encrypt-data, decrypt-data. Un valor que contiene sólo create-grant no es válido.
issuing_principal	String	ID del otorgante, que contiene de 1 a 64 bytes y coincide con la expresión regular ^[a-zA-Z0-9]{1, 64}$. Ejemplo: 0d0466b00d0466b00d0466b00d0466b0
creation_date	String	Tiempo de creación. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). Ejemplo: 1497341531000
name	String	Nombre de concesión. El valor es una cadena de 1 a 255 caracteres y coincide con la expresión regular ^[a-zA-Z0-9:/_-]{1,255}$.
retiring_principal	String	ID del usuario que puede retirar una concesión. Contiene de 1 a 64 bytes y coincide con la expresión regular ^[a-zA-Z0-9]{1, 64}$. Ejemplo: 0d0466b00d0466b00d0466b00d0466b0

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.

Código de estado: 404

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

Solicitudes de ejemplo

{
  "limit" : "1000"
}

Ejemplo de respuestas

Código de estado: 200

El procesamiento de la solicitud se ha realizado correctamente.

{
  "grants" : [ {
    "operations" : [ "create-datakey", "describe-key" ],
    "issuing_principal" : "8b961fb414344d59825ba0c8c008c815",
    "key_id" : "737fd52b-36c4-4c91-972e-f6e202de9f6e",
    "grant_id" : "dd3f03e9229a5e47a41be6c27a630e60d5cbdbad2be89465d63109ad034db7d8",
    "grantee_principal" : "13gg44z4g2sglzk0egw0u726zoyzvrs8",
    "name" : "13gg44z4g2sglzk0egw0u726zoyzvrs8",
    "creation_date" : "1597062260000",
    "grantee_principal_type" : "user"
  } ],
  "next_marker" : "",
  "total" : 1,
  "truncated" : "false"
}

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ódigo de estado: 404

La página solicitada no existe o no se encuentra.

{
  "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.
404	La página solicitada no existe o no se encuentra.