# cloudcanal-openapi-sdk

**Repository Path**: clougence/cloudcanal-openapi-sdk

## Basic Information

- **Project Name**: cloudcanal-openapi-sdk
- **Description**: No description available
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 9
- **Forks**: 0
- **Created**: 2021-11-10
- **Last Updated**: 2025-10-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cloudcanal-openapi-sdk

### Description

The open api client sdk project for cloudcanal. By now , we have not yet publish it to MAVEN centre repository,you can install it in local MAVEN repository and use it.

API include 5 parts
- cluster
- consolejob
- constant
- datajob
- datasource

### Example

- Read the [document](https://www.clougence.com/cc-doc/bestPractice/use_open_api_to_integrate_cc).
- Install CloudCanal , and create an DataJob.
- Checkout the source , DataJobApiTest.testQueryJob show the basic usage of open API.
- Write code and use.

```
    @Test
    public void testQueryJob() {
        try {
            UserProfile profile = new UserProfile("127.0.0.1:8111", "you cloudcanal account access key", "you cloudcanal account secret key");

            CcClient client = profile.genClient();
            QueryJobRequest request = new QueryJobRequest();
            request.setJobId(1L);
            String paramStr = request.toJson();
            String result = client.doJsonPost("/cloudcanal/console/api/v1/openapi/datajob/queryjob", paramStr);
            QueryJobResponse response = new Gson().fromJson(result, QueryJobResponse.class);
            Assert.assertNotNull(response);
        } catch (Exception e) {
            throw new RuntimeException("api failed.", e);
        }
    }
```

### How To Contribute

Checkout and follow the [API DOC](https://www.clougence.com/cc-doc/openCenter/openApi/apiUseReference/api_common_parameters) to implement contents as below

- We need all api RequestDO and ResponseDO implementation, DO's class name need in line with api name
- We need deserialize data from Response to ResponseDO logic
- We need https communication protocol for client

## README.md
- [English](README.md)
- [简体中文](readme/README.zh_CN.md)