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 segredo/ Gerenciamento do ciclo de vida/ Atualização de um segredo

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

Ver PDF

Atualização de um segredo

Função

Essa API é usada para atualizar os metadados de um segredo especificado.

Restrições

Essa API pode ser usada para modificar apenas os metadados de segredo, não o valor de segredo.

URI

PUT /v1/{project_id}/secrets/{secret_name}

**Tabela 1** Parâmetros de URI
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	String	ID do projeto
secret_name	Sim	String	Nome de segredo

Parâmetro de solicitação

**Tabela 2** Parâmetro de cabeçalho de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
X-Auth-Token	Sim	String	Token do usuário. Ele pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho da resposta).

**Tabela 3** Parâmetros de corpo de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
kms_key_id	Não	String	ID da CMK do KMS usado para criptografar valores do segredo. A CMK de um segredo pode ser atualizado. As versões de segredos após a atualização usam a nova CMK para criptografia. As versões de segredos antes da atualização usam a CMK anterior para descriptografia.
description	Não	String	Descrição de um segredo Restrições: o valor contém 2048 bytes.

Parâmetros de resposta

Código de status: 200

**Tabela 4** Parâmetro do corpo da resposta
Parâmetro	Tipo	Descrição
secret	Secret object	Segredo

**Tabela 5** Parâmetros de segredo
Parâmetro	Tipo	Descrição
id	String	ID do segredo
name	String	Nome de segredo
state	String	Status de segredo. Seu valor pode ser: ENABLED DISABLED PENDING_DELETE FROZEN
kms_key_id	String	ID da CMK do KMS usado para criptografar valores do segredo
description	String	Descrição de um segredo
create_time	Long	Tempo de criação do segredo. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970).
update_time	Long	Hora em que um segredo foi atualizado pela última vez. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970).
scheduled_delete_time	Long	Hora em que um segredo será excluído conforme programado. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970). Se um segredo não estiver no estado Pending deletion, o valor deste parâmetro é null.

Código de status: 400

**Tabela 6** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro
error_msg	String	Descrição do erro

Exemplo de solicitação

{
  "name" : "test",
  "description" : "update description"
}

Exemplo de resposta

Código de status: 200

O pedido foi bem-sucedido.

{
  "secret" : {
    "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "name" : "test",
    "state" : "ENABLED",
    "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
    "description" : "description",
    "create_time" : 1581507580000,
    "update_time" : 1581507580000,
    "scheduled_delete_time" : 1581507580000
  }
}