Recupera o valor em texto simples de um segredo por meio do gateway de uma KMS Instance. A resposta inclui os dados descriptografados do segredo, além de informações sobre a versão, status de rotação e configurações estendidas, caso solicitadas.
Parâmetros da solicitação
| Parâmetro | Tipo | Obrigatório | Padrão | Exemplo | Descrição |
|---|---|---|---|---|---|
| SecretName | String | Sim | — | secret001 | Nome do segredo. |
| VersionStage | String | Não | ACSCurrent | ACSCurrent | Rótulo de estágio que identifica a versão do segredo a ser recuperada. O KMS retorna o valor da versão marcada com o rótulo especificado. Valores válidos: ACSCurrent, ACSPrevious. Valor padrão: ACSCurrent. Nota Para segredos do Resource Access Management (RAM), segredos de banco de dados e segredos do Elastic Compute Service (ECS), o KMS retorna apenas as versões marcadas como ACSCurrent ou ACSPrevious. Os segredos de banco de dados incluem segredos do ApsaraDB RDS, PolarDB e ApsaraDB for Redis/Tair. |
| VersionId | String | Não | — | 00000000000000000000000000000001 | ID da versão do segredo a ser recuperada. Caso você especifique VersionStage e VersionId simultaneamente, o KMS verifica se a versão indicada existe. Se existir, o valor do segredo é retornado; caso contrário, um erro de parâmetro é gerado. Nota Segredos do RAM, de banco de dados e do ECS não suportam este parâmetro. Se você definir VersionId para esses tipos de segredo, o parâmetro será ignorado. |
| FetchExtendedConfig | Boolean | Não | false | false | Define se a configuração estendida do segredo deve ser retornada. Quando definido como true, a resposta inclui o campo ExtendedConfig. Valor padrão: false. |
Elementos da resposta
|
Parâmetro |
Tipo |
Exemplo |
Descrição |
|
SecretName |
String |
secret001 |
Nome do segredo. |
|
SecretType |
String |
Generic |
Tipo do segredo. Valores válidos: Generic (segredo genérico), Rds (segredo do ApsaraDB RDS), Redis (segredo do ApsaraDB for Redis/Tair), RAMCredentials (segredo do RAM), ECS (segredo do ECS), PolarDB (segredo do PolarDB). |
|
SecretData |
String |
testdata1 |
Valor do segredo em texto simples. O KMS descriptografa o texto cifrado armazenado e retorna o resultado neste campo. |
|
SecretDataType |
String |
binary |
Formato do valor do segredo. Valores válidos: text, binary. |
|
VersionId |
String |
00000000000000000000000000000001 |
ID da versão do segredo retornado. |
|
VersionStages |
List |
["ACSCurrent"] |
Rótulos de estágio associados à versão do segredo retornada. |
|
CreateTime |
String |
2020-02-21T15:39:26Z |
Momento da criação do segredo. Segue o padrão ISO 8601 no formato |
|
LastRotationDate |
String |
2020-07-05T08:22:03Z |
Data da última rotação do segredo. Segue o padrão ISO 8601 no formato |
|
NextRotationDate |
String |
2020-07-06T18:22:03Z |
Próxima data agendada para rotação do segredo. Segue o padrão ISO 8601 no formato |
|
AutomaticRotation |
String |
Enabled |
Status da rotação automática do segredo. Valores válidos: Enabled (rotação automática ativada), Disabled (rotação automática desativada), Invalid (status anormal que impede o KMS de realizar a rotação automática). |
|
RotationInterval |
String |
604800s |
Intervalo entre rotações automáticas, no formato |
|
ExtendedConfig |
String |
{"SecretSubType":"SingleUser","DBInstanceId":"rm-uf667446pc955****","CustomData":{}} |
Configuração estendida do segredo. Este campo só é retornado quando FetchExtendedConfig está definido como true. |
|
RequestId |
String |
6a3e9c36-1150-4881-84d3-eb8672fcafad |
ID da solicitação. |
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|
404 |
Forbidden.ResourceNotFound |
The resource does not exist in the system. |
O segredo especificado não existe. |
|
409 |
Rejected.Disabled |
The request was rejected because the key state is Disabled. |
A chave de criptografia usada para proteger o segredo está desativada. |
Para obter a lista completa de códigos de erro, consulte Códigos de erro do serviço.