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

Consulta um recurso de credencial que contém informações confidenciais.

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

eiam:ObtainCredential

get

*Credential

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
CredentialId	string	Sim	O ID da credencial.	cred_mkv7rgt4d7i4u7zqtzev2mxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
Credential	object	As informações da credencial.
InstanceId	string	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
CredentialId	string	O ID da credencial.	cred_mkv7rgt4d7i4u7zqtzev2mxxxx
Status	string	O status da credencial. Valores válidos: enabled: Ativado. disabled: Desativado.	enabled
CredentialIdentifier	string	O identificador da credencial.	credential_identifier_test
CredentialName	string	O nome da credencial.	credential_name
CredentialSubjectType	string	O tipo do sujeito ao qual a credencial pertence. Valores válidos: authentication_token_provider: Provedor de token de autenticação.	authentication_token_provider
CredentialSubjectId	string	O ID do sujeito ao qual a credencial pertence.	apt_werthgfdsasffxxxxx
CredentialScenarioLabel	string	O rótulo de cenários da credencial. Valores válidos: llm: Modelo de linguagem grande. saas: Serviço SaaS de terceiros.	llm
CredentialType	string	O tipo da credencial. Valores válidos: api_key: Credencial de autenticação por chave de API. oauth_client: Credencial de autenticação de cliente OAuth.	api_key
CredentialCreationType	string	O tipo de criação da credencial. Valores válidos: system_init: Criada pelo sistema. user_custom: Criada pelo usuário.	user_custom
Description	string	A descrição da credencial.	credential_description
CreateTime	integer	A hora de criação, no formato de timestamp UNIX. Unidade: milissegundos.	1649830225000
UpdateTime	integer	A hora da atualização, no formato de timestamp UNIX. Unidade: milissegundos.	1649830227000
CredentialContent	object	O conteúdo da credencial.
OAuthClientContent	object	Os detalhes da credencial de cliente OAuth 2.0.
ClientId	string	O ID do cliente.	dmvncmxersdxxxxxx
ClientSecret	string	O segredo do cliente.	nsklnertyt5ddwizncxxxx
ApiKeyContent	object	Os detalhes da credencial de chave de API.
ApiKey	string	A chave de API.	nsklncmwizncxxxx
CredentialSharingScope	string
ExclusiveUserId	string
CredentialExternalId	string

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Credential": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "CredentialId": "cred_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "Status": "enabled",
    "CredentialIdentifier": "credential_identifier_test",
    "CredentialName": "credential_name",
    "CredentialSubjectType": "authentication_token_provider",
    "CredentialSubjectId": "apt_werthgfdsasffxxxxx",
    "CredentialScenarioLabel": "llm",
    "CredentialType": "api_key",
    "CredentialCreationType": "user_custom",
    "Description": "credential_description",
    "CreateTime": 1649830225000,
    "UpdateTime": 1649830227000,
    "CredentialContent": {
      "OAuthClientContent": {
        "ClientId": "dmvncmxersdxxxxxx",
        "ClientSecret": "nsklnertyt5ddwizncxxxx"
      },
      "ApiKeyContent": {
        "ApiKey": "nsklncmwizncxxxx"
      }
    },
    "CredentialSharingScope": "",
    "ExclusiveUserId": "",
    "CredentialExternalId": ""
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.