云服务器内容精选

  • 权限类型 访问方式 类型 说明 ObsClient.enums.PermissionRead String 如果有桶的读权限,则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限,则可以获取该对象内容和元数据。 ObsClient.enums.PermissionWrite String 如果有桶的写权限,则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 ObsClient.enums.PermissionReadAcp String 如果有读ACP的权限,则可以获取对应的桶或对象的权限控制列表(ACL)。 桶或对象的所有者永远拥有读对应桶或对象ACP的权限。 ObsClient.enums.PermissionWriteAcp String 如果有写ACP的权限,则可以更新对应桶或对象的权限控制列表(ACL)。 桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。 拥有了写ACP的权限,由于可以更改权限控制策略,实际上意味着拥有了完全访问的权限。 ObsClient.enums.PermissionFullControl String 如果有桶的完全控制权限意味着拥有PermissionRead、PermissionWrite、PermissionReadAcp和PermissionWriteAcp的权限。 如果有对象的完全控制权限意味着拥有PermissionRead、PermissionWriteAcp和PermissionWriteAcp的权限。 父主题: 预定义常量
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 ETag String 对象的ETag值。 VersionId String 对象的版本号。 StorageClass String 对象的存储类型,当对象存储类型是标准存储时,该值为空。 SseKms String SSE-KMS方式的算法。 SseKmsKey String SSE-KMS加密方式下使用的KMS主密钥的ID值。 SseC String SSE-C方式的算法。 SseCKeyMd5 String SSE-C方式下加密使用密钥的MD5值,该值用于验证密钥传输过程中是否出错。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Key String 必选 对象名。 RequestDate String 或 Date 可选 指定请求时间。 说明: 当为String类型时,必须符合ISO8601或RFC822规范。 ACL String 可选 创建对象时可指定的预定义访问策略。 StorageClass String 可选 创建对象时可指定的对象的存储类型。 Body String 可选 待上传对象的内容。 SourceFile File 或 Blob 可选 待上传的文件(浏览器必须支持FileReader)。 ProgressCallback Function 可选 获取上传进度的回调函数。 说明: 该回调函数依次包含三个参数:已上传的字节数、总字节数、已使用的时间(单位:秒)。 Offset Number 可选 当设置了SourceFile时有效,代表源文件中某一分段的起始偏移大小,默认值为0, 单位为字节。 Metadata Object 可选 待上传对象的自定义元数据。 WebsiteRedirectLocation String 可选 当桶设置了Website配置,该参数指明对象的重定向地址。 Expires Number 可选 待上传对象的生命周期,单位:天。 SuccessActionRedirect String 可选 上传对象成功后的重定向的地址。 ContentType String 可选 待上传对象的MIME类型。 ContentLength Number 可选 当设置了SourceFile时有效,代表待上传对象数据的长度。 ContentMD5 String 可选 待上传对象数据的MD5值(经过Base64编码),提供给OBS服务端,校验数据完整性。 SseKms String 可选 以SSE-KMS方式加密对象,支持的值: kms SseKmsKey String 可选 SSE-KMS方式下加密的主密钥,可为空。 SseC String 可选 以SSE-C方式加密对象,支持的值: AES256 SseCKey String 可选 SSE-C方式下加密的密钥,由AES256算法得到。 Body与SourceFile不能同时使用。 当Body与SourceFile都为空时,上传对象的大小为0字节。
  • 代码样例 // 创建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, timeout : 300, // 这里以华北-北京四为例,其他地区请按实际情况填写 server: 'https://obs.cn-north-4.myhuaweicloud.com' });
  • 参数描述 字段名 类型 约束 说明 access_key_id String 可选 访问密钥中的AK。 secret_access_key String 可选 访问密钥中的SK。 server String 必选 连接OBS的服务地址。可包含协议类型、域名、端口号。示例:https://your-endpoint:443。 您可以从这里查看OBS当前开通的服务地址。 timeout Number 可选 HTTP/HTTPS请求的总超时时间(单位:秒)。默认为300秒。如网络状况不佳或者上传文件较大,建议增大timeout的值。 is_cname Boolean 可选 是否通过自定义域名访问OBS服务。默认为false。 useRawXhr Boolean 可选 是否使用原生XHR发送Ajax请求。默认为false。
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 Size String 桶的空间大小。 ObjectNumber String 桶内对象个数。 StandardSize String 返回标准存储类型存量大小 StandardObjectNumber String 返回标准存储类型对象个数 WarmSize String obs请求时返回低频存储类型存量大小 WarmObjectNumber String obs请求时返回低频存储类型对象个数 ColdSize String obs请求时返回归档存储类型存量大小 ColdObjectNumber String obs请求时返回归档存储类型对象个数 DeepArchiveSize String 返回深度归档存储类型存量大小 DeepArchiveObjectNumber String 返回深度归档存储类型对象个数 HighPerformanceSize String 返回高性能存储类型存量大小 HighPerformanceObjectNumber String 返回高性能存储类型对象个数 Standard_IASize String s3请求时返回低频存储类型存量大小 Standard_IAObjectNumber String s3请求时返回低频存储类型对象个数 GlacierSize String s3请求时返回归档存储类型存量大小 GlacierObjectNumber String s3请求时返回归档存储类型对象个数
  • 使用前需知 由于浏览器跨域问题,调用对象相关接口前,需要首先配置其所在桶的CORS,如下: 设置允许的请求来源为:* 设置允许的HTTP方法为:PUT, GET, POST, DELETE, HEAD 设置允许请求中可携带的头域为:* 设置允许响应中可返回的附加头域为: ETag Content-Type Content-Length Cache-Control Content-Disposition Content-Encoding Content-Language Expires x-obs-request-id x-obs-id-2 x-reserved-indicator x-obs-api x-obs-version-id x-obs-copy-source-version-id x-obs-storage-class x-obs-delete-marker x-obs-expiration x-obs-website-redirect-location x-obs-restore x-obs-version x-obs-object-type x-obs-next-append-position ObsClient的对象相关操作接口函数均支持首字母大小写,如ObsClient.putObject和ObsClient.PutObject是相同的函数。 父主题: 对象相关接口
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 CorsRules Array 桶的CORS规则列表。 ID String CORS规则ID。 AllowedMethod Array of Strings CORS规则允许的HTTP方法。 AllowedOrigin Array of Strings CORS规则允许的请求来源(表示域名的字符串)。 AllowedHeader Array of Strings CORS规则允许请求中可携带的头域。 MaxAgeSeconds String CORS规则允许客户端可以对跨域请求返回结果的缓存时间,以秒为单位。 ExposeHeader Array of Strings CORS规则允许响应中可返回的附加头域。
  • 请求参数 字段名 类型 约束 说明 Bucket String 可选 桶名。 Key String 可选 对象名,对应表单中的key字段。 Expires Number 可选 表单上传鉴权参数的过期时间(单位:秒),默认值300。 FormParams Object 可选 除key、policy、signature外,表单上传时的其他参数,支持的值: acl cache-control content-type content-disposition content-encoding expires
  • 请求参数 字段名 类型 约束 说明 Method String 必选 HTTP方法类型,支持的值: GET POST PUT DELETE HEAD Bucket String 可选 桶名。 Key String 可选 对象名。 SpecialParam String 可选 特殊操作符,代表要操作的子资源,支持的值: versions uploads location storageinfo quota storagePolicy acl append logging policy lifecycle website versioning cors notification tagging delete restore Expires Number 可选 带授权信息的URL的过期时间(单位:秒),默认值:300。 Headers Object 可选 请求中携带的头域。 QueryParams Object 可选 请求中携带的查询参数。
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 ETag String 合并段后根据各个段的ETag值计算出的结果。 Bucket String 合并段所在的桶。 Key String 合并段后得到的对象名。 Location String 合并段后得到的对象的url。 VersionId String 合并段后得到的对象版本号。
  • 修订记录 发布日期 修订记录 2019-09-03 第九次正式发布: 修改章节: OBS客户端初始化,新增useRawXhr参数; 2019-06-30 第八次正式发布。 修改章节: 判断桶是否存在到恢复归档存储对象,新增RequestDate字段。 2019-04-30 第七次正式发布。 修改章节: 使用前需知,新增x-obs-id-2和x-reserved-indicator字段。 请求对象,新增RequestDate字段。 SDK公共结果对象,新增Id2和Indicator字段。 2019-03-30 第六次正式发布。 新增章节: 简介。 2019-03-05 第五次正式发布。 2019-02-18 第四次正式发布。 新增章节: 断点续传上传 修改章节: 上传对象、下载对象、追加上传、上传段,增加ProgressCallback字段。 2018-08-31 第三次正式发布。 新增章节: 追加上传 生成带授权信息的表单上传参数 2018-03-31 第二次正式发布。 2018-02-24 第一次正式发布。
  • 请求参数 字段名 类型 约束 说明 Bucket String 如未设置UploadCheckpoint则必选 桶名。 Key String 如未设置UploadCheckpoint则必选 对象名。 RequestDate String 或 Date 可选 指定请求时间。 说明: 当为String类型时,必须符合ISO8601或RFC822规范。 SourceFile File 或 Blob 如未设置UploadCheckpoint则必选 待上传的源文件(浏览器必须支持FileReader)。 UploadCheckpoint Object 可选 断点续传记录对象,可通过ResumeCallback获取到。 PartSize Number 可选 分段大小,单位字节,取值范围是100KB~5GB,默认为9MB。 TaskNum Number 可选 分段上传时的最大并发数,默认为1。 ProgressCallback Function 可选 获取上传进度的回调函数。 说明: 该回调函数依次包含三个参数:已上传的字节数、总字节数、已使用的时间(单位:秒)。 EventCallback Function 可选 获取上传事件的回调函数。 说明: 该回调函数依次包含三个参数:事件类型,事件参数,事件结果; 事件类型可能的值:uploadPartSucceed、uploadPartFailed、uploadPartAborted、initiateMultipartUploadSucceed、initiateMultipartUploadFailed、completeMultipartUploadSucceed、completeMultipartUploadFailed、completeMultipartUploadAborted ResumeCallback Function 可选 获取断点续传控制参数的回调函数。 说明: 该回调函数依次包含两个参数:取消断点续传上传任务控制参数,断点续传记录对象; 可以调用取消断点续传上传任务控制参数的cancel方法来暂停断点续传上传任务; 断点续传记录对象中包含sourceFile字段代表待上传的文件,如果浏览器重启后该字段需要调用者重新进行设置。 ACL String 可选 创建对象时可指定的预定义访问策略。 StorageClass String 可选 创建对象时可指定的对象的存储类型。 Metadata Object 可选 对象的自定义元数据信息。 WebsiteRedirectLocation String 可选 当桶设置了Website配置,该参数指明对象的重定向地址。 Expires Number 可选 对象的生命周期,单位:天。 ContentType String 可选 对象的MIME类型。 SseKms String 可选 以SSE-KMS方式加密对象,支持的值:kms SseKmsKey String 可选 SSE-KMS方式下加密的主密钥,可为空。 SseC String 可选 以SSE-C方式加密对象,支持的值:AES256 SseCKey String 可选 SSE-C方式下加密的密钥,由AES256算法得到。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Key String 必选 对象名。 RequestDate String 或 Date 可选 指定请求时间。 说明: 当为String类型时,必须符合ISO8601或RFC822规范。 VersionId String 可选 待恢复归档存储对象的版本号。 Days Number 必选 恢复对象的保存时间(单位:天),取值范围:[1, 30]。 Tier String 可选 恢复选项。
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 Bucket String 桶名。 Key String 对象名。 UploadId String 分段上传任务的ID。 PartNumberMarker String 列举已上传段的起始位置,与请求中的该参数对应。 NextPartNumberMarker String 下次列举已上传段请求的起始位置。 MaxParts String 列举已上传段的返回结果最大段数目,与请求中的该参数对应。 IsTruncated String 表明本次请求是否返回了全部结果,“true”表示没有返回全部结果;“false”表示已返回了全部结果。 Parts Array 已上传段列表。 PartNumber String 段号。 LastModified String 段的最后上传时间。 ETag String 段的ETag值。 Size String 段的大小。 Initiator Object 分段上传任务的创建者。 ID String 创建者的DomainId。 Owner Object 和Initiator相同,代表分段上传任务的创建者。 ID String 创建者的DomainId。 StorageClass String 待分段上传对象的存储类型。