Channels:stop

Function

Stops tracking changes.

Scenario

By calling the channels.stop API, your app can stop file change notification on a channel.

Restrictions

Prototype

Path Parameters

None.

Query Parameters

Request Parameters

Request Header

Request Body

Request Example

POST https://driveapis.cloud.huawei.com.cn/drive/v1/channels/stop HTTP/1.1
Content-Type: application/json
Authorization: Bearer CV3PnPLZXyr9K2GV7RYZkF962JZvoEkMQhTho3QHQAPQUyma/lEyZskP/IMWrc7FvaeHivO7y0lyibI/fQvulBnTgtXArSVPsjaLKvYNkDsJSaIR2/sx+K40bYDWWpKFvJNKg2U47jRwz2mfiF3ortNk
Cache-Control: no-cache
{
            "category": "api#channel",
            "id": "46TMU",
            "resourceId": "MTIzMzIyMjQ1ODI0Nzc0MTgyNA",
            "resourceUri": "https://drive.hicloud.com/drive/v1/changes?pageSize=10&cursor=238247332125117440&form=json",
            "userToken": "Qeqqn",
            "expirationTime": "1574674540000",
            "type": "web_hook",
            "url": "https://www.huawei.com"
}

Response Parameters

If successful, this method returns status code 204.

Response Example

None.

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/channels/stop";
        String access_token = "CV5OUVN/e79TSba9Kaxlgx+TONKyYovWvre8BZM05oh6J51jBIbeYp0FRSuLcFBZoDaft0V/B+m+mPFf7MG3n8JmO8w3n6/K6zUI8I5/auSzdxv8GOdAPw==";
        // Stop tracking changes.
        Boolean isStop = false;
        isStop = channelsStop(url, access_token);

        System.out.println(isStop);
    }

    private static Boolean channelsStop(String url, String access_token) throws IOException {
        HttpPost httpPost = new HttpPost(url);
        httpPost.setHeader("Authorization","Bearer " + access_token);
        httpPost.setHeader("Content-Type", "application/json");
        httpPost.setHeader("Accept", "application/json");

        JSONObject jsonParam = new JSONObject();//You can get every value of jsonParam from ChangesSubscribe
        jsonParam.put("resourceId", "MTIzOTA0Njg3ODM3MTUxMjcwNA");
        jsonParam.put("category", "api#channel");
        jsonParam.put("expirationTime", "1582191947000");
        jsonParam.put("id", "46TMU");
        jsonParam.put("pushToken", "Qeqqn");
        jsonParam.put("type", "web_hook");
        jsonParam.put("url", "https://www.huawei.com");
        jsonParam.put("resourceUri", "https://drive.hicloud.com/drive/v3/changes?pageSize=100&cursor=299830100109593600&form=json&containers=drive");

        StringEntity entity = new StringEntity(jsonParam.toString());
        entity.setContentType("application/json");
        httpPost.setEntity(entity);

        CloseableHttpResponse response = HttpClientUtil.getClient().execute(httpPost);

        try {
            if(response.getStatusLine().getStatusCode() == 204){
                return true;
            }
            return false;
        }finally {
            response.close();
        }
    }