Implement Aliyun CDN API V3 signature with DescribeRefreshTasks and RefreshObjectCaches endpoints by Copilot · Pull Request #6 · MooncellWiki/janus

Copilot · 2026-01-11T15:12:13Z

Adds Aliyun CDN API integration with V3 signature authentication for querying and managing CDN refresh tasks.

Core Changes

Signature Module (src/aliyun/signature.rs)

HMAC-SHA256 V3 signature algorithm with RFC 3986 percent encoding
Automatic parameter sorting via BTreeMap (Aliyun requirement)
Signature key format: {AccessKeySecret}&

CDN Client (src/aliyun/cdn.rs)

AliyunCdnClient::describe_refresh_tasks() with full parameter support for querying refresh tasks
AliyunCdnClient::refresh_object_caches() for submitting new CDN cache refresh requests
Response parsing with proper field mapping for Aliyun's response structure

API Endpoints (src/routes/aliyun_handlers.rs)

JWT-protected POST /api/aliyun/describeRefreshTasks for querying refresh tasks
JWT-protected POST /api/aliyun/refreshObjectCaches for submitting cache refresh requests
OpenAPI documentation with complete schemas for both endpoints

Configuration (src/config.rs)

Added AliyunConfig with access_key_id and access_key_secret

Usage

// Configuration
[aliyun]
access_key_id = "LTAI5t..."
access_key_secret = "xxxxx"

// Query refresh tasks
POST /api/aliyun/describeRefreshTasks
Authorization: Bearer <jwt_token>
{
  "page_number": 1,
  "page_size": 20,
  "status": "Complete"
}

// Submit refresh request
POST /api/aliyun/refreshObjectCaches
Authorization: Bearer <jwt_token>
{
  "object_path": "http://example.com/path/to/file.js",
  "object_type": "File",
  "area": "domestic"
}

Dependencies

sha2, hmac, base64: Signature cryptography
urlencoding: URL encoding utilities

Notes

Uses r#gen() due to Rust 2024 edition gen keyword reservation
Fixed double URL encoding in query string construction (parameters pre-encoded during signing)
Designed for extensibility—AliyunSigner can be reused for other Aliyun APIs

Original prompt

This section details on the original issue you should resolve

<issue_title>实现阿里云接口签名及DescribeRefreshTasks API</issue_title>
<issue_description>## 目标
实现阿里云接口的签名方法和"刷新任务查询"的API调用。

参考文档

阿里云API签名方法文档: https://help.aliyun.com/zh/sdk/product-overview/v3-request-structure-and-signature

CDN DescribeRefreshTasks API: https://help.aliyun.com/zh/cdn/developer-reference/api-cdn-2018-05-10-describerefreshtasks

要求

完成阿里云标准V3接口签名算法的实现（处理时间戳、AccessKey、签名字符串构建与加密等）。

封装DescribeRefreshTasks的API，允许调用并传递请求参数，处理返回结果。

代码需有适当注释，并考虑后续扩展支持更多接口。</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes daflyinbed/janus#4

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com>

daflyinbed · 2026-01-14T15:16:13Z

@copilot https://help.aliyun.com/zh/cdn/developer-reference/api-cdn-2018-05-10-refreshobjectcaches 实现这个接口

Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com>

Copilot · 2026-01-14T15:24:25Z

@copilot https://help.aliyun.com/zh/cdn/developer-reference/api-cdn-2018-05-10-refreshobjectcaches 实现这个接口

Implemented RefreshObjectCaches API in commit bdef3c4. The endpoint is available at POST /api/aliyun/refreshObjectCaches with the following parameters:

object_path (required): Object paths to refresh (separated by newlines, max 1000 URLs or 100 directories)
object_type (optional): "File" for file refresh or "Directory" for directory refresh
area (optional): "domestic" or "overseas" for region-specific refresh

The API is JWT-protected and fully documented in the OpenAPI schema.

Copilot

Pull request overview

This PR implements Aliyun CDN API integration with V3 signature authentication, enabling CDN cache refresh task querying and submission. The implementation follows Aliyun's official API documentation and adds comprehensive API endpoints with JWT authentication.

Changes:

Implements ACS3-HMAC-SHA256 signature algorithm for Aliyun API authentication
Adds CDN client with DescribeRefreshTasks and RefreshObjectCaches endpoints
Integrates JWT-protected HTTP handlers with OpenAPI documentation

Reviewed changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/aliyun/signature.rs	Implements V3 signature algorithm with RFC 3986 percent encoding and HMAC-SHA256
src/aliyun/cdn.rs	CDN client with methods for querying and submitting cache refresh tasks
src/aliyun/mod.rs	Module structure exposing public API types
src/routes/aliyun_handlers.rs	JWT-protected HTTP handlers for CDN API endpoints
src/routes/mod.rs	Route registration and OpenAPI schema integration
src/config.rs	Aliyun configuration with access key credentials
src/state.rs	Application state updated with Aliyun config
src/lib.rs	Module visibility for aliyun package
src/tracing.rs	Updates module whitelist from template name to actual project name
example.toml	Configuration example for Aliyun credentials
Cargo.toml	Adds sha2 and hmac dependencies
Cargo.lock	Dependency lock file updates

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/aliyun/cdn.rs

src/tracing.rs

Copilot

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-14T16:16:11Z

src/routes/aliyun_handlers.rs

