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

Esta operação retorna os metadados de um segredo, mas não o valor correspondente.

Neste exemplo, consulta-se os metadados do segredo chamado secret001.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeSecret	Operação a executar. Defina o valor como DescribeSecret.
SecretName	String	Sim	secret001	Nome ou Alibaba Cloud Resource Name (ARN) do segredo. Nota Ao acessar um segredo em outra conta Alibaba Cloud, insira o ARN do segredo. O ARN segue o formato `acs:kms:${region}:${account}:secret/${secret-name}`.
FetchTags	String	Não	true	Especifique se as tags de recurso do segredo devem ser retornadas. Valores válidos: true: retorna as tags de recurso. false: não retorna as tags de recurso. Este é o valor padrão.

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

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
UpdateTime	String	2024-02-21T15:39:26Z	Horário da última atualização do segredo.
CreateTime	String	2024-02-21T15:39:26Z	Horário de criação do segredo.
NextRotationDate	String	2024-07-06T18:22:03Z	Horário previsto para a próxima rotação. Nota Retornado apenas quando a rotação automática está ativada.
EncryptionKeyId	String	key-hzz63ca8cbe3hefht****	ID da chave usada para criptografar o valor do segredo.
RotationInterval	String	3153600s	Intervalo para rotação automática. O valor segue o formato `integer[unit]`, onde `integer` indica o período e `unit` a unidade de tempo. O valor de `unit` é fixo como s (segundos). Por exemplo, 604800s corresponde a uma rotação automática a cada 7 dias. Nota Retornado apenas quando a rotação automática está ativada.
Arn	String	acs:kms:cn-hangzhou:154035569884****:secret/secret001	ARN do segredo.
ExtendedConfig	String	{\"AccountName\":\"kms\",\"Database\":\"kmsdata\",\"AccountPrivilege\":\"RoleReadOnly\",\"CloneAccountName\":\"kms_clone\",\"CustomData\":{},\"InstanceId\":\"pc-bp134f7hnijoey****\",\"RegionId\":\"cn-hangzhou\",\"SecretSubType\":\"DoubleUsers\"}"	Configuração estendida do segredo. Nota Retornado apenas para segredos do ApsaraDB RDS, Resource Access Management (RAM), PolarDB ou Elastic Compute Service (ecs).
LastRotationDate	String	2022-07-05T08:22:03Z	Horário da última rotação. Nota Retornado caso o segredo tenha sofrido rotação.
RequestId	String	93348dfb-3627-4417-8d90-487a76a909c9	ID da solicitação.
Description	String	userinfo	Descrição do segredo.
SecretName	String	secret001	Nome do segredo.
AutomaticRotation	String	Enabled	Indica se a rotação automática está ativada. Valores válidos: Enabled: rotação automática ativada. Disabled: rotação automática desativada. Invalid: status de rotação automática anormal. Nesse cenário, o Key Management Service (KMS) não consegue rotacionar o segredo automaticamente. Nota Retornado apenas para segredos do ApsaraDB RDS, PolarDB, RAM ou ecs.
SecretType	String	Rds	Tipo do segredo. Valores válidos: Generic: segredo genérico. Rds: segredo do ApsaraDB RDS. RAMCredentials: segredo do RAM. ecs: segredo do ecs. PolarDB: segredo do PolarDB.
PlannedDeleteTime	String	2025-03-21T15:45:12Z	Horário agendado para exclusão do segredo.
DKMSInstanceId	String	kst-bjj62d8f5e0sgtx8h****	ID da instância do KMS.
Tags	Array of Tag		Tags de recurso do segredo. Parâmetro não retornado se FetchTags for definido como false ou omitido.
Tag
TagValue	String	val1	Valor da tag.
TagKey	String	key1	Chave da tag.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeSecret
&SecretName=secret001
&FetchTags=true
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSecretResponse>
    <UpdateTime>2024-02-21T15:39:26Z</UpdateTime>
    <CreateTime>2024-02-21T15:39:26Z</CreateTime>
    <NextRotationDate>2024-07-06T18:22:03Z</NextRotationDate>
    <EncryptionKeyId>key-hzz63ca8cbe3hefht****</EncryptionKeyId>
    <RotationInterval>3153600s</RotationInterval>
    <Arn>acs:kms:cn-hangzhou:154035569884****:secret/secret001</Arn>
    <ExtendedConfig>{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\",  \"CustomData\":{} }</ExtendedConfig>
    <LastRotationDate>2022-07-05T08:22:03Z</LastRotationDate>
    <RequestId>93348dfb-3627-4417-8d90-487a76a909c9</RequestId>
    <Description>userinfo</Description>
    <SecretName>secret001</SecretName>
    <AutomaticRotation>Enabled</AutomaticRotation>
    <SecretType>Rds</SecretType>
    <PlannedDeleteTime>2025-03-21T15:45:12Z</PlannedDeleteTime>
    <DKMSInstanceId>kst-bjj62d8f5e0sgtx8h****</DKMSInstanceId>
    <Tags>
        <TagValue>val1</TagValue>
        <TagKey>key1</TagKey>
    </Tags>
</DescribeSecretResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "UpdateTime" : "2024-02-21T15:39:26Z",
  "CreateTime" : "2024-02-21T15:39:26Z",
  "NextRotationDate" : "2024-07-06T18:22:03Z",
  "EncryptionKeyId" : "key-hzz63ca8cbe3hefht****",
  "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" : "2025-03-21T15:45:12Z",
  "DKMSInstanceId" : "kst-bjj62d8f5e0sgtx8h****",
  "Tags" : [ {
    "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.	O parâmetro de entrada timestamp indica que a solicitação está fora do intervalo de tempo de processamento.
400	InvalidParameter	The specified parameter is not valid.	Valor inválido especificado para o parâmetro.
403	Forbidden.NoPermission	You are not authorized to perform the operation.	Sem autorização para executar a operação.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.