Tencent EdgeOne Documentation

https://edgeone.ai/zh/document
Admin
Tencent EdgeOne provides edge acceleration, security, and developer platforms, including edge...
Tokens:1,044,643
Snippets:5,330
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install dependencies and start dev server

Source: https://edgeone.ai/zh/document/196763737788014592

After creating the project, navigate into the directory, install dependencies, and start the development server. This is the standard workflow for local development.

```bash
cd my-vue-app
npm install
npm run dev
```

--------------------------------

### Install EdgeOne CLI in sandbox image

Source: https://edgeone.ai/zh/document/162228053922476032

Dockerfile steps to install the EdgeOne CLI in a sandbox image. The example script downloads and extracts the CLI package, installs it to system directories, and creates an `edgeone` command entry accessible via PATH. After building, verify with `edgeone --version`.

```dockerfile
COPY scripts/install-edgeone-cli.example.sh /tmp/install-edgeone-cli.sh
RUN bash /tmp/install-edgeone-cli.sh && rm /tmp/install-edgeone-cli.sh
```

--------------------------------

### Start React Development Server

Source: https://edgeone.ai/zh/document/196763685510774784

Navigates into the project directory and starts the development server with live page refresh.

```bash
cd my-react-app
npm start
```

--------------------------------

### Install dependencies and start Gatsby with EdgeOne Makers

Source: https://edgeone.ai/zh/document/178279639901777920

Installs dependencies and starts the Gatsby development server with EdgeOne Makers, using fePort=8000 to match Gatsby's port for cross-origin authentication.

```bash
npm install
gatsby develop && edgeone makers dev --fePort=8000
```

--------------------------------

### get usage examples

Source: https://edgeone.ai/zh/document/162227803822321664

Example usage of the get method. The first call returns a string (default text type). The second and third calls return a JSON object, either by passing the type as a string or as an object property.

```typescript
let value = await my_kv.get(key);
let value = await my_kv.get(key, "json");
let value = await my_kv.get(key, {type: "json"});
```

--------------------------------

### config.json routes example

Source: https://edgeone.ai/zh/document/204988861724463104

Example config.json with routes for static assets, filesystem handling, and API rewrites. The routes before and after 'handle: filesystem' use the same format.

```json
{
  "version": 3,
  "routes": [
    // 阶段一：预处理阶段（filesystem 之前）
    // 用于：重定向、设置响应头等
    { "src": "^/_next/static/(.*)__CODE_BLOCK_5___LINE_0_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_1_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_2_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_3_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_4_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_5_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_6_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_7_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_8_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_9_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_10_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_11_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_12_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_13_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_14_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_15_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_16_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_17_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_18_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_19_PLACEHOLDER_CONTENTquot;, "headers": { "cache-control": "public, max-age=31536000, immutable" } },

    { "handle": "filesystem" },

    // 阶段二：回源阶段（filesystem 之后）
    // 用于：API 路由、SSR 页面、函数调用
    { "src": "^/api/(.*)__CODE_BLOCK_5___LINE_0_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_1_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_2_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_3_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_4_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_5_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_6_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_7_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_8_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_9_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_10_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_11_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_12_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_13_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_14_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_15_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_16_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_17_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_18_PLACEHOLDER_CONTENT
__CODE_BLOCK_5___LINE_19_PLACEHOLDER_CONTENTquot;, "dest": "/api/$1" },
    { "src": "/.*" }
  ]
}
```

--------------------------------

### KV Storage Usage Example

Source: https://edgeone.ai/zh/document/210063123181080576

Shows how to use KV storage in EdgeOne Pages by accessing a bound variable. The example writes a value with put() and reads it with get().

```javascript
// KV：通过绑定变量名访问
await my_kv.put("visitCount", "1");
const count = await my_kv.get("visitCount");
```

--------------------------------

### Check Keyless server startup log

Source: https://edgeone.ai/zh/document/65286

Monitors the log to verify the service started successfully; look for 'launch success'.

```bash
tail -f log/keyless.log
```

--------------------------------

### Add Go Dependencies with go get

Source: https://edgeone.ai/zh/document/204373855432982528

Commands to add third-party dependencies using go get. Alternatively, you can import the packages in code and run go mod tidy to automatically detect and install dependencies.

```bash
go get github.com/gin-gonic/gin
go get github.com/go-chi/chi/v5
```

--------------------------------

### 初始化 SDK

Source: https://edgeone.ai/zh/document/74008

在 AppDelegate 的 didFinishLaunchingWithOptions 中初始化 SDK，设置 baseUrl 和可选日志级别。

```objectivec
#import <TCBasCommon/TCBasCommon.h>
#import <ClientAttestation/ClientAttestation.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // SDK初始化
    TCBasConfig *basConfig = [[TCBasConfig alloc] init];
    basConfig.baseUrl = @"www.example.com"; // 设置为业务域名
    basConfig.logLevel = TCBCLogLevelTypeWARN; // 可选，设置日志级别
    [TCBas initializeWithOptions:basConfig];
    return YES;
}
```

--------------------------------

### go.mod Example

Source: https://edgeone.ai/zh/document/204373855432982528

Example go.mod file showing the module name, Go version, and required dependencies. The build platform automatically performs cross-compilation (GOOS=linux GOARCH=amd64), so no manual configuration is needed.

```go
module my-project

go 1.26

require (
    github.com/gin-gonic/gin v1.10.0
)
```

--------------------------------

### Blob Storage Usage Example

Source: https://edgeone.ai/zh/document/210063123181080576

Shows how to use Blob storage in EdgeOne Pages via the @tencent/pages-blob SDK. The example imports getStore, obtains a store by name, and uses set() and get() to store and retrieve an object.

