Updated on 2023-02-27 GMT+08:00

Overview

Koo Command Line Interface (KooCLI) classifies command errors into five types, each of which has a different identifier at the start of the error message. Troubleshoot the errors as follows:

  • [NETWORK_ERROR]: HTTP request exceptions. Check the network connection.
  • [CLI_ERROR]: KooCLI exceptions that occur during command processing. Contact the on-call personnel of KooCLI.
  • [USE_ERROR]: Errors caused by an incorrect parameter in a command. Modify the parameter according to the error message.
  • [OPENAPI_ERROR]: Errors that occur when calling a cloud service API. Contact the on-call personnel of the cloud service.
  • [APIE_ERROR]: Errors that occur when calling API Explorer to obtain metadata. Contact the on-call personnel of API Explorer.

Alternatively, you can look through the following FAQs to find required information.

Table 1 FAQs

Category

Link

Authentication

How Do I Obtain a Permanent AK/SK?

How Do I Obtain an Account Name, Account ID, and Project ID?

How Do I Obtain a Region?

How Do I Obtain a Token?

How Do I Obtain a Temporary AK/SK and SecurityToken?

Authentication Mode Priority

Profiles

Which Profile Will Be Used by Default If No Profile Is Specified in a Command?

Metadata cache

Where Are Metadata Cache Files Stored? How Do I Clear Them?

Logs

Where Are Log Files Stored?

Network connections

What Can I Do If the Network Connection Times Out?

Cloud services

Why Am I Seeing a Message Indicating an Unsupported Service?

Cloud service APIs

Why Am I Seeing a Message Indicating an Unsupported Operation?

How Do I Specify a Cloud Service API and Its Version?

Regions

Why Am I Seeing a Message Indicating that the cli-region Parameter Is Missing?

Why Am I Seeing a Message Indicating Unsupported cli-region?

Parameters

What Are KooCLI System Parameters?

Why Am I Seeing a Message Indicating an Invalid Parameter?

Why Are Old and New 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

How Do I Use Interactive Mode and Autocomplete?

Output formats

What Output Formats Are Supported by KooCLI?

How Do I Use JMESPath Expressions?

Which Built-in Functions Are Supported by JMESPath?

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 for Using cli-output-rows, cli-output-cols, and cli-output-num?

How Do I Use cli-json-filter?

What Are the Precautions for Using cli-json-filter?

Other

How Do I Use KooCLI in Non-configuration Mode?

Should I Enclose a Service Name, Operation, and Parameter Value in Quotation Marks in a Command?

What Are the Application Scenarios of Online/Offline Modes?

How Do I Uninstall KooCLI?