报表分享与授权管理

接口路径：/openapi/v2/share/resource/{reportId}    （GET）

接口描述：作品可以被分享给组织所有成员、用户组以及具体的一个成员；该接口用于查询作品有效期限内的分享记录，不包含编辑授权记录。

输入参数：路径参数，reportId，报表的ID

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"a899f03f-aca8-****-8481-763ca6c30ccc",
    "code":null,
    "message":null,
    "data":[
        {
            "shareTo":"2fe4fbd8",
            "shareToType":2,
            "expireDate":4102329600000,
            "shareId":"bec5c411-eff5-****-9de8-4d7516947e30",
            "reportId":"85edbd5f-9847-****-a3da-6c51702a6f9b",
            "shareType":"dashboard",
            "nameOfShareTo":"所有成员",
            "authPoint": 1
        }
    ],
    "success":true
}

JAVA SDK 示例：

public static void QueryShareList() throws SDKException {
    String reportId = "2a35d7b1-6fed-xxxx-a723-4d32a8c6010c";
    HttpRequest request = HttpRequest.build()
            .setUri("/openapi/v2/share/resource/" + reportId)
            .setMethod(HttpMethod.GET);
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/share/resource/{reportId}   （POST）

接口描述：添加报表的一个分享授权，支持数据门户、仪表板、数据大屏、电子表格、自助取数、即席分析、数据填报，分享的粒度单位为【天】。

输入参数：reportId  路径参数

（表格中参数以JSON串形式附属到POST请求的body中）

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"609f94dc-f17c-****-839e-0548736da85e",
    "code":null,
    "message":null,
    "data":true,
    "success":true
}

JAVA SDK 示例：

public static void QueryShareList() throws SDKException {
    String reportId = "2a35d7b1-6fed-xxxx-a723-4d32a8c6010c";
    HttpRequest request = HttpRequest.build()
            .setUri("/openapi/v2/share/resource/" + reportId)
            .setMethod(HttpMethod.GET);
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口：/openapi/v2/share/{shareId}  (DELETE)

接口描述：按shareId删除数据作品的一个分享授权。

输入参数：shareId, 路径参数

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"609f94dc-f17c-****-839e-0548736da85e",
    "code":null,
    "message":null,
    "data":true,
    "success":true
}

JAVA SDK 示例：

public static void deleteReportShare() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/share/{shareId}")
        .setMethod(HttpMethod.DELETE);
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口：/openapi/v2/share/to/user/{userId}/shares（GET）

描述：查询授权给用户的报表列表（仅支持发布后的报表）。

输入参数：

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId": "284d25a9-34f0-****-8f76-98b1aeba766d",
    "code": null,
    "message": null,
    "data": [
        {
            "worksId": "f3bf46a8-****",
            "workType": "PAGE",
            "auth3rdFlag": "1",
            "workName": "报表名称",
            "workspaceId": "87c6b145-****",
            "securityLevel": "0",
            "description": null, 
            "ownerId": "363e88800032",
          	"accountName": null,
            "ownerName": "cat4***@aliyun.com",
            "modifyName": null,
            "gmtCreate": 1484818350000,
            "gmtModify": 1557823287000,
            "status":1
        }
    ],
    "success": true
}

JAVA SDK 示例：

public static void deleteReportShare() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/share/{shareId}")
        .setMethod(HttpMethod.DELETE);
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/share/cancel （POST）

接口描述：按照用户组、用户、组织（所有成员），删除指定报表的分享授权。

起始版本： 独立部署3.8.4

输入参数：（content-type:application/json;charset=UTF-8，参数以JSON对象格式附录在http body中）

输入参数示例：

{
    "reportId":"9bbd2088-****",
    "shareToIds":"abc,cdef,ddx",
    "shareToType":1
}

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"9bbd2088-6aeb-****-9ef3-082cc5a4f8f3",
    "code":null,
    "message":null,
    "data":true,
    "success":true
}

JAVA SDK 示例：

public static void deleteReportShare() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/share/cancel")
        .setMethod(HttpMethod.POST);
    request.addParameter("reportId", "12d2edc8-b3af-4ad1-80f9-ab306b512dcd");
    request.addParameter("shareToIds", "2fe4fbd8-588f-489a-b3e1-e92c7af083ea");
    request.addParameter("shareToType", 2); // 0 用户  1：用户组  2：组织（所有成员）
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/dashboard/permission（POST）

接口描述：用于新增一条仪表板的协同授权记录，支持编辑权限授权，已有的会被覆盖。

起始版本：独立部署4.2

接口参数：（content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交）

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"d3f913a6-84ec-****-b30f-fd7540f3bdeb", 
    "code":"0",
    "message":"success",
    "data": "aa42b0d4-bfa4-****-9fc6-fabdf3567e04",
    "success":true
}

