代码样例 此用例用于生成带授权信息的临时URL。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 from obs import ObsClient import os import traceback import base64 # 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取 # security_token = os.getenv("SecurityToken") # server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写 server = "https://obs.cn-north-4.myhuaweicloud.com" # 创建obsClient实例 # 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值 obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) try: # 生成创建桶的带授权信息的URL res1 = obsClient.createSignedUrl(method='PUT', bucketName='bucketname', expires=3600) print('signedUrl:', res1.signedUrl) print('actualSignedRequestHeaders:', res1.actualSignedRequestHeaders) # 生成上传对象的带授权信息的URL res2 = obsClient.createSignedUrl(method='PUT', bucketName='bucketname', objectKey='objectkey', expires=3600, headers={'Content-Type': 'text/plain'}) print('signedUrl:', res2.signedUrl) print('actualSignedRequestHeaders:', res2.actualSignedRequestHeaders) # 生成设置对象ACL的带授权信息的URL res3 = obsClient.createSignedUrl(method='PUT', bucketName='bucketname', objectKey='objectkey', specialParam='acl', expires=3600, headers={'x-obs-acl': 'private'}) print('signedUrl:', res3.signedUrl) print('actualSignedRequestHeaders:', res3.actualSignedRequestHeaders) # 生成下载对象的带授权信息的URL res4 = obsClient.createSignedUrl(method='GET', bucketName='bucketname', objectKey='objectkey', expires=3600) print('signedUrl:', res4.signedUrl) print('actualSignedRequestHeaders:', res4.actualSignedRequestHeaders) # 生成删除对象的带授权信息的URL res5 = obsClient.createSignedUrl(method='DELETE', bucketName='bucketname', objectKey='objectkey', expires=3600) print('signedUrl:', res5.signedUrl) print('actualSignedRequestHeaders:', res5.actualSignedRequestHeaders) # 生成删除桶的带授权信息的URL res6 = obsClient.createSignedUrl(method='DELETE', bucketName='bucketname', expires=3600) print('signedUrl:', res6.signedUrl) print('actualSignedRequestHeaders:', res6.actualSignedRequestHeaders) # 生成设置初始化分段任务的带授权信息的URL res7 = obsClient.createSignedUrl(method='POST', bucketName='bucketname', objectKey='objectkey', specialParam='uploads', expires=3600) print('signedUrl:', res7.signedUrl) print('actualSignedRequestHeaders:', res7.actualSignedRequestHeaders) # 生成上传段的带授权信息的URL, res8 = obsClient.createSignedUrl(method='PUT', bucketName='bucketname', objectKey='objectkey', expires=3600, queryParams={'partNumber': '1', 'uploadId': '00000*****'}) print('signedUrl:', res8.signedUrl) print('actualSignedRequestHeaders:', res8.actualSignedRequestHeaders) # 生成合并段的带授权信息的URL res9 = obsClient.createSignedUrl(method='POST', bucketName='bucketname', objectKey='objectkey', expires=3600, queryParams={'uploadId': '00000*****'}) print('signedUrl:', res9.signedUrl) print('actualSignedRequestHeaders:', res9.actualSignedRequestHeaders) # 生成图片持久化处理的带授权信息的URL # 源对象所在的桶名 bucketName = 'originBucketName'; # 处理前的源对象名 objectKey = 'test.png'; # 处理后的对象名 targetObjectName ="save.png" # 处理后保存的桶名, 可选参数 targetBucketName ="saveBucketName" queryParams={} queryParams["x-image-process"]="image/resize,w_100" queryParams["x-image-save-object"]=base64.b64encode(targetObjectName .encode("utf-8")).decode() # 可选参数 queryParams["x-image-save-bucket"]=base64.b64encode(targetBucketName .encode("utf-8")).decode() res10 = obsClient.createSignedUrl(method='GET', bucketName=bucketName, objectKey=objectKey, queryParams=queryParams, expires=3600) print('signedUrl:', res10.signedUrl) print('actualSignedRequestHeaders:', res10.actualSignedRequestHeaders) except: print(traceback.format_exc())

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 method str 必选 参数解释： HTTP方法类型 取值范围： GET POST PUT DELETE HEAD 默认取值： 无 bucketName str 可选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 objectKey str 可选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 specialParam str 可选 参数解释： 特殊操作符，代表要操作的子资源， 取值范围： versions uploads location storageinfo quota storagePolicy acl append logging policy lifecycle website versioning cors notification tagging delete restore 默认取值： 无 expires int 可选 参数解释： 带授权信息的URL的过期时间。 取值范围： 大于等于0的整型数，单位：秒。 默认取值： 300秒 headers dict 可选 参数解释： 请求中携带的头域。 默认取值： 无 queryParams dict 可选 参数解释： 请求中携带的查询参数。 默认取值： 无 如果遇到跨域报错、签名不匹配问题，请参考以下步骤排查问题： 未配置跨域，需要在控制台配置CORS规则，请参考配置桶允许跨域请求。 签名计算问题，请参考URL中携带签名排查签名参数是否正确；比如上传对象功能，后端将Content-Type参与计算签名生成授权URL，但是前端使用授权URL时没有设置Content-Type字段或者传入错误的值，此时会出现跨域错误。解决方案为：Content-Type字段前后端保持一致。

