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

Descrição da operação

Cria informações de destino da 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:CreateApiDestination

create

*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 da API. O nome deve ter de 2 a 127 caracteres.	api-destination-name
ConnectionName	string	Sim	O nome da configuração de conexão. O nome deve ter de 2 a 127 caracteres. Importante Antes de chamar esta operação, chame a operação Connection para criar uma configuração de conexão. Defina ConnectionName como o nome de uma conexão existente.	connection-name
Description	string	Não	A descrição do destino da API. A descrição pode ter até 255 caracteres.	Description of the connection configuration
HttpApiParameters	object	Sim	As informações de configuração do destino da API.
Endpoint	string	Sim	O endereço do endpoint do destino da API. O endereço pode ter até 127 caracteres.	http://127.0.0.1:8001/api
Method	string	Sim	O método de solicitação HTTP. Valores válidos:\n- GET\n- POST\n- HEAD\n- DELETE\n- PUT\n- PATCH.	POST

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	5DAF96FB-A4B6-548C-B999-0BFDCB22****
Message	string	A mensagem retornada.	success
Code	string	O código de status da API ou código de erro POP. Valores válidos: Success: A operação foi bem-sucedida.	Success
Date	object	A estrutura de dados retornada após a criação bem-sucedida do destino da API.
ApiDestinationName	string	O nome do destino da API.	ApiDestinationName

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "5DAF96FB-A4B6-548C-B999-0BFDCB22****",
  "Message": "success",
  "Code": "Success",
  "Date": {
    "ApiDestinationName": "ApiDestinationName"
  }
}

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	RequestParameterInvalid	The ApiDestination name is invalid! Only letters a~z or A~Z, numbers 0~9, underscore (_) and dash (-) are supported.
409	ApiDestinationAlreadyExist	The api-destination already existed!
409	ConnectionNotExist	The Connection not existed!
409	HttpApiParametersIsNull	HttpApiParameters is null!
409	EndpointIsBlank	Endpoint is blank!
409	Method	Method is blank!
409	EndpointLengthExceed	Endpoint length cannot exceed 127!
409	ApiDestinationCountExceedLimit	The current count of api-destination is [{0}], which will exceed the limit quota.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.