Help Center/ Config/ API Reference/ Before You Start
Updated on 2024-10-22 GMT+08:00

Before You Start

Config allows you to centrally record, search for, and evaluate your resources to ensure resource compliance.

This document describes the Config APIs. Parameter description and examples are provided. You can use provided APIs to perform operations on Config. For details about all supported operations, see API Overview.

Before using Config APIs, ensure that you are familiar with Config concepts. For details, see What Is Config.

Config supports Representational State Transfer (REST) APIs. 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. For the Config endpoint, see Regions and Endpoints.

Concepts

  • Organization

    An organization is an entity that you can create with the Organizations service to centrally manage multiple accounts. You can also use service control policies to control resource access for your organization. This helps you better meet security and compliance requirements.

  • Account

    An account is created upon successful registration. An 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, which 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 through 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 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 comprises of one or more physical data centers equipped with independent ventilation, fire suppression, moisture-proof, and power facilities. Computing, 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 allow you to build cross-AZ, high-availability systems.

  • Project

    There is a default project autamatically configured for each region. Default projects physically isolate resources (including compute, storage, and network resources) across regions. If you grant users permissions by project, the users can access all resources in the corresponding projects. If you need more refined access control, create subprojects under a default project and add resources to subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.

    Figure 1 Project-based resource isolation
  • Enterprise Project

    An enterprise project is more flexible than an IAM project. Enterprise projects isolate resources logically. You can include resources from different regions to an enterprise project and transfer resources between enterprise projects.

    For details about enterprise projects and about how to obtain enterprise project IDs, see Enterprise Management User Guide.

Querying Data by Page

Some Config APIs support pagination query if you add limit and marker to the request URL. To get the next page of results, you need to set the marker to the value of marker obtained from your last response.

Table 1 Config parameter description

Parameter

Type

Mandatory

Description

limit

Integer

No

Restricts the number of records displayed on each page. If limit is invalid, error code 400 will be returned.

marker

String

No

The marker value returned in the last pagination query. If marker is invalid, error code 400 will be returned.