Skip to main content

Aliyun OSS Access Parameters

This document introduces the parameters required to access Aliyun OSS, applicable to the following scenarios:

  • Catalog properties
  • Table Valued Function properties
  • Broker Load properties
  • Export properties
  • Outfile properties

Doris uses the S3 Client to access Aliyun OSS through the S3 compatible protocol.

Parameter Overview​

Property NameFormer NameDescriptionDefaultRequired
s3.endpointoss.endpointOSS endpoint, specifies the access endpoint for Aliyun OSS. Note that the endpoints for OSS and OSS HDFS are different.Yes
s3.regionoss.regionOSS region, specifies the region for Aliyun OSSNo
s3.access_keyoss.access_keyOSS access key, the access key for authentication with OSSYes
s3.secret_keyoss.secret_keyOSS secret key, the secret key used in conjunction with the access keyYes
s3.connection.maximumMaximum number of S3 connections, specifies the maximum number of connections established with the OSS service50No
s3.connection.request.timeoutS3 request timeout, in milliseconds, specifies the request timeout when connecting to the OSS service3000No
s3.connection.timeoutS3 connection timeout, in milliseconds, specifies the timeout when establishing a connection with the OSS service1000No
s3.sts_endpointNot yet supportedNo
s3.sts_regionNot yet supportedNo
s3.iam_roleNot yet supportedNo
s3.external_idNot yet supportedNo

Authentication Configuration​

When accessing Aliyun OSS, you need to provide Aliyun's Access Key and Secret Key, which are the following parameters:

  • s3.access_key (or oss.access_key)
  • s3.secret_key (or oss.secret_key)

Example Configuration​

"oss.access_key" = "ak",
"oss.secret_key" = "sk",
"oss.endpoint" = "oss-cn-beijing.aliyuncs.com",
"oss.region" = "cn-beijing"