- What's New
- Function Overview
- Service Overview
- Billing
- Getting Started
-
User Guide
- Permissions Management
- Enterprise Routers
- Attachments
- Route Tables
- Associations
- Propagations
- Routes
-
Routing Control
-
Route Policies
- Route Policy Overview
- Creating a Route Policy
- Associating a Route Policy with an Enterprise Router
- Changing the Route Policy Associated with an Enterprise Router
- Disassociating a Route Policy from an Enterprise Router
- Modifying a Route Policy
- Viewing a Route Policy
- Deleting a Route Policy
- Adding a Policy Node to a Route Policy
- Modifying a Policy Node in a Route Policy
- Exporting Policy Nodes in a Route Policy
- Viewing a Policy Node in a Route Policy
- Deleting a Policy Node from a Route Policy
-
IP Prefix Lists
- IP Prefix List Overview
- Creating an IP Prefix List
- Modifying the Name of an IP Prefix List
- Viewing an IP Prefix List
- Deleting an IP Prefix List
- Adding a Prefix Rule to an IP Address Prefix List
- Modifying an IP Prefix Rule in an IP Prefix List
- Exporting Prefix Rules in an IP Prefix List
- Viewing a Prefix Rule in an IP Prefix List
- Deleting a Prefix Rule from an IP Prefix List
-
AS_Path Lists
- AS_Path List Overview
- Creating an AS_Path List
- Modifying the Name of an AS_Path List
- Viewing an AS_Path List
- Deleting an AS_Path List
- Adding an AS_Path Filter to an AS_Path List
- Exporting AS_Path Filters in an AS_Path List
- Viewing an AS_Path Filter in an AS_Path List
- Deleting an AS_Path Filter from an AS_Path List
-
Route Policies
- Sharing
- Flow Logs
- Monitoring and Auditing
- Tags
- Quotas
-
Best Practices
- Summary on Enterprise Router Best Practices
- Connecting VPCs Across Regions Using Enterprise Router and Central Network
- Using Enterprise Router to Isolate VPCs in the Same Region
- Using a Third-Party Firewall to Protect VPCs Connected by Enterprise Routers
- Enabling an On-Premises Data Center to Access Service VPCs Using an Enterprise Router and Transit VPC
- Setting Up a Hybrid Cloud Network Using Enterprise Router and Direct Connect Global DC Gateway
-
Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Direct Connect Connections (Global DC Gateway)
- Overview
- Network and Resource Planning
- Process of Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Direct Connect Connections (Global DC Gateway)
- Procedure for Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Direct Connect Connections (Global DC Gateway)
-
Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Active/Standby Direct Connect Connections (Global DC Gateway)
- Overview
- Network and Resource Planning
- Process of Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Active/Standby Direct Connect Connections (Global DC Gateway)
- Procedure for Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Active/Standby Direct Connect Connections (Global DC Gateway)
- Setting Up a Hybrid Cloud Network Using Enterprise Router, VPN, and Direct Connect (Global DC Gateway)
- Setting Up a Hybrid Cloud Network Using Enterprise Router and Direct Connect (Virtual Gateway)
- Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Direct Connect Connections (Virtual Gateway)
- Setting Up a Hybrid Cloud Network Using Enterprise Router, VPN, and Direct Connect (Virtual Gateway)
- Allowing VPCs to Share an EIP to Access the Internet Using Enterprise Router and NAT Gateway
- Using Enterprise Router to Migrate the Network Set Up Through VPC Peering
- Using Enterprise Router to Migrate the Network Set Up Through Direct Connect (Global DC Gateway)
- Using Enterprise Router and Central Network to Migrate the Network Set Up Through a Cloud Connection
- API Reference
- FAQs
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Getting Started
- Enterprise Routers
- Attachments
- Route Tables
- Associations
- Propagations
- Routes
- Sharing
- Flow Logs
- Monitoring
- Interconnecting with CTS
- Permissions Management
- Tags
- Quotas
- FAQ
- Change History
-
User Guide (Ankara Region)
- Service Overview
- Getting Started
- Permissions Management
- Enterprise Routers
- Attachments
- Route Tables
- Associations
- Propagations
- Routes
- Sharing
- Flow Logs
- Monitoring
- Quotas
- FAQ
- Change History
- API Reference (Ankara Region)
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Response
Status Code
After sending a request, you will receive a response, including a status code, response header, and response body.
A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Codes.
For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.
Response Header
Similar to a request, a response also has a header, for example, Content-Type.
Figure 1 shows the response header fields for the API used to obtain a user token. The X-Subject-Token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
For security purposes, you are advised to set the token in ciphertext in configuration files or environment variables and decrypt it when using it.
(Optional) Response Body
The body of a response is often returned in a structured format (for example, JSON or XML) as specified in the Content-Type header field. The response body transfers content except the response header.
The following is part of the response body for the API used to obtain a user token.
1 2 3 4 5 6 7 8 9 10 11 12 |
{ "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... |
If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
1 2 3 4 |
{ "error_msg": "The request message format is invalid.", "error_code": "IMG.0001" } |
In the response body, error_code is an error code, and error_msg provides information about the error.
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