使用RegisterLocation API註冊OSS路徑-資料湖構建-阿里雲

調試

您可以在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	啟用採集任務的結果清單
	StorageCollectTaskOperationResult	啟用採集任務的結果

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。