Obtaining the Event Target Catalog
Function
This API is used to obtain the predefined target catalog of an event.
URI
GET /v1/{project_id}/target-catalogs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant resource space ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Offset, which is the position where the query starts. The value must be greater than or equal to 0. |
limit |
No |
Integer |
Number of records displayed on each page. The value must be within the range [1, 1000]. |
sort |
No |
String |
Sorting mode of the query results. |
fuzzy_label |
No |
String |
Label of the event target. It is used for fuzzy match. |
support_types |
No |
Array of strings |
Supported type of the event target, which can be SUBSCRIPTION (event subscription) or FLOW (event flow). |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of records. |
size |
Integer |
Number of records displayed on the current page. |
items |
Array of CatalogTargetInfo objects |
Object list. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID of the event target catalog. |
name |
String |
Name of the event target catalog. |
label |
String |
Label of the event target catalog. |
description |
String |
Description of the event target catalog. |
provider_type |
String |
Provider type, which can be OFFICIAL (official cloud service event target) and CUSTOM (third-party event target). |
parameters |
Array of CatalogTargetParameters objects |
Event target category parameters. |
created_time |
String |
UTC time when the catalog is created. |
updated_time |
String |
UTC time when the catalog is updated. |
Example Requests
Obtain the event target catalog.
GET https://{endpoint}/v1/{project_id}/target-catalogs
Example Responses
Status code: 200
Operation successful.
{ "total" : 1, "size" : 1, "items" : [ { } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Operation successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot