Help Center/ Anti-DDoS/ API Reference/ API Calling/ Authentication
Updated on 2024-09-12 GMT+08:00
View PDF

Authentication

AK/SK-based Authentication

An AK/SK is used to verify the identity of a request sender. In AK/SK-based 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 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, obtain the API Gateway signing SDK from the enterprise administrator.

Decompress the downloaded package and reference the obtained JAR files as dependencies.

Figure 1 Importing a JAR file
  1. Generate an AK/SK. If an AK/SK pair is already available, skip this step and go to 2. Find the downloaded AK/SK file, which is usually named credentials.csv.

    1. Register an account and log in to the management console.
    2. Click the username and choose My Credential from the drop-down list.
    1. On the My Credentials page, choose Access Keys in the navigation pane.
    2. Click Add Access Key.
    3. Click OK. Download the access key after it is created.

      Keep the access key secure.

  2. Download and decompress the demo project.
  3. Import the demo project to Eclipse.

    Figure 2 Selecting Existing Projects into Workspace
    Figure 3 Selecting the demo project
    Figure 4 Structure of the demo project

  4. Sign the request.

    The request signing method is integrated in the JAR files imported in 3. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to 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.
    1. Edit the main( ) method in the Demo.java file, and replace the bold text with actual values.

      As shown in the following code, 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.

      //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 Credential page.
String ak = System.getenv("CLOUD_SDK_AK")
String sk = System.getenv("CLOUD_SDK_SK")

//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);
}
    2. 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 the API call logs on the console.

Parent topic: API Calling