接口描述

PutSymlink接口用于为BOS已有的目的object（本文档称作"target object"）创建软链接（Symlink），您可以通过该软链接访问目的object。

注意：

• 软链接文件和target object可以位于相同region内的不同bucket，若设置x-bce-symlink-bucket，即表示跨bucket创建软连接，x-bce-symlink-bucket指定为target object所在bucket。
• 目前支持对标准存储、低频存储、冷存储、归档存储类型的object文件设置软链接。软链接文件本身不支持ARCHIVE类型。如果用户指定ARCHIVE类型，或者不指定类型且Bucket默认存储类型是ARCHIVE时，返回报错CODE_INVALID_ARGUMENT。
• 调用该接口创建软链接时，不会检查目标文件是否存在、以及是否有权限访问目标文件。使用软链接调用GetObject接口时候，会检查用户是否有软链接和目标文件的读取权限、目标文件是否存在。
• 创建软链接需要有相应写权限。
• 如果不指定"x-bce-forbid-overwrite"这个Header，如果存在与软链接文件同名的object文件时，创建软链接操作时会默认覆盖同名Object。
• 不支持二级软链接。用户创建二级软链时不会进行检查，但是用户无法通过二级软链访问指向的object数据。
• 通过软链接下载目标文件时，需要有软链接和目标文件的读权限。

请求

• 请求语法

PUT /<ObjectName>?symlink HTTP/1.1
Host: <BucketName>.bj.bcebos.com
Date: <Date>
Authorization: <AuthorizationString>
x-bce-symlink-target: <TargetObjectName>
x-bce-symlink-bucket: <TargetBucketName>
x-bce-forbid-overwrite: false

• 请求参数

  无特殊参数

• 请求头域

  名称	类型	描述	是否必选
  x-bce-symlink-target	String	指定软链接的目标文件。命名规范同Object。软链接的目标文件不能为软链接文件	是
  x-bce-symlink-bucket	String	指定软链接的目标文件所在bucket，若不设置，则表示被创建的软链接与软链接目标文件在同一个bucket下。	否
  x-bce-forbid-overwrite	String	指定创建软链接操作时是否覆盖同名Object。如果不指定x-bce-forbid-overwrite时，默认允许覆盖同名Object。指定x-bce-forbid-overwrite为true时，表示禁止覆盖同名Object；指定x-bce-forbid-overwrite为false时，表示允许覆盖同名Object。	否
  x-bce-meta-*	String	用户自定义的meta	否
  x-bce-storage-class	String	指定软链接文件的存储类型，STANDARD代表标准存储，STANDARD_IA代表低频存储，COLD代表冷存储,不指定时默认是bucket存储类型。软链接文件本身不支持ARCHIVE类型。	否
  x-bce-acl	String	CannedACL支持的header，用户设置软链接的权限，取值为private和public-read。	否
  x-bce-grant-read	String	CannedACL支持的header，用户设置软链接的读权限。支持多个id，以逗号分隔	否
  x-bce-grant-full-control	String	CannedACL支持的header，用户设置软链接的FULL_CONTROL权限。支持多个id，以逗号分隔	否

响应

• 响应头域

  名称	类型	描述
  ETag	String	软链接目标Object名字的HTTP协议实体标签

• 响应元素

  无特殊元素

示例

• 请求示例

PUT /<ObjectName>?symlink HTTP/1.1
Host: <BucketName>.bj.bcebos.com
Date: <Date>
Authorization: <AuthorizationString>
x-bce-symlink-target: <TargetObjectName>
x-bce-forbid-overwrite: false
x-bce-grant-read:id="e13bxxxxxxxxxxxxxxxxxxxxxxxx87b8",id="8c47xxxxxxxxxxxxxxxxxxxxxxxx4c94"

• 响应示例

HTTP/1.1 200 OK
x-bce-request-id: 4db4b34d-653d-4d9a-b49b-3049ca786409
Date: Wed, 31 May 2018 08:34:40 GMT
ETag: "1b2cf535f27731c974343645a3985328"
Server: BceBos