Before You Start

Overview

Welcome to the Data Encryption Workshop API Reference. DEW is a comprehensive data encryption service on the cloud. It provides Key Management Service (KMS), Dedicated Hardware Security Module (Dedicated HSM), and Key Pair Service (KPS). DEW uses HSMs to protect the security of your keys, and can be integrated with other Huawei cloud services to address data security, key security, and key management issues. Additionally, DEW enables you to develop customized encryption applications.

Before calling DEW APIs, ensure that you have understood the concepts related to DEW. For more information, see What Is DEW?

When interconnecting with KMS, retry is required. Error code such as 504, 502, 500, and 429 are included. Retry three to five times. For error codes 502 and 504, the timeout interval should be 5 to 8 seconds. Do not configure a long timeout interval. Otherwise, the client cannot respond.

API Calling

DEW supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS requests. For details about API calling, see Making an API Request.

Endpoints

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.

Constraints

In KMS, TPS (the number of API operations that can be performed by a user per second) is set to 20.

Concepts

• Accounts

  An account is created upon successful registration with the cloud platform. 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 used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.

• User

  An IAM user is created by an account in IAM to use cloud services. Each IAM user has its own identity credentials (password and access keys).

  The account name, username, and password will be required for API authentication.

• 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 as universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides services of the same type only or for specific tenants.

• Availability Zone (AZ)

  An AZ comprises one or multiple physical data centers equipped with independent ventilation, fire, water, and electricity facilities. Compute, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.

• Project

  A project corresponds to a region. Projects group and isolate resources (including compute, storage, and network resources) across physical regions. Users can be granted permissions in a default project to access all resources in the region associated with the project. For more refined access control, create subprojects under a project and create resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.

  Figure 1 Project isolation model
  
• Enterprise Project

  Enterprise projects group and manage resources across regions. Resources in enterprise projects are logically isolated from each other. An enterprise project can contain resources in multiple regions, and resources can be directly transferred between enterprise projects.

  For details about how to obtain enterprise project IDs and features, see Applicable Scenarios.

Selecting an API Type

For SSH key pairs, V3, V2.1, and V2 APIs are available. V3 APIs are recommended.