Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Cloud Log Resources/ Listing Cloud Log Resources
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Listing Cloud Log Resources

Function

This API is used to list cloud log resources.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/siem/cloud-logs/resource

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Value Range

N/A

Default value

N/A

workspace_id

Yes

String

Workspace ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

region_id

No

String

Region ID.

offset

No

Long

Page number.

limit

No

Long

Number of records on each page.

sort_key

No

String

Sorting field.

sort_dir

No

String

Sorting order.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

datasets

Array of DatasetItem objects

Dataset list.

exist

Boolean

Whether the resource exists.

workspaces

Array of strings

Workspace list.
Table 5 DatasetItem

Parameter

Type

Description

alert

Boolean

Whether to trigger an alert.

allow_alert

Boolean

Whether to configure an alert.

allow_lts

Boolean

Whether to allow long-term storage.

create_time

Long

Creation time, which is a timestamp in milliseconds.

domain_id

String

Tenant ID, which uniquely identifies a tenant.

enable

String

Enabling status. For example, active indicates that the rule is enabled.

project_id

String

Project ID, which is unique.

region

Boolean

Whether the data is region-level data.

region_id

String

Region ID, which indicates the current region.

success

Boolean

Whether the operation is successful.

total

Integer

Total number of records.

update_time

Long

Update time, which is a timestamp in milliseconds.

workspace_id

String

Workspace ID, which uniquely identifies a workspace.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

400

Error response.

Error Codes

See Error Codes.

Parent topic: Cloud Log Resources