{"id":19989065,"url":"https://github.com/icemap/java-tidbcloud-sdk-v1","last_synced_at":"2025-08-29T02:33:32.222Z","repository":{"id":119432631,"uuid":"538801418","full_name":"Icemap/java-tidbcloud-sdk-v1","owner":"Icemap","description":"[WIP] A Java wrapper for TiDB Cloud OpenAPI v1","archived":false,"fork":false,"pushed_at":"2022-09-20T04:41:07.000Z","size":199,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-01T21:42:55.540Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Icemap.png","metadata":{"files":{"readme":"README-gen.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-20T03:58:19.000Z","updated_at":"2022-09-20T04:38:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"09c8a7b4-846e-4862-91e6-03f220c40511","html_url":"https://github.com/Icemap/java-tidbcloud-sdk-v1","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Icemap/java-tidbcloud-sdk-v1","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icemap%2Fjava-tidbcloud-sdk-v1","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icemap%2Fjava-tidbcloud-sdk-v1/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icemap%2Fjava-tidbcloud-sdk-v1/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icemap%2Fjava-tidbcloud-sdk-v1/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Icemap","download_url":"https://codeload.github.com/Icemap/java-tidbcloud-sdk-v1/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icemap%2Fjava-tidbcloud-sdk-v1/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272611989,"owners_count":24964385,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-29T02:00:10.610Z","response_time":87,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T04:45:18.930Z","updated_at":"2025-08-29T02:33:32.159Z","avatar_url":"https://github.com/Icemap.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# java-tidbcloud-sdk-v1\n\n## Requirements\n\nBuilding the API client library requires [Maven](https://maven.apache.org/) to be installed.\n\n## Installation\n\nTo install the API client library to your local Maven repository, simply execute:\n\n```shell\nmvn install\n```\n\nTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:\n\n```shell\nmvn deploy\n```\n\nRefer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.\n\n### Maven users\n\nAdd this dependency to your project's POM:\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.icemap\u003c/groupId\u003e\n    \u003cartifactId\u003ejava-tidbcloud-sdk-v1\u003c/artifactId\u003e\n    \u003cversion\u003e0.0.1\u003c/version\u003e\n    \u003cscope\u003ecompile\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle users\n\nAdd this dependency to your project's build file:\n\n```groovy\ncompile \"com.github.icemap:java-tidbcloud-sdk-v1:0.0.1\"\n```\n\n### Others\n\nAt first generate the JAR by executing:\n\n    mvn package\n\nThen manually install the following JARs:\n\n* target/java-tidbcloud-sdk-v1-0.0.1.jar\n* target/lib/*.jar\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following Java code:\n\n```java\n\nimport com.github.icemap.invoker.*;\nimport com.github.icemap.invoker.auth.*;\nimport com.github.icemap.invoker.model.*;\nimport com.github.icemap.api.BackupApi;\n\nimport java.io.File;\nimport java.util.*;\n\npublic class BackupApiExample {\n\n    public static void main(String[] args) {\n        \n        BackupApi apiInstance = new BackupApi();\n        String projectId = \"projectId_example\"; // String | The ID of your project. You can get the project ID from the response of [List all accessible projects.](#tag/Project/operation/ListProjects).\n        String clusterId = \"clusterId_example\"; // String | The ID of your cluster that you want to take a manual backup. You can get the cluster ID from the response of [Get all clusters in a project](#tag/Cluster/operation/ListClustersOfProject).\n        CreateBackupReq body = new CreateBackupReq(); // CreateBackupReq | \n        try {\n            CreateBackupResp result = apiInstance.createBackup(projectId, clusterId, body);\n            System.out.println(result);\n        } catch (ApiException e) {\n            System.err.println(\"Exception when calling BackupApi#createBackup\");\n            e.printStackTrace();\n        }\n    }\n}\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.tidbcloud.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BackupApi* | [**createBackup**](docs/BackupApi.md#createBackup) | **POST** /api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups | Create a backup for a cluster.\n*BackupApi* | [**deleteBackup**](docs/BackupApi.md#deleteBackup) | **DELETE** /api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups/{backup_id} | Delete a backup for a cluster.\n*BackupApi* | [**getBackupOfCluster**](docs/BackupApi.md#getBackupOfCluster) | **GET** /api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups/{backup_id} | Get a backup for a cluster.\n*BackupApi* | [**listBackUpOfCluster**](docs/BackupApi.md#listBackUpOfCluster) | **GET** /api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups | List all backups for a cluster.\n*ClusterApi* | [**createCluster**](docs/ClusterApi.md#createCluster) | **POST** /api/v1beta/projects/{project_id}/clusters | Create a cluster.\n*ClusterApi* | [**deleteCluster**](docs/ClusterApi.md#deleteCluster) | **DELETE** /api/v1beta/projects/{project_id}/clusters/{cluster_id} | Delete a cluster.\n*ClusterApi* | [**getCluster**](docs/ClusterApi.md#getCluster) | **GET** /api/v1beta/projects/{project_id}/clusters/{cluster_id} | Get a cluster by ID.\n*ClusterApi* | [**listClustersOfProject**](docs/ClusterApi.md#listClustersOfProject) | **GET** /api/v1beta/projects/{project_id}/clusters | List all clusters in a project.\n*ClusterApi* | [**listProviderRegions**](docs/ClusterApi.md#listProviderRegions) | **GET** /api/v1beta/clusters/provider/regions | List the cloud providers, regions and available specifications.\n*ClusterApi* | [**updateCluster**](docs/ClusterApi.md#updateCluster) | **PATCH** /api/v1beta/projects/{project_id}/clusters/{cluster_id} | Modify a Dedicated Tier cluster.\n*ProjectApi* | [**listProjects**](docs/ProjectApi.md#listProjects) | **GET** /api/v1beta/projects | List all accessible projects.\n*RestoreApi* | [**createRestoreTask**](docs/RestoreApi.md#createRestoreTask) | **POST** /api/v1beta/projects/{project_id}/restores | Create a restore task.\n*RestoreApi* | [**getRestoreTask**](docs/RestoreApi.md#getRestoreTask) | **GET** /api/v1beta/projects/{project_id}/restores/{restore_id} | Get a restore task.\n*RestoreApi* | [**listRestoreTasks**](docs/RestoreApi.md#listRestoreTasks) | **GET** /api/v1beta/projects/{project_id}/restores | List the restore tasks in a project.\n\n\n## Documentation for Models\n\n - [Apiv1betaprojectsprojectIdclustersConfig](docs/Apiv1betaprojectsprojectIdclustersConfig.md)\n - [Apiv1betaprojectsprojectIdclustersConfigComponents](docs/Apiv1betaprojectsprojectIdclustersConfigComponents.md)\n - [Apiv1betaprojectsprojectIdclustersConfigIpAccessList](docs/Apiv1betaprojectsprojectIdclustersConfigIpAccessList.md)\n - [Apiv1betaprojectsprojectIdclustersclusterIdConfig](docs/Apiv1betaprojectsprojectIdclustersclusterIdConfig.md)\n - [Apiv1betaprojectsprojectIdclustersclusterIdConfigComponents](docs/Apiv1betaprojectsprojectIdclustersclusterIdConfigComponents.md)\n - [Apiv1betaprojectsprojectIdclustersclusterIdConfigComponentsTidb](docs/Apiv1betaprojectsprojectIdclustersclusterIdConfigComponentsTidb.md)\n - [Apiv1betaprojectsprojectIdclustersclusterIdConfigComponentsTiflash](docs/Apiv1betaprojectsprojectIdclustersclusterIdConfigComponentsTiflash.md)\n - [Apiv1betaprojectsprojectIdclustersclusterIdConfigComponentsTikv](docs/Apiv1betaprojectsprojectIdclustersclusterIdConfigComponentsTikv.md)\n - [CreateBackupReq](docs/CreateBackupReq.md)\n - [CreateBackupResp](docs/CreateBackupResp.md)\n - [CreateClusterReq](docs/CreateClusterReq.md)\n - [CreateClusterResp](docs/CreateClusterResp.md)\n - [CreateRestoreReq](docs/CreateRestoreReq.md)\n - [CreateRestoreResp](docs/CreateRestoreResp.md)\n - [ErrorResponse](docs/ErrorResponse.md)\n - [GetBackupOfClusterResp](docs/GetBackupOfClusterResp.md)\n - [GetClustersOfProjectResp](docs/GetClustersOfProjectResp.md)\n - [GetClustersOfProjectRespConfig](docs/GetClustersOfProjectRespConfig.md)\n - [GetClustersOfProjectRespConfigComponents](docs/GetClustersOfProjectRespConfigComponents.md)\n - [GetClustersOfProjectRespConfigComponentsTidb](docs/GetClustersOfProjectRespConfigComponentsTidb.md)\n - [GetClustersOfProjectRespConfigComponentsTiflash](docs/GetClustersOfProjectRespConfigComponentsTiflash.md)\n - [GetClustersOfProjectRespConfigComponentsTikv](docs/GetClustersOfProjectRespConfigComponentsTikv.md)\n - [GetClustersOfProjectRespItems](docs/GetClustersOfProjectRespItems.md)\n - [GetClustersOfProjectRespStatus](docs/GetClustersOfProjectRespStatus.md)\n - [GetClustersOfProjectRespStatusConnectionStrings](docs/GetClustersOfProjectRespStatusConnectionStrings.md)\n - [GetClustersOfProjectRespStatusConnectionStringsStandard](docs/GetClustersOfProjectRespStatusConnectionStringsStandard.md)\n - [GetClustersOfProjectRespStatusConnectionStringsVpcPeering](docs/GetClustersOfProjectRespStatusConnectionStringsVpcPeering.md)\n - [GetClustersOfProjectRespStatusNodeMap](docs/GetClustersOfProjectRespStatusNodeMap.md)\n - [GetClustersOfProjectRespStatusNodeMapTidb](docs/GetClustersOfProjectRespStatusNodeMapTidb.md)\n - [GetClustersOfProjectRespStatusNodeMapTiflash](docs/GetClustersOfProjectRespStatusNodeMapTiflash.md)\n - [GetClustersOfProjectRespStatusNodeMapTikv](docs/GetClustersOfProjectRespStatusNodeMapTikv.md)\n - [GetProjectsResp](docs/GetProjectsResp.md)\n - [GetProjectsRespItems](docs/GetProjectsRespItems.md)\n - [GetProviderRegionsResp](docs/GetProviderRegionsResp.md)\n - [GetProviderRegionsRespItems](docs/GetProviderRegionsRespItems.md)\n - [GetProviderRegionsRespNodeQuantityRange](docs/GetProviderRegionsRespNodeQuantityRange.md)\n - [GetProviderRegionsRespNodeQuantityRange1](docs/GetProviderRegionsRespNodeQuantityRange1.md)\n - [GetProviderRegionsRespNodeQuantityRange2](docs/GetProviderRegionsRespNodeQuantityRange2.md)\n - [GetProviderRegionsRespStorageSizeGibRange](docs/GetProviderRegionsRespStorageSizeGibRange.md)\n - [GetProviderRegionsRespStorageSizeGibRange1](docs/GetProviderRegionsRespStorageSizeGibRange1.md)\n - [GetProviderRegionsRespTidb](docs/GetProviderRegionsRespTidb.md)\n - [GetProviderRegionsRespTiflash](docs/GetProviderRegionsRespTiflash.md)\n - [GetProviderRegionsRespTikv](docs/GetProviderRegionsRespTikv.md)\n - [GetRestoreResp](docs/GetRestoreResp.md)\n - [InlineResponse400](docs/InlineResponse400.md)\n - [InlineResponseDefault](docs/InlineResponseDefault.md)\n - [ListBackupOfClusterResp](docs/ListBackupOfClusterResp.md)\n - [ListBackupOfClusterRespItems](docs/ListBackupOfClusterRespItems.md)\n - [ListRestoreResp](docs/ListRestoreResp.md)\n - [ListRestoreRespCluster](docs/ListRestoreRespCluster.md)\n - [ListRestoreRespItems](docs/ListRestoreRespItems.md)\n - [OpenapiBackupTypeEnum](docs/OpenapiBackupTypeEnum.md)\n - [OpenapiCloudProvider](docs/OpenapiCloudProvider.md)\n - [OpenapiClusterComponents](docs/OpenapiClusterComponents.md)\n - [OpenapiClusterConfig](docs/OpenapiClusterConfig.md)\n - [OpenapiClusterConnectionStrings](docs/OpenapiClusterConnectionStrings.md)\n - [OpenapiClusterInfoOfRestore](docs/OpenapiClusterInfoOfRestore.md)\n - [OpenapiClusterItem](docs/OpenapiClusterItem.md)\n - [OpenapiClusterItemStatus](docs/OpenapiClusterItemStatus.md)\n - [OpenapiClusterNodeMap](docs/OpenapiClusterNodeMap.md)\n - [OpenapiClusterStatus](docs/OpenapiClusterStatus.md)\n - [OpenapiClusterType](docs/OpenapiClusterType.md)\n - [OpenapiCreateBackupResp](docs/OpenapiCreateBackupResp.md)\n - [OpenapiCreateClusterResp](docs/OpenapiCreateClusterResp.md)\n - [OpenapiCreateRestoreResp](docs/OpenapiCreateRestoreResp.md)\n - [OpenapiGetBackupOfClusterResp](docs/OpenapiGetBackupOfClusterResp.md)\n - [OpenapiGetBackupOfClusterRespStatusEnum](docs/OpenapiGetBackupOfClusterRespStatusEnum.md)\n - [OpenapiGetClusterConfig](docs/OpenapiGetClusterConfig.md)\n - [OpenapiGetRestoreResp](docs/OpenapiGetRestoreResp.md)\n - [OpenapiGetRestoreRespStatusEnum](docs/OpenapiGetRestoreRespStatusEnum.md)\n - [OpenapiIpAccessListItem](docs/OpenapiIpAccessListItem.md)\n - [OpenapiListBackupItem](docs/OpenapiListBackupItem.md)\n - [OpenapiListBackupItemStatusEnum](docs/OpenapiListBackupItemStatusEnum.md)\n - [OpenapiListBackupOfClusterResp](docs/OpenapiListBackupOfClusterResp.md)\n - [OpenapiListClustersOfProjectResp](docs/OpenapiListClustersOfProjectResp.md)\n - [OpenapiListProjectItem](docs/OpenapiListProjectItem.md)\n - [OpenapiListProjectsResp](docs/OpenapiListProjectsResp.md)\n - [OpenapiListProviderRegionsItem](docs/OpenapiListProviderRegionsItem.md)\n - [OpenapiListProviderRegionsResp](docs/OpenapiListProviderRegionsResp.md)\n - [OpenapiListRestoreOfProjectResp](docs/OpenapiListRestoreOfProjectResp.md)\n - [OpenapiListRestoreRespItem](docs/OpenapiListRestoreRespItem.md)\n - [OpenapiListRestoreRespItemStatusEnum](docs/OpenapiListRestoreRespItemStatusEnum.md)\n - [OpenapiNodeQuantityRange](docs/OpenapiNodeQuantityRange.md)\n - [OpenapiNodeStatus](docs/OpenapiNodeStatus.md)\n - [OpenapiNodeStorageSizeRange](docs/OpenapiNodeStorageSizeRange.md)\n - [OpenapiStandardConnection](docs/OpenapiStandardConnection.md)\n - [OpenapiTiDBComponent](docs/OpenapiTiDBComponent.md)\n - [OpenapiTiDBNodeMap](docs/OpenapiTiDBNodeMap.md)\n - [OpenapiTiDBProfile](docs/OpenapiTiDBProfile.md)\n - [OpenapiTiFlashComponent](docs/OpenapiTiFlashComponent.md)\n - [OpenapiTiFlashNodeMap](docs/OpenapiTiFlashNodeMap.md)\n - [OpenapiTiFlashProfile](docs/OpenapiTiFlashProfile.md)\n - [OpenapiTiKVComponent](docs/OpenapiTiKVComponent.md)\n - [OpenapiTiKVNodeMap](docs/OpenapiTiKVNodeMap.md)\n - [OpenapiTiKVProfile](docs/OpenapiTiKVProfile.md)\n - [OpenapiUpdateClusterComponents](docs/OpenapiUpdateClusterComponents.md)\n - [OpenapiUpdateClusterConfig](docs/OpenapiUpdateClusterConfig.md)\n - [OpenapiUpdateTiDBComponent](docs/OpenapiUpdateTiDBComponent.md)\n - [OpenapiUpdateTiFlashComponent](docs/OpenapiUpdateTiFlashComponent.md)\n - [OpenapiUpdateTiKVComponent](docs/OpenapiUpdateTiKVComponent.md)\n - [OpenapiVPCPeeringConnection](docs/OpenapiVPCPeeringConnection.md)\n - [ProtobufAny](docs/ProtobufAny.md)\n - [RpcStatus](docs/RpcStatus.md)\n - [UpdateClusterReq](docs/UpdateClusterReq.md)\n\n\n## Documentation for Authorization\n\nAll endpoints do not require authorization.\nAuthentication schemes defined for the API:\n\n## Recommendation\n\nIt's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issue.\n\n## Author\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficemap%2Fjava-tidbcloud-sdk-v1","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficemap%2Fjava-tidbcloud-sdk-v1","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficemap%2Fjava-tidbcloud-sdk-v1/lists"}