tencent cloud

边缘安全加速平台 EO

动态与公告
产品动态
安全公告
产品公告
产品简介
产品概述
产品优势
应用场景
EdgeOne 与 CDN 等产品功能对比
使用限制
购买指南
试用套餐体验权益说明
免费版套餐使用说明
计费概述
计费项目
购买指引
续费指引
欠费与退款说明
套餐选型对比
关于“干净流量”计费说明
DDoS 防护容量说明
快速入门
选择业务场景
快速接入网站安全加速
通过 Pages 快速部署网站
域名服务与源站配置
域名服务
HTTPS 证书
源站配置
站点加速
概述
访问控制
智能加速
缓存配置
文件优化
网络优化
URL 重写
修改头部
修改应答内容
规则引擎
图片与视频处理
单连接下载限速
DDoS 与 Web 防护
概述
DDoS 防护
Web 防护
Bot 管理
API 资产识别(Beta)
边缘函数
概述
快速指引
操作指引
Runtime APIs
示例函数
实践教程
Pages
四层代理
概述
新建四层代理实例
修改四层代理实例配置
停用/删除四层代理实例
批量配置转发规则
获取客户端真实IP
数据分析与日志服务
日志服务
数据分析
告警服务
站点与计费管理
计费管理
站点管理
版本管理
通用策略
通用参考
配置语法
请求与响应行为
国家/地区及对应代码枚举
Terraform
Terraform 简介
安装和配置 Terraform
实践教程
自动预热/清除缓存
防盗刷/盗链实践
HTTPS 相关实践
加速优化
流量调度
数据分析与告警
第三方日志平台集成实践
对象存储类源站(例如:COS)配置实践
跨域响应配置
API 文档
History
Introduction
API Category
Making API Requests
Site APIs
Acceleration Domain Management APIs
Site Acceleration Configuration APIs
Edge Function APIs
Alias Domain APIs
Security Configuration APIs
Layer 4 Application Proxy APIs
Content Management APIs
Data Analysis APIs
Log Service APIs
Billing APIs
Certificate APIs
Origin Protection APIs
Load Balancing APIs
Diagnostic Tool APIs
Custom Response Page APIs
API Security APIs
DNS Record APIs
Content Identifier APIs
Legacy APIs
Ownership APIs
Image and Video Processing APIs
Multi-Channel Security Gateway APIs
Version Management APIs
Data Types
Error Codes
常见问题
产品特性相关问题
DNS 记录相关问题
域名配置相关问题
站点加速相关问题
数据与日志相关问题
安全防护相关问题
源站配置相关问题
排障指南
异常状态码参考
EdgeOne 4XX/5XX 状态码排障指南
520/524状态码排障指南
521/522 状态码排障指南
工具指南
相关协议
Service Level Agreement
源站防护启用特别约定
TEO 政策
隐私协议
数据处理和安全协议
联系我们
词汇表

Cookies

PDF
聚焦模式
字号
最后更新时间: 2024-01-30 17:05:56
Cookies 提供了一组 cookie 操作接口。
注意:
Cookies 对象以 name + domain + path 为唯一 key, 管理 Cookie 对象集。

构造函数

const cookies = new Cookies(cookieStr?: string, isSetCookie?: boolean);

参数

参数名称
类型
必填
说明
cookieStr
string
Cookie 字符串或者 Set-Cookie 字符串。
isSetCookie
boolean
参数 cookieStr 是否是 Set-Cookie 字符串,默认为 false。

方法

get

cookies.get(name?: string): null | Cookie | Array<Cookie>;
获取指定名称的 Cookie 对象。存在多个 name 匹配时,返回 Cookie 数组。

参数

参数名称
类型
必填
说明
name
string
Cookie 名称,取值说明如下。
缺省 name
表示获取所有 Cookie 对象。
指定 name
表示获取指定 name 的 Cookie 对象,存在多个匹配时,返回 Cookie 数组。
Cookie 对象属性如下,详细参见 MDN 官方文档 Set-Cookie
属性名
类型
只读
说明
name
string
Cookie 名称。
value
string
Cookie 值。
domain
string
Cookie 的作用域名。
path
string
Cookie 的作用路径。
expires
string
Cookie 最长有效时间, 取值符合 HTTP Date 首部标准。
max_age
string
Cookie 经过 max_age 秒失效,单位秒(s)。
samesite
string
控制 Cookie 跨站点请求伪造攻击(CSRF)的保护。
httponly
boolean
禁止 JavaScript 访问 Cookie,仅限 HTTP 请求携带。
secure
boolean
Cookie 仅限 HTTPS 请求协议携带。

set

cookies.set(name: string, value: string, options?: Cookie): boolean;
覆盖添加 Cookie。返回 true,表示添加成功,返回 false,表示添加失败(超过了 cookies 数量限制,详细参见 cookies 大小限制)。
注意:
name + domain + path 为唯一 key,覆盖添加 Cookie。

参数

参数名称
类型
必填
说明
name
string
Cookie 名称。
value
string
Cookie 值。
Cookie
string
Cookie 属性配置项。

append

cookies.append(name: string, value: string, options?: Cookie): boolean;
追加 Cookie,用于相同 name, 多个 value 的场景。返回 true,表示添加成功,返回 false,表示添加失败(value 重复或超过了 cookies 数量限制,详细参见 cookies 大小限制)。
注意:
name + domain + path 为唯一 key 追加 Cookie。

remove

cookies.remove(name: string, options?: Cookie): boolean;
删除 Cookie。
注意:
name + domain + path 为唯一 key 删除 Cookie。

参数

参数名称
类型
必填
说明
name
string
Cookie 名称。
options
Cookie 属性配置项,其中属性 domian 和 path 可支持 *, 表示匹配所有。

使用限制

特殊字符自动转义

name 值包含字符 " ( ) , / : ; ? < = > ? @ [ ] \\ { }0x00~0x1F0x7F~0xFF 将被自动转义。
value 值包含字符 , , ; " \\0x00~0x1F0x7F~0xFF 将被自动转义。

cookies 大小限制

Cookie 属性 name 大小不超过 64B。
Cookie 属性 value, domain, path, expires, max_age, samesite 累计大小不超过 1KB。
cookies 转义后所有字段总长度不超过 4KB。
cookies 中包含的 Cookie 对象总数不超过 64个。

示例代码

function handleEvent(event) {
const response = new Response('hello world');

// 生成 cookies 对象
const cookies = new Cookies('ssid=helloworld; expires=Sun, 10-Dec-2023 03:10:01 GMT; path=/; domain=.tencentcloud.com; samesite=.tencentcloud.com', true);

// 设置响应头 Set-Cookie
response.setCookies(cookies);

return response;
}

addEventListener('fetch', (event) => {
event.respondWith(handleEvent(event));
});

相关参考

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