UNPKG

ks3-js-sdk

Version:

js sdk for ks3

1,409 lines (1,405 loc) 37.7 kB
export let apiList = [{ name: 'listObjects', info: '获取对象列表', method: 'GET', document: 'https://docs.ksyun.com/documents/42288', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'delimiter', required: false, text: '否', describe: '分隔符,用于对一组参数进行分割的字符', tip: '字符串', type: 'String', show: true }, { name: 'encoding-type', required: false, text: '否', describe: '前缀匹配,用来规定返回的文件前缀地址', tip: '字符串', type: 'String', show: true }, { name: 'marker', required: false, text: '否', describe: '指定列举指定空间中对象的起始位置', tip: '非负整数', type: 'String', show: true }, { name: 'max-keys', required: false, text: '否', describe: '设置响应体中返回的最大记录数', tip: '正整数', type: 'String', show: true }, { name: 'prefix', required: false, text: '否', describe: '限定响应结果列表使用的前缀', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { delimiter: '', 'encoding-type': '', marker: '', 'max-keys': '', prefix: '' }, rules: { delimiter: { required: false }, 'encoding-type': { required: false }, marker: { required: false, digits: true }, 'max-keys': { required: false, digits: true, min: 1 }, prefix: { required: false }, signature: { required: false } } }, { name: 'headObject', info: '获取对象信息', method: 'HEAD', document: 'https://docs.ksyun.com/documents/42319', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '' }, rules: { key: { required: true }, signature: { required: false } } }, { name: 'getObject', info: '获取对象', method: 'GET', document: 'https://docs.ksyun.com/documents/42320', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'range', required: false, text: '否', describe: '用于请求资源的部分内容,单位是byte', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '', range: '' }, rules: { key: { required: true }, range: { required: false }, signature: { required: false } } }, { name: 'getObjectUrl', info: '获取对象的Url', method: '无', document: '', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'method', required: false, text: '否', describe: '请求方法,PUT/GET/POST/DELETE', tip: '字符串', type: 'String', show: true }, { name: 'expires', required: false, text: '否', describe: '签名失效时间,默认为900秒', tip: '正整数', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false } ], paramsForm: { key: '', method: '', expires: '' }, rules: { key: { required: true }, signature: { required: false }, expires: { required: false, digits: true, min: 1 } } }, { name: 'putObjectByPresignedUrl', info: '外链上传', method: '无', document: '', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'expiration', required: false, text: '否', describe: '超时时间,默认为900秒', tip: '正整数', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, ], paramsForm: { key: '', expiration: '' }, rules: { key: { required: true }, expiration: { required: false, digits: true, min: 1 } } }, { name: 'delObject', info: '删除指定对象', method: 'DELETE', document: 'https://docs.ksyun.com/documents/42318', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '' }, rules: { key: { required: true }, signature: { required: false } } }, { name: 'postObject', info: 'post方法添加对象', method: 'POST', document: 'https://docs.ksyun.com/documents/42322', params: [ { name: 'file', required: true, text: '是', describe: '上传的文件', tip: '文件', type: 'File', show: true }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'acl', required: false, text: '否', describe: '文件预设ACL(private | public-read),默认值private', tip: '字符串', type: 'String', show: true }, { name: 'KSSAccessKeyId', required: true, text: '是', describe: 'AK,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需传入,由其他参数计算得出', tip: '字符串', type: 'String', show: false }], paramsForm: { file: '', key: '', acl: '' }, rules: { key: { required: true }, acl: { required: false }, policy: { required: false }, file: { required: true }, encryption: { required: false } } }, { name: 'putObject', info: 'put方法添加对象', method: 'PUT', document: 'https://docs.ksyun.com/documents/42325', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'file', required: true, text: '是', describe: '上传的文件', tip: '文件', type: 'File', show: true }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'acl', required: false, text: '否', describe: '文件预设ACL(private | public-read),默认值private', tip: '字符串', type: 'String', show: true }, { name: 'encryption', required: false, text: '否', describe: '是否加密文件,若加密请填写true', tip: '布尔值', type: 'Boolean', show: true }, { name: 'storageClass', required: false, text: '否', describe: '对象的存储类型,STANDARD/STANDARD_IA/ARCHIVE', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { file: '', key: '', acl: '', encryption: '', storageClass: '' }, rules: { key: { required: true }, file: { required: true } } }, { name: 'getObjectAcl', info: '获取对象的ACL', method: 'GET', document: 'https://docs.ksyun.com/documents/42336', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '' }, rules: { key: { required: true }, signature: { required: false } } }, { name: 'putObjectAcl', info: '设置对象的ACL', method: 'PUT', document: 'https://docs.ksyun.com/documents/42337', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'acl', required: true, text: '是', describe: '文件预设ACL(private | public-read),默认值private', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '', acl: '' }, rules: { key: { required: true }, acl: { required: true }, signature: { required: false } } }, { name: 'uploadMultiPart', info: '本地文件分块上传', method: 'PUT', document: 'https://docs.ksyun.com/documents/42334', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'file', required: true, text: '是', describe: '上传的文件', tip: '文件', type: 'File', show: true }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'acl', required: false, text: '否', describe: '文件预设ACL(private | public-read),默认值private', tip: '字符串', type: 'String', show: true }, { name: 'encryption', required: false, text: '否', describe: '是否加密文件,若加密请填写true', tip: '布尔值', type: 'Boolean', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { file: '', key: '', acl: '', encryption: '' }, rules: { key: { required: true }, acl: { required: false }, file: { required: true }, signature: { required: false } } }, { name: 'listParts', info: '列出指定上传任务中所有已上传的块', method: 'GET', document: 'https://docs.ksyun.com/documents/42329', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'uploadId', required: true, text: '是', describe: '初始化分块上传时获取的上传id', tip: '字符串', type: 'String', show: true }, { name: 'maxParts', required: false, text: '否', describe: '设置响应体中块的最大数量(默认值: 1000)', tip: '正整数', type: 'String', show: true }, { name: 'partNumberMarker', required: false, text: '否', describe: '指定应该从哪个块开始列举(只有比设定值大的块才会被列举)', tip: '正整数', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '', uploadId: '', maxParts: '', partNumberMarker: '' }, rules: { key: { required: true }, uploadId: { required: true }, maxParts: { required: false, digits: true, min: 1 }, partNumberMarker: { required: false, digits: true, min: 1 }, signature: { required: false } } }, { name: 'abortMultipartUpload', info: '取消已上传块', method: 'DELETE', document: 'https://docs.ksyun.com/documents/42330', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'uploadId', required: true, text: '是', describe: '初始化分块上传时获取的上传id', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '', uploadId: '' }, rules: { key: { required: true }, uploadId: { required: true }, signature: { required: false } } }, { name: 'listMultipartUploads', info: '列出所有正在进行的分块上传任务', method: 'GET', document: 'https://docs.ksyun.com/documents/42328', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'max-uploads', required: false, text: '否', describe: '限定要列出正在进行任务的上限值([1,1000]),默认1000', tip: '正整数', type: 'String', show: true }, { name: 'upload-id-marker', required: false, text: '否', describe: '与key-marker配合使用,指定列举目标空间中正在进行分块上传任务的起始位置', tip: '字符串', type: 'String', show: true }, { name: 'key-marker', required: false, text: '否', describe: '与upload-id-marker配合使用,指定列举目标空间中正在进行分块上传任务的起始位置', tip: '字符串', type: 'String', show: true }, { name: 'encoding-type', required: false, text: '否', describe: '指明请求KS3与KS3响应使用的编码方式。object key 可以包含任意Unicode字符', tip: '字符串', type: 'String', show: true }, { name: 'prefix', required: false, text: '否', describe: '限定响应结果列表使用的前缀,正如你在电脑中使用的文件夹一样', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { 'max-uploads': '', 'upload-id-marker': '', 'key-marker': '', 'encoding-type': '', 'prefix': '' }, rules: { 'max-uploads': { required: false, digits: true, min: 1 } } }, { name: 'uploadPartCopy', info: '分块复制文件', method: 'PUT', document: 'https://docs.ksyun.com/documents/42327', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '目标文件的key', tip: '字符串', type: 'String', show: true }, { name: 'sourceBucket', required: true, text: '是', describe: '源文件的bucket', tip: '字符串', type: 'String', show: true }, { name: 'sourceKey', required: true, text: '是', describe: '源文件的key', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '', sourceBucket: '', sourceKey: '' }, rules: { key: { required: true }, sourceBucket: { required: true }, sourceKey: { required: true }, signature: { required: false }, } }, { name: 'putObjectCopy', info: '复制小文件', method: 'PUT', document: 'https://docs.ksyun.com/documents/42324', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '目标的key', tip: '字符串', type: 'String', show: true }, { name: 'sourceBucket', required: true, text: '是', describe: '源文件的bucket', tip: '字符串', type: 'String', show: true }, { name: 'sourceKey', required: true, text: '是', describe: '源文件的key', tip: '字符串', type: 'String', show: true }, { name: 'storageClass', required: false, text: '是', describe: '对象的存储类型,STANDARD/STANDARD_IA/ARCHIVE', tip: '字符串', type: 'String', show: true }, { name: 'encryption', required: false, text: '否', describe: '是否加密文件,若加密请填写true,如果源文件进行过加密,copy时目标文件也要进行加密', tip: '布尔值', type: 'Boolean', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '', sourceBucket: '', sourceKey: '', storageClass: '', encryption: '' }, rules: { key: { required: true }, sourceBucket: { required: true }, sourceKey: { required: true }, signature: { required: false }, } }, { name: 'restoreObject', info: '解冻指定对象', method: 'POST', document: 'https://docs.ksyun.com/documents/42343', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '' }, rules: { key: { required: true }, signature: { required: false } } }, { name: 'modifyStorageClass', info: '修改对象的存储类型', method: 'PUT', document: '', params: [ { name: 'bucket', required: true, text: '是', describe: 'bucket的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'region', required: true, text: '是', describe: 'region的名称,在全局配置中填写', tip: '字符串', type: 'String', show: false }, { name: 'key', required: true, text: '是', describe: '请求对象的key', tip: '字符串', type: 'String', show: true }, { name: 'storageClass', required: true, text: '是', describe: '对象的存储类型,STANDARD/STANDARD_IA/ARCHIVE', tip: '字符串', type: 'String', show: true }, { name: 'headers', required: false, text: '否', describe: '自定义请求头信息', tip: '对象', type: 'Object', show: false }, { name: 'signature', required: true, text: '是', describe: '请求签名,无需填写,该参数会自动获取', tip: '字符串', type: 'String', show: false }], paramsForm: { key: '', storageClass: '' }, rules: { key: { required: true }, storageClass: { required: true }, signature: { required: false } } }] export var apiMenu = [ { type: 'Object相关', list: [ 'listObjects', 'headObject', 'getObject', 'getObjectUrl', 'putObjectByPresignedUrl', 'delObject', 'postObject', 'putObject', 'getObjectAcl', 'putObjectAcl', ] }, { type: '分块上传相关', list: [ 'uploadMultiPart', 'listParts', 'abortMultipartUpload', 'listMultipartUploads', ] }, { type: '文件管理相关', list: [ 'uploadPartCopy', 'putObjectCopy', 'restoreObject', 'modifyStorageClass' ] } ]