```javascript
// Blob：通过 SDK 直接使用
import { getStore } from "@tencent/pages-blob";
const store = getStore("uploads");
await store.set("photos/cat.jpg", imageData);
const file = await store.get("photos/cat.jpg");
```

--------------------------------

### CI pipeline deployment examples

Source: https://edgeone.ai/zh/document/162228053922476032

Example commands for deploying to production (default) and preview environments in a CI pipeline. Both use the EDGEONE_API_TOKEN environment variable for the required -t flag.

```bash
# 生产环境部署
edgeone makers deploy -n project-name -t $EDGEONE_API_TOKEN

# 预览环境部署
edgeone makers deploy -n project-name -e preview -t $EDGEONE_API_TOKEN
```

--------------------------------

### Sign Tencent Cloud API request with HMAC-SHA1 in C#

Source: https://edgeone.ai/zh/document/50459

C# example for signing Tencent Cloud API requests with HMAC-SHA1. It builds the plain text to sign from sorted request parameters, computes the signature, and prints the signed GET request URL for the DescribeInstances action.

```csharp
using System;
using System.Collections.Generic;
using System.Net;
using System.Security.Cryptography;
using System.Text;

public class Application {
    public static string Sign(string signKey, string secret)
    {
        string signRet = string.Empty;
            using (HMACSHA1 mac = new HMACSHA1(Encoding.UTF8.GetBytes(signKey)))
            {
                byte[] hash = mac.ComputeHash(Encoding.UTF8.GetBytes(secret));
                signRet = Convert.ToBase64String(hash);
            }
        return signRet;
    }
    public static string MakeSignPlainText(SortedDictionary<string, string> requestParams, string requestMethod, string requestHost, string requestPath)
    {
        string retStr = "";
        retStr += requestMethod;
        retStr += requestHost;
        retStr += requestPath;
        retStr += "?";
        string v = "";
        foreach (string key in requestParams.Keys)
        {
            v += string.Format("{0}={1}&", key, requestParams[key]);
        }
        retStr += v.TrimEnd('&');
        return retStr;
    }

    public static void Main(string[] args)
    {
        string SECRET_ID = "AKID********************************";
        string SECRET_KEY = "********************************";

        string endpoint = "cvm.tencentcloudapi.com";
        string region = "ap-guangzhou";
        string action = "DescribeInstances";
        string version = "2017-03-12";
        double RequestTimestamp = 1465185768;
        // long timestamp = ToTimestamp() / 1000;
        // string requestTimestamp = timestamp.ToString();
        Dictionary<string, string> param = new Dictionary<string, string>();
        param.Add("Limit", "20");
        param.Add("Offset", "0");
        param.Add("InstanceIds.0", "ins-09dx96dg");
        param.Add("Action", action);
        param.Add("Nonce", "11886");
        // param.Add("Nonce", Math.Abs(new Random().Next()).ToString());

        param.Add("Timestamp", RequestTimestamp.ToString());
        param.Add("Version", version);

        param.Add("SecretId", SECRET_ID);
        param.Add("Region", region);
        SortedDictionary<string, string> headers = new SortedDictionary<string, string>(param, StringComparer.Ordinal);
        string sigInParam = MakeSignPlainText(headers, "GET", endpoint, "/");
        Console.WriteLine(sigInParam);
        string sigOutParam = Sign(SECRET_KEY, sigInParam);

        Console.WriteLine("GET https://cvm.tencentcloudapi.com");
        foreach (KeyValuePair<string, string> kv in headers)
        {
            Console.WriteLine(kv.Key + ": " + kv.Value);
        }
        Console.WriteLine("Signature" + ": " + WebUtility.UrlEncode(sigOutParam));
        Console.WriteLine();

        string result = "https://cvm.tencentcloudapi.com/?";
        foreach (KeyValuePair<string, string> kv in headers)
        {
            result += WebUtility.UrlEncode(kv.Key) + "=" + WebUtility.UrlEncode(kv.Value) + "&";
        }
        result += WebUtility.UrlEncode("Signature") + "=" + WebUtility.UrlEncode(sigOutParam);
        Console.WriteLine("GET " + result);
    }
}
```

--------------------------------

### Build the Keyless server

Source: https://edgeone.ai/zh/document/65286

Compiles the project and makes the keyless binary executable.

```bash
go build -o keyless main.go && chmod a+x keyless
```

--------------------------------

### Clone the ai-sdk-image-generator-starter repository

Source: https://edgeone.ai/zh/document/184786907382796288

Clones the starter template repository from your GitHub account and navigates into the project directory.

```bash
git clone https://github.com/${your-github-account}/ai-sdk-image-generator-starter.git
cd ai-sdk-image-generator
```

--------------------------------

### Install @edgeone/astro adapter

Source: https://edgeone.ai/zh/document/193481130260738048

Installs the Makers Astro adapter package.

```bash
npm install @edgeone/astro
```

--------------------------------

### toAnthropicMessages / to_anthropic_messages - TS and Python examples

Source: https://edgeone.ai/zh/document/211800596876181504

Converts message history to Anthropic Messages API format. The TypeScript example fetches history and passes it to `anthropic.messages.create`. The Python example does the same with `anthropic_client.messages.create`.

```typescript
const history = await context.store.getMessages({
  conversationId: context.conversation_id,
})
const resp = await anthropic.messages.create({
  model: 'claude-sonnet-4',
  max_tokens: 1024,
  messages: context.store.toAnthropicMessages(history),
})
```

```python
history = await context.store.get_messages(
    conversation_id=context.conversation_id,
)
resp = await anthropic_client.messages.create(
    model="claude-sonnet-4",
    max_tokens=1024,
    messages=context.store.to_anthropic_messages(history),
)
```
Tokens:
Raw