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
Situation Awareness
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/ Koo Command Line Interface/ FAQs/ Parameters/ How Do I Use cli-jsonInput?

How Do I Use cli-jsonInput?

Updated on 2023-03-13 GMT+08:00

Background

Tools such as the command prompt (cmd.exe) have restrictions on the allowed maximum string length. If there are too many parameters in a command or the parameter values are too long, the parameters entered may be incomplete due to the length limit. In this case, use --cli-jsonInput=${jsonFileName} to pass cloud service API parameters through a JSON file. KooCLI parses and uses the parameters in the JSON file to call the target API.

Usage Description

For details about how to use cli-jsonInput, see Passing API Parameters with JSON File.

Precautions

  • The JSON file passed by using the --cli-jsonInput option supports only API parameters of cloud services and does not support system parameters. If a parameter of the target API has the same name as a new system parameter or an old system parameter, the one written into the jsonInput file is identified as an API parameter by default.
  • In the JSON file passed by using the --cli-jsonInput option, KooCLI obtains and parses the parameter value based on the key at the outermost layer of JSON. Currently, the supported keys include path, query, body, formData, header, and cookie. The content under other keys at the outermost layer of JSON will be ignored. If none of the keys at this layer is supported, the following error message is displayed:

    [USE_ERROR] The cli-jsonInput file contains invalid content. For details, see...

  • When you use the --cli-jsonInput option to pass cloud service API parameters, all API parameters in the same position must be written into a JSON file or directly passed using a command. Otherwise, the parameters may not be completely parsed, and the following error message is displayed:

    [USE_ERROR] The following parameters are required: *

  • The --cli-jsonInput option supports only JSON files with the .json extension. The maximum file size is 5 MB. When --cli-jsonInput is used, the JSON file format and the parameter types in the file are verified. If the JSON file has incorrect format, the following error message is displayed:

    [USE_ERROR]Failed to parse file for the cli-jsonInput parameter. Cause: File contains invalid parameters.

    If the JSON file contains an unsupported parameter type, the following error message is displayed:

    [USE_ERROR] Value type of * is not supported.

  • When you use the --cli-jsonInput option to pass cloud service API parameters, parameter values cannot be custom parameters.

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