Cloud Config provides a visual console and also supports OpenAPI, the Alibaba Cloud SDK, the Alibaba Cloud CLI. Select the integration method that best suits your requirements.
OpenAPI Explorer
OpenAPI Explorer is an all-in-one platform that combines API search, documentation, online debugging, SDK generation, code samples, error diagnosis, and call statistics. You can call APIs for various Alibaba Cloud services, view the requests and responses, and generate SDK sample code. For more information, see What is OpenAPI.
Version
Cloud Config currently supports API version 2020-09-07. This is a version identifier, not a date. The APIs under this version always provide the latest data and were not frozen on 2020-09-07.
|
Version |
Description |
|
Recommended |
Online debugging
OpenAPI Explorer lets you debug Cloud Config APIs online. Before calling an API, you need to know the API version, endpoints, and available integration methods.
For example, to debug the ListSupportedProducts operation, select it from the left-side navigation pane in OpenAPI Explorer. In the center panel, select a region, such as China (Shanghai), from the Service endpoint drop-down list. In the parameter section, enter a string for NextToken for pagination and an integer up to 500 for MaxResults. Click Send Request to debug the API.
Debug portal
To debug the Cloud Config APIs, go to: Cloud Config API Debugging
Endpoints
The endpoint for Cloud Config depends on your account's site, not the region. The following table lists the available endpoints.
|
Site |
Region |
Region ID |
Public endpoint |
VPC endpoint |
IPv6 |
|
China site |
China (Shanghai) |
cn-shanghai |
config.cn-shanghai.aliyuncs.com |
config-vpc.cn-shanghai.aliyuncs.com |
config-dualstack.cn-shanghai.aliyuncs.com |
|
International site |
Singapore |
ap-southeast-1 |
config.ap-southeast-1.aliyuncs.com |
config-vpc.ap-southeast-1.aliyuncs.com |
Not supported |
User identities
When you log on to OpenAPI Explorer with your Alibaba Cloud account, API calls use that account by default. Because an Alibaba Cloud account has full access to your resources, we strongly recommend using a RAM user with limited permissions for API calls and daily operations. Grant the RAM user the necessary permissions to manage Cloud Config resources before making calls. For more information, see Use RAM for access control.
|
Identity |
Supported |
|
Supported |
|
|
RAM user (recommended) |
Supported |
|
RAM role (recommended) |
Supported |
More information
Integration methods
We recommend using an SDK to call APIs. SDKs offer the easiest integration and the most comprehensive support.
Supported methods
|
Method |
Supported |
|
Alibaba Cloud SDK (recommended) |
Supported |
|
Supported |
|
|
Not supported |
|
|
Supported |
-
Alibaba Cloud SDK
-
Alibaba Cloud provides SDKs for Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. The SDKs handle request signing, timeouts, and retries, and return structured response objects. For more information, see Alibaba Cloud SDK.
-
You can use the Alibaba Cloud SDK to call Cloud Config APIs. For a list of supported languages and instructions on how to install dependencies, see Cloud Config SDK.
-
-
Alibaba Cloud CLI
-
The Alibaba Cloud CLI is a command-line tool built on Alibaba Cloud APIs for managing services and automating tasks in scripts. For more information, see What is the Alibaba Cloud CLI?
-
You can use the Alibaba Cloud CLI to call Cloud Config APIs.
-
-
Resource Orchestration Service (ROS)
-
Resource Orchestration Service (ROS) automates cloud resource deployment through templates. You define resources such as ECS instances and RDS database instances along with their dependencies, and ROS creates and configures them automatically. For more information, see What is Resource Orchestration Service.
-
Resource Orchestration Service (ROS) does not support calling Cloud Config APIs.
-
-
Direct HTTP requests
If you make direct HTTP requests, you must implement the signature algorithm, construct the request, and make the HTTP call. For more information about the signature mechanism, see Cloud Config API overview and V3 request body and signature mechanism.
Usage notes
If a Cloud Config API call returns an error, use the returned error code to check your request parameters and values.
You can also run self-service diagnostics on the Alibaba Cloud OpenAPI Diagnostic Platform by using the request ID or SDK error message from the response.
FAQ
-
Cloud Config helps you audit cloud resources by tracking configuration history and evaluating compliance against your policies. For more information, see What is Cloud Config?
-
In addition to Java, SDKs are available for C#, Go, Python, Node.js/TypeScript, PHP, and C++. For more information, see SDK reference.