接口约束 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 如果遇到跨域报错、签名不匹配问题，请参考以下步骤排查问题： 未配置跨域，需要在控制台配置CORS规则，请参考配置桶允许跨域请求。 签名计算问题，请参考URL中携带签名排查签名参数是否正确；比如上传对象功能，后端将Content-Type参与计算签名生成授权URL，但是前端使用授权URL时没有设置Content-Type字段或者传入错误的值，此时会出现跨域错误。解决方案为：Content-Type字段前后端保持一致。

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input CreatePostSignatureSyncInput 必选 参数解释： 生成带授权信息的表单上传参数接口入参，详见CreatePostSignatureSyncInput。 表2 CreatePostSignatureSyncInput 参数名称 参数类型 是否可选 描述 Bucket string 可选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 Key string 可选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4. emyhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 Expires number 可选 参数解释： 表单上传鉴权的过期时间。 取值范围： 0~（263-1），单位：秒。 默认取值： 300 FormParams object 可选 参数解释： 除key，policy，signature外，表单上传时的其他参数。 取值范围： acl、cache-control、content-type、content-disposition、content-encoding、expires。 默认取值： 无

返回结果 表3 CreateBrowserBasedSignatureOutput 参数名称 参数类型 描述 OriginPolicy string 参数解释： Policy未经过base64之前的值，仅用于校验。 示例：{"expiration":"2023-09-12T12:52:59Z","conditions":[{"content-type":"text/plain"},{"bucket":"examplebucket"},{"key":"example/objectname"},]}"。 默认取值： 无 Policy string 参数解释： 表单中的policy，已经base64之后的值。 示例：eyJleHBpcmF0aW9uIjoiMjAyMy0wOS0xMlQxMjo1Mjo1OVoiLCJjb25kaXRpb25zIjpbeyJjb250ZW50LXR5cGUiOiJ0ZXh0L3BsYWluIn0seyJidWNrZXQiOiJleGFtcGxlYnVja2V0In0seyJrZXkiOiJleGFtcGxlL29iamVjdG5hbWUifSxdfQ==。 默认取值： 无 Signature string 参数解释： 表单中的signature。 示例：g0jQr4v9VWd1Q2FOFDG6LGfV9Cw=。 默认取值： 无

响应示例 状态码： 200 获取JsSdk响应。 { "data" : { "page_token_key" : "1724663471194", "page_token" : "752**************************2aa", "js_sdk_url" : "https://orgid-beta.ulanqab.huawei.com/orgid/console-web/jssdk/jssdk.umd.js", "retry_js_sdk_url" : "https://orgid-beta.ulanqab.huawei.com/orgid/console-web/jssdk/jssdk.umd.js", "transaction_id" : "1724663471194", "orgid_config" : "{\"sdk_auth_code\":\"043********************5e1\",\"organization_source\":\"HUAWEI_ID\"}" }, "code" : 0, "msg" : "Successful." }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 消息日志跟踪标识（必须58位）

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应信息 data JsSdkData object jsSdk信息 表3 JsSdkData 参数 参数类型 描述 page_token_key String 后端接口返回参数 page_token String 后端接口返回参数 js_sdk_url String jsSdk的地址 retry_js_sdk_url String jsSdk的地址 transaction_id String 事务id orgid_config String 后端接口返回参数，格式必须为json字符串。值中sdk_auth_code只能使用一次。每次初始化必须后端重新获取。

返回结果说明 表5 返回结果 参数名称 参数类型 描述 output *CreateSignedUrlOutput 参数解释： 接口返回信息，详情参见CreateSignedUrlOutput。 err error 参数解释： 接口返回错误信息。 表6 CreateSignedUrlOutput 参数名称 参数类型 描述 SignedUrl string 参数解释： 带授权信息的URL。 默认取值： 无 ActualSignedRequestHeaders http.Header 参数解释： 通过带授权信息的URL发起请求时实际应携带的头域。 默认取值： 无

