Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda> Data Encryption Workshop> Referência de API> APIs> APIs de gerenciamento de chaves> Gerenciamento do ciclo de vida> Alteração da descrição de uma CMK

Atualizado em 2023-02-28 GMT+08:00

Ver PDF

Alteração da descrição de uma CMK

Função

Essa API permite que você altere a descrição de uma CMK.

Restrições

Uma chave principal padrão (cujo sufixo de alias é /default) não permite alterações na descrição.
Uma CMK no status de exclusão agendada não permite alterações de descrição.

URI

POST /v1.0/{project_id}/kms/update-key-description

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatoriedade	Tipo	Descrição
project_id	Sim	String	ID do projeto.

Parâmetros de solicitação

**Tabela 2** Parâmetros de cabeçalho 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).

**Tabela 3** Parâmetros de corpo de solicitação
Parâmetro	Obrigatoriedade	Tipo	Descrição
key_id	Sim	String	ID de CMK. Deve ter 36 bytes e corresponder à expressão regular ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Exemplo: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
key_description	Sim	String	Descrição da chave. Pode conter de 0 a 255 caracteres.
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

**Tabela 4** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
key_info	KeyDescriptionInfo object	Descrição da chave.

**Tabela 5** KeyDescriptionInfo
Parâmetro	Tipo	Descrição
key_id	String	ID de CMK.
key_description	String	Descrição da chave.

Código de status: 400

**Tabela 6** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Object	Mensagem de erro.

**Tabela 7** ErrorDetail
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Informação de erro.

Código de status: 403

**Tabela 8** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Object	Mensagem de erro.

**Tabela 9** ErrorDetail
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Informação de erro.

Código de status: 404

**Tabela 10** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Object	Mensagem de erro.

**Tabela 11** ErrorDetail
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Informação de erro.

Exemplo de solicitações

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "key_description" : "test"
}

Exemplo de respostas

Código de status: 200

Processamento da solicitação bem-sucedido.

{
  "key_info" : {
    "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "key_description" : "test"
  }
}

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

O recurso solicitado não existe ou não foi encontrado.

{
  "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.
404	O recurso solicitado não existe ou não foi encontrado.