图片样式

最后更新时间:2021-10-08 11:14:59

    简介

    本文档提供关于图片样式相关的 API 概览以及 SDK 示例代码。

    API 说明
    增加样式 增加存储桶样式
    查询样式 查询存储桶样式
    删除样式 删除存储桶样式

    增加样式

    功能说明

    对某一个存储桶设置样式功能,后续上传到该存储桶的图片文件都会被添加指定的样式。

    示例代码

    try {
          $result = $cosClient->PutBucketImageStyle(array(
          'Bucket' => 'examplebucket-1250000000', //格式:BucketName-APPID
          'StyleName' => 'style_name',//样式名称
          'StyleBody' => 'imageMogr2/thumbnail/!50px', //样式信息
      ));
      // 请求成功
      print_r($result);
    } catch (\Exception $e) {
      // 请求失败
      echo($e);
    }
    

    参数说明

    参数名称 类型 描述 是否必填
    Bucket String 存储桶名称,格式:BucketName-APPID
    StyleName String 样式名称
    StyleBody String 样式信息

    返回结果示例

    Guzzle\Service\Resource\Model Object
    (
      [structure:protected] => 
      [data:protected] => Array
          (
              [RequestId] => NWQwOGRkNDdfMjJiMjU4NjRfNzVjXzEwNmVjY2M=
              [Bucket] => examplebucket-1250000000
              [Location] => examplebucket-1250000000.pic.ap-beijing.myqcloud.com/
          )
    )
    

    返回结果说明

    参数名称 类型 描述 父节点
    RequestId String 请求 ID 标识
    Bucket String 存储桶名称,格式:BucketName-APPID
    Location String 请求资源地址

    查询样式

    功能说明

    查询某个存储桶下已有的样式。

    示例代码

    try {
           $result = $cosClient->GetBucketImageStyle(array(
           'Bucket' => 'examplebucket-1250000000', //格式:BucketName-APPID
           'StyleName' => 'style_name', //样式名称
       ));
       // 请求成功
       print_r($result);
    } catch (\Exception $e) {
       // 请求失败
       echo($e);
    }
    

    参数说明

    参数名称 类型 描述 是否必填
    Bucket String 存储桶名称,格式:BucketName-APPID
    StyleName String 样式名称

    返回结果示例

    Guzzle\Service\Resource\Model Object
    (
      [structure:protected] => 
      [data:protected] => Array
          (
              [RequestId] => NWQwOGRkNDdfMjJiMjU4NjRfNzVjXzEwNmVjY2M=
              [Bucket] => examplebucket-1250000000
              [Location] => examplebucket-1250000000.pic.ap-beijing.myqcloud.com/
              [StyleRule] => Array(
                  [0] => Array(
                      [StyleName] => style_name
                      [StyleBody] => imageMogr2/thumbnail/!50px
                  )
              )
         )
    )
    

    返回结果说明

    参数名称 类型 描述 父节点
    RequestId String 请求 ID 标识
    Bucket String 存储桶名称,格式:BucketName-APPID
    Location String 请求资源地址
    StyleRule Array 样式信息列表

    删除样式

    功能说明

    删除某一特定样式。

    示例代码

    try {
           $result = $cosClient->DeleteBucketImageStyle(array(
           'Bucket' => 'examplebucket-1250000000', //格式:BucketName-APPID
           'StyleName' => 'style_name', //样式名称
       ));
       // 请求成功
       print_r($result);
    } catch (\Exception $e) {
       // 请求失败
       echo($e);
    }
    

    参数说明

    参数名称 类型 描述 是否必填
    Bucket String 存储桶名称,格式:BucketName-APPID
    StyleName String 样式名称

    返回结果示例

    Guzzle\Service\Resource\Model Object
    (
      [structure:protected] => 
      [data:protected] => Array
          (
              [RequestId] => NWQwOGRkNDdfMjJiMjU4NjRfNzVjXzEwNmVjY2M=
              [Bucket] => examplebucket-1250000000
              [Location] => examplebucket-1250000000.pic.ap-beijing.myqcloud.com/
         )
    )
    

    返回结果说明

    参数名称 类型 描述 父节点
    RequestId String 请求 ID 标识
    Bucket String 存储桶名称,格式:BucketName-APPID
    Location String 请求资源地址