获取软链接对象

功能说明

获取软链接对象。

开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。

接口约束

您必须是桶拥有者或拥有下载对象的权限，才能获取软链接对。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。
对于存储类别为归档存储或深度归档存储的对象，需要确认对象的状态为“已恢复”才能对其进行下载。

方法定义

ObsClient.putSymlink(params)

请求参数说明

表1 请求参数列表
参数名称	参数类型	是否必选	描述
Bucket	String	必选	参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无
Key	String	是	参数解释：软链接对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。取值范围：长度大于0且不超过1024的字符串。默认取值：无
VersionId	String	可选	参数解释：软链接对象的版本号。取值范围：长度为32的字符串。默认取值：无

返回结果说明

表2 ICommonMsg
参数名称	参数类型	描述
symlinkTarget	String	参数解释：软链接指向的目标对象名。默认取值：无
Status	Number	参数解释： OBS服务端返回的HTTP状态码。取值范围：状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。
Code	String	参数解释： OBS服务端返回的错误码。
Message	String	参数解释： OBS服务端返回的错误描述。
HostId	String	参数解释： OBS服务端返回的请求服务端ID。
RequestId	String	参数解释： OBS服务端返回的请求ID。
Id2	String	参数解释： OBS服务端返回的请求ID2。
Indicator	String	参数解释： OBS服务端返回的详细错误码。

示例代码

// 创建ObsClient实例
var obsClient = new ObsClient({
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
    // 前端本身没有process对象，可以使用webpack类打包工具定义环境变量，就可以在代码中运行了。
    // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
    access_key_id: process.env.AccessKeyID,
    secret_access_key: process.env.SecretAccessKey,
    // 这里以华北-北京四为例，其他地区请按实际情况填写
    server: 'https://obs.cn-north-4.myhuaweicloud.com'
});

obsClient.getSymlink({
    Bucket : 'bucketname',
    Key : 'symlinkObjectname'
}, function (err, result) {
    if (err) {
        console.error('putSymlink Error-->' + err);
    } else {
        if (result.CommonMsg.Status < 300 && result.InterfaceResult) {
            console.log('result-->' + result);
        }
    }
});