This topic describes the integration solutions supported by ENS. You can call API operations to implement automatic integration with ENS, improving the development efficiency of using ENS.
OpenAPI Explorer overview
Alibaba Cloud provides OpenAPI Explorer for you to efficiently understand and use the API operations of various Alibaba Cloud services. OpenAPI Explorer provides multiple features related to API operations, including intelligent search, documentation, online debugging, SDK download, sample code, error diagnostics, and call statistics. In OpenAPI Explorer, you can call the API operations of Alibaba Cloud services and view API requests and responses. In addition, OpenAPI Explorer automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services.
For more information, see Overview.
Version description
API version | Description |
We recommend that you use this version. |
Online debugging
ENS provides features such as API debugging in OpenAPI Explorer. Before you call API operations, you must understand the following information provided by ENS: versions, endpoints, API styles, and calling methods.
Debugging
API debugging page: Debugging.
Endpoints
Use the endpoint of the Singapore region ens.ap-southeast-1.aliyuncs.com
.
For more information, see Endpoints.
Identities
By default, after you log on to OpenAPI Explorer with your Alibaba Cloud account, the account is used to perform online debugging. An Alibaba Cloud account has permissions on all API operations. If you use an Alibaba Cloud account to call API operations, security risks may arise. We recommend that you call API operations or perform routine O&M as a Resource Access Management (RAM) user. Before you call API operations as a RAM user, grant the required permissions to the RAM user based on your business requirements. The RAM user must have the permissions to manage ENS resources. For more information, see System policies for ENS.
Identity | Supported |
Yes | |
RAM user (recommended) | Yes |
RAM role (recommended) | Yes |
We recommend that you grant only sufficient permissions to a RAM user or RAM role and call an operation as the RAM user or by assuming the RAM role.
References
Integration methods
Calling methods
Calling method | Supported |
Alibaba Cloud SDKs (recommended) | Yes |
Yes | |
Yes | |
Yes | |
Yes |
Alibaba Cloud SDKs
Alibaba Cloud provides SDKs in multiple programming languages, including Java, C#, Go, Python, TypeScript, Node.js, PHP, and C++. You can integrate SDKs into your applications to directly call API operations. The SDKs encapsulate information such as the signature logic, timeout mechanism, and retry mechanism and return structured response objects based on specifications. This provides convenience for developers. For more information, see Alibaba Cloud SDKs.
You can use Alibaba Cloud SDKs to call ENS API operations. For more information about supported languages and dependencies, visit the ENS SDK Center.
Alibaba Cloud CLI
You can use Alibaba Cloud CLI to call ENS API operations. For more information, see Sample commands.
You can run
aliyun
commands to interact with Alibaba Cloud services and manage cloud service resources. For more information, see What is Alibaba Cloud CLI?
Terraform
Terraform is an open source tool that is used to preview, configure, and manage cloud infrastructure and resources in a secure and efficient manner. Terraform works in a similar way as Resource Orchestration Service (ROS). Terraform calls API operations by interpreting templates. For more information, see What is Terraform?
For information about how to use Terraform to orchestrate ENS resources, see Resource integration by using Terraform.
Supported resources
You can use Terraform to manage ENS resources, including regular and data resources. For more information about Terraform, see What is Terraform?
Resource type
Resource name
Description
Resources
Provides disks.ENS
Provides disk instance attachments.ENS
Provides elastic IP addresses (EIPs).ENS
Provides image resources.ENS
Provides instances.ENS
Provides instance security group attachments.ENS
Provides key pairs.ENS
Provides load balancers.ENS
Provides networks.ENS
Provides security groups.ENS
Provides snapshots.ENS
Provides vSwitches.ENS
Data Sources
Provides key pairs of the current Alibaba Cloud user.ENS
ROS
ROS is an Alibaba Cloud service that can simplify the management of cloud computing resources. You can create a template to describe the required cloud computing resources such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, and the dependencies between the resources. ROS automatically creates and configures all resources based on the template to implement automated deployment and O&M. For more information, see What is ROS?.
You can use ROS to call API operations of ENS. Resources that can be orchestrated by using ROS include regular resources and data resources.
Regular resources:
ALIYUN::ENS::Disk: creates a pay-as-you-go or subscription data disk.
ALIYUN::ENS::DiskInstanceAttachment: attaches a data disk to an ENS instance.
ALIYUN::ENS::Instance: creates an ENS instance.
ALIYUN::ENS::InstanceSecurityGroupAttachment: adds an ENS instance to a security group.
ALIYUN::ENS::KeyPair: imports the public key of a Rivest-Shamir-Adleman (RSA)-encrypted key pair.
ALIYUN::ENS::Network: creates a virtual private cloud (VPC).
ALIYUN::ENS::NetworkAcl: creates a network access control list (ACL).
ALIYUN::ENS::NetworkAclAssociation: associates an ACL with networks.
ALIYUN::ENS::SecurityGroup: creates a security group.
ALIYUN::ENS::Snapshot: creates a snapshot.
ALIYUN::ENS::VSwitch: creates a vSwitch.
Data resources:
DATASOURCE::ENS::Instances: queries the details of ENS instances.
For information about how to use ROS to orchestrate ENS resources, see Resource integration by using ROS.
Custom API encapsulation
To make native HTTP calls, you must create custom requests and sign the requests. For more information about the signature mechanism, see List of operations by function and Request syntax and signature method V3.
Usage notes
If an error is returned after you call an API operation, check whether the request parameters and the parameter values are valid based on the returned error code. For more information, see Service error codes.
You can also use the Alibaba Cloud OpenAPI diagnostics platform to perform self-service diagnostics based on the returned request ID or SDK error message.