+/// Request payload for refresh object caches endpoint
+#[derive(ToSchema, Serialize, Deserialize, Debug)]
+pub struct RefreshObjectCachesPayload {
+    /// Object paths to refresh (separated by newlines, max 1000 URLs or 100 directories per request)


The documentation states paths are 'separated by newlines', but the field is a single String without validation or parsing logic. This could be misleading. Consider either adding validation to ensure the format is correct, or clarifying in the documentation that the caller is responsible for formatting multiple paths correctly.

Copilot · 2026-01-14T16:16:12Z

src/aliyun/cdn.rs

+/// Reference: https://help.aliyun.com/zh/cdn/developer-reference/api-cdn-2018-05-10-refreshobjectcaches
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct RefreshObjectCachesRequest {
+    /// Object paths to refresh (separated by newlines, max 1000 URLs or 100 directories per request)


Same as Comment 1 - the documentation mentions newline separation but there's no validation or parsing. The documentation should clarify that formatting is the caller's responsibility, or validation should be added.

Copilot · 2026-01-14T16:16:12Z

src/routes/aliyun_handlers.rs

+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub object_type: Option<String>,
+
+    /// Whether to directly delete CDN cache nodes (default false)


The documentation states 'default false', but this is an Option field with no actual default value applied. If false is truly the default, consider using #[serde(default)] to apply it automatically, or update the documentation to clarify this is Aliyun's API default, not the struct's default.

Copilot · 2026-01-14T16:16:12Z

src/aliyun/cdn.rs

+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub object_type: Option<String>,
+
+    /// Whether to directly delete CDN cache nodes (default false)


Same as Comment 3 - documentation mentions 'default false' but no #[serde(default)] is applied to enforce this default.

daflyinbed · 2026-01-15T03:16:52Z

close #4

… and RefreshObjectCaches endpoints (#6) * Initial plan * Implement Aliyun API signature and DescribeRefreshTasks API Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com> * Fix double URL encoding in CDN query string Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com> * Apply rustfmt formatting Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com> * fix: tracing whitelist * fix: aliyun signature * refactor: aliyun signature * fmt * Add RefreshObjectCaches API implementation Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com> * fix * fix --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com> Co-authored-by: 夕舞八弦 <1677759063@qq.com>

Copilot AI self-assigned this Jan 11, 2026

Initial plan

3468e09

Copilot AI assigned daflyinbed Jan 11, 2026

Copilot started work on behalf of daflyinbed January 11, 2026 15:12 View session

Copilot AI and others added 3 commits January 11, 2026 15:23

Implement Aliyun API signature and DescribeRefreshTasks API

0671693

Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com>

Fix double URL encoding in CDN query string

f70e858

Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com>

Apply rustfmt formatting

9ba72c1

Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Implement Alibaba Cloud API signature and DescribeRefreshTasks~~ Implement Aliyun CDN API V3 signature and DescribeRefreshTasks endpoint Jan 11, 2026

Copilot AI requested a review from daflyinbed January 11, 2026 15:32

Copilot finished work on behalf of daflyinbed January 11, 2026 15:32

daflyinbed added 4 commits January 14, 2026 22:20

fix: tracing whitelist

d491586

fix: aliyun signature

ca851e8

refactor: aliyun signature

388236f

fmt

1f423da

Copilot started work on behalf of daflyinbed January 14, 2026 15:16 View session

Add RefreshObjectCaches API implementation

bdef3c4

Co-authored-by: daflyinbed <21363956+daflyinbed@users.noreply.github.com>

Copilot AI changed the title ~~Implement Aliyun CDN API V3 signature and DescribeRefreshTasks endpoint~~ Implement Aliyun CDN API V3 signature with DescribeRefreshTasks and RefreshObjectCaches endpoints Jan 14, 2026

Copilot finished work on behalf of daflyinbed January 14, 2026 15:25

daflyinbed requested a review from Copilot January 14, 2026 15:46

Copilot started reviewing on behalf of daflyinbed January 14, 2026 15:47 View session

Copilot AI reviewed Jan 14, 2026

View reviewed changes

src/aliyun/cdn.rs Outdated Show resolved Hide resolved

src/tracing.rs Show resolved Hide resolved

daflyinbed added 2 commits January 15, 2026 00:10

fix

0853de6

fix

6988a7a

daflyinbed requested a review from Copilot January 14, 2026 16:13

Copilot started reviewing on behalf of daflyinbed January 14, 2026 16:14 View session

Copilot AI reviewed Jan 14, 2026

View reviewed changes

daflyinbed changed the base branch from main to aliyun January 15, 2026 03:15

daflyinbed marked this pull request as ready for review January 15, 2026 03:15

daflyinbed merged commit 2235925 into aliyun Jan 15, 2026
8 checks passed

Copilot AI mentioned this pull request Jan 17, 2026

Add Aliyun OSS EventBridge integration from aliyun branch #9

Closed

daflyinbed deleted the copilot/implement-aliyun-api-signature branch January 19, 2026 06:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Aliyun CDN API V3 signature with DescribeRefreshTasks and RefreshObjectCaches endpoints#6

Implement Aliyun CDN API V3 signature with DescribeRefreshTasks and RefreshObjectCaches endpoints#6
daflyinbed merged 11 commits intoaliyunfrom
copilot/implement-aliyun-api-signature

Copilot AI commented Jan 11, 2026 •

edited

Loading

Uh oh!

daflyinbed commented Jan 14, 2026

Uh oh!

Copilot AI commented Jan 14, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 14, 2026

Uh oh!

Copilot AI Jan 14, 2026

Uh oh!

Copilot AI Jan 14, 2026

Uh oh!

Copilot AI Jan 14, 2026

Uh oh!

Uh oh!

daflyinbed commented Jan 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Jan 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Core Changes

Usage

Dependencies

Notes

参考文档

要求

Comments on the Issue (you are @copilot in this section)

Uh oh!

daflyinbed commented Jan 14, 2026

Uh oh!

Copilot AI commented Jan 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

daflyinbed commented Jan 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 11, 2026 •

edited

Loading