Help Center> Cloud Data Migration> API Reference> Public Data Structures> Link Parameter Description> Link to OSS on Alibaba Cloud
View PDF

Link to OSS on Alibaba Cloud

Description

By creating an OSS link, you can extract files from Object Storage Service (OSS) on Alibaba Cloud. Files in CSV, JSON, and binary formats are supported.

Sample Link

{
    "links": [
        {
            "link-config-values": {
                "configs": [
                    {
                        "inputs": [
                            {
                                "name": "linkConfig.storageType",
                                "value": "OSS"
                            },
                            {
                                "name": "linkConfig.ossEndpoint",
                                "value": "oss-cn-qingdao.aliyuncs.com"
                            },
                            {
                                "name": "linkConfig.ossAuthType",
                                "value": "ACCESS_KEY"
                            },
                            {
                                "name": "linkConfig.accessKey",
                                "value": "LTAI1mR805IE0cVr"
                            },
                            {
                                "name": "linkConfig.securityKey",
                                "value": "Add password here"
                            }
                        ],
                        "name": "linkConfig"
                    }
                ]
            },
            "name": "op_oss_link",
            "connector-name": "obs-connector"
        }
    ]
}

Link Parameters

Parameter

Mandatory

Type

Description

linkConfig.storageType

Yes

String

Storage class of an object

linkConfig.ossEndpoint

Yes

String

Endpoint of OSS

linkConfig.ossAuthType

Yes

Boolean
Identity authentication method
  • ACCESS_KEY: Use the access key to access OSS.
  • STS: Use the temporary key and security token to access OSS.

linkConfig.accessKey

Yes

String

AK

linkConfig.securityKey

Yes

String

SK

linkConfig.securityToken

No

String

Temporary security token required when a temporary access key is used to log in to OSS