调用SetDataSourceShare分享目标数据源至指定DataWorks工作空间或指定用户。分享后,该工作空间的所有成员或指定的用户可以查看和使用目标数据源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SetDataSourceShare

要执行的操作。

DatasourceName String mysql_name

待分享的目标数据源名称。

EnvType String 1

目标数据源所属的环境。取值如下:

  • 0:开发环境。
  • 1:生产环境。
ProjectId Long 10000

目标数据源所在的DataWorks工作空间ID。您可以调用ListProjects接口获取工作空间ID。

RegionId String cn-shanghai

目标数据源所在的地域。例如,华东2(上海)是cn-shanghai,华北3(张家口)是cn-zhangjiakou。您无需填写RegionId,会根据调用的endpoint自动解析。

ProjectPermissions String [{"projectId":1000,"permission":"WRITE","sharedName":"PX_DATAHUB1.shared_name"}]

指定需要分享目标数据源的DataWorks工作空间。分享后,该工作空间的所有成员均可查看或使用目标数据源。使用JSONARRAY格式。{"projectId":1000,"permission":"WRITE","sharedName":"PX_DATAHUB1.shared_name"}

参数说明如下:

  • projectId:需要分享目标数据源的工作空间ID。
  • permission:支持READ(读取)和WRITE(写入)两种模式权限。READ(读取)表示指定工作空间的所有成员仅可以读取目标数据源的数据,但是不能修改该数据;WRITE(写入)表示指定工作空间的所有成员可以修改目标数据源的数据。
  • sharedName:待分享的数据源名称。
UserPermissions String [{"projectId":10000,"users":[{"userId":"276184575345452131","permission":"WRITE"}],"sharedName":"PX_DATAHUB1.shared_name"}]

指定需要分享目标数据源的用户。分享后,该用户可查看或使用目标数据源。使用JSONARRAY格式。{"projectId":10000,"users":[{"userId":"276184575345452131","permission":"WRITE"},"sharedName":"PX_DATAHUB1.shared_name"}],

参数说明如下:

  • projectId:指定DataWorks工作空间的ID。表示需要分享目标数据源的用户仅在该工作空间下可查看或使用目标数据源。
  • userId:需要分享目标数据源的用户ID。
  • permission:支持READ(读取)和WRITE(写入)两种模式权限。READ(读取)表示指定的用户仅可以读取目标数据源的数据,但是不能修改该数据;WRITE(写入)表示指定的用户可以修改目标数据源的数据。
  • sharedName:待分享的数据源名称。

ProjectPermissions和UserPermissions如果都为空,则该接口不会做任何修改。如果都不为空,则既会UserPermissions生效,ProjectPermissions也会生效

返回数据

名称 类型 示例值 描述
Data Struct

分享目标数据源的返回数据。

Message String datasource is wrong

分享目标数据源失败后的原因描述。如果分享目标数据源成功,则该参数的返回值为空。

Status String success

分享目标数据源的结果状态。取值如下:

  • success:表示目标数据源分享成功。
  • fail:表示目标数据源分享失败。您可以查看Message参数定位失败原因。
RequestId String 0000-ABCD-EFG

本次调用的唯一ID。用于出现错误后定位日志,排查问题。

Success Boolean true

请求是否成功。取值如下:

  • true:成功。
  • false:失败。

示例

请求示例

http(s)://[Endpoint]/?Action=SetDataSourceShare
&DatasourceName=mysql_name
&EnvType=1
&ProjectId=10000
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

<RequestId>0000-ABCD-EFG	</RequestId>
<Data>
    <Status>success</Status>
    <Message>datasource is wrong</Message>
</Data>
<Success>true</Success>

JSON格式

{
    "RequestId": "0000-ABCD-EFG",
    "Data": {
        "Status": "success",
        "Message": "datasource is wrong"
    },
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.DI.NoPrivilege No access. 没有权限访问
500 InternalError.DI.Parameter A DI internal error occurred. 数据集成内部业务错误
400 Invalid.DI.Parameter The parameter is invalid. 参数错误

访问错误中心查看更多错误码。