ListApiDestinations - EventBridge: Central de Documentação do Alibaba Cloud

Consulta uma lista de destinos de API.

Descrição da operação

Você pode usar esta operação de API para consultar uma lista de destinos de API.

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

eventbridge:ListApiDestinations

list

*ApiDestination

acs:eventbridge:{#regionId}:{#accountId}:apidestination/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ApiDestinationNamePrefix	string	Não	O prefixo do nome do destino de API.	api-demo
ConnectionName	string	Não	O nome da conexão.	connection-name
MaxResults	integer	Não	O número máximo de entradas a serem retornadas em uma chamada. Você pode usar este parâmetro e NextToken para implementar a paginação. Valor padrão: 10.	10
NextToken	string	Não	Se você definir Limit e existirem valores de retorno excedentes, este parâmetro será retornado. Valor padrão: 0.	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	96D7C0AB-DCE5-5E82-96B8-4725E1706BB1
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, success é retornado. Se a solicitação falhar, um código de erro será retornado.	success
Code	string	O código de resposta retornado. O valor Success indica que a solicitação foi bem-sucedida.	Success
Data	object	Os dados retornados.
ApiDestinations	array<object>	Os destinos de API.
	array<object>
ApiDestinationName	string	The name of the API destination.	api-destination-2
ConnectionName	string	The connection name.	connection-name
Description	string	The description of the connection.	demo
HttpApiParameters	object	The request parameters that are configured for the API destination.
Endpoint	string	The endpoint of the API destination.	http://127.0.0.1:8001/api
Method	string	The HTTP request method. Valid values: POST GET DELETE PUT HEAD TRACE PATCH	POST
GmtCreate	integer	The time when the API destination was created.	1665223213000
NextToken	string	Se existirem valores de retorno excedentes, este parâmetro será retornado.	1
Total	number	O número total de entradas retornadas.	2
MaxResults	number	O número máximo de entradas retornadas por página.	10

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "96D7C0AB-DCE5-5E82-96B8-4725E1706BB1",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ApiDestinations": [
      {
        "ApiDestinationName": "api-destination-2",
        "ConnectionName": "connection-name",
        "Description": "demo",
        "HttpApiParameters": {
          "Endpoint": "http://127.0.0.1:8001/api",
          "Method": "POST"
        },
        "GmtCreate": 1665223213000
      }
    ],
    "NextToken": "1",
    "Total": 2,
    "MaxResults": 10
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.