Integration overview

Version

Alibaba Cloud APIs are versioned to manage different releases. Cloud Config currently supports the API version 2020-09-07. This value 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.

Online debugging

You can use OpenAPI Explorer to 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.

User identities

When you log on to OpenAPI Explorer with your Alibaba Cloud account, API calls use that account by default. Since an Alibaba Cloud account has full access to your resources, this poses a security risk. We strongly recommend creating and using a RAM user with limited permissions for API calls and daily operations. You must grant the RAM user the necessary permissions to manage Cloud Config resources before making calls. For more information, see Use RAM for access control.

More information

• Identity, credentials, and authorization

• Throttling and quota management

Supported methods

• Alibaba Cloud SDK

  • Alibaba Cloud provides SDKs for multiple programming languages, including Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. You can integrate an SDK into your application to call APIs directly. The SDKs simplify development by handling common tasks such as request signing, timeouts, and retries, and by returning 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 (Command Line Interface) is a general-purpose tool built on our APIs for managing your Alibaba Cloud services from the command line. You can use the Alibaba Cloud CLI to interact with your services and automate 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. For details, see CLI integration examples.

• Terraform

  • Terraform is an open source tool that allows you to safely and efficiently preview, configure, and manage cloud infrastructure and resources. It operates similarly to Resource Orchestration Service (ROS). It converts templates into internal data to make OpenAPI calls. For more information, see What is Terraform on Alibaba Cloud?

  • Terraform supports orchestrating Cloud Config. For the supported resource types and data sources, see Cloud Config Terraform resources and data sources.

  • To get started quickly with Terraform to orchestrate Cloud Config, see Use Terraform to create a delivery channel.

• Resource Orchestration Service (ROS)

  • Resource Orchestration Service (ROS) is an Alibaba Cloud service that simplifies cloud resource management. Developers and administrators can write templates to define the required Alibaba Cloud resources, such as ECS instances and RDS database instances, and the dependencies between resources. The ROS orchestration engine then automatically creates and configures all resources based on the template, which enables automated deployment and O&M. 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.