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

Consulta as informações sobre um destino de API.

Descrição da operação

Você pode chamar esta operação de API para consultar as informações sobre um destino 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:GetApiDestination

get

*ApiDestination

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ApiDestinationName	string	Sim	O nome do destino de API.	api-destination-name

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	B896B484-F16D-59DE-9E23-DD0E5C361108
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, success é retornado. Se a solicitação falhar, um código de erro é 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.
ApiDestinationName	string	O nome do destino de API.	demo
ConnectionName	string	O nome da conexão.	test-basic
Description	string	A descrição do destino de API.	demo
HttpApiParameters	object	Os parâmetros de solicitação configurados para o destino de API.
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	A hora em que o destino de API foi criado.	1649055710565

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "B896B484-F16D-59DE-9E23-DD0E5C361108",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ApiDestinationName": "demo",
    "ConnectionName": "test-basic",
    "Description": "demo",
    "HttpApiParameters": {
      "Endpoint": "http://127.0.0.1:8001/api\n",
      "Method": "POST"
    },
    "GmtCreate": 1649055710565
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception
409	ApiDestinationNotExist	The api-destination not existed!

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.