Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Cloud Operations Center/ API Reference/ API/ Script Management/ Obtaining Details About a Custom Script

Obtaining Details About a Custom Script

Updated on 2024-04-19 GMT+08:00

Function

This API is used to query details about a custom script.

URI

GET /v1/job/scripts/{script_uuid}

Table 1 Path parameters

Parameter

Mandatory or Not

Type

Description

script_uuid

Yes

String

Script UUID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

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

version

String

Script version number. The field will be discarded later. You are not advised to specify it.

Minimum length: 1 character

Maximum length: 16 characters

description

String

Script description

Minimum length: 1 character

Maximum length: 256 characters

type

String

Script type. The options are as follows: SHELL: shell script; PYTHON: Python script; BAT: Bat script.

The value can be:

  • SHELL
  • PYTHON
  • BAT

content

String

Script content

Minimum length: 1 character

Maximum length: 4096 characters

script_params

Array of ScriptParamDefine objects

Input parameter

Array length: 0 to 20 characters

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:

  • PENDING_APPROVE
  • APPROVED
  • REJECTED

gmt_created

Long

Creation time.

Minimum value: 1

Maximum value: 9,223,372,036,854,775,807

gmt_modified

Long

Update 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: 32 characters

operator

String

Modifier.

Minimum length: 1 character

Maximum length: 32 characters

properties

ScriptPropertiesModel object

Script label. Risk level (value range: LOW, MEDIUM, and HIGH), reviewer, and interpreter

Table 3 ScriptParamDefine

Parameter

Type

Description

param_name

String

The parameter name can contain only letters, digits, and underscores (_).

Minimum length: 1 character

Maximum length: 64 characters

param_value

String

Default value.

Minimum length: 0 character

Maximum length: 1,024 characters

param_description

String

Description of the parameter.

Minimum length: 0 character

Maximum length: 256 characters

param_order

Integer

Parameter sequence. The value starts from 1 and must be consecutive.

Minimum value: 1

Maximum value: 20

sensitive

Boolean

Whether a parameter is sensitive.

Table 4 ScriptPropertiesModel

Parameter

Type

Description

risk_level

String

Risk level. LOW: low risk; MEDIUM: medium risk; HIGH: high risk

The value can be:

  • LOW
  • MEDIUM
  • HIGH

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, review 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:

  • DEFAULT
  • SMS
  • EMAIL
  • DING_TALK
  • WE_LINK
  • WECHAT
  • CALLNOTIFY
  • NOT_TO_NOTIFY
Table 5 ReviewerInfo

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

Request Example

None

Response Example

None

Status Code

Status Code

Description

200

Details About a Custom Script

Error code

See Error code.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback