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

Consulta os metadados de um segredo.

Descrição da operação

Esta operação retorna os metadados de um segredo. Esta operação não retorna o valor do segredo.

Neste exemplo, os metadados do segredo chamado secret001 são consultados.

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
SecretName	string	Sim	O nome do segredo.	secret001
FetchTags	string	Não	Especifica se as tags de recurso do segredo devem ser retornadas. Valores válidos: true: As tags de recurso são retornadas. false: As tags de recurso não são retornadas. Este é o valor padrão.	true

Para obter mais informações sobre os parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
UpdateTime	string	A hora em que o segredo foi atualizado.	2022-02-21T15:39:26Z
CreateTime	string	A hora em que o segredo foi criado.	2022-02-21T15:39:26Z
NextRotationDate	string	A hora em que a próxima rotação será realizada. Nota Este parâmetro é retornado quando a rotação automática está ativada.	2022-07-06T18:22:03Z
EncryptionKeyId	string	O ID da chave mestra do cliente (CMK) que é usada para criptografar o valor do segredo.	00aa68af-2c02-4f68-95fe-3435d330****
RotationInterval	string	O intervalo para rotação automática. O valor está no formato integer[unit]. integer indica a duração do tempo. unit: indica a unidade de tempo. O valor de unit é fixo como s. Por exemplo, se o valor for 604800s, a rotação automática será realizada em um intervalo de 7 dias. Nota Este parâmetro é retornado quando a rotação automática está ativada.	3153600s
Arn	string	O Alibaba Cloud Resource Name (ARN) do segredo.	acs:kms:cn-hangzhou:154035569884****:secret/secret001
ExtendedConfig	string	A configuração estendida do segredo. Nota Este parâmetro é retornado apenas para um segredo gerenciado do ApsaraDB RDS, um segredo gerenciado do Resource Access Management (RAM) ou um segredo gerenciado do Elastic Compute Service (ECS).	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	A hora em que a última rotação foi realizada. Nota Este parâmetro é retornado se o segredo foi rotacionado.	2022-07-05T08:22:03Z
RequestId	string	O ID da solicitação, que é usado para localizar e solucionar problemas.	93348dfb-3627-4417-8d90-487a76a909c9
Description	string	A descrição do segredo.	userinfo
SecretName	string	O nome do segredo.	secret001
AutomaticRotation	string	Indica se a rotação automática está ativada. Valores válidos: Enabled: indica que a rotação automática está ativada. Disabled: indica que a rotação automática está desativada. Invalid: indica que o status da rotação automática está anormal. Nesse caso, o Secrets Manager não pode rotacionar o segredo automaticamente. Nota Este parâmetro é retornado apenas para um segredo gerenciado do ApsaraDB RDS, um segredo gerenciado do RAM ou um segredo gerenciado do ECS.	Enabled
SecretType	string	O tipo do segredo. Valores válidos: Generic: indica um segredo genérico. Rds: indica um segredo gerenciado do ApsaraDB RDS. RAMCredentials: indica um segredo gerenciado do RAM. ECS: indica um segredo gerenciado do ECS.	Rds
PlannedDeleteTime	string	A hora em que o segredo está programado para ser excluído.	2022-03-21T15:45:12Z
DKMSInstanceId	string	O ID da instância dedicada do KMS.	kst-bjj62d8f5e0sgtx8h****
Tags	object
Tag	array<object>	As tags de recurso do segredo. Este parâmetro não é retornado se você definir o parâmetro FetchTags como false ou não especificar o parâmetro FetchTags.
	object
TagValue	string	The tag value.	val1
TagKey	string	The tag key.	key1

Exemplos

Resposta de sucesso

JSON formato

{
  "UpdateTime": "2022-02-21T15:39:26Z",
  "CreateTime": "2022-02-21T15:39:26Z",
  "NextRotationDate": "2022-07-06T18:22:03Z",
  "EncryptionKeyId": "00aa68af-2c02-4f68-95fe-3435d330****",
  "RotationInterval": "3153600s",
  "Arn": "acs:kms:cn-hangzhou:154035569884****:secret/secret001",
  "ExtendedConfig": "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\",  \\\"CustomData\\\":{} }",
  "LastRotationDate": "2022-07-05T08:22:03Z",
  "RequestId": "93348dfb-3627-4417-8d90-487a76a909c9",
  "Description": "userinfo",
  "SecretName": "secret001",
  "AutomaticRotation": "Enabled",
  "SecretType": "Rds",
  "PlannedDeleteTime": "2022-03-21T15:45:12Z",
  "DKMSInstanceId": "kst-bjj62d8f5e0sgtx8h****",
  "Tags": {
    "Tag": [
      {
        "TagValue": "val1",
        "TagKey": "key1"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalTimestamp	The input parameter Timestamp that is mandatory for processing this request is not supplied.	The input parameter timestamp indicates that the request is outside the processing time range.
400	InvalidParameter	The specified parameter is not valid.	An invalid value is specified for the parameter.
403	Forbidden.NoPermission	You are not authorized to perform the operation.	You are not authorized to perform the operation.
404	Forbidden.ResourceNotFound	Resource not found
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.