- What's New
- Function Overview
- Product Bulletin
- Service Overview
-
Billing
- Billing Overview
- Billing Modes
- Billed Items
- Billing Examples
- Billing Mode Changes
- Renewing Subscriptions
- Bills
- Arrears
- Billing Termination
- Cost Management
-
Billing FAQ
- How Is CBR Billed?
- What Is the Billing Cycle of Pay-per-Use Vaults?
- How Do I Disable CBR?
- How Do I Unsubscribe from CSBS or VBS Resource Packages?
- Why Is a Message Displayed Indicating Insufficient User Rights When I Create a Policy?
- What Can I do If a Yearly/Monthly-Billed Vault Is About to Expire?
- How Do I Unsubscribe from a Vault?
- What Should I Do If the Fee Is Too High When I Expand the Capacity of a Vault?
- Can I Change a Server Backup Vault to a Disk Backup Vault or the Other Way Around?
- Why Are CBR Backups Displayed on the VBS Console?
- What Charges Will I Incur When Using a Backup to Create an Image?
- How Do I Purchase a CBR Replication Traffic Package?
- Can I Change the Protection Type of an Existing Vault?
- What Resources Do I Need to Implement Cross-Region Backup Replication?
- Why AM I Still Being Billed After a Resource is Deleted?
- Getting Started
-
User Guide
- Management permissions
-
Vault Management
- Overview
- Viewing a Vault
- Deleting a Vault
- Associating Resources to a Vault
- Dissociating Resources from a Vault
- Migrating Resources from a Vault
- Expanding Vault Capacity
- Reducing Vault Capacity
- Changing from Pay-per-Use to Yearly/Monthly
- Changing Vault Specifications
- Replicating a Vault Across Regions
- Managing Vault Tags
- Managing the Enterprise Projects of Vaults
- Enabling Backup Locking
- Backup Management
- Policy Management
- Organizational Policy Management
- Application-Consistent Backup
- File Backup (Supported Conditionally)
-
Restoring Data
- Restoring from a Cloud Server Backup
- Creating an Image from a Cloud Server Backup
- Restoring from a Cloud Disk Backup
- Creating a Disk from a Cloud Disk Backup
- Creating a File System from an SFS Turbo Backup
- Restoring from a Desktop Backup
- Restoring from a File Backup
- Restoring from a Hybrid Cloud Backup
- (Optional) Migrating Resources from CSBS/VBS
- Managing Tasks
- Cloud Eye Monitoring
- Recording CBR Operations Using CTS
- Quotas
- Appendix
-
Hybrid Cloud Backup Feature Guide
- Hybrid Cloud Backup
- Application Scenarios
- Constraints and Limitations
-
VMware Backup
- VMware Backup Process
- Downloading and Installing eBackup
- Configuring eBackup
- Adding a VMware Protected Environment
- Preparing for VMware Backup Storage
- Performing VMware Backup
- Restoring Data Using VMware Backups
- Managing a Protected VMware Environment
- Managing VMware Backup Storage
- Managing VMware Backups
- Common Operations
-
Best Practices
-
Using a Custom Script to Implement Application-Consistent Backup
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Verifying the Application-Consistent Backup Result
- Protecting SQL Server
- Troubleshooting a Custom Script Error
- Performing Periodic Recovery Drills Using the Backup Data
- Creating Backup Policies Based on Service Tiering
-
Using a Custom Script to Implement Application-Consistent Backup
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
CBR APIs
- Tasks
- Protection
- Backups
- Backup Sharing
-
Vaults
- Creating a Vault
- Querying a Specified Vault
- Querying the Vault List
- Modifying a Vault
- Deleting a Vault
- Dissociating Resources
- Associating Resources
- Applying a Policy to a Vault
- Removing a Policy from a Vault
- Querying the Vault List in Other Regions
- Migrating Resources
- Batch Modifying Vaults
- Setting Auto Backup for a Vault
- Creating a Yearly/Monthly Vault
- Querying Vault Usage of a Project
- File Backup
- Tags
- Policies
- Organizational Policies
- Metering
- Operations
- Restore Points
- Projects
- Application Cases
- Permissions Policies and Supported Actions
- Appendix
- SDK Reference
-
Troubleshooting
- Failed to Execute a Backup Task
- Failed to Delete a Backup
- Failed to Expand the Vault Capacity
- Failed to Attach Disks
- Data Disks Are Not Displayed After a Windows Server Is Restored
- Failed to Cancel Backup Sharing
- Failed to Download or Install the Agent Required by Application-Consistent
- Failed to Install the Agent on Windows
- Failed to Implement Application-Consistent Backup
- A Server Created Using an Image Enters Maintenance Mode After Login
- Failed to Migrate VMware Backups to the Cloud
- Failed to Restore a VMware Backup to a Cloud Server
- An Error Message Is Displayed Indicating that the Path of a Storage Unit Is Invalid
- Failed to Import an eBackup Image Template, with an Error Displayed Indicating That the File Is Invalid
- The Download Dialog Box Disappears When I Download eBackup on a VMware VM
- File Backup Failed Due to Inconsistent Time Between Backup Client and UTC Time
-
FAQs
- Concepts
-
Billing
- How Is CBR Billed?
- What Is the Billing Cycle of Pay-per-Use Vaults?
- How Do I Disable CBR?
- How Do I Unsubscribe from CSBS or VBS Resource Packages?
- Why Is a Message Displayed Indicating Insufficient User Rights When I Create a Policy?
- What Can I do If a Yearly/Monthly-Billed Vault Is About to Expire?
- How Do I Unsubscribe from a Vault?
- What Should I Do If the Fee Is Too High When I Expand the Capacity of a Vault?
- Can I Change a Server Backup Vault to a Disk Backup Vault or the Other Way Around?
- Why Are CBR Backups Displayed on the VBS Console?
- What Charges Will I Incur When Using a Backup to Create an Image?
- How Do I Purchase a CBR Replication Traffic Package?
- What Resources Do I Need to Implement Cross-Region Backup Replication?
-
Backup
- Do I Need to Stop the Server Before Performing a Backup?
- Can I Back Up a Server Deployed with Databases?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CBR Support Cross-Region Backup?
- How Do I Migrate Server Data Across Regions Using Server Backups?
- Can I Back Up Two Disks to One Target Disk?
- How Do I Replicate a Disk to the Same AZ in a Region as the Source Disk?
- Can I Migrate Backups Between Vaults?
- Can I Use Its Backup for Restoration After a Resource Is Deleted?
- How Many Backups Can I Create for a Resource?
- Can I Use an Incremental Backup to Restore Data After a Full Backup Is Deleted?
- Can I Stop an Ongoing Backup Task?
- How Do I Reduce the Vault Space Occupied by Backups?
- How Do I View the Size of Each Backup?
- How Do I View My Backup Data?
- How Long Will My Backups Be Kept?
- How Do I Implement Periodic Full Backups for My Resources?
- How Do I Query Resources that Have not Been Backed Up?
- Is There Any Requirement on the Network Bandwidth During Data Backup?
-
Capacity
- How Large of a Vault Do I Need?
- Why Is My Backup Size Larger Than My Disk Size?
- What Can I Do If the Vault Capacity Is Not Enough?
- Why Does the Used Capacity of a Vault Change Only Slightly After I Deleted Unwanted Backups?
- Will Backup Continue If the Usage of a Vault Reaches the Upper Limit?
- How Do I Adjust the Vault Capacity Alarm Threshold?
-
Restoration
- Do I Need to Stop the Server Before Restoring Data Using Backups?
- Can I Use a System Disk Backup to Recover an ECS?
- Do I Need to Stop the Server Before Restoring Data Using Disk Backups?
- Can a Server Be Restored Using Its Backups After It Is Changed?
- Can a Disk Be Restored Using Its Backups After Its Capacity Is Expanded?
- What Can I Do if the Password Becomes a Random One After I Use a Backup to Restore a Server or Use an Image to Create a Server?
- What Changes Will Be Made to the Original Backup When I Use the Backup to Restore a Server?
- How Do I Restore Data to a New Server?
- How Do I Restore a Data Disk Backup to a System Disk?
- Can I Use CBR to Restore Data to Any Point When the Data Was Backed Up?
- Can I Stop an Ongoing Restoration Task?
-
Policies
- How Do I Configure Automatic Backup for a Server or Disk?
- Why the New Retention Rule I Changed Is Not Applied?
- How Do I Back Up Multiple Resources at a Time?
- How Do I Retain My Backups Permanently?
- How Can I Cancel Auto Backup or Auto Replication?
- How Can I Have the System Automatically Delete Backups That I No Longer Need?
- Why Aren't My Backups Deleted Based on the Retention Rule?
- Optimization
-
Others
- Is There a Quota for CBR Vaults?
- Can I Merge My Vaults?
- How Do I Delete a Backup That Has Been Used to Create an Image While Retaining the Image?
- Can I Export Disk Backup Data to Another Server?
- Why Do I Need a Vault to Accept the Image Shared to Me?
- Can I Download Backup Data to a Local PC?
- How Do I Copy Disk Data to Another Account?
- Videos
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Getting Started
- Vault Management
- Backup Management
- Policy Management
- Restoring Data
- Managing Tasks
- Monitoring
- Quotas
-
FAQs
- Concepts
- Billing
-
Backup
- Do I Need to Stop the Server Before Performing a Backup?
- Can I Back Up a Server Deployed with Databases?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CBR Support Cross-Region Backup?
- Can I Back Up Two Disks to One Target Disk?
- How Do I Replicate a Disk to the Same AZ in a Region as the Source Disk?
- Will the Server Performance Be Affected If I Delete Its Backups?
- Can I Use Its Backup for Restoration After a Resource Is Deleted?
- How Many Backups Can I Create for a Resource?
- Can I Use an Incremental Backup to Restore Data After a Full Backup Is Deleted?
- Can I Stop an Ongoing Backup Task?
- How Do I Reduce the Vault Space Occupied by Backups?
- How Do I View the Size of Each Backup?
- How Do I View My Backup Data?
- How Long Will My Backups Be Kept?
- Capacity
-
Restoration
- Do I Need to Stop the Server Before Restoring Data Using Backups?
- Can I Use a System Disk Backup to Recover an ECS?
- Do I Need to Stop the Server Before Restoring Data Using Disk Backups?
- Can a Server Be Restored Using Its Backups After It Is Changed?
- Can a Disk Be Restored Using Its Backups After Its Capacity Is Expanded?
- What Can I Do if the Password Becomes a Random One After I Use a Backup to Restore a Server or Use an Image to Create a Server?
- What Changes Will Be Made to the Original Backup When I Use the Backup to Restore a Server?
- How Do I Restore Data to a New Server?
- Can I Stop an Ongoing Restoration Task?
-
Policies
- How Do I Configure Automatic Backup for a Server or Disk?
- Why the New Retention Rule I Changed Is Not Applied?
- How Do I Back Up Multiple Resources at a Time?
- How Do I Retain My Backups Permanently?
- How Can I Cancel Auto Backup?
- How Can I Have the System Automatically Delete Backups That I No Longer Need?
- Why Aren't My Backups Deleted Based on the Retention Rule?
- Optimization
-
Others
- Is There a Quota for CBR Vaults?
- Can I Merge My Vaults?
- How Do I Delete a Backup That Has Been Used to Create an Image While Retaining the Image?
- Can I Export Disk Backup Data to Another Server?
- Why Do I Need a Vault to Accept the Image Shared to Me?
- Can I Download Backup Data to a Local PC?
- How Do I Copy Disk Data to Another Account?
- Troubleshooting Cases
- Appendix
- API Reference (ME-Abu Dhabi Region)
-
Best Practices (ME-Abu Dhabi Region)
-
Using a Custom Script to Implement Application-Consistent Backup
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Troubleshooting a Custom Script Error
- Verifying the Application-Consistent Backup Result (Linux)
- Verifying the Application-Consistent Backup Result (Windows)
- Protecting SQL Server in Failover Cluster Mode
- Protecting SQL Server in Always on Availability Groups Mode
- Change History
-
Using a Custom Script to Implement Application-Consistent Backup
-
User Guide (Paris)
- Service Overview
- Getting Started
- Vault Management
- Backup Management
- Policy Management
- Restoring Data
- Application-Consistent Backup
- (Optional) Migrating Resources from CSBS/VBS
- Managing Tasks
- Monitoring
- Auditing
- Quotas
-
FAQs
- Concepts
-
Backup
- Do I Need to Stop the Server Before Performing a Backup?
- Can I Back Up a Server Deployed with Databases?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CBR Support Cross-Region Backup?
- Can I Back Up Two Disks to One Target Disk?
- How Do I Replicate a Disk to the Same AZ in a Region as the Source Disk?
- Will the Server Performance Be Affected If I Delete Its Backups?
- Can I Use Its Backup for Restoration After a Resource Is Deleted?
- How Many Backups Can I Create for a Resource?
- Can I Use an Incremental Backup to Restore Data After a Full Backup Is Deleted?
- Can I Stop an Ongoing Backup Task?
- How Do I Reduce the Vault Space Occupied by Backups?
- How Do I View the Size of Each Backup?
- How Do I View My Backup Data?
- How Long Will My Backups Be Kept?
- Capacity
-
Restoration
- Do I Need to Stop the Server Before Restoring Data Using Backups?
- Can I Use a System Disk Backup to Recover an ECS?
- Do I Need to Stop the Server Before Restoring Data Using Disk Backups?
- Can a Server Be Restored Using Its Backups After It Is Changed?
- Can a Disk Be Restored Using Its Backups After Its Capacity Is Expanded?
- What Can I Do if the Password Becomes a Random One After I Use a Backup to Restore a Server or Use an Image to Create a Server?
- What Changes Will Be Made to the Original Backup When I Use the Backup to Restore a Server?
- How Do I Restore Data to a New Server?
- How Do I Restore a Data Disk Backup to a System Disk?
- Can I Stop an Ongoing Restoration Task?
-
Policies
- How Do I Configure Automatic Backup for a Server or Disk?
- Why the New Retention Rule I Changed Is Not Applied?
- How Do I Back Up Multiple Resources at a Time?
- How Do I Retain My Backups Permanently?
- How Can I Cancel Auto Backup or Auto Replication?
- How Can I Have the System Automatically Delete Backups That I No Longer Need?
- Why Aren't My Backups Deleted Based on the Retention Rule?
- Optimization
-
Others
- Is There a Quota for CBR Vaults?
- Can I Merge My Vaults?
- How Do I Delete a Backup That Has Been Used to Create an Image While Retaining the Image?
- Can I Export Disk Backup Data to Another Server?
- Why Do I Need a Vault to Accept the Image Shared to Me?
- Can I Download Backup Data to a Local PC?
- How Do I Copy Disk Data to Another Account?
- Troubleshooting Cases
- Appendix
- API Reference (Paris)
-
Best Practices (Paris)
-
Using a Custom Script to Implement Application-Consistent Backup
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Troubleshooting a Custom Script Error
- Verifying the Application-Consistent Backup Result (Linux)
- Verifying the Application-Consistent Backup Result (Windows)
- Protecting SQL Server in Failover Cluster Mode
- Protecting SQL Server in Always on Availability Groups Mode
- Performing Periodic Recovery Drills Using the Backup Data
- Creating Backup Policies Based on Service Tiering
- Change History
-
Using a Custom Script to Implement Application-Consistent Backup
-
User Guide (Kuala Lumpur Region)
- Service Overview
- Getting Started
- Permissions Management
- Vault Management
- Backup Management
- Policy Management
- Restoring Data
- Application-Consistent Backup
- Managing Tasks
- Monitoring
- Quotas
-
FAQs
- Concepts
-
Backup
- Do I Need to Stop the Server Before Performing a Backup?
- Can I Back Up a Server Deployed with Databases?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CBR Support Cross-Region Backup?
- Will the Server Performance Be Affected If I Delete Its Backups?
- Can I Use Its Backup for Restoration After a Resource Is Deleted?
- How Many Backups Can I Create for a Resource?
- Can I Stop an Ongoing Backup Task?
-
Restoration
- Do I Need to Stop the Server Before Restoring Data Using Backups?
- Can I Use a System Disk Backup to Recover an ECS?
- Do I Need to Stop the Server Before Restoring Data Using Disk Backups?
- Can a Server Be Restored Using Its Backups After It Is Changed?
- Can a Disk Be Restored Using Its Backups After Its Capacity Is Expanded?
- What Can I Do if the Password Becomes a Random One After I Use a Backup to Restore a Server or Use an Image to Create a Server?
- What Changes Will Be Made to the Original Backup When I Use the Backup to Restore a Server?
- Can I Stop an Ongoing Restoration Task?
- Policies
- Others
- Troubleshooting Cases
- Appendix
- API Reference (Kuala Lumpur Region)
-
Best Practices (Kuala Lumpur Region)
-
Using a Custom Script to Implement Application-Consistent Backup
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Troubleshooting a Custom Script Error
- Verifying the Application-Consistent Backup Result (Linux)
- Verifying the Application-Consistent Backup Result (Windows)
- Protecting SQL Server in Failover Cluster Mode
- Protecting SQL Server in Always on Availability Groups Mode
- Change History
-
Using a Custom Script to Implement Application-Consistent Backup
-
User Guide (Ankara Region)
- Service Overview
- Getting Started
- Permissions Management
- Vault Management
- Backup Management
- Policy Management
- Restoring Data
- Application-Consistent Backup
- Managing Tasks
- Monitoring
- Quotas
-
FAQs
- Concepts
-
Backup
- Do I Need to Stop the Server Before Performing a Backup?
- Can I Back Up a Server Deployed with Databases?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CBR Support Cross-Region Backup?
- Will the Server Performance Be Affected If I Delete Its Backups?
- Can I Use Its Backup for Restoration After a Resource Is Deleted?
- How Many Backups Can I Create for a Resource?
- Can I Stop an Ongoing Backup Task?
- Capacity
-
Restoration
- Do I Need to Stop the Server Before Restoring Data Using Backups?
- Can I Use a System Disk Backup to Recover an ECS?
- Do I Need to Stop the Server Before Restoring Data Using Disk Backups?
- Can a Server Be Restored Using Its Backups After It Is Changed?
- Can a Disk Be Restored Using Its Backups After Its Capacity Is Expanded?
- What Can I Do if the Password Becomes a Random One After I Use a Backup to Restore a Server or Use an Image to Create a Server?
- What Changes Will Be Made to the Original Backup When I Use the Backup to Restore a Server?
- Can I Stop an Ongoing Restoration Task?
- Policies
- Others
- Troubleshooting Cases
- Appendix
- API Reference (Ankara Region)
-
Best Practices (Ankara Region)
-
Using a Custom Script to Implement Application-Consistent Backup
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Troubleshooting a Custom Script Error
- Verifying the Application-Consistent Backup Result (Linux)
- Verifying the Application-Consistent Backup Result (Windows)
- Protecting SQL Server in Failover Cluster Mode
- Protecting SQL Server in Always on Availability Groups Mode
- Change History
-
Using a Custom Script to Implement Application-Consistent Backup
-
User Guide (ME-Abu Dhabi Region)
- Glossary
- General Reference
Copied.
Making an API Request
This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.
Request URI
A request URI is in the following format:
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
Parameter |
Description |
---|---|
URI-scheme |
Protocol used to transmit requests. All APIs use HTTPS. |
Endpoint |
Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints. |
resource-path |
Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens. |
query-string |
Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of Parameter name=Parameter value. For example, ? limit=10 indicates that a maximum of 10 data records will be displayed. |
To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
Request Methods
Method |
Description |
---|---|
GET |
Requests the server to return specified resources. |
PUT |
Requests the server to update specified resources. |
POST |
Requests the server to add resources or perform special operations. |
DELETE |
Requests the server to delete specified resources, for example, an object. |
HEAD |
Same as GET except that the server must return only the response header. |
PATCH |
Requests the server to update partial content of a specified resource. If the resource does not exist, a new resource will be created. |
For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
1 |
POST https://{{endpoint}}/v3/auth/tokens |
Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.
Parameter |
Description |
Mandatory |
Example Value |
---|---|---|---|
Host |
Specifies the server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is in the format of Hostname:Port number. If the port number is not specified, the default port is used. The default port number for https is 443. |
No This field is mandatory for AK/SK authentication. |
code.test.com or code.test.com:443 |
Content-Type |
Specifies the type (or format) of the message body. The default value application/json is recommended. Other values of this field will be provided for specific APIs if any. |
Yes |
application/json |
Content-Length |
Specifies the length of the request body. The unit is byte. |
No |
3495 |
X-Project-Id |
Specifies the project ID. Obtain the project ID by following the instructions in Obtaining a Project ID. |
No This field is mandatory for requests that use AK/SK authentication in the Dedicated Cloud (DeC) scenario or multi-project scenario. |
e9993fc787d94b6c886cbaa340f9c0f4 |
X-Auth-Token |
Specifies the user token. It is a response to the API for obtaining a user token (This is the only API that does not require authentication). After the request is processed, the value of X-Subject-Token in the response header is the token value. |
No This field is mandatory for token authentication. |
The following is part of an example token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ |
In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDKs to sign a request. During the signature, the Authorization (signature authentication) and X-Sdk-Date (time when a request is sent) headers are automatically added in the request.
For more details, see "Authentication Using AK/SK" in Authentication.
The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:
1 2 |
POST https://{{endpoint}}/v3/auth/tokens Content-Type: application/json |
(Optional) Request Body
This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the Content-Type header field. The request body transfers content except the request header.
The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with the actual values. Obtain a project name from Regions and Endpoints.
The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see "Obtaining a User Token".
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
POST https://{{endpoint}}/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } |
If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, X-Subject-Token is the desired user token. This token can then be used to authenticate the calling of other APIs.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot