Help Center/ Distributed Cache Service/ API Reference (Ankara Region)/ Before You Start
Updated on 2024-11-26 GMT+08:00
View PDF
Share

Before You Start

Welcome to Distributed Cache Service (DCS). DCS is an online, distributed, in-memory cache service compatible with Redis. It is reliable, scalable, usable out of the box, and easy to manage, meeting your requirements for high read/write performance and fast data access.

In addition to the web console, you can also invoke APIs for managing your DCS O&M resources. This document describes how to use application programming interfaces (APIs) to perform operations on DCS, such as creating, deleting, and scaling up DCS instances. For details about all supported operations, see API Overview.

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

  • Some APIs are supported only in certain regions.
  • DCS is continuously upgraded with new functions, and the existing APIs are inevitably adjusted. For example, new response parameters may be added.
  • To reduce the impact of API changes, DCS is backward compatible with APIs when possible. However, when you use DCS, you should accept and ignore unused parameters and parameter values in returned content (in JSON format).

Endpoints

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. Contact the administrator to obtain regions endpoints.

Concepts

  • Account

    An account is created upon successful registration. 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. To ensure security, create Identity and Access Management (IAM) users and grant them permissions for routine management.

  • IAM user

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

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

  • Regions are geographic areas isolated from each other. Resources are region-specific and cannot be used across regions through internal network connections. For low network latency and quick resource access, select the nearest region.
  • An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, compute, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected by high-speed optical fibers for building 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 isolating model