Querying Scripts
Function
Queries scripts.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v2/{project_id}/scripts
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Query offset. The default value is 0. |
limit |
No |
Integer |
The number of records for each query ranges from 1 to 100. The default value is 10. |
id |
No |
String |
Script ID. |
name |
No |
String |
Script name. |
type |
No |
String |
Script type. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total number. |
scripts |
Array of ScriptSimpleInfo objects |
Scripts. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Script ID. |
name |
String |
Script name. |
description |
String |
Description. |
type |
String |
Script type: POWERSHELL, BAT, or SHELL. |
version |
String |
Script version. |
create_time |
DateTime |
Creation time. |
update_time |
DateTime |
Update time. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 405
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 503
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Example Requests
None
Example Responses
Status code: 200
Response to a successful request.
{ "count" : 0, "scripts" : [ { "id" : "string", "name" : "string", "description" : "string", "type" : "string", "version" : "string", "create_time" : "2024-12-25T07:09:33.224Z", "update_time" : "2024-12-25T07:09:33.224Z" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Response to a successful request. |
400 |
The request cannot be understood by the server due to malformed syntax. |
401 |
Authentication failed. |
403 |
No operation permissions. |
404 |
No resources found. |
405 |
The method specified in the request is not allowed. |
500 |
An internal service error occurred. For details, see the error code description. |
503 |
Service unavailable. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot