文档

RegisterLocation - 注册Location

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

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /webapi/locations

请求参数

名称类型必填描述示例值
bodyobject

HTTP

Locationstring

注册的 OSS 路径

oss://mybucket/
RoleNamestring

RAM 角色名称

说明 Data Lake Formation 读/写 OSS 路径下的数据,需要相关授权角色,可以选择 AliyunDLFWorkFlowDefaultRole 角色,它将会自动内建相关路径的授权权限。或者您自定义角色,但需要由您手工保障该角色,有相应路径的读写权限。
AliyunDLFWorkFlowDefaultRole
InventoryCollectEnabledboolean

是否启用 OSS 存储空间清单

true
OssLogCollectEnabledboolean

是否启用 OSS 日志转存

true

返回参数

名称类型描述示例值
object

注册结果

RequestIdstring

请求 ID

3C2678BA-3451-14C3-90E2-D4EF5B4E7A84
Successboolean

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

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

返回数据

LocationIdstring

Location ID

LOC-AB8FBC17F95A4AF5
StorageCollectTaskOperationResultListarray

启用采集任务的结果列表

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看变更集
  • 本页导读 (0)
文档反馈