调用RegisterLocation注册Location_数据湖构建(DLF)-阿里云帮助中心

将OSS路径注册为由DLF管理。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dlf:RegisterLocation		全部资源 ``	无	无

请求语法

POST /webapi/locations HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	HTTP
Location	string	是	注册的 OSS 路径	oss://mybucket/
RoleName	string	是	RAM 角色名称说明 Data Lake Formation 读/写 OSS 路径下的数据，需要相关授权角色，可以选择 AliyunDLFWorkFlowDefaultRole 角色，它将会自动内建相关路径的授权权限。或者您自定义角色，但需要由您手工保障该角色，有相应路径的读写权限。	AliyunDLFWorkFlowDefaultRole
InventoryCollectEnabled	boolean	否	是否启用 OSS 存储空间清单	true
OssLogCollectEnabled	boolean	否	是否启用 OSS 日志转存	true

返回参数

名称	类型	描述	示例值
	object	注册结果
RequestId	string	请求 ID	3C2678BA-3451-14C3-90E2-D4EF5B4E7A84
Success	boolean	请求是否成功。取值如下： true：成功 false：失败	true
Data	object	返回数据
LocationId	string	Location ID	LOC-AB8FBC17F95A4AF5
StorageCollectTaskOperationResultList	array	启用采集任务的结果列表
StorageCollectTaskOperationResultList	StorageCollectTaskOperationResult	启用采集任务的结果

示例

正常返回示例

JSON格式

{
  "RequestId": "3C2678BA-3451-14C3-90E2-D4EF5B4E7A84",
  "Success": true,
  "Data": {
    "LocationId": "LOC-AB8FBC17F95A4AF5",
    "StorageCollectTaskOperationResultList": [
      {
        "Success": true,
        "TaskId": "",
        "TaskType": "",
        "DlfCreated": true,
        "ErrCode": "",
        "ErrMessage": ""
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2022-10-28	新增 OpenAPI	查看变更详情