Access an instance over HTTPS

Prerequisites

• The secure access proxy is enabled for the instance.

  Note

  You can view instances with the secure access proxy enabled on the Created tab of the Security and Specifications > Secure Access Proxy page. To enable this feature, see Enable the secure access proxy.

• You are authorized to use the secure access proxy.

  Note

  Check your authorization status for the instance on the details page of the secure access proxy. If you are not authorized, see Apply for secure access proxy authorization.

Usage notes

Security rules apply to instances that have both the secure access proxy and secure collaboration features enabled. We recommend that you limit a single query to return a maximum of 3,000 rows. Data Management Service (DMS) cannot guarantee stability if a query returns too many rows.

Request parameters

Response format

When you access the instance over HTTPS, the response is returned in JSON format.

The JSON object has the following structure:

The following are sample responses:

• Successful query

  {
    "columnMetas": [
      {
        "columnName":"column1",
        "columnLabel":"column1",
        "columnTypeName":"varchar",
        "precision":10,
        "scale":2,
        "nullable":true,
        "autoIncrement":true,
        "tableName":"table1"
      },
      {
        "columnName":"column2",
        "columnLabel":"column2",
        "columnTypeName":"varchar",
        "precision":10,
        "scale":2,
        "nullable":true,
        "autoIncrement":true,
        "tableName":"table1"
      } 
    ],
    "updateCount": 0,
    "requestId": "xhqej0xgcytbhc8scjopgqsywcaibi",
    "rowCount": 1,
    "rows": [
      {
        "col1": 1,
        "col2": "xxxx"
      }
    ],
    "success": true
  }

• Successful update

  {
    "updateCount": 0,
    "requestId": "xhqej0xgcytbhc8scjopgqsywcaibi",
    "success": true
  }

• Request failure

  {
    "message": 'AccessKey ID is required.',
    "requestId": "xhqej0xgcytbhc8scjopgqsywcaibi",
    "success": false
  }

Examples

You can use the command line, an SQL client, or application code to access an instance that has the secure access proxy enabled.

The following examples use these values: the endpoint is dpxxxx-xxxxxxxx.proxy.dms.aliyuncs.com, the database name is database, the AccessKey ID is user, the AccessKey Secret is pwd, and the SQL command is SHOW DATABASES.

• Use the curl command

  # GET request
  curl 'https:///server/?accessId=&accessSecret=&sql='

  # GET request example
  curl 'https://dpxxxx-xxxxxxxx.proxy.dms.aliyuncs.com/server/database?accessId=user&accessSecret=pwd&sql=SHOW%20DATABASES'

  # POST request
  curl 'https:///server/' -H 'accessId:' -H 'accessSecret:' -H 'Content-Type:text/plain' -d ''

  # POST request example
  curl 'https://dpxxxx-xxxxxxxx.proxy.dms.aliyuncs.com/server/database' -H 'accessId:user' -H 'accessSecret:pwd' -H 'Content-Type:text/plain' -d 'SHOW DATABASES'

• Use a Python program

  Note

  This example uses Python 2.

  GET request:

  import requests
  url = "https:///server/?accessId=&accessSecret=&sql="
  print requests.get(url).text

  GET request example:

  import requests
  url = "https://dpxxxx-xxxxxxxx.proxy.dms.aliyuncs.com/server/database?accessId=user&accessSecret=pwd&sql=SHOW DATABASES"
  print requests.get(url).text

  POST request:

  import requests
  url = "https:///server/"
  headers = {
      "Content-Type": "text/plain;charset=utf-8",
      "accessId": "",
      "accessSecret": ""
  }
  print requests.post(url, headers=headers, data='').text

  POST request example:

  import requests
  url = "https://dpxxxx-xxxxxxxx.proxy.dms.aliyuncs.com/server/database"
  headers = {
      "Content-Type": "text/plain;charset=utf-8",
      "accessId": "user",
      "accessSecret": "pwd"
  }
  print requests.post(url, headers=headers, data='SHOW DATABASES').text

• Use a Node.js program

  GET request:

  const https = require("https");
  https.get("https:///server/?accessId=&accessSecret=&sql=SHOW DATABASES", resp => {
      resp.on("data", data => {
          console.log(JSON.parse(data));
      });
  });

  GET request example:

  const https = require("https");
  https.get("https://dpxxxx-xxxxxxxx.proxy.dms.aliyuncs.com/server/database?accessId=user&accessSecret=pwd&sql=SHOW DATABASES", resp => {
      resp.on("data", data => {
          console.log(JSON.parse(data));
      });
  });

  POST request:

  const https = require("https");
  var req = https.request({
      hostname: '',
      port: 443,
      path: '/server/',
      method: 'POST',
      headers: {
          'Content-Type': 'text/plain; charset=UTF-8',
          accessId: '',
          accessSecret: ''
      }
  }, resp => {
      resp.on("data", data => {
          console.log(JSON.parse(data));
      });
  });
  req.write("");
  req.end();

  POST request example:

  const https = require("https");
  var req = https.request({
      hostname: 'dpxxxx-xxxxxxxx.proxy.dms.aliyuncs.com',
      port: 443,
      path: '/server/database',
      method: 'POST',
      headers: {
          'Content-Type': 'text/plain; charset=UTF-8',
          accessId: 'user',
          accessSecret: 'pwd'
      }
  }, resp => {
      resp.on("data", data => {
          console.log(JSON.parse(data));
      });
  });
  req.write("SHOW DATABASES");
  req.end();

• Use the Postman client

  GET request: In Postman, send a GET request to the URL https://dpxxxx-xxxxxxxx.proxy.dms.aliyuncs.com/server/. In the URL parameters, set accessId to your AccessKey ID, accessSecret to your AccessKey Secret, and sql to the SQL statement that you want to execute, such as SHOW DATABASES. Click Send.

  POST request: In Postman, set the request method to POST and the URL to https://dpxxxx-xxxxxxxx.proxy.dms.aliyuncs.com/server/. On the Headers tab, add these headers: set Content-Type to text/plain, accessId to your AccessKey ID, and accessSecret to your AccessKey Secret. On the Body tab, select raw, choose Text, and enter the SQL statement, such as SHOW DATABASES, in the text area. Click Send.