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

Consulta os detalhes de um segredo.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

sae:DescribeSecret

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /pop/v1/sam/secret/secret HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NamespaceId	string	Sim	O ID do namespace no qual o segredo reside. Se o namespace for o padrão, você precisa inserir apenas o ID da região, como cn-beijing.	cn-beijing:test
SecretId	integer	Sim	O ID da instância de segredo a ser consultada. Você pode chamar a operação ListSecrets para visualizar os IDs das instâncias de segredo.	16

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	As informações adicionais retornadas. Valores válidos: success: Se a chamada for bem-sucedida, success será retornado. Um código de erro: Se a chamada falhar, um código de erro será retornado.	success
TraceId	string	O ID de rastreamento usado para consultar os detalhes da solicitação.	0a98a02315955564772843261e****
Data	object	A resposta.
NamespaceId	string	O ID do namespace.	cn-beijing:test
SecretId	integer	O ID da instância de segredo.	16
SecretName	string	O nome da instância de segredo.	registry-auth
SecretType	string	O tipo da instância de segredo.	kubernetes.io/dockerconfigjson
SecretData	object	Os dados de pares chave-valor do segredo.
	string	Os dados de pares chave-valor do segredo.	{".dockerconfigjson":"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0="}
CreateTime	integer	A hora em que o segredo foi criado.	1593746835111
UpdateTime	integer	A hora em que o segredo foi atualizado.	1593746835111
RelateApps	array<object>	Os aplicativos associados.
	object	As informações sobre o aplicativo.
AppId	string	The application ID.	f16b4000-9058-4c22-a49d-49a28f0b****
AppName	string	The name of the application.	test-app
ErrorCode	string	O código de erro retornado. Valores válidos: O parâmetro ErrorCode não é retornado se a solicitação for bem-sucedida. Se a chamada falhar, o parâmetro ErrorCode será retornado. Para mais informações, consulte Códigos de erro neste tópico.
Code	string	O código de status HTTP. Valores válidos: 2xx: A chamada foi bem-sucedida. 3xx: A chamada foi redirecionada. 4xx: A chamada falhou. 5xx: Ocorreu um erro de servidor.	200
Success	boolean	Indica se os detalhes da instância de segredo foram consultados com sucesso. Valores válidos: true: As informações foram consultadas. false: Falha na consulta.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "NamespaceId": "cn-beijing:test",
    "SecretId": 16,
    "SecretName": "registry-auth",
    "SecretType": "kubernetes.io/dockerconfigjson",
    "SecretData": {
      "key": "{\".dockerconfigjson\":\"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0=\"}"
    },
    "CreateTime": 1593746835111,
    "UpdateTime": 1593746835111,
    "RelateApps": [
      {
        "AppId": "f16b4000-9058-4c22-a49d-49a28f0b****",
        "AppName": "test-app"
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	InvalidSecretId.NotFound	The specified SecretId [%s] does not exist in our records.
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.