Updated on 2025-10-29 GMT+08:00

Importing Resources

Function

This API is used to import resources. You need to fill in the downloaded template based on the data object types and descriptions specified for resources. Mandatory fields cannot be left empty. The backend will verify all fields during import.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/sa/resources/import

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

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Resource type.

provider

Yes

String

Resource provider.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

Yes

String

Definition

Language. Reference value: zh-cn or en-us.

Constraints

N/A

Range

zh-cn: Chinese environment

en-us: English environment

Default Value

N/A

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

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A

Table 4 FormData parameters

Parameter

Mandatory

Type

Description

uploadFile

Yes

File

Resource import file.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

data

data object

Returned data of alert import results.

Table 6 data

Parameter

Type

Description

batch_ids

Array of strings

IDs of the imported alerts.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Body of the response for importing resources.

Error Codes

See Error Codes.