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 ReferenceInstancesDescribeUserData - Queries instance custom data
Copy page
Download PDFInstances
DescribeUserData - Queries instance custom data
Copy pageDownload PDFDescribeUserData - Queries instance custom data
Call the DescribeUserData operation to query the custom data of an ECS instance.
Usage notes
- The returned custom data of the instance is in Base64-encoded format.
- If no custom data is specified for the instance, an empty value is returned.
- For information about how to configure custom data for an instance, see Configuring custom data.
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.
Action string required Sample value: DescribeUserData
The operation that you want to perform. Valid value: DescribeUserData.
Version stringrequired Sample value: 2020-04-01
The API version. Value: 2020-04-01.
ScheduledInstanceId string Optional Sample value: esi-ycvye5a380l8j1ld****
ESI order ID.
InstanceId string required Sample value: i-l8j0j2jynelea7nu****
The ID of the instance that you want to query.
Response parameters
Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.
InstanceId string Sample value: i-l8j0j2jynelea7nu****
The instance ID.
ScheduledInstanceId string Sample value: esi-ycvye5a380l8j1ld****
ESI order ID.
UserData string Sample value: IyEvYmluL2Jhc2gKdG91Y2ggL3RtcC91c2VyZG******
The custom data of the instance.
Sample request
GET /?Action=DescribeUserData&Version=2020-04-01&InstanceId=i-l8j0j2jynelea7nu**** HTTP/1.1
Host: ecs.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: ecs
Sample response
{
"ResponseMetadata": {
"RequestId": "2021110417394001022514606307D7****",
"Action": "DescribeUserData",
"Version": "2020-04-01",
"Service": "ecs",
"Region": "cn-beijing"
},
"Result":{
"InstanceId":"i-l8j0j2jynelea7nu****",
"UserData":"IyEvYmluL2Jhc2gKdG91Y2ggL3RtcC91c2VyZG******"
}
}
Error codes
The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.
Status code | Error codes | Error message | Description |
Status code | Error codes | Error message | Description |
400 | MissingParameter.InstanceId | The required parameter InstanceId is not supplied. | The instance ID cannot be left empty. |
404 | InvalidInstance.NotFound | The specified instance does not exist. | The specified instance does not exist. |
500 | InternalError | An internal error has occurred. | An internal error occurred. Try again. If multiple attempts fail, submit a ticket. |
Last updated: 2026.06.18 17:48:24
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