请求参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input *CreateSignedUrlInput 必选 参数解释： 生成带授权信息的URL请求参数，详情参见CreateSignedUrlInput。 表2 CreateSignedUrlInput 参数名称 参数类型 是否必选 描述 Method HttpMethodType 必选 参数解释： HTTP方法类型，详情参见HttpMethodType。 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的字符串。 默认取值： 无 SubResource SubResourceType 可选 参数解释： 要访问的子资源，详情参见SubResourceType。 Expires int 可选 参数解释： 带授权信息的URL的过期时间。 取值范围： 0~（231-1），单位：秒。 默认取值： 300 Headers map[string]string 可选 参数解释： 请求中携带的头域。 默认取值： 无 QueryParams map[string]string 可选 参数解释： 请求中携带的查询参数。 默认取值： 无 表3 HttpMethodType 常量名 原始值 说明 HttpMethodGet GET HTTP GET请求。 HttpMethodPut POST HTTP POST请求。 HttpMethodPost PUT HTTP PUT请求。 HttpMethodDelete DELETE HTTP DELETE请求。 HttpMethodHead HEAD HTTP HEAD请求。 HttpMethodOptions OPTIONS HTTP OPTIONS请求。 表4 SubResourceType 常量名 原始值 适用接口 SubResourceStoragePolicy storagePolicy 设置/获取桶存储类型。 SubResourceQuota quota 设置/获取桶配额。 SubResourceStorageInfo storageinfo 获取桶存量信息。 SubResourceLocation location 获取桶区域位置。 SubResourceAcl acl 设置/获取桶ACL、设置/获取对象ACL。 SubResourcePolicy policy 设置/获取/删除桶策略。 SubResourceCors cors 设置/获取/删除桶CORS配置。 SubResourceVersioning versioning 设置/获取桶多版本状态。 SubResourceWebsite website 设置/获取/删除桶Website配置。 SubResourceLogging logging 设置/获取桶日志管理配置。 SubResourceLifecycle lifecycle 设置/获取/删除桶生命周期配置。 SubResourceNotification notification 设置/获取桶时间通知配置。 SubResourceTagging tagging 设置/获取/删除桶标签。 SubResourceDelete delete 批量删除对象。 SubResourceVersions versions 列举桶内多版本对象。 SubResourceUploads uploads 列举桶内分段上传任务、初始化分段上传任务。 SubResourceRestore restore 恢复归档或深度归档存储对象。

接口约束 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 如果遇到跨域报错、签名不匹配问题，请参考以下步骤排查问题： 未配置跨域，需要在控制台配置CORS规则，请参考配置桶允许跨域请求。 签名计算问题，请参考URL中携带签名排查签名参数是否正确；比如上传对象功能，后端将Content-Type参与计算签名生成授权URL，但是前端使用授权URL时没有设置Content-Type字段或者传入错误的值，此时会出现跨域错误。解决方案为：Content-Type字段前后端保持一致。

请求参数 表1 参数列表 字段名 类型 约束 说明 Method String 必选 HTTP方法类型，支持的值： GET POST PUT DELETE HEAD Bucket String 可选 桶名。 Key String 可选 对象名。 SpecialParam String 可选 特殊操作符，代表要访问的子资源，详情参见SubResourceType。 Expires Number 可选 带授权信息的URL的过期时间（单位：秒），默认值：300。 Headers Object 可选 请求中携带的头域。 QueryParams Object 可选 请求中携带的查询参数。 表2 SubResourceType 常量值 适用接口 storagePolicy 设置/获取桶存储类型。 quota 设置/获取桶配额。 storageinfo 获取桶存量信息。 location 获取桶区域位置。 acl 设置/获取桶ACL、设置/获取对象ACL。 policy 设置/获取/删除桶策略。 cors 设置/获取/删除桶CORS配置。 versioning 设置/获取桶多版本状态。 website 设置/获取/删除桶Website配置。 logging 设置/获取桶日志管理配置。 lifecycle 设置/获取/删除桶生命周期配置。 notification 设置/获取桶时间通知配置。 tagging 设置/获取/删除桶标签。 delete 批量删除对象。 versions 列举桶内多版本对象。 uploads 列举桶内分段上传任务、初始化分段上传任务。 restore 恢复归档或深度归档存储对象。

