Koo Command Line Interface
Koo Command Line Interface
- 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
On this page
Show all
Help Center/
Koo Command Line Interface/
FAQs/
Other/
How Do I Use KooCLI in Non-configuration Mode?
Copied.
How Do I Use KooCLI in Non-configuration Mode?
When using KooCLI in non-configuration mode, you do not need to pass your authentication information through a profile. Instead, directly pass your authentication parameters in commands. This mode enables you to use the CLI conveniently without adding any profiles. For details, see Using KooCLI in Non-configuration Mode.
Note the following when using the KooCLI in this mode:
- Using an AK/SK in non-configuration mode
- Access key (permanent AK/SK)
- When cloud service APIs are called using a permanent AK/SK, pass both the access key ID (cli-access-key) and secret access key (cli-secret-key) in commands for authentication.
- If a global service is to be accessed, the ID (cli-domain-id) of the account used to create the IAM user is also required for authentication. If the ID is not passed to the command, KooCLI automatically obtains it based on the user authentication information. However, if the cli-access-key or cli-secret-key parameter is missing or the cli-domain-id parameter fails to be automatically obtained, the following error message is displayed:
- [USE_ERROR] Parameters cli-access-key,cli-secret-key must be specified at the same time.
- [USE_ERROR] cli-domain-id is required for access to global services using AK/SK. Add this parameter or run `hcloud configure set` to configure it.
- If both an AK/SK and a profile (cli-profile) are specified in a command, the AK/SK is preferentially used for authentication.
- Temporary security credentials (temporary AK/SK and SecurityToken)
- Using a temporary AK/SK and SecurityToken to call cloud service APIs through KooCLI is similar to using a permanent AK/SK. If both an AK/SK (cli-access-key/cli-secret-key) and SecurityToken (cli-security-token) are passed in the command, the AK/SK is considered temporary.
- If a global service is to be accessed, the ID (cli-domain-id) of the account used to create the IAM user is also required for authentication. If the ID is not passed to the command, KooCLI automatically obtains it based on the user authentication information. However, if the cli-access-key or cli-secret-key parameter is missing or the cli-domain-id parameter fails to be automatically obtained, the following error message is displayed:
- [USE_ERROR] Parameters cli-access-key,cli-secret-key must be specified at the same time.
- [USE_ERROR] cli-domain-id is required for access to global services using AK/SK. Add this parameter or run `hcloud configure set` to configure it.
- If a temporary AK/SK, SecurityToken, and profile (cli-profile) are specified in a command, the AK/SK and SecurityToken are preferentially used for authentication.
- Access key (permanent AK/SK)
- Using an ECS agency in non-configuration mode
- This authentication mode applies only when you use KooCLI on an ECS.
- To use this mode, create a cloud service agency to delegate ECS to use the CLI on the IAM console, and add the agency in the Management Information > Agency area of the ECS details page. For details, see Cloud Service Delegation.
Parent topic: Other
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.
The system is busy. Please try again later.
For any further questions, feel free to contact us through the chatbot.
Chatbot