Querying Code Snippets

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

Workspace ID.

code_segment_id

No

String

Code snippet ID.

code_segment_name

No

String

Code snippet name.

offset

No

Long

Definition

Offset.

Constraints

N/A

Range

N/A

Default Value

N/A

limit

No

Long

Definition

Data query limit.

Range

0-1000

Default Value

N/A

sort_key

No

String

Sorting by attribute.

sort_dir

No

String

Sorting order. The value can be ASC or DESC.

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

count

Integer

Count.

records

Array of CodeSegment objects

Code snippet.

code_segment_id

String

UUID

project_id

String

Project ID.

workspace_id

String

Workspace ID.

code_negment_name

String

Code snippet name.

description

String

Code snippet description.

code

String

Code snippet.

create_by

String

IAM user ID.

create_time

Integer

Timestamp, in ms.

update_by

String

IAM user ID.

update_time

Integer

Timestamp, in ms.

error_code

String

Error code.

error_msg

String

Error description.

200

Request succeeded.

400

Error response