Obtaining the Event Target Catalog

This API is used to obtain the predefined target catalog of an event.

GET /v1/{project_id}/target-catalogs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.

**Table 2** Query Parameters
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).

**Table 3** Request header 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.

Status code: 200

**Table 4** Response body parameters
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.

**Table 5** CatalogTargetInfo
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.

**Table 6** CatalogTargetParameters
Parameter	Type	Description
name	String	Name of the target parameter.
label	String	Label of the target parameter.
metadata	Object	Metadata of the target parameter, for example, whether the parameter is mandatory and which text box type is used.

Obtain the event target catalog.

GET https://{endpoint}/v1/{project_id}/target-catalogs

Status code: 200

Operation successful.

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

Status Code	Description
200	Operation successful.

Parent topic: Event Target Catalog Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel