ENS:Integration overview

Version description

Online debugging

ENS supports API debugging in OpenAPI Explorer. Before you call API operations, review the following ENS-specific information: versions, endpoints, API styles, and calling methods.

On the ENS page in OpenAPI Explorer, the left-side navigation pane lists service categories such as instances, disks, snapshots, images, security groups, and networks. In the center pane, you can configure API parameters, select a service address, such as China (Hangzhou), and enter request parameters. The right-side pane displays API documentation—including information about API rate limits, request parameters, and response parameters—on the Documentation, Debugging Result, SDK Sample, and CLI Sample tabs.

Debugging

Access the ENS API debugging portal.

Endpoints

Use the endpoint of the Singapore region ens.ap-southeast-1.aliyuncs.com.

For more information, see Endpoints.

Identities

By default, OpenAPI Explorer uses your Alibaba Cloud account for online debugging. Because an Alibaba Cloud account has full API permissions, using it directly may pose security risks. We recommend that you use a Resource Access Management (RAM) user instead. Before you call API operations as a RAM user, grant the required permissions based on your business requirements. The RAM user must have permissions to manage ENS resources. For more information, see System policies for ENS.

We recommend that you grant only the minimum required permissions to a RAM user or RAM role and use that identity to call API operations.

References

• Identity, credential, and authorization

• Throttling and quota management

Calling methods

Alibaba Cloud SDKs

• Alibaba Cloud SDKs are available in Java, C#, Go, Python, TypeScript, Node.js, PHP, and C++. The SDKs encapsulate signature logic, timeout handling, and retry mechanisms, and return structured response objects. For more information, see Alibaba Cloud SDKs.

• You can use Alibaba Cloud SDKs to call ENS APIs. For supported languages and installation instructions, see 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 for previewing, configuring, and managing cloud infrastructure and resources. Similar to Resource Orchestration Service (ROS), Terraform interprets templates and calls API operations accordingly. 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	alicloud_ens_disk	Provides disks.ENS
  	alicloud_ens_disk_instance_attachment	Provides disk instance attachments.ENS
  	alicloud_ens_eip	Provides elastic IP addresses (EIPs).ENS
  	alicloud_ens_image	Provides image resources.ENS
  	alicloud_ens_instance	Provides instances.ENS
  	alicloud_ens_instance_security_group_attachment	Provides instance security group attachments.ENS
  	alicloud_ens_key_pair	Provides key pairs.ENS
  	alicloud_ens_load_balancer	Provides load balancers.ENS
  	alicloud_ens_network	Provides networks.ENS
  	alicloud_ens_security_group	Provides security groups.ENS
  	alicloud_ens_snapshot	Provides snapshots.ENS
  	alicloud_ens_vswitch	Provides vSwitches.ENS
  Data Sources	alicloud_ens_key_pairs	Provides key pairs of the current Alibaba Cloud user.ENS

ROS

• Resource Orchestration Service (ROS) simplifies cloud resource management. You can create templates that describe the required resources, such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, along with their dependencies. ROS then automatically creates and configures all resources for 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 construct and sign the requests yourself. For more information, see List of operations by function and Request syntax and signature method V3.