# ctyun-cae-sdk-java

**Repository Path**: ctyunfaas/ctyun-cae-sdk-java

## Basic Information

- **Project Name**: ctyun-cae-sdk-java
- **Description**: 天翼云云应用引擎OpenAPI开发SDK（Java）
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-07
- **Last Updated**: 2026-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ctyun-cae-sdk-java

云应用引擎（CAE）OpenAPI 的 Java SDK。

## 目录结构

```
├── src/main/java/cn/ctyun/
│   ├── sdk/          # SDK 核心库（客户端、凭证、请求/响应、端点注册等）
│   └── apis/         # CAE 服务 API 定义（38 个 API）
├── src/test/java/cn/ctyun/
│   └── apis/         # 使用示例（测试用例）
└── pom.xml           # Maven: cn.ctyun:ctyun-cae-sdk-java
```

## 快速开始

### 1. 本地安装 SDK
> ⚠️ **注意**：由于本 SDK 暂未发布至远程 Maven 仓库，使用前需先将其安装至您的本地 Maven 仓库。

1. 克隆或下载本 SDK 源码到本地。
2. 进入 SDK 项目根目录（即 `pom.xml` 所在目录），执行以下命令：
   ```bash
   mvn clean install

### 引入 Maven 依赖

安装完成后，在您的业务项目 pom.xml 中添加以下依赖：

```xml
<dependency>
    <groupId>cn.ctyun</groupId>
    <artifactId>ctyun-cae-sdk-java</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>
```

### 代码示例

```java
import cn.ctyun.sdk.*;
import cn.ctyun.apis.Apis;

// 创建客户端
CtyunClient client = CtyunClient.defaultClient();

// 创建凭证
Credential credential = new Credential("<YOUR_AK>", "<YOUR_SK>");

// 创建 CAE API 实例
Apis apis = new Apis("cae-global.ctapi.ctyun.cn", client);

// 构建请求并设置 RegionId
CaeGetNamespaceListApi.CaeGetNamespaceListRequest request = new CaeGetNamespaceListApi.CaeGetNamespaceListRequest();
request.setRegionId("bb9fdb42056xxxeda1610242ac1xxxxx");

// 调用 API（以查询命名空间列表为例）
CaeGetNamespaceListApi.CaeGetNamespaceListResponse response =
    apis.caeGetNamespaceListApi.send(credential, request);
```

## 支持的功能

### 命名空间管理
- 创建/删除/更新/查询命名空间
- 查询命名空间列表
- 查询命名空间资源详情
- 命名空间配置管理（ConfigMap/Secret 的增删改查）

### 应用管理
- 创建/删除应用
- 启停应用
- 扩缩容（手动扩缩、弹性伸缩）
- 查询应用变更单、事件、实例、容器、修订版本
- 查询应用资源列表

### 网络管理
- 绑定/解绑 ELB
- 编辑 ELB 配置
- 查询 ELB 详情
- 查询 ELB 证书列表

### 可观测性
- 开启/关闭 ARMS
- 开启/关闭 MSE
- 应用日志配置

## 使用示例

参考 `src/test/java/cn/ctyun/apis/` 目录下的测试文件，例如：

- `CaeGetNamespaceListApiTest.java` - 查询命名空间列表
- `CaeCreateNamespaceApiTest.java` - 创建命名空间
- `CaeBindELBApiTest.java` - 绑定 ELB
- `CaeEnableApplicationArmsApiTest.java` - 开启 ARMS

## 许可证

Copyright (c) 2019-present, Ctyun Cloud

Distributed under the MIT License.
See [LICENSE.txt](./LICENSE.txt) for full license text.