Domain name for API request: eb.tencentcloudapi.com.
This API is used to create a delivery target.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: CreateTarget. |
Version | Yes | String | Common Params. The value used for this API: 2021-04-16. |
Region | No | String | Common Params. This parameter is not required for this API. |
EventBusId | Yes | String | Event bus ID |
Type | Yes | String | Target type |
TargetDescription | Yes | TargetDescription | Target description |
RuleId | Yes | String | Event rule ID |
Parameter Name | Type | Description |
---|---|---|
TargetId | String | Target ID |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTarget
<Common request parameters>
{
"EventBusId": "eb-xxxxxx",
"Type": "scf",
"TargetDescription": {
"ResourceDescription": "qcs::scf:ap-guangzhou:uin/xxxxxxxx:namespace/xxxxxx/function/xxxxx/x"
},
"RuleId": "rule-xxxxxxx"
}
{
"Response": {
"RequestId": "b7662cf2-ce20-4b3e-aff2-2cb875cf0b6b",
"TargetId": "target-xxxxxx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
FailedOperation.AddPrivateLink | Failed to add the private link |
FailedOperation.AuthenticateUserFailed | User authentication failed |
FailedOperation.CreateTrigger | Failed to create the delivery target. Please check the function status. |
FailedOperation.ESInternalError | ES cluster internal error |
FailedOperation.ESRequestFailed | ES cluster operation failure |
FailedOperation.ESTemplateConflict | ES indexing template conflict |
InvalidParameter.Payload | Payload does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.AMPParams | The AMPParams value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.BatchEventCount | The BatchEventCount value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.BatchTimeout | The BatchTimeout value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.CKafkaTargetParams | The CKafka parameter is invalid. Please check and try again. |
InvalidParameterValue.CallbackType | The CallbackType value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.CallbackWeComURL | The CallbackWeComURL value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.ElasticSearchTargetParams | ES target parameter error |
InvalidParameterValue.EventBusId | The EventBusId value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.NoticeReceiverChannel | The NoticeReceiverChannel value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.NoticeReceiverTimeWindow | The NoticeReceiverTimeWindow value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.NoticeReceiverUserIds | The NoticeReceiverUserIds value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.NoticeReceiverUserType | The NoticeReceiverUserType value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.Qualifier | The Qualifier value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.RuleId | The RuleId value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.TargetDescription | The TargetDescription value does not conform to the specification. Please fix it and try again. |
InvalidParameterValue.Type | The Type value does not conform to the specification. Please fix it and try again. |
LimitExceeded.ClusterPrivateLinkExceeded | Reached the upper limit of cluster private links |
LimitExceeded.Logset | The Logset quantity has reached the upper limit. You can submit a ticket to increase it. |
LimitExceeded.Target | The Target quantity has reached the upper limit. You can submit a ticket to increase it. |
LimitExceeded.Trigger | Failed to create the delivery target, as the number of function triggers has reached the limit. You can submit a ticket to increase it. |
LimitExceeded.UserPrivateLinkExceeded | Reached the upper limit of private links for the user |
OperationDenied.AccountNotExists | Failed to create the delivery target, as it was detected that the current account did not exist. Please check your account status. |
OperationDenied.DefaultCLSResourceUnsupported | You cannot create a CLS event target based on the default EventBridge logset in the custom event bus. |
OperationDenied.ESVersionUnsupported | The current ES version is not supported. |
OperationDenied.EventBusResourceIsLocked | Due to service upgrade, this resource is locked. It may last for about 3-5 minutes. Event pushing is not affected. |
OperationDenied.UnsupportedOperation | The current user account type does not support this operation. Please submit a ticket. |
ResourceNotFound.EventBus | The specified event bus was not found. Please create it and try again. |
ResourceNotFound.Function | The specified Function was not found. Please create it and try again. |
ResourceNotFound.Namespace | Failed to create the delivery target, as the specified namespace was not found. Please create it and try again. |
ResourceNotFound.PrivateLinkResource | The privatelink is not found. |
ResourceNotFound.Role | The specified service role was not found. Please create it and try again. |
ResourceNotFound.Rule | The specified Rule was not found. Please create it and try again. |
ResourceNotFound.Target | The specified Target was not found. Please create it and try again. |
ResourceNotFound.Version | Failed to create the delivery target, as the specified service version was not found. Please create it and try again. |
ResourceUnavailable.ESUnhealth | ES cluster status error |
ResourceUnavailable.Target | Failed to create the delivery target, as the current resource was unavailable. |
Was this page helpful?