Querying a Script List
Function
This API is used to query custom job script list.
The maximum of 100 script can be queried.
URI
GET /v1/job/scripts
Parameter |
Mandatory or Not |
Type |
Description |
---|---|---|---|
limit |
Yes |
Integer |
Pagination parameter: maximum number of records returned on each page. Minimum value: 1 Maximum value: 100 |
marker |
No |
Long |
Pagination parameter: ID of the last record on the previous page. Minimum value: 0 Maximum value: 9223372036854775807 |
name_like |
No |
String |
Script name (fuzzy) Minimum length: 1 character Maximum length: 32 characters |
creator |
No |
String |
Creator Minimum length: 1 character Maximum length: 64 characters |
risk_level |
No |
String |
Risk level. LOW: low risk. MEDIUM: medium risk. HIGH: high risk. The value can be:
|
type |
No |
String |
Script type. The options are as follows: SHELL: shell script; PYTHON: Python script; BAT: Bat script. The value can be:
|
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Long |
Total number of records Minimum value: 1 Maximum value: 9,223,372,036,854,775,807 |
data |
Array of ScriptListModel objects |
Data list on a single page Array length: 1 to 100 characters |
Parameter |
Type |
Description |
---|---|---|
id |
Long |
Script auto-increment ID. Minimum value: 1 Maximum value: 9,223,372,036,854,775,807 |
script_uuid |
String |
Script UUID. Minimum length: 1 character Maximum length: 25 characters |
name |
String |
Script name Minimum length: 1 character Maximum length: 64 characters |
type |
String |
Script type. The options are as follows: SHELL: shell script; PYTHON: Python script; BAT: Bat script. The value can be:
|
status |
String |
Script status. The options are as follows: PENDING_APPROVE: to be approved; APPROVED: normal (approved); REJECTED: rejected (approved by the reviewer) The value can be:
|
gmt_created |
Long |
Creation time. Minimum value: 1 Maximum value: 9,223,372,036,854,775,807 |
gmt_modified |
Long |
Modification time Minimum value: 1 Maximum value: 9,223,372,036,854,775,807 |
creator |
String |
Creator. Minimum length: 1 character Maximum length: 64 characters |
creator_id |
String |
Creator ID. Minimum length: 1 character Maximum length: 64 characters |
operator |
String |
Modifier. Minimum length: 1 character Maximum length: 64 characters |
properties |
ScriptPropertiesModel object |
Script label: risk_level (value range: LOW, MEDIUM, and HIGH) and reviewer |
Parameter |
Type |
Description |
---|---|---|
risk_level |
String |
Risk level. LOW: low risk; MEDIUM: medium risk; HIGH: high risk The value can be:
|
version |
String |
Script version number Minimum length: 1 character Maximum length: 10 characters |
reviewers |
Array of ReviewerInfo objects |
Approver. If this parameter is not specified, approval is not required. Array length: 0 to 5 characters |
protocol |
String |
Review message notification protocol, which is used to notify reviewers. DEFAULT: default; SMS: SMS; EMAIL: email; DING_TALK: DingTalk; WE_LINK: WeLink; WECHAT: WeChat; CALLNOTIFY: language; NOT_TO_NOTIFY: no notification The value can be:
|
Parameter |
Type |
Description |
---|---|---|
reviewer_name |
String |
Reviewer name (IAM username) Minimum length: 1 character Maximum length: 64 characters |
reviewer_id |
String |
Reviewer ID (IAM user ID) Minimum length: 0 character Maximum length: 32 characters |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code Minimum length: 8 characters Maximum length: 36 characters |
error_msg |
String |
Error description Minimum length: 2 characters Maximum length: 512 characters |
Request Example
None
Response Example
Status code: 400
Contains error information.
{ "error_code" : "COC.00040701", "error_msg" : "error_msg" }
Status Code
Status Code |
Description |
---|---|
200 |
Script pagination data. |
400 |
Contains error information. |
Error code
See Error code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.