- 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.
KooCLI Concepts
This topic describes common terms related to KooCLI.
- Command
Commands are operation instructions provided by KooCLI to configure the working environment or call open APIs of cloud services.
The format of an API calling command is as follows:
hcloud [options] <service> <operation> [--param1=paramValue1 --param2=paramValue2 ...]
The format of a system command is as follows:
hcloud [options] <systemCommand> <operation> [--param1=paramValue1 --param2=paramValue2 ...]
In the following command for querying Elastic Cloud Servers (ECSs), service is ECS, operation is NovaListServers, and the common information required for calling the API is obtained from the profile named default:
hcloud ECS NovaListServers --cli-profile=default
- Operation
A unique name for a cloud service API released on API Explorer. You can query the operation list of a cloud service by using API Explorer or by running the hcloud <service> --help command.
- Profile
Profiles store common information required for calling cloud service APIs. They can be defined by running KooCLI commands. All profiles constitute a configuration file, which is stored on your local host. When calling a cloud service API, you can specify a profile rather than manually inputting the common information.
The common information that can be set in a profile includes the access key (AK/SK), region (cli-region), project ID (cli-project-id), and account ID (cli-domain-id).
- Default profile
The profile to be used by default if no profile is specified in a command. KooCLI takes the profile that is last added or modified as the default. If the default profile is deleted, the earliest added profile among the remaining ones is used as the new default. You can run the hcloud configure set --cli-profile=${profileName} command to change the default profile.
- Parameter
Parameters are classified into API parameters and KooCLI system parameters. API parameters are defined in cloud service APIs. System parameters are built-in parameters of KooCLI. The system parameters are used in a fixed mode and have specific meanings. For details, see the system parameter list.
- Option
Options are KooCLI system parameters that can be directly added to commands for calling APIs. Not all system parameters can be used as options. For details, see the option list.
- Metadata
Details about cloud services and their APIs that are obtained by KooCLI during command execution to verify and parse parameters. Remotely obtained metadata is stored locally to reduce network I/O and improve command response. A file that stores metadata is called a metadata cache file. For details, see Managing Metadata.
When using the offline mode, KooCLI downloads existing metadata, which is called an "offline metadata package".
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