响应消息 响应参数 参数说明见表表1、表2 表1 响应参数说明 参数 类型 说明 maintain_windows Array 支持的维护时间窗列表 表2 maintain_windows参数说明 参数 类型 说明 seq Integer 序号。 begin String 维护时间窗开始时间。 end String 维护时间窗结束时间。 default Boolean 是否为默认时间段。 响应示例 { "maintain_windows": [{ "default": false, "seq": 1, "begin": "22:00:00", "end": "02:00:00" }, { "default": true, "seq": 2, "begin": "02:00:00", "end": "06:00:00" }, { "default": false, "seq": 3, "begin": "06:00:00", "end": "10:00:00" }, { "default": false, "seq": 4, "begin": "10:00:00", "end": "14:00:00" }, { "default": false, "seq": 5, "begin": "14:00:00", "end": "18:00:00" }, { "default": false, "seq": 6, "begin": "18:00:00", "end": "22:00:00" }] }

响应示例 状态码： 200 查询主维度监控对象成功。 { "router" : [ "dcs_instance_id" ], "total" : 1, "children" : [ { "dim_name" : "dcs_cluster_redis_node", "dim_route" : "dcs_instance_id,dcs_cluster_redis_node" } ], "instances" : [ { "name" : "dcs-test001", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19" } ], "dcs_cluster_redis_node" : [ { "name" : "(master)192.168.2.145", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "b1f4aa9e4dae50888e58c9caecdfc108" }, { "name" : "(replica)192.168.2.199", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "e0e10e489a73487147928167396474bc" }, { "name" : "(master)192.168.2.243", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "e797c3ba8bee782e25cdd4a90eb00517" }, { "name" : "(replica)192.168.2.164", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "d810fb44f9f7a359e000cf277a824c43" }, { "name" : "(master)192.168.2.95", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "f25c37a4654d50b07e629fc2adfba60f" }, { "name" : "(replica)192.168.2.51", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "da5149a20dc7caf35587e4d2433fe452" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 router Array of strings 当前查询维度路由。如果是主维度，则数组中是自身ID。 children Array of DimChild objects 当前查询维度子维度对象列表。当前只有维度为dcs_instance_id时才有值。 Proxy集群有两个子维度，分别为dcs_cluster_redis_node和dcs_cluster_proxy_node。 Cluster集群有一个子维度 dcs_cluster_proxy_node。 instances Array of InstancesMonitoredObject objects 当前查询维度监控对象列表。 dcs_cluster_redis_node Array of ClusterRedisNodeMonitoredObject objects Proxy集群或Cluster集群时才存在，表示集群数据节点维度的监控对象列表。字段名称与children的子维度对象名称相同。 dcs_cluster_proxy_node Array of ProxyNodeMonitoredObject objects Redis 3.0 Proxy集群时才存在，表示集群Proxy节点维度的监控对象列表。字段名称与children的子维度对象名称相同。 dcs_cluster_proxy2_node Array of Proxy2NodeMonitoredObject objects Redis 4.0和5.0的Proxy集群时才存在，表示集群Proxy节点维度的监控对象列表。字段名称与children的子维度对象名称相同。 total Integer 主维度监控对象的总数。 表4 DimChild 参数 参数类型 描述 dim_name String 维度名称，当前支持维度有dcs_instance_id、dcs_cluster_redis_node、 dcs_cluster_proxy_node和dcs_memcached_instance_id。 dim_route String 维度的路由，结构为主维度名称,当前维度名称，比如： dim_name字段为dcs_cluster_redis_node时，这个字段的值为dcs_instance_id,dcs_cluster_redis_node。 表5 InstancesMonitoredObject 参数 参数类型 描述 dcs_instance_id String 测量对象ID，即实例的ID。 name String 测量对象名称，即实例名称。 status String 测量对象状态，即实例状态。 表6 ClusterRedisNodeMonitoredObject 参数 参数类型 描述 dcs_instance_id String 测量对象ID，即节点的ID。 name String 测量对象名称，即节点IP。 dcs_cluster_redis_node String 维度dcs_cluster_redis_node的测量对象的ID。 status String 测量对象状态，即节点状态。 表7 ProxyNodeMonitoredObject 参数 参数类型 描述 dcs_instance_id String 测量对象ID，即节点的ID。 name String 测量对象名称，即节点IP。 dcs_cluster_proxy_node String 维度dcs_cluster_proxy_node 的测量对象的ID。 status String 测量对象状态，即节点状态。 表8 Proxy2NodeMonitoredObject 参数 参数类型 描述 dcs_instance_id String 测量对象ID，即节点的ID。 name String 测量对象名称，即节点IP。 dcs_cluster_proxy2_node String 维度dcs_cluster_proxy2_node 的测量对象的ID。 status String 测量对象状态，即节点状态。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024