Event Bridge
- Release Notes and Announcements
- Product Introduction
- Getting Started
- Event Source
- Event
- Tencent Cloud Service Event
- Cloud Monitor Event
- Practical Tutorial
- Migrating Event Alarm
- API Documentation
- Making API Requests
- Event Rule APIs
- Event Storage APIs
- Delivery Target APIs
- Event Connector APIs
- Data Transformer APIs
ListTargets
Last updated: 2023-12-01 16:50:04
1. API Description
Domain name for API request: eb.tencentcloudapi.com.
This API is used to get the list delivery targets.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: ListTargets. |
| 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. |
| RuleId | Yes | String | Event rule ID |
| EventBusId | Yes | String | Event bus ID |
| OrderBy | No | String | Indicates by which field to sort the returned results. Valid values: AddTime (creation time), ModTime (modification time) |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Order | No | String | Indicates whether the returned results are sorted in ascending or descending order. Valid values: ASC (ascending order), DESC (descending order) |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of targets |
| Targets | Array of Target | Target information |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Getting the List of Targets
Input Example
POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListTargets
<Common request parameters>
{
"EventBusId": "eb-l65vlc2",
"RuleId": "rule-fdltium8"
}
Output Example
{
"Response": {
"RequestId": "03118ade-8de2-4514-af4b-b9a2f170ddd9",
"Targets": [
{
"EventBusId": "eb-l65vlc2u",
"RuleId": "rule-fdltium8",
"TargetDescription": {
"ResourceDescription": "qcs::scf:ap-guanzhou:uin/3473058547:namespace/default/function/test/1"
},
"TargetId": "target-azwj7s7g",
"Type": "scf",
"EnableBatchDelivery": false,
"BatchEventCount": 1,
"BatchTimeout": 1
},
{
"EventBusId": "eb-l65vlc2u",
"RuleId": "rule-fdltium8",
"TargetDescription": {
"ResourceDescription": "qcs::scf:ap-guanzhou:uin/3473058547:namespace/default/function/test/1"
},
"TargetId": "target-o5yx01oq",
"Type": "scf",
"EnableBatchDelivery": false,
"BatchEventCount": 1,
"BatchTimeout": 1
},
{
"EventBusId": "eb-l65vlc2u",
"RuleId": "rule-fdltium8",
"TargetDescription": {
"ResourceDescription": "qcs::scf:ap-guanzhou:uin/3473058547:namespace/default/function/test/1"
},
"TargetId": "target-prp1ovqi",
"Type": "scf",
"EnableBatchDelivery": false,
"BatchEventCount": 1,
"BatchTimeout": 1
},
{
"EventBusId": "eb-l65vlc2u",
"RuleId": "rule-fdltium8",
"TargetDescription": {
"ResourceDescription": "qcs::scf:ap-guanzhou:uin/3473058547:namespace/default/function/test/1"
},
"TargetId": "target-krcwchke",
"Type": "scf",
"EnableBatchDelivery": false,
"BatchEventCount": 1,
"BatchTimeout": 1
},
{
"EventBusId": "eb-l65vlc2u",
"RuleId": "rule-fdltium8",
"TargetDescription": {
"ResourceDescription": "qcs::scf:ap-guanzhou:uin/3473058547:namespace/default/function/test/1"
},
"TargetId": "target-e9r3a1l0",
"Type": "scf",
"EnableBatchDelivery": false,
"BatchEventCount": 1,
"BatchTimeout": 1
}
],
"TotalCount": 5
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue.EventBusId | The EventBusId value does not conform to the specification. Please fix it and try again. |
| InvalidParameterValue.Limit | The Limit value does not conform to the specification. Please fix it and try again. |
| InvalidParameterValue.Offset | The Offset value does not conform to the specification. Please fix it and try again. |
| InvalidParameterValue.Order | The Order value does not conform to the specification. Please fix it and try again. |
| InvalidParameterValue.OrderBy | The OrderBy 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.TargetId | The TargetId value does not conform to the specification. Please fix it and try again. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.EventBus | The specified event bus was not found. Please create it and try again. |
| ResourceNotFound.Rule | The specified Rule was not found. Please create it and try again. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No