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

Consulta as informações de recursos de uma conta em nuvem.

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:GetCloudAccount

get

*CloudAccount.

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
CloudAccountId	string	Sim	O ID da conta em nuvem.	ca_01kmegjc11qa1txxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
CloudAccount	object	Os detalhes da conta em nuvem.
InstanceId	string	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
CloudAccountId	string	O ID da conta em nuvem.	ca_01kmegjc11qa1txxxxx
CloudAccountName	string	O nome da conta em nuvem.	cloud_accout_xxxx
CloudAccountVendorType	string	O tipo da conta em nuvem. Valores válidos: alibaba_cloud: Alibaba Cloud. [_single.resp.200.props.CloudAccount.CloudAccountVendorType.enum. alibaba_cloud] alibaba_cloud [responses.200.schema.properties.CloudAccount.properties.CloudAccountVendorType.enumValueTitles. alibaba_cloud] alibaba_cloud Valores válidos: alibaba_cloud : alibaba_cloud	alibaba_cloud
CloudAccountExternalId	string	O identificador único externo da conta em nuvem.	1234567
CloudAccountProviderName	string	O nome do provedor de identidade.	idaas-eiam-oidc-provider
CloudAccountHealth	string	O status de integridade da conta em nuvem. Valores válidos: healthy: Íntegro. unhealthy: Não íntegro. unknown: Desconhecido. Valores válidos: healthy : healthy. unhealthy : unhealthy. unknown : unknown.	healthy
CloudAccountHealthCheckResult	object	O resultado da verificação de integridade da conta em nuvem.
LastCheckTime	integer	A hora da última verificação de integridade. O valor é um carimbo de data/hora UNIX em milissegundos.	1649830226000
Result	string	O resultado da verificação de integridade da conta em nuvem. Valores válidos: success: Bem-sucedido. failed: Falhou. Valores válidos: success : success. failed : failed.	success
ErrorReason	object	O motivo do erro. Este campo retorna um valor quando o status da verificação de integridade é não íntegro.
ErrorCode	string	O código de erro.	AuthenticationFail.NoPermission
ErrorMessage	string	A mensagem de erro.	There is no permission
PrivilegeHostingState	string	O estado de hospedagem da conta em nuvem. O valor padrão é hosting_unmanaged. Valores válidos: hosting_unmanaged: Não gerenciado. A conta em nuvem não iniciou a hospedagem e está no estado inicial. hosting_pending: Hospedagem em andamento. A tarefa de hospedagem foi enviada e está sendo executada de forma assíncrona. Aguarde a conclusão do processo de hospedagem antes que o estado final seja atingido. hosting_completed: Hospedagem concluída. O processo de hospedagem da conta em nuvem foi executado com êxito. Os modelos de permissão e as vinculações de hospedagem relacionados entraram em vigor. hosting_failed: Falha na hospedagem. O processo de hospedagem encontrou uma exceção. Visualize o motivo da falha e reinicie a hospedagem. hosting_removing: Remoção em andamento. A tarefa de remoção foi enviada e está sendo executada de forma assíncrona. Aguarde a conclusão do processo de remoção antes que o estado final seja atingido. hosting_remove_failed: Falha na remoção. O processo de remoção encontrou uma exceção. Visualize o motivo da falha e reinicie a remoção.	hosting_unmanaged
PrivilegeStatus	string	O status da chave de privilégios. Valores válidos: enabled: Ativado. O recurso está ativo e pode ser usado normalmente. disabled: Desativado. O recurso está desativado e não tem mais efeito. Você pode reativá-lo para restaurar a funcionalidade.	enabled
PrivilegeApplicationIds	array	A lista de IDs de aplicativos de privilégio associados.
	string	A lista de IDs de aplicativos de privilégio associados.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
PrivilegeHostingError	object	O motivo da falha na hospedagem ou remoção de privilégios.
ErrorCode	string	O código de erro da falha.	Error
ErrorMessage	string	A mensagem de falha.	test message
Description	string	A descrição da conta em nuvem.	cloud_accout_description
CloudAccountProviderConfig	object	As informações de configuração do provedor de identidade.
AuthorizationServerId	string	O ID do servidor de autorização.	iauths_system
Issuer	string	O emissor.	https://xxxxx.aliyunidaas.com/api/v2/iauths_system/oauth2
Audience	string	O identificador de público-alvo.	urn:cloud:idaas:sts:xxx:xxx
OidcJwksEndpoint	string	O endpoint da chave pública de verificação de assinatura.	https://xxxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/jwks
CreateTime	integer	A hora de criação. O valor é um carimbo de data/hora UNIX em milissegundos.	1649830225000
UpdateTime	integer	A hora da última atualização. O valor é um carimbo de data/hora UNIX em milissegundos.	1649830227000
CloudAccountSite	string	O site da conta em nuvem. Valores válidos: china_mainland: China continental. global: Global.	china_mainland
CloudAccountRoleCreationType	string	O tipo de criação de função da conta em nuvem.	test

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "CloudAccount": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "CloudAccountId": "ca_01kmegjc11qa1txxxxx",
    "CloudAccountName": "cloud_accout_xxxx",
    "CloudAccountVendorType": "alibaba_cloud",
    "CloudAccountExternalId": "1234567",
    "CloudAccountProviderName": "idaas-eiam-oidc-provider",
    "CloudAccountHealth": "healthy",
    "CloudAccountHealthCheckResult": {
      "LastCheckTime": 1649830226000,
      "Result": "success",
      "ErrorReason": {
        "ErrorCode": "AuthenticationFail.NoPermission",
        "ErrorMessage": "There is no permission"
      }
    },
    "PrivilegeHostingState": "hosting_unmanaged",
    "PrivilegeStatus": "enabled",
    "PrivilegeApplicationIds": [
      "app_mkv7rgt4d7i4u7zqtzev2mxxxx"
    ],
    "PrivilegeHostingError": {
      "ErrorCode": "Error",
      "ErrorMessage": "test message"
    },
    "Description": "cloud_accout_description",
    "CloudAccountProviderConfig": {
      "AuthorizationServerId": "iauths_system",
      "Issuer": "https://xxxxx.aliyunidaas.com/api/v2/iauths_system/oauth2",
      "Audience": "urn:cloud:idaas:sts:xxx:xxx",
      "OidcJwksEndpoint": "https://xxxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/jwks"
    },
    "CreateTime": 1649830225000,
    "UpdateTime": 1649830227000,
    "CloudAccountSite": "china_mainland",
    "CloudAccountRoleCreationType": "test"
  }
}

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.