JAVA SDK 示例：

public static void authorize() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/dashboard/permission")
        .setMethod(HttpMethod.POST)
        .setHttpContentType(FormatType.FORM);
    request.addParameter("resourceId","xxx");
    request.addParameter("authorizedId","xxx");
    request.addParameter("authorizeScope","xxx");
    request.addParameter("authPoints","xxx");
    // 非必填参数
    // request.addParameter("expireDay","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/report/permission（POST）

接口描述：用于新增一条电子表格的协同授权记录，支持编辑权限授权，已有的会被覆盖。

起始版本：独立部署4.2.2

接口参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"d3f913a6-84ec-****-b30f-fd7540f3bdeb", 
    "code":"0",
    "message":"success",
    "data": "aa42b0d4-bfa4-****-9fc6-fabdf3567e04",
    "success":true
}

JAVA SDK 示例：

public static void authorize() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/report/permission")
        .setMethod(HttpMethod.POST)
        .setHttpContentType(FormatType.FORM);
    request.addParameter("resourceId","xxx");
    request.addParameter("authorizedId","xxx");
    request.addParameter("authorizeScope","xxx");
    request.addParameter("authPoints","xxx");
    // 非必填参数
    // request.addParameter("expireDay","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/dashboardOfflineQuery/permission（POST）

接口描述：用于新增一条自助取数的协同授权记录，支持编辑权限授权，已有的会被覆盖。

起始版本：独立部署4.2.2

接口参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"d3f913a6-84ec-****-b30f-fd7540f3bdeb", 
    "code":"0",
    "message":"success",
    "data": "aa42b0d4-bfa4-****-9fc6-fabdf3567e04",
    "success":true
}

JAVA SDK 示例：

public static void authorize() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/dashboardOfflineQuery/permission")
        .setMethod(HttpMethod.POST)
        .setHttpContentType(FormatType.FORM);
    request.addParameter("resourceId","xxx");
    request.addParameter("authorizedId","xxx");
    request.addParameter("authorizeScope","xxx");
    request.addParameter("authPoints","xxx");
    // 非必填参数
    // request.addParameter("expireDay","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/cube/permission（POST）

接口描述：用于新增一条数据集的协同授权记录，支持编辑权限授权，已有的会被覆盖。

起始版本：独立部署4.3.3

接口参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"d3f913a6-84ec-****-b30f-fd7540f3bdeb", 
    "code":"0",
    "message":"success",
    "data": "aa42b0d4-bfa4-****-9fc6-fabdf3567e04",
    "success":true
}

JAVA SDK 示例：

public static void authorize() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/cube/permission")
        .setMethod(HttpMethod.POST)
        .setHttpContentType(FormatType.FORM);
    request.addParameter("resourceId","xxx");
    request.addParameter("authorizedId","xxx");
    request.addParameter("authorizeScope","xxx");
    request.addParameter("authPoints","xxx");
    // 非必填参数
    // request.addParameter("expireDay","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/datasource/permission（POST）

接口描述：用于新增一条数据源的协同授权记录，支持编辑权限授权，已有的会被覆盖。

起始版本：独立部署4.3.3

接口参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"d3f913a6-84ec-****-b30f-fd7540f3bdeb", 
    "code":"0",
    "message":"success",
    "data": "aa42b0d4-bfa4-****-9fc6-fabdf3567e04",
    "success":true
}

JAVA SDK 示例：

public static void authorize() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/datasource/permission")
        .setMethod(HttpMethod.POST)
        .setHttpContentType(FormatType.FORM);
    request.addParameter("resourceId","xxx");
    request.addParameter("authorizedId","xxx");
    request.addParameter("authorizeScope","xxx");
    request.addParameter("authPoints","xxx");
    // 非必填参数
    // request.addParameter("expireDay","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/screen/permission（POST）

接口描述：用于新增一条数据大屏的协同授权记录，支持编辑权限授权，已有的会被覆盖。

起始版本：独立部署4.5.3

接口参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"d3f913a6-84ec-****-b30f-fd7540f3bdeb", 
    "code":"0",
    "message":"success",
    "data": "aa42b0d4-bfa4-****-9fc6-fabdf3567e04",
    "success":true
}

JAVA SDK 示例：

public static void authorize() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/screen/permission")
        .setMethod(HttpMethod.POST)
        .setHttpContentType(FormatType.FORM);
    request.addParameter("resourceId","xxx");
    request.addParameter("authorizedId","xxx");
    request.addParameter("authorizeScope","xxx");
    request.addParameter("authPoints","xxx");
    // 非必填参数
    // request.addParameter("expireDay","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/ANALYSIS/permission（POST）

