All Products
Search
Document Center

Data Lake Formation:GetTableToken

Last Updated:Oct 28, 2025

Obtains a temporary access credential for a data lake table.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /dlf/v1/{catalogId}/databases/{database}/tables/{table}/token HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

isInternal

boolean

No

Specifies whether the access is from a VPC.

true

catalogId

string

Yes

The catalog ID.

clg-paimon-xxx

database

string

Yes

The database name.

database_name

table

string

Yes

The table name.

table_name

Response elements

Element

Type

Description

Example

object

Schema of response.

token

object

The temporary access credential for the catalog hosting the table.

string

The temporary access credential for the catalog hosting the table.

{ "fs.oss.accessKeyId": "xxx", "fs.oss.accessKeySecret": "xxx", "fs.oss.securityToken": "xxx", "fs.oss.endpoint": "xxx" }

expiresAtMillis

integer

The expiration time of the temporary access credential.

1749160909000

Examples

Success response

JSON format

{
  "token": {
    "key": "{\n    \"fs.oss.accessKeyId\": \"xxx\",\n    \"fs.oss.accessKeySecret\": \"xxx\",\n    \"fs.oss.securityToken\": \"xxx\",\n    \"fs.oss.endpoint\": \"xxx\"\n  }"
  },
  "expiresAtMillis": 1749160909000
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.