Skip to content

Commit cd1ad63

Browse files
carsonxucarsonxu
committedNov 5, 2018
update csp doc
·
v1.8.7v0.4.23
1 parent 198bb79 commit cd1ad63

File tree

3 files changed

+19
-249
lines changed

3 files changed

+19
-249
lines changed
 

‎csp/api.md

+4-203
Original file line numberDiff line numberDiff line change
@@ -898,47 +898,7 @@ Put Bucket Lifecycle 接口可以设置存储桶的生命周期规则。
898898

899899
#### 使用示例
900900

901-
示例一：上传 30 天后，沉降至低频存储
902-
```js
903-
cos.putBucketLifecycle({
904-
Bucket: 'test-1250000000', /* 必须 */
905-
Region: 'ap-guangzhou', /* 必须 */
906-
Rules: [{
907-
"ID": "1",
908-
"Status": "Enabled",
909-
"Filter": {},
910-
"Transition": {
911-
"Days": "30",
912-
"StorageClass": "STANDARD_IA"
913-
}
914-
}],
915-
}, function(err, data) {
916-
console.log(err || data);
917-
});
918-
```
919-
920-
示例二：指定目录前缀 dir/，上传 90 天后，沉降至归档存储
921-
```js
922-
cos.putBucketLifecycle({
923-
Bucket: 'test-1250000000', /* 必须 */
924-
Region: 'ap-guangzhou', /* 必须 */
925-
Rules: [{
926-
"ID": "2",
927-
"Filter": {
928-
"Prefix": "dir/",
929-
},
930-
"Status": "Enabled",
931-
"Transition": {
932-
"Days": "90",
933-
"StorageClass": "ARCHIVE"
934-
}
935-
}],
936-
}, function(err, data) {
937-
console.log(err || data);
938-
});
939-
```
940-
941-
示例三：上传 180 天后，删除文件
901+
示例一：上传 180 天后，删除文件
942902
```js
943903
cos.putBucketLifecycle({
944904
Bucket: 'test-1250000000', /* 必须 */
@@ -956,7 +916,7 @@ cos.putBucketLifecycle({
956916
});
957917
```
958918