接口描述：用于新增一条即席分析的协同授权记录，支持编辑权限授权，已有的会被覆盖。

起始版本：独立部署4.5.3

接口参数：（content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交）

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"d3f913a6-84ec-****-b30f-fd7540f3bdeb", 
    "code":"0",
    "message":"success",
    "data": "aa42b0d4-bfa4-****-9fc6-fabdf3567e04",
    "success":true
}

JAVA SDK 示例：

public static void authorize() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/ANALYSIS/permission")
        .setMethod(HttpMethod.POST)
        .setHttpContentType(FormatType.FORM);
    request.addParameter("resourceId","xxx");
    request.addParameter("authorizedId","xxx");
    request.addParameter("authorizeScope","xxx");
    request.addParameter("authPoints","xxx");
    // request.addParameter("expireDay","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/dataForm/permission（POST）

接口描述：用于新增一条数据填报的协同授权记录，支持编辑权限授权，已有的会被覆盖。

起始版本：独立部署4.5.3

接口参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId":"d3f913a6-84ec-****-b30f-fd7540f3bdeb", 
    "code":"0",
    "message":"success",
    "data": "aa42b0d4-bfa4-****-9fc6-fabdf3567e04",
    "success":true
}

JAVA SDK 示例：

public static void authorize() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/dataForm/permission")
        .setMethod(HttpMethod.POST)
        .setHttpContentType(FormatType.FORM);
    request.addParameter("resourceId","xxx");
    request.addParameter("authorizedId","xxx");
    request.addParameter("authorizeScope","xxx");
    request.addParameter("authPoints","xxx");
    // 非必填参数
    // request.addParameter("expireDay","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/authorize/resource/auth（GET）

接口描述：查看资源的协同授权记录，不代表作品的权限，需要结合授权属性判断。

版本起始：独立部署4.5.3

接口参数：

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
	"traceId": "7f9bb6fd***********478a66086216",
	"code": "0",
	"message": "success",
	"data": [
                {
                    "authorizedId": "17e3f9*******de02224f",
                    "authorizedName": "teest",
                    "resourceId": "8a88b********69b81e9",
                    "scope": 0,
                    "expireDate": 4102329600000,
                    "gmtCreate": "2025-10-24 17:27:56",
                    "authorities":
                    [
                        "READ",
                        "EXPORT"
                    ],
                    "resourceType": "dashboard"
                }
            ],
	"success": true
}

JAVA SDK 示例：

public static void listAuthConfigByResource() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/authorize/resource/auth")
        .setMethod(HttpMethod.GET);
    request.addParameter("resourceId","xxx");
    request.addParameter("worksType","xxx");
    request.addParameter("shareToType","xxx");
    // 非必填参数
    // request.addParameter("hasAuth","xxx");
    // request.addParameter("keyword","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/{resourceType}/permission/attributes（POST）

接口描述：修改资源的协同授权属性。

版本起始：独立部署4.5.3

接口参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId": "b442c4c5-0f97-****-b397-0cf98b2febcd",
    "code": "0",
    "message": "success",
    "data": true,
    "success": true,
    "dynamicMessage": null
}

JAVA SDK 示例：

public static void updatePermissionAttributes() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/{resourceType}/permission/attributes")
        .setMethod(HttpMethod.POST)
        .setHttpContentType(FormatType.FORM);
    request.addParameter("resourceId","xxx");
    // 非必填参数
    // request.addParameter("editPermissionType","xxx");
    // request.addParameter("usePermissionType","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

接口路径：/openapi/v2/{resourceType}/permission/unauthorize（DELETE）

接口描述：删除指定资源的用户级别协同授权记录。

版本起始：独立部署4.5.3

接口参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

注意事项：以下情况无法删除授权：使用权限属性已设置为所有空间开发者、编辑权限属性已设置为所有空成员、编辑权限属性已设置为所有空间开发者、空间管理员默认拥有权限、作品所有者默认拥有权限、已授权用户组包含该用户、已授权给全部组织成员、已授权给全部空间成员。

返回参数说明（SDK调用时，仅返回data部分）：

返回参数：

{
    "traceId": "b442c4c5-0f97-****-b397-0cf98b2febcd",
    "code": "0",
    "message": "success",
    "data": true,
    "success": true,
    "dynamicMessage": null
}

JAVA SDK 示例：

public static void unauthorizedByUserId() throws SDKException {
    HttpRequest request = HttpRequest.build()
        .setUri("/openapi/v2/{resourceType}/permission/unauthorize")
        .setMethod(HttpMethod.DELETE)
        .setHttpContentType(FormatType.FORM);
    request.addParameter("resourceId","xxx");
    request.addParameter("userId","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}