Elastic Compute Service
Elastic Compute Service
Elastic Compute Service
Document
Elastic Compute Service
What's New
Announcement
OpenAPI related
Pricing and quotas are related
About products and plugins
Feature discontinuation
Overview
Billing
Billable items
Billing methods
Billing methods change
Getting Started
User Guide
Instances
Instance types
X86 Computing
Elastic Bare Metal Server
Heterogeneous Computing
Select instance billing method
Spot instance
Elastic Scheduled Instance
Offsetting Resources
Reserved Instances
Buying ECS instances
Logging in to an instance
Logging in to a Linux instance
Managing instance status
Modifying instance types
Using instance user data and metadata
Instance metadata
Images
Public images
veLinux images
Custom images
Importing custom images
Creating custom images
Image detection
End of life (EOL) of image
Elastic Block Storage
Basic volume operations
Partitioning and formatting a volume
Extending a volume
EBS Agent
Snapshots
Basic snapshot operations
Auto snapshot policies
DataInsights
Network
Network interface and IP address
IP Address
IPv4 address
Security group
Security
Passwords and key pairs
Deployment and scaling
Monitoring
Monitoring metrics
Event monitoring
Local volume event O&M
Method 1: Solve the local volume failure by replacing the faulty volume
O&M
Cloud assistant
Managing agents
Process choreography
Common operation and maintenance tasks
Batch operations on instances
Batch operations on EBS Volumes
Batch operations on images
Temporary upgrade of bandwidth
Managing application updates
orchestration plan
Patch management
Managing patch plans
Managing patch baselines
IAM
Tags and projects
Best Practices
AI applications
OpenClaw (formerly Moltbot)
Quickly deploying OpenClaw via application templates
Quickly deploying OpenClaw via marketplace images
Manually deploying OpenClaw
Self-service website creation
Building environments
Building a Web environment (Windows)
Building applications
Building FTP site
Deploying databases
Building game servers
Building websites
Building a WordPress blog
Building multiple websites
Manage software sources for Linux instances
AIGC practices
Performance test
Network performance test
Instance configuration
Setting up AD Domain Services on Windows OS
Windows Multi - User Login
Changing screen resolution
Instance data
Uploading or downloading files
Data restoration
ECS instance local time synchronization
Volume
Monitoring
Security
Images
Kernel fine-tuning
O&M
Troubleshooting
Remote log in issue
Linux operating system issue
Windows operating system issue
SSH log in issue
Operating system issue
veLinux operating system issue
Linux operating system issue
Windows operating system issue
Instance status issue
Instance unable to start issue
High instance load issue
GPU instances issue
Network connection issue
Network configuration issue
Storage classes issue
EBS Volume issue
Local Disk issue
Logs and monitoring issue
Third - party software issue
API Reference
Regions and availability zones
Instances
Images
HPC clusters
Key pairs
Tags
Volumes
Reserved storage capacity
Snapshot
Auto snapshot policy
Monitoring
Deployment sets
Launch templates
Cloud assistant
Patch management
SDK reference
CLI Reference
FAQ
Dedicated Host DDH
What's New
Billing
User Guide
Manage Dedicated Host
Manage Dedicated Host Cluster
Manage ECS instances
Monitoring and O&M
API reference
proprietary host
- Documentation
Elastic Compute ServiceElastic Compute ServiceAPI ReferenceCall methodsRequest structure
Copy page
Download PDFCall methods
Request structure
Copy pageDownload PDFRequest structure
To call an OpenAPI API, send a request to the specified service endpoint and include the required signature information and API-specific business parameters. The structure of an OpenAPI request is organized as follows. An unencoded URL request for DescribeInstances is used as an example.
Example 1: GET request
Example 2: POST (form) request
GET /?Action=DescribeInstances&Version=2020-04-01&InstanceIds.1=i-3ti9101aju3vj0****** HTTP/1.1
Host: ecs.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: ecs
POST /?Action=DescribeInstances&Version=2020-04-01 HTTP/1.1
Host: ecs.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: ecs
--data-urlencode 'InstanceIds.1=i-3ti9101aju3vj0******' \
--data-urlencode 'MaxResults=1'
- GET and POST indicate request methods. The OpenAPI of ECS supports the following request methods:
- GET request.
- POST request with parameters submitted via a form.
- Action=DescribeInstances specifies the operation to be called, and Version=2020-04-01 specifies the API version.
- Host specifies the service endpoint. For more information, see Service address.
- Region and Service indicate the region and name of the service. For more information, refer to Common parameters.
- HTTP specifies the protocol of the request.
Communication protocols
Requests can be sent via either HTTP or HTTPS. We recommend that you use HTTPS for higher security.
Request methods
See the specific requirements of each API operation for request methods.
Warning
- The Action and Version parameters in the common parameters must be included in the query string.
- For GET requests, all parameters must be URL-encoded.
Request parameters
An OpenAPI request consists of two types of parameters: common parameters and API-specific parameters. Common parameters are required for every API call. For more information, see Common parameters. API-specific parameters are unique to each API. See the description of the specific API for details.
Character encoding
Requests and responses are encoded using the UTF-8 character set.
Last updated: 2026.06.18 17:48:23
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
