ApsaraDB for MongoDB:Integration overview

API versions

API version numbers indicate major versions. The current version forApsaraDB for MongoDB is 2015-12-01. Despite its date-like format, this number does not reflect the last update date.

Online debugging

ApsaraDB for MongoDB supports API debugging in OpenAPI Explorer. Before calling an API operation, review its version, endpoint, and calling method inApsaraDB for MongoDB.

For example, the CreateDBInstance operation page lists API categories on the left, a parameter form (RegionId, ZoneId, Engine, EngineVersion, DBInstanceClass, DBInstanceStorage, etc.) in the middle, and reference documentation on the right. Click Initiate Call to run the request.

Debugging page

Debug API operations at: https://api.alibabacloud.com/api/Dds/2015-12-01/.

Endpoints

Select an endpoint based on the region of your resource. For example, anApsaraDB for MongoDB instance in the China (Zhangjiakou) region uses public endpointmongodb.cn-zhangjiakou.aliyuncs.com and VPC endpointmongodb-vpc.cn-zhangjiakou.aliyuncs.com.

• Public endpoints are accessible globally.

• VPC endpoints are accessible only within the VPC in the corresponding region and offer these benefits:

  • Higher security and privacy.

  • Lower latency by avoiding public Internet overhead.

  • Lower cost through internal network communication.

Endpoints.

Supported identities

OpenAPI Explorer uses your Alibaba Cloud account for debugging by default. Because an Alibaba Cloud account has full API permissions, we recommend that you use a RAM user for routine API calls and O&M. Grant the RAM user the required permissions on ApsaraDB for MongoDB instances. Use RAM to implement access control. The following table lists the supported user identities.

SDKs

• Alibaba Cloud provides SDKs for Java, C#, Go, Python, TypeScript, Node.js, PHP, and C++. The SDKs handle signature logic, timeouts, and retries, and return structured response objects. Alibaba Cloud SDKs.

• OpenAPI Explorer generates SDK code samples for calling ApsaraDB for MongoDB API operations. Supported languages and dependencies:ApsaraDB for MongoDB SDK.

Alibaba Cloud CLI

• Alibaba Cloud CLI lets you run aliyun commands to manage cloud resources. What is Alibaba Cloud CLI

• Call ApsaraDB for MongoDB API operations through Alibaba Cloud CLI. Call API in the RPC and RESTful styles.

• Step-by-step walkthrough for calling ApsaraDB for MongoDB API operations with Alibaba Cloud CLI: CLI integration example.

Terraform

• Terraform is an open source tool for previewing, configuring, and managing cloud infrastructure. Like ROS, Terraform converts templates into API calls. What is Alibaba Cloud Terraform?

• Step-by-step walkthrough for orchestrating ApsaraDB for MongoDB resources with Terraform: Terraform integration examples.

ROS

• ROS is an Alibaba Cloud service that simplifies cloud resource management. You create templates to define resources (such as ECS and ApsaraDB RDS instances) and their dependencies, and ROS automatically creates and configures them. What is Resource Orchestration Service

• You can use ROS to manage ApsaraDB for MongoDB. Supported resource types:

  • Common resources:

    • ALIYUN::MONGODB::Instance: creates an ApsaraDB for MongoDB instance.

    • ALIYUN::MONGODB::ServerlessInstance: creates an ApsaraDB for MongoDB serverless instance.

    • ALIYUN::MONGODB::ShardingInstance: creates or clones an ApsaraDB for MongoDB sharded cluster instance.

  • Data resources:

    • DATASOURCE::MONGODB::Instances: queries ApsaraDB for MongoDB instances.

    • DATASOURCE::MONGODB::InstanceClasses: queries the ApsaraDB for MongoDB instance types available in a zone.

• Step-by-step walkthrough for orchestrating ApsaraDB for MongoDB resources with ROS: Resource orchestration integration example.

Custom encapsulation

If none of the preceding methods meet your requirements, you can manually encapsulate API requests. This method is not recommended. Request syntax and signature method V3.