Changes:subscribe

功能介绍

订阅变更。

场景描述

Changes.subscribe接口实现订阅目录或文件变化的功能，主要是针对用户维度所有资源的变化。

使用约束

• Scope至少包含下面其中一个：
  • https://www.huawei.com/auth/drive.file
  • https://www.huawei.com/auth/drive
  • https://www.huawei.com/auth/drive.readonly
  • https://www.huawei.com/auth/drive.metadata
  • https://www.huawei.com/auth/drive.metadata.readonly
• url参数采用允许清单机制，只支持设置在允许清单中的url
• 仅支持80/8080/443/8443/8888此范围内端口回调

接口原型

路径参数

无。

查询参数

请求参数

Request Header

Request Body

请求示例

POST https://driveapis.cloud.huawei.com.cn/drive/v1/changes/subscribe?cursor=238247332125117440&fields=*   HTTP/1.1
Content-Type: application/json
Authorization: Bearer CV3PnPLZXyr9K2GV7RYZkF962JZvoEkMQhTho3QHQAPQUyma/lEyZskP/IMWrc7FvaeHivO7y0lyibI/fQvulBnTgtXArSVPsjaLKvYNkDsJSaIR2/sx+K40bYDWWpKFvJNKg2U47jRwz2mfiF3ortNk
Cache-Control: no-cache
{
            "url": "https://www.huawei.com",
            "expirationTime": 1574674540000,
            "id": "46TMU",
            "type": "web_hook",
            "userToken": "Qeqqn"
}

响应参数

状态码为200时:

响应示例

{
            "resourceId": "MTIzMzIyMjQ1ODI0Nzc0MTgyNA",
            "category": "api#channel",
            "expirationTime": 1574674540000,
            "id": "46TMU",
            "resourceUri": "https://drive.hicloud.com/drive/v3/changes?pageSize=10&cursor=238247332125117440&form=json",
            "userToken": "Qeqqn"
}

常见错误码

错误码后4位为业务错误码，用于区分错误场景，其他业务错误码见状态码章节。

调用示例

    public static void main(String[] args) throws IOException {
        // 设置请求地址，当前页游标和用户认证令牌
        String url = "https://10.33.18.209:9998/drive/v1/changes/subscribe";
        String cursor = "299830100109593600";// 通过ChangesGetStartCursor API获取当前页游标
        String access_token = "CV5OUVN/e79TSba9Kaxlgx+TONKyYovWvre8BZM05oh6J51jBIbeYp0FRSuLcFBZoDaft0V/B+m+mPFf7MG3n8JmO8w3n6/K6zUI8I5/auSzdxv8GOdAPw==";
        // 订阅变更
        JSONObject changesInfo = changesSubscribe(url, access_token, cursor);
        System.out.println(changesInfo.toJSONString());
    }

    private static JSONObject changesSubscribe(String url, String access_token, String cursor) throws IOException {
        StringBuilder stringBuilder = new StringBuilder("");
        stringBuilder.append("?").append("fields=*").append("&").append("cursor").append("=").append(cursor);
        HttpPost httpPost = new HttpPost(url + stringBuilder);
        httpPost.setHeader("Authorization","Bearer " + access_token);
        httpPost.setHeader("Content-Type", "application/json");
        httpPost.setHeader("Accept", "application/json");

        JSONObject jsonParam = new JSONObject();
        jsonParam.put("id", "46TMU");
        jsonParam.put("type", "web_hook");//default value,can't change
        jsonParam.put("pushToken", "Qeqqn");
        jsonParam.put("url", "https://www.huawei.com");//Only support https.
        jsonParam.put("expirationTime", 1582191947000);//optional.You can set it in 1-7 day or use default.Unix Time

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

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

        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();
        }
    }