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
On this page

Show all

KooCLI Concepts

Updated on 2024-06-12 GMT+08:00

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".

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