- What's New
- Function Overview
- Service Overview
- Billing
- Getting Started
-
User Guide
- Permissions Management
- Elastic IP
- EIP Billing
- EIP Pool
- Shared Bandwidth
- Shared Data Package
- Global EIPs
- Global Internet Gateways
- Global Internet Bandwidths
- Global Connection Bandwidths
- Cloud Eye Monitoring
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- APIs
- API V3
- Native OpenStack Neutron APIs V2.0
- Application Examples
- Permissions Policies and Supported Actions
- Appendix
- SDK Reference
-
FAQs
-
Product Consultation
- Managing Quotas
- How Do I Assign or Retrieve a Specific EIP?
- Why Is an EIP Newly Assigned the Same as the One I Released?
- Can I Buy a Specific EIP?
- Does an EIP Change Over Time?
- Why Can't I Find My Purchased EIP on the Management Console?
- What Is the EIP Assignment Policy?
- Can an EIP Be Used or Migrated Across Accounts?
- How Do I Query the Traffic Usage of My EIP?
- Do I Need to Configure a Shared Data Package for Use After It Is Purchased?
- Can I Change the Dedicated Bandwidth Used by an EIP to a Shared Bandwidth?
- How Many ECSs Can I Bind an EIP To?
- What Are the Differences Between EIP, Private IP Address, and Virtual IP Address?
- What Are the Differences Among a Bandwidth Add-On Package, Shared Data Package, and Shared Bandwidth?
- When Should I Use Premium BGP and Are There Any Limitations on Using Premium BGP?
- Why My EIPs Are Frozen? How Do I Unfreeze My EIPs?
-
Billing and Payments
- How Is an EIP Billed?
- How Do I Change My EIP Billing Mode Between Pay-per-Use and Yearly/Monthly?
- How Do I Change the Billing Option of a Pay-per-Use EIP Between By Bandwidth and By Traffic?
- Why Am I Still Being Billed After My EIP Has Been Unbound or Released?
- When Will I Be Billed for Reservation Price?
-
EIP Binding and Unbinding
- How Do I Access an ECS with an EIP Bound from the Internet?
- How Can I Unbind an Existing EIP from an Instance and Bind Another EIP to the Instance?
- Can I Bind an EIP of an ECS to Another ECS?
- Can I Bind an EIP to a Cloud Resource in Another Region?
- Can Multiple EIPs Be Bound to an ECS?
- What Are the Differences Between Unbinding and Releasing an EIP?
-
Bandwidth
- How Do I Increase a Bandwidth to Be More Than 300 Mbit/s?
- What Bandwidth Types Are Available?
- How Many EIPs Can I Add to Each Shared Bandwidth?
- What Are the Differences Between a Dedicated Bandwidth and a Shared Bandwidth?
- What Are Inbound Bandwidth and Outbound Bandwidth?
- How Do I Know If My EIP Bandwidth Has Been Exceeded?
- What Are the Differences Between Public Bandwidth and Private Bandwidth?
- Can I Increase a Yearly/Monthly Bandwidth and Decrease It Later?
- What Is the Relationship Between Bandwidth and Upload/Download Rate?
- What Are the Differences Among Static BGP, Dynamic BGP, and Premium BGP?
-
Connectivity
- What Are the Priorities of the Custom Route and EIP If Both Are Configured for an ECS to Enable the ECS to Access the Internet?
- Why Can't My ECS Access the Internet Even After an EIP Is Bound?
- What Should I Do If an EIP Cannot Be Pinged?
- How Do I Unblock an EIP?
- Why Is There Network Jitter or Packet Loss During Cross-Border Communications?
- Why Does the Download Speed of My ECS Is Slow?
-
Product Consultation
- Videos
- Glossary
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Quick Start
-
Elastic IP
- EIP Overview
- Assigning an EIP and Binding It to an ECS
- Assigning an EIP
- Binding an EIP to an Instance
- Unbinding an EIP from an Instance
- Releasing an EIP
- Changing Dedicated Bandwidth Size of an EIP
- Unbinding an EIP from an ECS and Releasing the EIP
- Modifying an EIP Bandwidth
- Exporting EIP Information
- Managing EIP Tags
- Shared Bandwidth
- Monitoring
-
FAQs
-
Product Consultation
- What Is a Quota?
- How Do I Assign or Retrieve a Specific EIP?
- Why Is an EIP Newly Assigned the Same as the One I Released?
- What Are the Differences Between EIP, Private IP Address, and Virtual IP Address?
- Can an EIP That Uses Dedicated Bandwidth Be Changed to Use Shared Bandwidth?
- Can I Bind an EIP to Multiple ECSs?
- What Are the Differences Between the Primary and Extension NICs of ECSs?
- What Is the EIP Assignment Policy?
- Can I Assign a Specific EIP?
- Can a Bandwidth Be Used by Multiple Accounts?
- How Do I Unbind an EIP from an Instance and Bind a New EIP to the Instance?
- Why Can't I Find My Assigned EIP on the Management Console?
- EIP Binding and Unbinding
-
Bandwidth
- What Is the Bandwidth Size Range?
- How Do I Increase a Bandwidth to Be More Than 300 Mbit/s?
- What Bandwidth Types Are Available?
- Is There a Limit to the Number of EIPs That Can Be Added to Each Shared Bandwidth?
- What Are the Differences Between a Dedicated Bandwidth and a Shared Bandwidth?
- What Are Inbound Bandwidth and Outbound Bandwidth?
- How Do I Know If My EIP Bandwidth Limit Has Been Exceeded?
- What Are the Differences Between Public Bandwidth and Private Bandwidth?
- What Is the Relationship Between Bandwidth and Upload/Download Rate?
- Connectivity
-
Product Consultation
- Change History
- API Reference (ME-Abu Dhabi Region)
-
User Guide (Kuala Lumpur Region)
- Service Overview
- Quick Start
- EIP
- Shared Bandwidth
- Monitoring
-
FAQs
- Product Consultation
- EIP Binding and Unbinding
-
Bandwidth
- What Is the Bandwidth Size Range?
- What Bandwidth Types Are Available?
- Is There a Limit to the Number of EIPs That Can Be Added to Each Shared Bandwidth?
- What Are the Differences Between a Dedicated Bandwidth and a Shared Bandwidth? Can a Dedicated Bandwidth Be Changed to a Shared Bandwidth or the Other Way Around?
- Connectivity
- Change History
- API Reference (Kuala Lumpur Region)
- User Guide (Ankara Region)
- API Reference (Ankara Region)
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Authentication
- Token authentication: Requests are authenticated using tokens.
- AK/SK authentication: Requests are encrypted using AK/SK pairs. AK/SK authentication is recommended because it is more secure than token authentication.
Token Authentication
The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. You can obtain a token by calling the Obtaining User Token API.
EIP is a project-level service. When you call the API, set auth.scope in the request body to project.
{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", // IAM user name "password": "********", // IAM user password "domain": { "name": "domainname" //Name of the account to which the IAM user belongs } } } }, "scope": { "project": { "name": "xxxxxxxx" // Project Name } } } }
After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
1 2 3 |
POST https://{{endpoint}}/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... |
AK/SK Authentication
An AK/SK is used to verify the identity of a request sender. In AK/SK authentication, a signature needs to be obtained and then added to requests.
AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
SK: secret access key, which is used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.
The following uses a demo project to show how to sign a request and use an HTTP client to send an HTTPS request.
Download the demo project at https://github.com/api-gate-way/SdkDemo.
If you do not need the demo project, visit the following URL to download the API Gateway signing SDK:
Obtain the API Gateway signing SDK from the enterprise administrator.
Decompress the downloaded package to obtain a JAR file. Add the decompressed JAR file to the project as a dependency package. The following figure shows an example.

- Generate an AK/SK. (If you already have an AK/SK file, skip this step and find it. Generally, the file name is credentials.csv.)
- Log in to the management console.
- Click the username and select My Credentials from the drop-down list.
- In the navigation tree on the left, click Access Keys.
- Click Add Access Key.
- Enter an access key description and click OK.
- Enter the verification code received by email, SMS message, or MFA application.
NOTE:
If you have enabled operation protection (Security Settings > Critical Operations > Operation Protection), you need to enter the verification code.
For users created in IAM that have not bound with any email address or mobile number, only the login password needs to be entered.
- Download the access key file.
NOTE:
Keep the access key secure.
- Download and extract the demo project.
- Import the demo project to Eclipse.
Figure 2 Selecting Existing Projects into WorkspaceFigure 3 Selecting the demo projectFigure 4 Structure of the demo project
- Sign the request.
The signature method is integrated into the JAR file imported in 3. Before sending the request, you need to sign the requested content. The obtained signature is included in the HTTP header of the request.
The demo code is classified into the following classes to demonstrate signing and sending the HTTP request:
- AccessService: An abstract class that merges the GET, POST, PUT, and DELETE methods into the access method.
- Demo: Execution entry used to simulate the sending of GET, POST, PUT, and DELETE requests.
- AccessServiceImpl: Implements the access method, which contains the code required for communication with API Gateway.
- Edit the main method in the Demo.java file, and replace the bold text with actual values.
If you use other methods such as POST, PUT, and DELETE, see the corresponding comment.
Specify region, serviceName, ak/sk, and url as the actual values. In this demo, the URLs for accessing VPC resources are used.
To obtain the project ID in the URLs, see Obtaining a Project ID.
To obtain the endpoint, contact the enterprise administrator.
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 27 28 29 30 31 32 33 34 35 36 37 38
//TODO: Replace region with the name of the region in which the service to be accessed is located. private static final String region = ""; //TODO: Replace vpc with the name of the service you want to access. For example, ecs, vpc, iam, and elb. private static final String serviceName = ""; public static void main(String[] args) throws UnsupportedEncodingException { //TODO: Replace the AK and SK with those obtained on the My Credentials page. String ak = "ZIRRKMTWP******1WKNKB"; String sk = "Us0mdMNHk******YrRCnW0ecfzl"; //TODO: To specify a project ID (multi-project scenarios), add the X-Project-Id header. //TODO: To access a global service, such as IAM, DNS, CDN, and TMS, add the X-Domain-Id header to specify an account ID. //TODO: To add a header, find "Add special headers" in the AccessServiceImple.java file. //TODO: Test the API String url = "https://{Endpoint}/v1/{project_id}/vpcs"; get(ak, sk, url); //TODO: When creating a VPC, replace {project_id} in postUrl with the actual value. //String postUrl = "https://serviceEndpoint/v1/{project_id}/cloudservers"; //String postbody ="{\"vpc\": {\"name\": \"vpc\",\"cidr\": \"192.168.0.0/16\"}}"; //post(ak, sk, postUrl, postbody); //TODO: When querying a VPC, replace {project_id} in url with the actual value. //String url = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}"; //get(ak, sk, url); //TODO: When updating a VPC, replace {project_id} and {vpc_id} in putUrl with the actual values. //String putUrl = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}"; //String putbody ="{\"vpc\":{\"name\": \"vpc1\",\"cidr\": \"192.168.0.0/16\"}}"; //put(ak, sk, putUrl, putbody); //TODO: When deleting a VPC, replace {project_id} and {vpc_id} in deleteUrl with the actual values. //String deleteUrl = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}"; //delete(ak, sk, deleteUrl); }
- Compile the code and call the API.
In the Package Explorer area on the left, right-click Demo.java, choose Run AS > Java Application from the shortcut menu to run the demo code.
You can view API call logs on the console.
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