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

Consulta todos os segredos na região atual.

Descrição da operação

Para chamar esta operação, o usuário RAM ou a função RAM deve ter a política necessária concedida. Para obter mais informações, consulte Resource Access Management.
Esta operação retorna apenas os metadados do segredo, não os valores do segredo.

Este exemplo mostra como consultar segredos criados pelo usuário atual na região atual. PageNumber é definido como 1 e PageSize é definido como 2, retornando metadados para dois segredos.

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
FetchTags	string	Não	Especifica se as tags de recurso devem ser retornadas para cada segredo. Valores válidos: true: As tags de recurso são retornadas. false (padrão): As tags de recurso não são retornadas.	false
PageNumber	integer	Não	O número da página. O valor deve ser maior que 0. Valor padrão: 1.	1
PageSize	integer	Não	O tamanho da página. O valor deve estar entre 1 e 100. Valor padrão: 10.	2
Filters	string	Não	Filtra segredos com base em condições especificadas. O valor é uma lista de até 10 pares chave-valor. Ao filtrar por tag, a consulta retorna no máximo 4.000 recursos. Se mais de 4.000 recursos corresponderem ao filtro, chame a operação ListResourceTags. Key Descrição: A propriedade do filtro. Tipo: String. Values Descrição: O valor do filtro. Tipo: String. Você pode especificar até 10 itens. Valores válidos para Key: Defina Key como SecretName para filtrar pelo nome do segredo. Defina Key como Description para filtrar pela descrição do segredo. Defina Key como TagKey para filtrar pela chave da tag. Defina Key como TagValue para filtrar pelo valor da tag. Defina Key como DKMSInstanceId para filtrar pelo ID da instância KMS. Defina Key como SecretType para filtrar pelo tipo de segredo. Values pode ser Generic, RDS, Redis, RAMCredentials, ECS ou PolarDB. Defina Key como Creator para filtrar pelo criador do segredo. Se você especificar vários valores para uma chave, o filtro aplicará um OR lógico. Por exemplo, se você inserir `[ {"Key":"SecretName", "Values":["sec1","sec2"]} ]`, isso significa: `(SecretName=sec1 OR SecretName=sec2)`.	[{"Key":"SecretName", "Values":["Val1","Val2"]}]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	2
RequestId	string	O identificador exclusivo gerado pelo Alibaba Cloud para a solicitação. Use-o para localizar e solucionar problemas.	6a6287a0-ff34-4780-a790-fdfca900557f
TotalCount	integer	O número de segredos.	55
SecretList	object
Secret	array<object>	A lista de segredos.
	array<object>
SecretName	string	The name of the secret.	secret001
UpdateTime	string	The time when the secret was last updated.	2024-07-17T07:59:05Z
SecretType	string	The type of the secret. Valid values: `Generic`: a generic secret. `Rds`: an RDS secret. `Redis`: a Redis or Tair secret. `RAMCredentials`: a RAM secret. `ECS`: an ECS secret. `PolarDB`: a PolarDB secret.	Generic
PlannedDeleteTime	string	The scheduled deletion time.	2024-08-17T07:59:05Z
CreateTime	string	The time when the secret was created.	2024-07-17T07:59:05Z
Tags	object
Tag	array<object>	The resource tags for the secret. This parameter is not returned if the `FetchTags` parameter is set to `false` or is not specified.
	object	A resource tag.
TagValue	string	The tag value.	val1
TagKey	string	The tag key.	key1
OwingService	string	The owner service.	alb

Exemplos

Resposta de sucesso

JSON formato

{
  "PageNumber": 1,
  "PageSize": 2,
  "RequestId": "6a6287a0-ff34-4780-a790-fdfca900557f",
  "TotalCount": 55,
  "SecretList": {
    "Secret": [
      {
        "SecretName": "secret001",
        "UpdateTime": "2024-07-17T07:59:05Z",
        "SecretType": "Generic",
        "PlannedDeleteTime": "2024-08-17T07:59:05Z",
        "CreateTime": "2024-07-17T07:59:05Z",
        "Tags": {
          "Tag": [
            {
              "TagValue": "val1",
              "TagKey": "key1"
            }
          ]
        },
        "OwingService": "alb"
      }
    ]
  }
}

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
500	InternalFailure	Internal Failure
403	Forbidden.NoPermission	This operation is forbidden by permission system
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.