Call the RegisterLocation API to register an OSS path - Data Lake Formation - Alibaba Cloud - Data Lake Formation

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dlf:RegisterLocation

*All Resource

*

None

Request syntax

POST /webapi/locations HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
Location	string	Yes	The OSS path to register.	oss://mybucket/
RoleName	string	Yes	The Resource Access Management (RAM) role name. Note DLF requires an authorized role to read and write data in the specified OSS path. You can use the `AliyunDLFWorkFlowDefaultRole` role, which is pre-configured with the required permissions for the path. Alternatively, you can use a custom role, but you must manually grant that role read and write permissions.	AliyunDLFWorkFlowDefaultRole
InventoryCollectEnabled	boolean	No	Specifies whether to enable the storage inventory.	true
OssLogCollectEnabled	boolean	No	Specifies whether to enable OSS log collection.	true

Response elements

Element	Type	Description	Example
	object	The registration result.
RequestId	string	The request ID.	3C2678BA-3451-14C3-90E2-D4EF5B4E7A84
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	object	The returned data.
LocationId	string	The ID of the location.	LOC-AB8FBC17F95A4AF5
StorageCollectTaskOperationResultList	array	The list of results for the enabled collection tasks.
	StorageCollectTaskOperationResult	The result of an enabled collection task.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.