Changes:getStartCursor

Function

Obtains the starting cursor.

Scenario

By calling the Changes.getStartCursor API, your app can obtain the starting cursor required by the Changes.subscribe API.

Restrictions

Prototype

Path Parameters

None.

Query Parameters

Request Parameters

Request Header

Request Body

None.

Request Example

GET  https://driveapis.cloud.huawei.com.cn/drive/v1/changes/getStartCursor?fields=*    HTTP/1.1 
Content-Type: application/json 
Authorization: Bearer CV3PnPLZXyr9K2GV7RYZkF962JZvoEkMQhTho3QHQAPQUyma/lEyZskP/IMWrc7FvaeHivO7y0lyibI/fQvulBnTgtXArSVPsjaLKvYNkDsJSaIR2/sx+K40bYDWWpKFvJNKg2U47jRwz2mfiF3ortNk 
Cache-Control: no-cache

Response Parameters

When the status code is 200:

Response Example

{
            "category": "drive#startCursor",
            "startCursor": "238247332125117440"
}

Common Result Codes

The last four digits in the result code indicate the service error code, which is used to differentiate error scenarios. For details about other service error codes, please refer to Status Codes.

Call Example

   public static void main(String[] args) throws IOException {
        // Set the request URL and access token.
        String url = "https://driveapis.cloud.huawei.com.cn/drive/v1/changes/getStartCursor";
        String access_token = "CV5OUVN/e79TSba9Kaxlgx+TONKyYovWvre8BZM05oh6J51jBIbeYp0FRSuLcFBZoDaft0V/B+m+mPFf7MG3n8JmO8w3n6/K6zUI8I5/auSzdxv8GOdAPw==";
        // Obtain the starting cursor.
        JSONObject cursorInfo = changesGetStartCursor(url, access_token);
        System.out.println(cursorInfo.toJSONString());
    }

    private static JSONObject changesGetStartCursor(String url, String access_token) throws IOException {
        StringBuilder stringBuilder = new StringBuilder("");
        stringBuilder.append("?").append("fields=*");
        HttpGet httpGet = new HttpGet(url + stringBuilder);
        httpGet.setHeader("Authorization","Bearer " + access_token);
        CloseableHttpResponse response = HttpClientUtil.getClient().execute(httpGet);

        try {
            HttpEntity responseEntity = response.getEntity();
            String ret = responseEntity != null ? EntityUtils.toString(responseEntity) : null;
            JSONObject jsonObject = (JSONObject) JSON.parse(ret);
            EntityUtils.consume(responseEntity);
            return jsonObject;
        }finally {
            response.close();
        }
    }