diff --git a/aspnet-core/framework/cloud-aliyun/LINGYUN.Abp.Aliyun/README.EN.md b/aspnet-core/framework/cloud-aliyun/LINGYUN.Abp.Aliyun/README.EN.md index a9f0ceeb3..5fb453139 100644 --- a/aspnet-core/framework/cloud-aliyun/LINGYUN.Abp.Aliyun/README.EN.md +++ b/aspnet-core/framework/cloud-aliyun/LINGYUN.Abp.Aliyun/README.EN.md @@ -6,12 +6,12 @@ Reference: [Alibaba Cloud API Documentation](https://help.aliyun.com/document_de ## Features -* Provides basic SDK integration for Alibaba Cloud services -* Supports Alibaba Cloud RAM (Resource Access Management) authentication -* Supports STS Token access -* Supports Alibaba Cloud SMS service -* Supports Alibaba Cloud Object Storage Service (OSS) -* Provides distributed cache support for optimizing high concurrency scenarios +- Provides basic SDK integration for Alibaba Cloud services +- Supports Alibaba Cloud RAM (Resource Access Management) authentication +- Supports STS Token access +- Supports Alibaba Cloud SMS service +- Supports Alibaba Cloud Object Storage Service (OSS) +- Provides distributed cache support for optimizing high concurrency scenarios ## Module Reference @@ -27,50 +27,56 @@ public class YouProjectModule : AbpModule ### Authentication Configuration -* **AliyunSettingNames.Authorization.RegionId** - * Description: Alibaba Cloud service region - * Type: Optional - * Default value: default - * Example: oss-cn-hangzhou +- **AliyunSettingNames.Authorization.RegionId** -* **AliyunSettingNames.Authorization.AccessKeyId** - * Description: AccessKey ID of Alibaba Cloud RAM account - * Type: Required - * How to get: Access Alibaba Cloud Console - Access Control + - Description: Alibaba Cloud service region + - Type: Optional + - Default value: default + - Example: oss-cn-hangzhou -* **AliyunSettingNames.Authorization.AccessKeySecret** - * Description: AccessKey Secret of RAM account - * Type: Required - * How to get: Access Alibaba Cloud Console - Access Control +- **AliyunSettingNames.Authorization.AccessKeyId** + + - Description: AccessKey ID of Alibaba Cloud RAM account + - Type: Required + - How to get: Access Alibaba Cloud Console - Access Control + +- **AliyunSettingNames.Authorization.AccessKeySecret** + - Description: AccessKey Secret of RAM account + - Type: Required + - How to get: Access Alibaba Cloud Console - Access Control ### STS Token Configuration -* **AliyunSettingNames.Authorization.UseSecurityTokenService** - * Description: Whether to use STS Token access - * Type: Optional - * Default value: false - * Recommendation: Recommended to enable for improved security - -* **AliyunSettingNames.Authorization.RamRoleArn** - * Description: Alibaba Cloud RAM role ARN - * Type: Required when STS Token is enabled - * Format: acs:ram::$accountID:role/$roleName - -* **AliyunSettingNames.Authorization.RoleSessionName** - * Description: Custom token name - * Type: Optional - * Usage: For access auditing - -* **AliyunSettingNames.Authorization.DurationSeconds** - * Description: Token expiration time - * Type: Optional - * Default value: 3000 - * Unit: Seconds - -* **AliyunSettingNames.Authorization.Policy** - * Description: Permission policy - * Type: Optional - * Format: JSON string +- **AliyunSettingNames.Authorization.UseSecurityTokenService** + + - Description: Whether to use STS Token access + - Type: Optional + - Default value: false + - Recommendation: Recommended to enable for improved security + +- **AliyunSettingNames.Authorization.RamRoleArn** + + - Description: Alibaba Cloud RAM role ARN + - Type: Required when STS Token is enabled + - Format: acs:ram::$accountID:role/$roleName + +- **AliyunSettingNames.Authorization.RoleSessionName** + + - Description: Custom token name + - Type: Optional + - Usage: For access auditing + +- **AliyunSettingNames.Authorization.DurationSeconds** + + - Description: Token expiration time + - Type: Optional + - Default value: 3000 + - Unit: Seconds + +- **AliyunSettingNames.Authorization.Policy** + - Description: Permission policy + - Type: Optional + - Format: JSON string ### SMS Service Configuration @@ -94,44 +100,45 @@ public class YouProjectModule : AbpModule The module supports the following Alibaba Cloud regions: -* China Regions - * North China 1 (Qingdao) - cn-qingdao - * North China 2 (Beijing) - cn-beijing - * North China 3 (Zhangjiakou) - cn-zhangjiakou - * North China 5 (Hohhot) - cn-huhehaote - * East China 1 (Hangzhou) - cn-hangzhou - * East China 2 (Shanghai) - cn-shanghai - * South China 1 (Shenzhen) - cn-shenzhen - * South China 2 (Heyuan) - cn-heyuan - * South China 3 (Guangzhou) - cn-guangzhou - * Southwest 1 (Chengdu) - cn-chengdu - -* Hong Kong and International Regions - * Hong Kong - cn-hongkong - * US (Silicon Valley) - us-west-1 - * US (Virginia) - us-east-1 - * Japan (Tokyo) - ap-northeast-1 - * South Korea (Seoul) - ap-northeast-2 - * Singapore - ap-southeast-1 - * Australia (Sydney) - ap-southeast-2 - * Malaysia (Kuala Lumpur) - ap-southeast-3 - * Indonesia (Jakarta) - ap-southeast-5 - * Philippines (Manila) - ap-southeast-6 - * Thailand (Bangkok) - ap-southeast-7 - * India (Mumbai) - ap-south-1 - * Germany (Frankfurt) - eu-central-1 - * UK (London) - eu-west-1 - * UAE (Dubai) - me-east-1 +- China Regions + + - North China 1 (Qingdao) - cn-qingdao + - North China 2 (Beijing) - cn-beijing + - North China 3 (Zhangjiakou) - cn-zhangjiakou + - North China 5 (Hohhot) - cn-huhehaote + - East China 1 (Hangzhou) - cn-hangzhou + - East China 2 (Shanghai) - cn-shanghai + - South China 1 (Shenzhen) - cn-shenzhen + - South China 2 (Heyuan) - cn-heyuan + - South China 3 (Guangzhou) - cn-guangzhou + - Southwest 1 (Chengdu) - cn-chengdu + +- Hong Kong and International Regions + - Hong Kong - cn-hongkong + - US (Silicon Valley) - us-west-1 + - US (Virginia) - us-east-1 + - Japan (Tokyo) - ap-northeast-1 + - South Korea (Seoul) - ap-northeast-2 + - Singapore - ap-southeast-1 + - Australia (Sydney) - ap-southeast-2 + - Malaysia (Kuala Lumpur) - ap-southeast-3 + - Indonesia (Jakarta) - ap-southeast-5 + - Philippines (Manila) - ap-southeast-6 + - Thailand (Bangkok) - ap-southeast-7 + - India (Mumbai) - ap-south-1 + - Germany (Frankfurt) - eu-central-1 + - UK (London) - eu-west-1 + - UAE (Dubai) - me-east-1 ## Performance Optimization -* In high concurrency scenarios, it is recommended to enable distributed caching to improve performance -* When using STS Token, the token will be automatically cached until expiration -* It is recommended to set DurationSeconds reasonably to avoid frequent token refreshes +- In high concurrency scenarios, it is recommended to enable distributed caching to improve performance +- When using STS Token, the token will be automatically cached until expiration +- It is recommended to set DurationSeconds reasonably to avoid frequent token refreshes ## Related Modules -* [LINGYUN.Abp.Aliyun.SettingManagement](../LINGYUN.Abp.Aliyun.SettingManagement/README.md) - Provides configuration management functionality -* [LINGYUN.Abp.Aliyun.Features](../LINGYUN.Abp.Aliyun.Features/README.md) - Provides feature management functionality +- [LINGYUN.Abp.Aliyun.SettingManagement](../LINGYUN.Abp.Aliyun.SettingManagement/README.md) - Provides configuration management functionality +- [LINGYUN.Abp.Aliyun.Features](../LINGYUN.Abp.Aliyun.Features/README.md) - Provides feature management functionality [查看中文文档](README.md) diff --git a/aspnet-core/framework/cloud-aliyun/LINGYUN.Abp.Aliyun/README.md b/aspnet-core/framework/cloud-aliyun/LINGYUN.Abp.Aliyun/README.md index 23e590bad..e9cb61afa 100644 --- a/aspnet-core/framework/cloud-aliyun/LINGYUN.Abp.Aliyun/README.md +++ b/aspnet-core/framework/cloud-aliyun/LINGYUN.Abp.Aliyun/README.md @@ -1,17 +1,17 @@ # LINGYUN.Abp.Aliyun -阿里云SDK集成模块。 +阿里云 SDK 集成模块。 -参照:[阿里云API文档](https://help.aliyun.com/document_detail/28763.html) +参照:[阿里云 API 文档](https://help.aliyun.com/document_detail/28763.html) ## 功能特性 -* 提供阿里云服务的基础SDK集成 -* 支持阿里云RAM(访问控制)认证 -* 支持STS Token访问 -* 支持阿里云短信服务(SMS) -* 支持阿里云对象存储(OSS) -* 提供分布式缓存支持,优化高并发场景 +- 提供阿里云服务的基础 SDK 集成 +- 支持阿里云 RAM(访问控制)认证 +- 支持 STS Token 访问 +- 支持阿里云短信服务(SMS) +- 支持阿里云对象存储(OSS) +- 提供分布式缓存支持,优化高并发场景 ## 模块引用 @@ -27,50 +27,56 @@ public class YouProjectModule : AbpModule ### 认证配置 -* **AliyunSettingNames.Authorization.RegionId** - * 说明:阿里云服务区域 - * 类型:可选 - * 默认值:default - * 示例:oss-cn-hangzhou - -* **AliyunSettingNames.Authorization.AccessKeyId** - * 说明:阿里云RAM账号的AccessKey ID - * 类型:必须 - * 获取方式:访问阿里云控制台-访问控制 - -* **AliyunSettingNames.Authorization.AccessKeySecret** - * 说明:RAM账号的AccessKey Secret - * 类型:必须 - * 获取方式:访问阿里云控制台-访问控制 - -### STS Token配置 - -* **AliyunSettingNames.Authorization.UseSecurityTokenService** - * 说明:是否使用STS Token访问 - * 类型:可选 - * 默认值:false - * 建议:建议开启,提高安全性 - -* **AliyunSettingNames.Authorization.RamRoleArn** - * 说明:阿里云RAM角色ARN - * 类型:启用STS Token时必须 - * 格式:acs:ram::$accountID:role/$roleName - -* **AliyunSettingNames.Authorization.RoleSessionName** - * 说明:用户自定义令牌名称 - * 类型:可选 - * 用途:用于访问审计 - -* **AliyunSettingNames.Authorization.DurationSeconds** - * 说明:用户令牌的过期时间 - * 类型:可选 - * 默认值:3000 - * 单位:秒 - -* **AliyunSettingNames.Authorization.Policy** - * 说明:权限策略 - * 类型:可选 - * 格式:JSON字符串 +- **AliyunSettingNames.Authorization.RegionId** + + - 说明:阿里云服务区域 + - 类型:可选 + - 默认值:default + - 示例:oss-cn-hangzhou + +- **AliyunSettingNames.Authorization.AccessKeyId** + + - 说明:阿里云 RAM 账号的 AccessKey ID + - 类型:必须 + - 获取方式:访问阿里云控制台-访问控制 + +- **AliyunSettingNames.Authorization.AccessKeySecret** + - 说明:RAM 账号的 AccessKey Secret + - 类型:必须 + - 获取方式:访问阿里云控制台-访问控制 + +### STS Token 配置 + +- **AliyunSettingNames.Authorization.UseSecurityTokenService** + + - 说明:是否使用 STS Token 访问 + - 类型:可选 + - 默认值:false + - 建议:建议开启,提高安全性 + +- **AliyunSettingNames.Authorization.RamRoleArn** + + - 说明:阿里云 RAM 角色 ARN + - 类型:启用 STS Token 时必须 + - 格式:acs:ram::$accountID:role/$roleName + +- **AliyunSettingNames.Authorization.RoleSessionName** + + - 说明:用户自定义令牌名称 + - 类型:可选 + - 用途:用于访问审计 + +- **AliyunSettingNames.Authorization.DurationSeconds** + + - 说明:用户令牌的过期时间 + - 类型:可选 + - 默认值:3000 + - 单位:秒 + +- **AliyunSettingNames.Authorization.Policy** + - 说明:权限策略 + - 类型:可选 + - 格式:JSON 字符串 ### 短信服务配置 @@ -94,44 +100,45 @@ public class YouProjectModule : AbpModule 本模块支持以下阿里云区域: -* 中国区域 - * 华北1(青岛)- cn-qingdao - * 华北2(北京)- cn-beijing - * 华北3(张家口)- cn-zhangjiakou - * 华北5(呼和浩特)- cn-huhehaote - * 华东1(杭州)- cn-hangzhou - * 华东2(上海)- cn-shanghai - * 华南1(深圳)- cn-shenzhen - * 华南2(河源)- cn-heyuan - * 华南3(广州)- cn-guangzhou - * 西南1(成都)- cn-chengdu - -* 香港及海外区域 - * 香港 - cn-hongkong - * 美国(硅谷)- us-west-1 - * 美国(弗吉尼亚)- us-east-1 - * 日本(东京)- ap-northeast-1 - * 韩国(首尔)- ap-northeast-2 - * 新加坡 - ap-southeast-1 - * 澳大利亚(悉尼)- ap-southeast-2 - * 马来西亚(吉隆坡)- ap-southeast-3 - * 印度尼西亚(雅加达)- ap-southeast-5 - * 菲律宾(马尼拉)- ap-southeast-6 - * 泰国(曼谷)- ap-southeast-7 - * 印度(孟买)- ap-south-1 - * 德国(法兰克福)- eu-central-1 - * 英国(伦敦)- eu-west-1 - * 阿联酋(迪拜)- me-east-1 +- 中国区域 + + - 华北 1(青岛)- cn-qingdao + - 华北 2(北京)- cn-beijing + - 华北 3(张家口)- cn-zhangjiakou + - 华北 5(呼和浩特)- cn-huhehaote + - 华东 1(杭州)- cn-hangzhou + - 华东 2(上海)- cn-shanghai + - 华南 1(深圳)- cn-shenzhen + - 华南 2(河源)- cn-heyuan + - 华南 3(广州)- cn-guangzhou + - 西南 1(成都)- cn-chengdu + +- 香港及海外区域 + - 香港 - cn-hongkong + - 美国(硅谷)- us-west-1 + - 美国(弗吉尼亚)- us-east-1 + - 日本(东京)- ap-northeast-1 + - 韩国(首尔)- ap-northeast-2 + - 新加坡 - ap-southeast-1 + - 澳大利亚(悉尼)- ap-southeast-2 + - 马来西亚(吉隆坡)- ap-southeast-3 + - 印度尼西亚(雅加达)- ap-southeast-5 + - 菲律宾(马尼拉)- ap-southeast-6 + - 泰国(曼谷)- ap-southeast-7 + - 印度(孟买)- ap-south-1 + - 德国(法兰克福)- eu-central-1 + - 英国(伦敦)- eu-west-1 + - 阿联酋(迪拜)- me-east-1 ## 性能优化 -* 在高并发场景下,建议开启分布式缓存以提高性能 -* 使用STS Token时,Token会自动缓存到过期前 -* 建议合理设置DurationSeconds,避免过于频繁的Token刷新 +- 在高并发场景下,建议开启分布式缓存以提高性能 +- 使用 STS Token 时,Token 会自动缓存到过期前 +- 建议合理设置 DurationSeconds,避免过于频繁的 Token 刷新 ## 相关模块 -* [LINGYUN.Abp.Aliyun.SettingManagement](../LINGYUN.Abp.Aliyun.SettingManagement/README.md) - 提供配置管理功能 -* [LINGYUN.Abp.Aliyun.Features](../LINGYUN.Abp.Aliyun.Features/README.md) - 提供功能管理功能 +- [LINGYUN.Abp.Aliyun.SettingManagement](../LINGYUN.Abp.Aliyun.SettingManagement/README.md) - 提供配置管理功能 +- [LINGYUN.Abp.Aliyun.Features](../LINGYUN.Abp.Aliyun.Features/README.md) - 提供功能管理功能 [点击查看英文文档](README.EN.md) diff --git a/common.props b/common.props index cd370d567..0a038b782 100644 --- a/common.props +++ b/common.props @@ -11,9 +11,8 @@ git https://github.com/colinin/abp-next-admin true - Debug;Release;PostgreSQL - + @@ -36,9 +35,4 @@ $(SolutionDir)LocalNuget - - POSTGRESQL - $(SolutionDir)LocalNuget - - \ No newline at end of file