PutSecretValue - Key Management Service: Central de Documentação do Alibaba Cloud

Descrição da operação

Para obter informações sobre a política de acesso necessária para que um usuário RAM ou uma função RAM chame esta operação OpenAPI, consulte Resource Access Management.
Esta operação oferece suporte apenas a segredos genéricos. Cada segredo genérico pode ter no máximo 10 versões. Se o número de versões exceder o limite, o KMS exclui a versão mais antiga.
Por padrão, o novo valor do segredo é marcado com ACSCurrent, e a versão anterior que estava marcada com ACSCurrent é marcada com ACSPrevious. Você pode especificar o parâmetro VersionStage para substituir esse comportamento padrão.
Esta operação armazena uma nova versão de um valor de segredo. Você não pode usá-la para modificar uma versão existente de um valor de segredo. Você deve especificar um número de versão ao armazenar uma nova versão. O KMS processa solicitações com base nas seguintes regras:
- Se o número da versão não existir no segredo, o KMS cria uma nova versão e armazena o valor do segredo.
- Se o número da versão já existir no segredo, o KMS compara o valor do segredo na solicitação com o valor armazenado. Se os valores forem iguais, a solicitação é ignorada e uma mensagem de sucesso é retornada. Isso torna a operação idempotente. Se os valores forem diferentes, a solicitação é rejeitada.

Este tópico fornece um exemplo de como armazenar uma nova versão de um valor de segredo para o segredo chamado secret001. O novo número da versão (VersionId) é v3 e o valor do segredo (SecretData) é importantdata.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VersionId	string	Sim	O número da versão do segredo. O valor deve ser exclusivo no segredo.	v3
SecretName	string	Sim	O nome ou Alibaba Cloud Resource Name (ARN) do segredo. Nota Ao acessar um segredo em outra conta do Alibaba Cloud, você deve especificar o ARN do segredo. O ARN de um segredo está no formato `acs:kms:${region}:${account}:secret/${secret-name}`.	secret001
SecretData	string	Sim	O valor do segredo. O valor é criptografado e armazenado na nova versão especificada.	importantdata
SecretDataType	string	Não	O tipo do valor do segredo. Valores válidos: text (padrão) binary	text
VersionStages	string	Não	Os rótulos de estágio usados para marcar a nova versão. Se você não especificar este parâmetro, o KMS marca a nova versão com ACSCurrent.	["ACSCurrent","ACSNext"]

Para mais informações sobre parâmetros de solicitação comuns, consulte Common parameters.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
SecretName	string	O nome do segredo.	secret001
VersionId	string	O número da versão do segredo.	v3
RequestId	string	O ID da solicitação, que é um identificador exclusivo gerado pelo Alibaba Cloud. Você pode usar este ID para solucionar problemas.	f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8
VersionStages	object
VersionStage	array	Os rótulos de estágio da versão do segredo.
	string	O rótulo de estágio da versão do segredo.	{ "VersionStage": [ "ACSCurrent", "ACSNext" ] }

Exemplos

Resposta de sucesso

JSON formato

{
  "SecretName": "secret001",
  "VersionId": "v3",
  "RequestId": "f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8",
  "VersionStages": {
    "VersionStage": [
      "{ \"VersionStage\": [ \"ACSCurrent\", \"ACSNext\" ] }"
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidParameter	some of the specified parameters "\" is not valid
400	Rejected.LimitExceeded	exceed secret limits error
500	InternalFailure	Internal Failure
403	Forbidden.NoPermission	This operation is forbidden by permission system
404	Forbidden.ResourceNotFound	Resource not found
409	Rejected.ResourceExist	The request was rejected becasue key already exsit

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.