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

Consulta informações sobre um ou mais aplicativos EIAM usando paginação.

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

list

*Aplicação.

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx.
PageNumber	integer	Não	O número da página.	1
PageSize	integer	Não	O tamanho da página.	20
ApplicationIds	array	Não	A lista de IDs de aplicativos.	Ram Account SSO.
	string	Não	O ID do aplicativo.	app_mkv7rgt4d7i4u7zqtzev2mxxxx.
ApplicationName	string	Não	O nome do aplicativo. Apenas correspondência difusa à esquerda é suportada.	Ram Account SSO.
AuthorizationType	string	Não	O tipo de autorização de acesso ao aplicativo. Valores válidos: authorize_required: Autorização explícita é necessária para acesso. default_all: Todos os membros têm permissões de acesso por padrão. Valores válidos: authorize_required : Autorização explícita é necessária para acesso. default_all : Todos os membros têm permissões de acesso por padrão.	authorize_required.
Status	string	Não	O status do aplicativo. Valores válidos: enabled: Ativado. disabled: Desativado. Valores válidos: disabled : Desativado. enabled : Ativado.	enabled.
M2MClientStatus	string	Não	Especifica se a identidade do Cliente M2M está ativada.	enabled.
ResourceServerStatus	string	Não	Especifica se a capacidade ResourceServer está ativada.	enabled.
SsoType	string	Não	A condição de filtro de tipo de SSO. Vários tipos podem ser separados por vírgulas. Exemplo: oauth2/m2m,oidc+oauth2/m2m. Valores válidos: oauth2/m2m : oauth2/m2m. saml2 : saml2 oidc : oidc. oidc+oauth2/m2m : oidc+oauth2/m2m.	oauth2/m2m.
ApplicationCreationType	string	Não	O tipo de criação do aplicativo. Se este parâmetro for deixado vazio, aplicativos do tipo user_custom serão consultados por padrão. Para consultar aplicativos de todos os tipos, defina este parâmetro como all. Valores válidos: system_init : Criado pelo sistema. user_custom : Criado pelo usuário.	system_init.
ApplicationIdentityType	string	Não	O tipo de identidade do aplicativo. Se este parâmetro for deixado vazio, aplicativos do tipo application serão consultados por padrão. Para consultar aplicativos de todos os tipos de identidade, defina este parâmetro como all. Valores válidos: all : all. agent : Agente. application : Aplicativo.	application.
ApplicationTemplateId	string	Não	O ID do modelo de aplicativo.	apt_ramuser_xxxx.
CustomFields	array<object>	Não	A lista de campos personalizados.
	object	Não	O objeto de campo personalizado.
FieldName	string	Não	O identificador do campo personalizado. Valores válidos: agent_type: O tipo de agente.	agent_type.
FieldValue	string	Não	O valor do campo personalizado.	x-claw.
ServiceManaged	boolean	Não	Especifica se o modelo de aplicativo é gerenciado por um serviço de nuvem.	true.
ManagedServiceCode	string	Não	O ServiceCode do serviço de nuvem que gerencia o modelo de aplicativo.	waf.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	O número total de entradas retornadas.	100
Applications	array<object>	A lista de informações dos aplicativos.
	object	As informações do aplicativo.
InstanceId	string	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx.
ApplicationId	string	O ID do aplicativo.	app_mkv7rgt4d7i4u7zqtzev2mxxxx.
ClientId	string	O ID do cliente do aplicativo.	app_mkv7rgt4d7i4u7zqtzev2mxxxx.
LogoUrl	string	A URL do logotipo do aplicativo.	https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg.
ApplicationName	string	O nome do aplicativo.	SAML Application.
Description	string	A descrição do aplicativo.	Um aplicativo de teste.
SsoType	string	O protocolo de single sign-on. Valores válidos: saml2: Protocolo SAML 2.0. oidc: Protocolo OpenID Connect. oauth2/m2m: Protocolo OAuth 2.0. oidc+oauth2/m2m: Protocolos OpenID Connect e OAuth 2.0.	saml2
ApplicationSourceType	string	A origem de criação do aplicativo. Valores válidos: urn:alibaba:idaas:app:source:template: Modelo de aplicativo. urn:alibaba:idaas:app:source:standard: Protocolo padrão.	urn:alibaba:idaas:app:source:standard.
Features	string	Os recursos suportados pelo aplicativo, retornados como uma string de array JSON. Valores válidos: sso: Single sign-on. slo: Single logout. provision: Sincronização de contas. api_invoke: Acesso à API. m2m_client: Capacidade de Cliente M2M. resource_server: Capacidade de serviço de API. other: Fallback.	["sso", "provision"]
Status	string	O status do aplicativo. Valores válidos: enabled: Ativado. disabled: Desativado. deleted: Exclusão lógica.	enabled.
CreateTime	integer	A hora de criação do aplicativo, no formato de timestamp UNIX. Unidade: milissegundos.	1649830226000
UpdateTime	integer	A hora em que o aplicativo foi atualizado pela última vez, no formato de timestamp UNIX. Unidade: milissegundos.	1649830226000
ServiceManaged	boolean	Especifica se o modelo de aplicativo é gerenciado por um serviço de nuvem.	true.
ManagedServiceCode	string	O ServiceCode do serviço de nuvem que gerencia o modelo de aplicativo.	rpa.
ApplicationTemplateId	string	O ID do modelo de aplicativo.	apt_xxx_xxx.
ApplicationCreationType	string	O tipo de criação do aplicativo. Valores válidos: system_init : Criado pelo sistema. user_custom : Criado pelo usuário.	user_custom.
ResourceServerStatus	string	O status do servidor de recursos.	enabled.
ResourceServerIdentifier	string	O identificador único do ResourceServer.	https://example.com.
ResourceServerSourceType	string	O tipo de origem do servidor de recursos. Valores válidos: urn:cloud:idaas:resourceserver:source:custom : Personalizado. urn:cloud:idaas:resourceserver:source:system : Sistema.	urn:cloud:idaas:resourceserver:source:custom.
ApplicationIdentityType	string	O tipo de identidade do aplicativo. Valores válidos: agent : Agente. application : Aplicativo.	application.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Applications": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "ApplicationId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
      "ClientId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
      "LogoUrl": "https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg",
      "ApplicationName": "SAML Application",
      "Description": "A test application",
      "SsoType": "saml2",
      "ApplicationSourceType": "urn:alibaba:idaas:app:source:standard",
      "Features": "[\"sso\", \"provision\"]",
      "Status": "enabled",
      "CreateTime": 1649830226000,
      "UpdateTime": 1649830226000,
      "ServiceManaged": true,
      "ManagedServiceCode": "rpa",
      "ApplicationTemplateId": "apt_xxx_xxx",
      "ApplicationCreationType": "user_custom",
      "ResourceServerStatus": "enabled",
      "ResourceServerIdentifier": "https://example.com",
      "ResourceServerSourceType": "urn:cloud:idaas:resourceserver:source:custom",
      "ApplicationIdentityType": "application"
    }
  ]
}

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.