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

Obtém vários segredos.

Descrição da operação

Para obter detalhes sobre a política de acesso que deve ser concedida aos usuários do Resource Access Management (RAM) ou às funções do RAM para invocar esta operação de API, consulte Controle de acesso.
Se você não especificar um ID de versão ou estágio de versão, o KMS retornará o valor do segredo da versão marcada com ACSCurrent por padrão.
O chamador também deve ter a permissão kms:GetSecretValue em todos os segredos do lote.
Se um segredo usar uma chave mestra personalizada para proteger o valor do segredo, o chamador também deve ter a permissão kms:Decrypt na chave mestra correspondente.

Este tópico fornece um exemplo de como obter o valor de um segredo chamado secret001. A resposta mostra que o valor do segredo SecretData é testdata1.

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.

Sintaxe da solicitação

GET  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SecretsList	array<object>	Não	A lista de informações de segredos. Você pode consultar até 20 segredos diferentes por vez.
	object	Não
SecretName	string	Sim	O nome ou o Alibaba Cloud Resource Name (ARN) do segredo. Nota Para acessar um segredo que pertence a outra conta da Alibaba Cloud, você deve especificar o ARN do segredo. O ARN está no formato acs:kms:${region}:${account}:secret/${secret-name}.	secret001
VersionStage	string	Não	O estágio da versão do segredo. Valor padrão: ACSCurrent. Se você especificar este parâmetro, o valor do segredo do estágio de versão especificado será retornado. Se você não especificar este parâmetro, o valor do segredo do estágio de versão ACSCurrent será retornado. Nota Para segredos do ApsaraDB RDS, segredos do PolarDB, segredos do Redis/Tair, segredos do RAM e segredos do ECS, você só pode obter os valores dos segredos das versões marcadas com ACSPrevious e ACSCurrent.	ACSCurrent
VersionId	string	Não	O ID da versão do segredo.	v1
FetchExtendedConfig	string	Não	Especifica se deve ser obtida a configuração estendida do segredo. Valores válidos: true: Obtém a configuração estendida. false: Não obtém a configuração estendida. Este é o valor padrão. Nota Segredos genéricos não suportam configurações estendidas. Se você especificar este parâmetro para um segredo genérico, ele será ignorado. Valores válidos: true : Obtém a configuração estendida. false : Não obtém a configuração estendida.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	8252db58-2036-408c-a3d5-56e656dc2551
SecretValues	array<object>	A lista de segredos obtidos com êxito.
	array<object>
