GetCatalogToken - Data Lake Formation - Alibaba Cloud Documentation Center

Obtains a temporary access credential (token) for a catalog.

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/catalogs/{catalog}/token HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
catalog	string	Yes	The catalog name.	catalog_demo

Response elements

Element	Type	Description	Example
	object	The response body.
token	object	The token for the catalog.
	string	The token details.	{ "fs.oss.accessKeyId": "xxx", "fs.oss.accessKeySecret": "xxx", "fs.oss.securityToken": "xxx", "fs.oss.endpoint": "xxx", "fs.oss.bucket.name": "xxx" }
expiresAtMillis	integer	The token expiration time.	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    \"fs.oss.bucket.name\": \"xxx\"\n  }"
  },
  "expiresAtMillis": 1749160909000
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.