ListBrands - Identity as a Service: Central de Documentação do Alibaba Cloud

Obtém uma lista de marcas.

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

list

*Brand

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
NextToken	string	Não	O token de paginação.	NTxxxxxexample
PreviousToken	string	Não	O token usado para consultar a página anterior.	PTxxxxxexample
MaxResults	integer	Não	O número de entradas por página em uma consulta paginada.	20

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 na lista.	100
NextToken	string	O token de paginação retornado por esta chamada.	NTxxxexample
PreviousToken	string	O token de paginação retornado por esta chamada.	PTxxxexample
MaxResults	integer	O número de entradas por página em uma consulta paginada.	20
Brands	array<object>	A lista de dados de marcas.
	object	Os dados da marca.
InstanceId	string	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
BrandId	string	O ID da marca.	brand_xxxx
BrandName	string	O nome da marca.	Marca personalizada
BrandType	string	O tipo de marca. Valores válidos: system_init : Inicializado pelo sistema. user_custom : Definido pelo usuário.	user_custom
Status	string	O status da marca. Valores válidos: disabled : Desativado. enabled : Ativado.	enabled
SmsGatewayId	string	O ID do gateway de SMS.	smsgw_01l9f0kunrrjhxxx
SystemNotificationStatus	string	O status de ativação das notificações do sistema. Valores válidos: disabled(禁用) : Desativado enabled(启用) : Ativado	enabled

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "PreviousToken": "PTxxxexample",
  "MaxResults": 20,
  "Brands": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "BrandId": "brand_xxxx",
      "BrandName": "Marca personalizada",
      "BrandType": "user_custom",
      "Status": "enabled",
      "SmsGatewayId": "smsgw_01l9f0kunrrjhxxx",
      "SystemNotificationStatus": "enabled"
    }
  ]
}

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.