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
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
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
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
Huawei Cloud Astro Canvas
Huawei Cloud Astro Zero
CodeArts Governance
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 (CCI)
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
Cloud Transformation
Well-Architected Framework
Cloud Adoption Framework
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
Blockchain
Blockchain Service
Web3 Node Engine Service
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Huawei Cloud Astro Zero/ API Reference/ APIs/ Scripts/ Obtaining Script Signature Information

Obtaining Script Signature Information

Updated on 2025-03-21 GMT+08:00

Function

This API is used to obtain the script signature information, including script name, input and output parameters, declared class names, and method names. It is synchronous, meaning the invocation result is returned only after the function execution is complete.

This API can be called only when you save or save as a script. If the type of an input or output parameter defined in the script is incorrect, an error message is reported when this API is called.

URI

GET Huawei Cloud Astro Zero domain name/u-route/baas/script/v1.0/signature/{scriptName}{?version=1.0.1}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

scriptName

Yes

String

Explanation

Script name. For details, see Logging In to the Application Designer. Go to the application designer and view the script name in the Logic > Script list.

Constraints

None

Value

None

Default value

None

version

No

String

Explanation

Version number of the script. If this parameter is not set, the script of the latest version is executed.

Constraints

None

Value

None

Default value

None

Request Parameters

None

Response Parameters

Table 2 Response parameters

Parameter

Type

Description

resCode

String

Explanation

Return code.

Value

If the request is successful, 0 is returned. For details about other error codes, see Error Codes.

resMsg

String

Explanation

Message returned.

Value

If the request is successful, Success is returned. In other cases, an error message is returned.

result

result object

Explanation

Content returned when the request is successful.

Table 3 result parameters

Parameter

Type

Description

description

String

Explanation

Description of the script.

Value

None

script

String

Explanation

Name of a script.

Value

None

methodName

String

Explanation

Method name. The method name is available only after the @action.method is used in the script.

Value

None

methodObject

String

Explanation

Class that the method belongs to.

Value

None

input

String

Explanation

Input type. Generally, this parameter is set to Input.

Value

None

output

String

Explanation

Output type. Generally, this parameter is set to Output.

Value

None

label

String

Explanation

Label of the script.

Value

None

inputs

Array of inputs objects

Explanation

Variables of the input type.

outputs

Array of inputs objects

Explanation

Variables of the output type.

types

Object

Explanation

Name of the class that uses the @action.param annotation in the script.

Table 4 inputs and outputs parameters

Parameter

Type

Description

description

String

Explanation

Description of the script.

Value

None

name

String

Explanation

Name of the script.

Value

None

label

String

Explanation

Method name. The method name is available only after the @action.method is used in the script.

Value

None

message

String

Explanation

Error message returned when an invalid parameter is entered during script running.

Value

None

isCollection

String

Explanation

Whether the variable type is a collection.

Value

None

pattern

String

Explanation

Regular expression that a variable must comply with.

Value

None

valueType

String

Explanation

Type of the variable.

Value

None

required

String

Explanation

Whether the variable is mandatory.

Value

None

Example Request

To obtain the signature information of the Namespace__editEquipment script, send the following request:
GET https://Huawei Cloud Astro Zero domain name/u-route/baas/script/v1.0/signature/Namespace__editEquipment

Example Response

{
    "resCode": "0",
    "resMsg": "Success",
    "result": {
        "description": "",
        "input": "ActionInput",
        "inputs": [
            {
                "description": "",
                "isCollection": false,
                "label": "equipment",
"lengthInCharacter": false , ...
            }
        ],
        "label": "",
        "methodName": "editEquipment",
        "methodObject": "EditEquipment",
        "output": "ActionOutput",
        "outputs": [
            {
                "description": "",
                "isCollection": false,
                "label": "",
"lengthInCharacter": false , ...
            }
        ],
        "script": "Namespace__editEquipment,"
        "types": {
            "ActionInput": [
                {
                    "description": "",
                    "isCollection": false,
                    "label": "equipment",
"lengthInCharacter": false , ...
                }
            ],
            "ActionOutput": [
                {
                    "description": "",
                    "isCollection": false,
                    "label": "",
"lengthInCharacter": false , ...
                }
            ]
        }
    }
}

Status Code

See Status Codes.

Error Code

See Error Codes.

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