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

Esta operação retorna os metadados dos segredos, mas não os valores criptografados.

Neste exemplo, a API retorna os segredos da conta atual do Alibaba Cloud na região atual. O parâmetro PageNumber está definido como 1 e o PageSize como 2, o que indica o retorno de dois segredos na página atual.

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 da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListSecrets	Operação a ser executada. Defina o valor como ListSecrets.
FetchTags	String	Não	false	Especifique se as tags de recurso do segredo devem ser retornadas. Valores válidos: true false (padrão)
PageNumber	Integer	Não	1	Número da página. A numeração começa em 1. Valor padrão: 1.
PageSize	Integer	Não	2	Número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
Filters	String	Não	[{"Key":"SecretName", "Values":["Val1","Val2"]}]	Condição de filtro dos segredos. O filtro consiste em um ou mais pares chave-valor. É possível especificar até 10 pares. Ao usar uma chave ou valor de tag para filtrar recursos, o limite é de 4.000 recursos consultados. Para consultar mais de 4.000 recursos, chame a operação ListResourceTags. Key Descrição: propriedade a consultar. Tipo: string. Values Descrição: valor da propriedade. Tipo: string. Comprimento: 0 a 10. Valores válidos: Se o campo Key for SecretName, defina o valor como o nome de um segredo. Se o campo Key for Description, defina o valor como a descrição de um segredo. Se o campo Key for TagKey, defina o valor como uma chave de tag. Se o campo Key for TagValue, defina o valor como um valor de tag. Se o campo Key for DKMSInstanceId, defina o valor como o ID da sua instância do Key Management Service (KMS). Se o campo Key for SecretType, defina o valor como Generic, Rds, Redis, RAMCredentials, ECS ou PolarDB. Se o campo Key for Creator, defina o valor como o criador do segredo. A relação lógica entre os valores do campo Values em um par chave-valor é OR. Exemplo: `[ {"Key":"SecretName", "Values":["sec1","sec2"]} ]`. Neste caso, a semântica equivale a `SecretName=sec 1 OR SecretName=sec 2`.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageNumber	Integer	1	Número da página.
PageSize	Integer	2	Número de entradas por página.
RequestId	String	6a6287a0-ff34-4780-a790-fdfca900557f	ID da solicitação.
TotalCount	Integer	55	Total de segredos retornados.
SecretList	Array of Secret		Lista de segredos.
Secret
SecretName	String	secret001	Nome do segredo.
UpdateTime	String	2024-07-17T07:59:05Z	Hora da última atualização.
SecretType	String	Generic	Tipo do segredo. Valores válidos: Generic: segredo genérico. Rds: segredo do ApsaraDB RDS. Redis: segredo do ApsaraDB for Redis ou Tair. RAMCredentials: segredo do RAM. ECS: segredo do ECS. PolarDB: segredo do PolarDB.
PlannedDeleteTime	String	2024-08-17T07:59:05Z	Hora agendada para exclusão do segredo.
CreateTime	String	2024-07-17T07:59:05Z	Hora de criação do segredo.
Tags	Array of Tag		Tags de recurso do segredo. Este parâmetro não é retornado se você definir FetchTags como false ou não especificar o parâmetro FetchTags.
Tag
TagValue	String	val1	Valor da tag.
TagKey	String	key1	Chave da tag.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListSecrets
&FetchTags=false
&PageNumber=1
&PageSize=2
&Filters=[{"Key":"SecretName", "Values":["Val1","Val2"]}]
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<ListSecretsResponse>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <RequestId>6a6287a0-ff34-4780-a790-fdfca900557f</RequestId>
    <TotalCount>55</TotalCount>
    <SecretList>
        <SecretName>secret001</SecretName>
        <UpdateTime>2024-07-17T07:59:05Z</UpdateTime>
        <SecretType>Generic</SecretType>
        <PlannedDeleteTime>2024-08-17T07:59:05Z</PlannedDeleteTime>
        <CreateTime>2024-07-17T07:59:05Z</CreateTime>
        <Tags>
            <TagValue>val1</TagValue>
            <TagKey>key1</TagKey>
        </Tags>
    </SecretList>
</ListSecretsResponse>

Formato JSON

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

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	The specified parameter is not valid.	Valor inválido especificado para o parâmetro.

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