SecretDataType	string	O tipo do valor do segredo. Valores válidos: text binary	binary
CreateTime	string	A hora em que o segredo foi criado. A hora é exibida em UTC.	2024-02-21T15:39:26Z
VersionId	string	O ID da versão do segredo.	v1
NextRotationDate	string	A hora em que a próxima rotação é realizada. A hora é exibida em UTC. Nota Este parâmetro é retornado apenas quando a rotação automática está ativada.	2024-07-06T18:22:03Z
SecretData	string	O valor do segredo. O KMS descriptografa o valor do segredo em texto cifrado armazenado e retorna este parâmetro. Para um segredo genérico, o valor do segredo especificado é retornado. Para um segredo do ApsaraDB RDS ou um segredo do Redis/Tair, o valor do segredo está no seguinte formato: {"AccountName":"","AccountPassword":""}. Para um segredo do RAM, o valor do segredo está no seguinte formato: {"AccessKeyId":"Adfdsfd","AccessKeySecret":"fdsfdsf","GenerateTimestamp": "2023-03-25T10:42:40Z"}. Para um segredo do ECS, o valor do segredo está em um dos seguintes formatos: Segredo de senha: {"UserName":"ecs-user","Password":"H5asdasdsads**"}. Segredo de par de chaves pública e privada (a chave privada está no formato PEM): {"UserName":"ecs-user","PublicKey":"ssh-rsa mKwnVix9YTFY9Rs= imported-openssh-key","PrivateKey": "d6bee1cb-2e14-4277-ba6b-73786b21**"}. Para um segredo do PolarDB, o valor do segredo está no seguinte formato: {"AccountName":"","AccountPassword":""}.	testdata1
RotationInterval	string	O intervalo para rotação automática de segredos. O valor está no formato integer[unit]. integer indica a duração do tempo e unit indica a unidade de tempo. Valores válidos para unit: s (segundos). Por exemplo, um intervalo de rotação de 7 dias é 604800s. Nota Este parâmetro é retornado apenas quando a rotação automática está ativada.	604800s
ExtendedConfig	string	A configuração estendida do segredo. Nota Este parâmetro é retornado apenas para segredos do ApsaraDB RDS, segredos do PolarDB, segredos do Redis/Tair, segredos do RAM ou segredos do ECS quando FetchExtendedConfig é definido como true.	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	A hora em que a última rotação foi realizada. A hora é exibida em UTC. Nota Este parâmetro é retornado apenas quando o segredo foi rotacionado.	2023-07-05T08:22:03Z
RequestId	string	O ID da solicitação. O ID é um identificador exclusivo gerado pela Alibaba Cloud para a solicitação e pode ser usado para solucionar e localizar problemas.	8252db58-2036-408c-a3d5-56e656dc2551
SecretName	string	O nome do segredo.	secret001
AutomaticRotation	string	Indica se a rotação automática está ativada. Valores válidos: Enabled: A rotação automática está ativada. Disabled: A rotação automática está desativada. Invalid: O status de rotação está anormal e o KMS não pode rotacionar o segredo automaticamente. Nota Este parâmetro é retornado apenas para segredos do ApsaraDB RDS, segredos do PolarDB, segredos do Redis/Tair, segredos do RAM ou segredos do ECS.	Enabled
SecretType	string	O tipo do segredo. Valores válidos: Generic: segredo genérico. Rds: segredo do ApsaraDB RDS. Redis: segredo do Redis/Tair. RAMCredentials: segredo do RAM. ECS: segredo do ECS. PolarDB: segredo do PolarDB.	Generic
VersionStages	object	Os rótulos de estágio da versão do segredo.
VersionStage	array	Os rótulos de estágio da versão do segredo.
	string	Os rótulos de estágio da versão do segredo.	{ "VersionStage": [ "ACSCurrent" ] }
Errors	array<object>	A lista de erros para segredos que não puderam ser obtidos.
	object	Nenhum.
SecretName	string	O nome do segredo.	secret002
HttpStatus	integer	O código de status HTTP retornado para o erro.	404
Code	string	O código de erro do serviço.	Forbidden.ResourceNotFound
Message	string	A mensagem de erro retornada quando o segredo não pode ser obtido.	Resource not found.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "8252db58-2036-408c-a3d5-56e656dc2551",
  "SecretValues": [
    {
      "SecretDataType": "binary",
      "CreateTime": "2024-02-21T15:39:26Z",
      "VersionId": "v1",
      "NextRotationDate": "2024-07-06T18:22:03Z",
      "SecretData": "testdata1",
      "RotationInterval": "604800s",
      "ExtendedConfig": "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\",  \\\"CustomData\\\":{} }",
      "LastRotationDate": "2023-07-05T08:22:03Z",
      "RequestId": "8252db58-2036-408c-a3d5-56e656dc2551",
      "SecretName": "secret001",
      "AutomaticRotation": "Enabled",
      "SecretType": "Generic",
      "VersionStages": {
        "VersionStage": [
          "{ \"VersionStage\": [ \"ACSCurrent\" ] }"
        ]
      }
    }
  ],
  "Errors": [
    {
      "SecretName": "secret002",
      "HttpStatus": 404,
      "Code": "Forbidden.ResourceNotFound",
      "Message": "Resource not found"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
403	Forbidden.DKMSInstanceStateInvalid	The DKMS instance state is invalid.
403	Forbidden.DKMSInstanceNotFound	The specified DKMS Instance is not found.
404	Forbidden.KeyNotFound	The specified Key is not found.
404	Forbidden.ResourceNotFound	Resource not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.