Help Center/ KooDrive/ API Reference/ Before You Start
Updated on 2025-03-07 GMT+08:00

Before You Start

Overview

KooDrive is an online service provided by Huawei Cloud for government and enterprise customers. It provides functions such as data storage, access, synchronization, management, and collaboration. It is a one-stop digital content center for enterprises and enables efficient knowledge collaboration.

This document describes how to use application programming interfaces (APIs) to perform operations on KooDrive, such as adding file directories, obtaining file details, and renaming files. For details about all supported operations, see API Overview.

If you plan to access KooDrive through an API, ensure that you are familiar with KooDrive concepts. For details, see Service Overview.

API Calling

KooDrive supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

Endpoints

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. Currently, KooDrive is deployed only in the AP-Singapore region, and the endpoint is intl.myhuaweicloud-koodrive.com.

Constraints

None

Concepts

  • Account

    An account is created upon successful registration with the cloud system. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be directly used to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.

  • User

    A KooDrive user is created by the tenant administrator (also called system administrator) in the KooDrive service plane. After a KooDrive user signs in to the service system, an Access-Token (AT) is generated. The AT is used for verification and authentication of subsequent API calling.

  • Region

    Regions are divided based on geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.

    For details, see Region and AZ.

  • AZ

    An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.