959-
示例四：上传 30 天后，删除碎片
919+
示例二：上传 30 天后，删除碎片（未完成的UploadId）
960920
```js
961921
cos.putBucketLifecycle({
962922
Bucket: 'test-1250000000', /* 必须 */
@@ -988,6 +948,8 @@ cos.putBucketLifecycle({
988948
| - - - Prefix | 规则要匹配上的 Object 前缀 | String | 否 |
989949
| - - Expiration | 表示对 Object 删除 | Object | 否 |
990950
| - - - Days | 规则生效天数，按文件上传时间开始算，必须为正整数 | Object | 是 |
951+
| - - AbortIncompleteMultipartUpload | 表示删除碎片 | Object | 否 |
952+
| - - - Days | 规则生效天数，按文件上传时间开始算，必须为正整数 | Object | 是 |
991953

992954
#### 回调函数说明
993955

@@ -1045,167 +1007,6 @@ function(err, data) { ... }
10451007
| - headers | 请求返回的头部信息 | Object |
10461008

10471009

1048-
### Get Bucket Replication
1049-
1050-
Get Bucket Replication 接口实现获取存储桶的跨区域复制规则
1051-
1052-
#### 使用示例
1053-
1054-
```js
1055-
cos.getBucketReplication({
1056-
Bucket: 'test-1250000000', /* 必须 */
1057-
Region: 'ap-guangzhou', /* 必须 */
1058-
}, function(err, data) {
1059-
console.log(err || data);
1060-
});
1061-
```
1062-
1063-
#### 返回示例
1064-
1065-
```json
1066-
{
1067-
"ReplicationConfiguration": {
1068-
"Role": "qcs::cam::uin/459000000:uin/459000000",
1069-
"Rules": {
1070-
"ID": "1",
1071-
"Status": "Enabled",
1072-
"Prefix": "sync/",
1073-
"Destination": {
1074-
"Bucket": "qcs:id/0:cos:ap-chengdu:appid/1250000000:backup",
1075-
"StorageClass": "Standard"
1076-
}
1077-
}
1078-
},
1079-
"statusCode": 200,
1080-
"headers": {}
1081-
}
1082-
```
1083-
1084-
#### 参数说明
1085-
1086-
| 参数名 | 参数描述 | 类型 | 必填 |
1087-
|--------|----------|------|------|
1088-
| Bucket | Bucket 的名称。命名规则为{name}-{appid} ，此处填写的存储桶名称必须为此格式 | String | 是 |
1089-
| Region | Bucket 所在区域。枚举值请见：[Bucket 地域信息](https://cloud.tencent.com/document/product/436/6224) | String | 是 |
1090-
1091-
#### 回调函数说明
1092-
1093-
```js
1094-
function(err, data) { ... }
1095-
```
1096-
1097-
| 参数名 | 参数描述 | 类型 |
1098-
|--------|----------|------|
1099-
| err | 请求发生错误时返回的对象，包括网络错误和业务错误。如果请求成功，则为空，[错误码文档](https://cloud.tencent.com/document/product/436/7730) | Object |
1100-
| data | 请求成功时返回的对象，如果请求发生错误，则为空 | Object |
1101-
| - ReplicationConfiguration | 跨区域复制规则 | Object |
1102-
| - - Role | 复制过程以什么角色的身份，格式：qcs::cam::uin/10001:uin/10002，其中 10001 是主帐号，10002 是子帐号 | Object |
1103-
| - - Rules | 复制具体规则列表 | ObjectArray |
1104-
| - - - ID | 任务标识 ID | String |
1105-
| - - - Status | 规则状态，枚举值：Enabled、Disabled | String |
1106-
| - - - Prefix | 要复制的 Object 前缀 | String |
1107-
| - - - Destination | 要复制的 Object 前缀 | Object |
1108-
| - - - - Bucket | 要复制到的存储桶，格式：qcs:id/0:cos:<Region>:appid/<AppId>:<ShortBucketName>，例如：qcs:id/0:cos:ap-guangzhou:appid/1250000000:backup | Object |
1109-
| - - - - StorageClass | 复制后的存储类型，枚举值：STANDARD、STANDARD_IA，默认值：STANDARD | Object |
1110-
1111-
1112-
### Put Bucket Replication
1113-
1114-
Put Bucket Replication 接口实现设置存储桶的跨区域复制规则。
1115-
1116-
#### 使用示例
1117-
1118-
```js
1119-
cos.putBucketReplication({
1120-
Bucket: 'test-1250000000', /* 必须 */
1121-
Region: 'ap-guangzhou', /* 必须 */
1122-
ReplicationConfiguration: { /* 必须 */
1123-
Role: "qcs::cam::uin/459000000:uin/459000000",
1124-
Rules: [{
1125-
ID: "1",
1126-
Status: "Enabled",
1127-
Prefix: "sync/",
1128-
Destination: {
1129-
Bucket: "qcs:id/0:cos:ap-chengdu:appid/1250000000:backup",
1130-
StorageClass: "Standard",
1131-
}
1132-
}]
1133-
}
1134-
}, function (err, data) {
1135-
console.log(err || data);
1136-
});
1137-
```
1138-
1139-
#### 参数说明
1140-
1141-
| 参数名 | 参数描述 | 类型 | 必填 |
1142-
|--------|----------|------|------|
1143-
| Bucket | Bucket 的名称。命名规则为{name}-{appid} ，此处填写的存储桶名称必须为此格式 | String | 是 |
1144-
| Region | Bucket 所在区域。枚举值请见：[Bucket 地域信息](https://cloud.tencent.com/document/product/436/6224) | String | 是 |
1145-
| ReplicationConfiguration | 定义跨区域复制规则 | Object | 是 |
1146-
| - Role | 复制过程以什么角色的身份，格式：qcs::cam::uin/10001:uin/10002，其中 10001 是主帐号，10002 是子帐号 | Object | 否 |
1147-
| - Rules | 复制具体规则列表 | ObjectArray | 是 |
1148-
| - - ID | 任务标识 ID | String | 否 |
1149-
| - - Status | 规则状态，枚举值：Enabled、Disabled | String | 是 |
1150-
| - - Prefix | 要复制的 Object 前缀 | String | 否 |
1151-
| - - Destination | 要复制的 Object 前缀 | Object | 是 |
1152-
| - - - Bucket | 要复制到的存储桶，格式：qcs:id/0:cos:<Region>:appid/<AppId>:<ShortBucketName>，例如：qcs:id/0:cos:ap-guangzhou:appid/1250000000:backup | Object | 是 |
1153-
| - - - StorageClass | 复制后的存储类型，枚举值：STANDARD、STANDARD_IA，默认值：STANDARD | Object | 否 |
1154-
1155-
#### 回调函数说明
1156-
1157-
```js
1158-
function(err, data) { ... }
1159-
```
1160-
1161-
| 参数名 | 参数描述 | 类型 |
1162-
|--------|----------|------|
1163-
| err | 请求发生错误时返回的对象，包括网络错误和业务错误。如果请求成功，则为空，[错误码文档](https://cloud.tencent.com/document/product/436/7730) | Object |
1164-
| - statusCode | 请求返回的 HTTP 状态码，如 200、403、404 等 | Number |
1165-
| - headers | 请求返回的头部信息 | Object |
1166-
| data | 请求成功时返回的对象，如果请求发生错误，则为空 | Object |
1167-
| - statusCode | 请求返回的 HTTP 状态码，如 200、403、404 等 | Number |
1168-
| - headers | 请求返回的头部信息 | Object |
1169-
1170-
1171-
### Delete Bucket Replication
1172-
1173-
Delete Bucket Replication 接口可以删除存储桶的跨区域复制规则。
1174-
1175-
#### 使用示例
1176-
1177-
```js
1178-
cos.deleteBucketReplication({
1179-
Bucket: 'test-1250000000', /* 必须 */
1180-
Region: 'ap-guangzhou', /* 必须 */
1181-
}, function(err, data) {
1182-
console.log(err || data);
1183-
});
1184-
```
1185-
1186-
#### 参数说明
1187-
1188-
| 参数名 | 参数描述 | 类型 | 必填 |
1189-
|--------|----------|------|------|
1190-
| Bucket | Bucket 的名称。命名规则为{name}-{appid} ，此处填写的存储桶名称必须为此格式 | String | 是 |
1191-
| Region | Bucket 所在区域。枚举值请见：[Bucket 地域信息](https://cloud.tencent.com/document/product/436/6224) | String | 是 |
1192-
1193-
#### 回调函数说明
1194-
1195-
```js
1196-
function(err, data) { ... }
1197-
```
1198-
1199-
| 参数名 | 参数描述 | 类型 |
1200-
|--------|----------|------|
1201-
| err | 请求发生错误时返回的对象，包括网络错误和业务错误。如果请求成功，则为空，[错误码文档](https://cloud.tencent.com/document/product/436/7730) | Object |
1202-
| - statusCode | 请求返回的 HTTP 状态码，如 200、403、404 等 | Number |
1203-
| - headers | 请求返回的头部信息 | Object |
1204-
| data | 请求成功时返回的对象，如果请求发生错误，则为空 | Object |
1205-
| - statusCode | 请求返回的 HTTP 状态码，如 200、403、404 等 | Number |
1206-
| - headers | 请求返回的头部信息 | Object |
1207-
1208-
12091010

12101011
## Object 操作
12111012

‎csp/auth.php ‎csp/auth-json.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -151,4 +151,6 @@ function obj2str($obj)
151151
header('Content-Type: text/plain');
152152
header('Allow-Control-Allow-Origin: http://127.0.0.1'); // 这里修改允许跨域访问的网站
153153
header('Allow-Control-Allow-Headers: origin,accept,content-type');
154-
echo getAuthorization($method, $pathname, $query, $headers);
154+
$sign = getAuthorization($method, $pathname, $query, $headers);
155+
156+
echo '{"sign":"' . $sign .'"}';

‎csp/csp.html

+12-45
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,24 @@ <h1>cos-js-sdk-v5</h1>
4747
var cos = new COS({
4848
CompatibilityMode: true,
4949
ServiceDomain: 'http://cos.default.example.com',
50+
51+
// 后缀式
5052
Domain: 'http://cos.{Region}.example.com', // 后缀式
5153
ForcePathStyle: true, // 后缀式
54+
55+
// 前缀式
5256
// Domain: 'http://{Bucket}.cos.{Region}.example.com', // 前缀式
57+
5358
getAuthorization: function (options, callback) {
54-
var url = './auth.php?method=' + options.Method + '&pathname=' + encodeURIComponent(options.Key);
59+
var url = './auth-json.php?method=' + options.Method + '&pathname=' + encodeURIComponent(options.Key);
5560
var xhr = new XMLHttpRequest();
5661
xhr.open('GET', url, true);
5762
xhr.onload = function (e) {
58-
callback(e.target.responseText);
63+
var sign;
64+
try {
65+
sign = JSON.parse(e.target.responseText).sign;
66+
} catch (e) {}
67+
callback(sign);
5968
};
6069
xhr.send();
6170
},
@@ -92,7 +101,7 @@ <h1>cos-js-sdk-v5</h1>
92101

93102
function getAuth() {
94103
var key = '1.png';
95-
getAuthorization({
104+
cos.options.getAuthorization({
96105
Method: 'get',
97106
Key: key
98107
}, function (auth) {
@@ -270,45 +279,6 @@ <h1>cos-js-sdk-v5</h1>
270279
});
271280
}
272281

273-
function putBucketReplication() {
274-
var AppId = config.Bucket.substr(config.Bucket.lastIndexOf('-') + 1);
275-
cos.putBucketReplication({
276-
Bucket: config.Bucket, // Bucket 格式：test-1250000000
277-
Region: config.Region,
278-
ReplicationConfiguration: {
279-
Role: "qcs::cam::uin/459000000:uin/459000000",
280-
Rules: [{
281-
ID: "1",
282-
Status: "Enabled",
283-
Prefix: "img/",
284-
Destination: {
285-
Bucket: "qcs::cos:ap-guangzhou::test-" + AppId
286-
},
287-
}]
288-
}
289-
}, function (err, data) {
290-
logger.log(err || data);
291-
});
292-
}
293-
294-
function getBucketReplication() {
295-
cos.getBucketReplication({
296-
Bucket: config.Bucket, // Bucket 格式：test-1250000000
297-
Region: config.Region
298-
}, function (err, data) {
299-
logger.log(err || data);
300-
});
301-
}
302-
303-
function deleteBucketReplication() {
304-
cos.deleteBucketReplication({
305-
Bucket: config.Bucket, // Bucket 格式：test-1250000000
306-
Region: config.Region
307-
}, function (err, data) {
308-
logger.log(err || data);
309-
});
310-
}
311-
312282
function deleteBucket() {
313283
cos.deleteBucket({
314284
Bucket: 'testnew-' + config.Bucket.substr(config.Bucket.lastIndexOf('-') + 1),
@@ -654,9 +624,6 @@ <h1>cos-js-sdk-v5</h1>
654624
'getBucketLifecycle',
655625
'putBucketLifecycle',
656626
'deleteBucketLifecycle',
657-
'putBucketReplication',
658-
'getBucketReplication',
659-
'deleteBucketReplication',
660627
'deleteBucket',
661628
'putObject',
662629
'putObjectCopy',

0 commit comments

Comments
 (0)
Please sign in to comment.