Obtaining the Data Space List

Function

This API is used to obtain the data space list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/siem/dataspaces

**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
dataspace_name	No	String	dataspace name
dataspace_id	No	String	Data space ID.
offset	No	Long	Page number.
limit	No	Long	Number of records on each page.
sort_dir	No	String	Sorting order.
sort_key	No	String	Sorting field.

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
count	Long	Quantity.
records	Array of Dataspace objects	Data space list.

**Table 5** Dataspace
Parameter	Type	Description
create_by	String	Creator.
create_time	Long	Creation time.
dataspace_id	String	Workspace ID.
dataspace_name	String	Workspace name.
dataspace_type	String	Data space type. The value can be system-defined or user-defined.
description	String	Description.
domain_id	String	Account ID.
project_id	String	Project ID.
region_id	String	region ID
update_by	String	Updater.
update_time	Long	Update time.

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

Status code: 200

Successful.

{
  "count" : 10,
  "records" : [ {
    "create_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx",
    "create_time" : 1584883694354,
    "dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
    "dataspace_name" : "dataspace-01",
    "dataspace_type" : "system-defined",
    "description" : "test dataspace",
    "domain_id" : "0531ed520xxxxxxebedb6e57xxxxxxxx",
    "project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
    "region_id" : "cn-north-1",
    "update_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx",
    "update_time" : 1584883694354
  } ]
}