- Function Overview
- What's New
- Service Overview
- Getting Started
-
User Guide
- Configuration Management
- HTTP Proxy
- Commonly Used Commands
-
Options
- Option Overview
- Printing Help Information
- Printing Debugging Information
- Generating API Input Parameter Skeleton in JSON Format
- Checking Command
- Specifying Region
- Calling APIs with AK/SK in Non-configuration Mode
- Specifying Account ID
- Specifying Profile
- Specifying Authentication Mode
- Specifying Output Format
- Passing API Parameters with JSON File
- Specifying Request Timeouts
- Specifying Retry Count
- Skipping HTTPS Request Certificate Verification
- Specifying a Domain Name
- Polling Results
- Obtaining CLI Examples on API Explorer
- Using KooCLI in Non-configuration Mode
- Online Experience
- Obtaining Authentication Information
-
FAQs
- Overview
- Authentication
- Profiles
- Metadata Cache
- Logs
- Network Connections
- Cloud Services
- Cloud Service APIs
- Regions
-
Parameters
- What Are KooCLI System Parameters?
- Why Am I Seeing a Message Indicating an Invalid Parameter?
- Why Are Old and New KooCLI System Parameters (Such as region and cli-region) Available? Which Parameters Are Recommended?
- Why Am I Seeing a Message Indicating a Duplicate Parameter?
- How Do I Use cli-jsonInput?
- When Can I Use cli-jsonInput?
- Why Am I Seeing a Message Indicating an Unsupported Parameter Position or Type?
- How Do I Leave a Body Parameter Empty for Cloud Service APIs?
- Interactive Mode and Autocomplete
-
Output Formats
- What Output Formats Are Supported by KooCLI?
- How Do I Define a JMESPath Expression?
- Which KooCLI System Parameters Are Related to Data Output? Which Ones Are Recommended?
- How Do I Use cli-output, cli-query, and cli-output-num?
- How Do I Use cli-output-rows, cli-output-cols, and cli-output-num? What Are the Precautions?
- How Do I Use cli-json-filter? What Are the Precautions?
- Other
- Videos
- General Reference
Show all
Copied.
Why Are Old and New KooCLI System Parameters (Such as region and cli-region) Available? Which Parameters Are Recommended?
Background
Among the KooCLI system parameters, some have two forms, for example, --region and --cli-region. The parameters without the prefix cli- are old system parameters. Those with the prefix cli- are new system parameters. This happens because some parameters of cloud service APIs may have the same names as old system parameters. Two parameters with the same name in a command may be used for different purposes. That is, one is used as a parameter of the target API, and the other is used as a system parameter. When checking the validity of parameters, the following error message may be displayed:
[USE_ERROR] Duplicate *. Change the key of the KooCLI system parameter to cli-*.
In addition, if the cloud service API contains a parameter (or a custom one) with the same name as an old system parameter, KooCLI cannot determine the function if the API parameter appears in a command. Therefore, when parsing the command, the CLI confirms the actual function of the parameter with you through interactive information to prevent errors. Example:
- The target API contains a parameter with the same name as the KooCLI system parameter %s (unknown location %s). Confirm whether this parameter is a KooCLI system parameter (a), a target API parameter (b), or both (c):
- You can define a parameter for the target API using the same name as the KooCLI system parameter %s (unknown location %s). Confirm whether this parameter is a KooCLI system parameter (a), a target API parameter (b), or both (c):
When you construct KooCLI commands, use the new system parameters to prevent errors or interactions caused by parameter conflicts.
The new system parameters have been added to the new parameter list. The old system parameters can still be used but will not be upgraded.
Old System Parameters
The following table describes KooCLI's old system parameters and the corresponding new system parameters.
Old Parameter |
Description |
New Parameter |
---|---|---|
region |
Region. |
cli-region |
access-key |
Access key ID required in AK/SK mode. |
cli-access-key |
secret-key |
Secret access key required in AK/SK mode. |
cli-secret-key |
domain-id |
Account ID. |
cli-domain-id |
project-id |
Project ID. |
cli-project-id |
profile |
Profile. |
cli-profile |
mode |
Authentication mode (AKSK or ecsAgency). |
cli-mode |
jsonInput |
Passes API parameters using a JSON file. |
cli-jsonInput |
output-cols |
Specifies the fields to print during table output. |
cli-output-cols |
output-rows |
Specifies the levels to print during table output. |
cli-output-rows |
output-num |
Whether to print the row numbers during table output. The value can be true (default) or false. |
cli-output-num |
json-filter |
Performs a JMESPath query on the output JSON result. |
cli-json-filter |
connect-timeout |
Request connection timeout, in seconds. The default value is 5s, and the minimum value is 1s. |
cli-connect-timeout |
read-timeout |
I/O timeout, in seconds. The default value is 10s, and the minimum value is 1s. |
cli-read-timeout |
retry-count |
Specifies the number of connection attempts. The value ranges from 0 to 5. The default value is 0. |
cli-retry-count |
security-token |
Specifies a temporary token, which must be used together with a temporary AK/SK. |
cli-security-token |
lang |
Language, which can be cn or en. |
cli-lang |
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