kb-cloud-client-typescript 2.4.0-alpha.110 → 2.4.0-alpha.111

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (105) hide show
  1. package/dist/adminapi/api.d.ts +1 -0
  2. package/dist/adminapi/api.d.ts.map +1 -1
  3. package/dist/adminapi/api.js +1 -0
  4. package/dist/adminapi/api.js.map +1 -1
  5. package/dist/adminapi/apis/redis-key-analysis-api.d.ts +264 -0
  6. package/dist/adminapi/apis/redis-key-analysis-api.d.ts.map +1 -0
  7. package/dist/adminapi/apis/redis-key-analysis-api.js +300 -0
  8. package/dist/adminapi/apis/redis-key-analysis-api.js.map +1 -0
  9. package/dist/adminapi/models/admin-create-redis-key-analysis-request-parameters.d.ts +43 -0
  10. package/dist/adminapi/models/admin-create-redis-key-analysis-request-parameters.d.ts.map +1 -0
  11. package/dist/adminapi/models/admin-create-redis-key-analysis-request-parameters.js +16 -0
  12. package/dist/adminapi/models/admin-create-redis-key-analysis-request-parameters.js.map +1 -0
  13. package/dist/adminapi/models/admin-create-redis-key-analysis-request.d.ts +26 -0
  14. package/dist/adminapi/models/admin-create-redis-key-analysis-request.d.ts.map +1 -0
  15. package/dist/adminapi/models/admin-create-redis-key-analysis-request.js +16 -0
  16. package/dist/adminapi/models/admin-create-redis-key-analysis-request.js.map +1 -0
  17. package/dist/adminapi/models/admin-create-redis-key-analysis200-response.d.ts +31 -0
  18. package/dist/adminapi/models/admin-create-redis-key-analysis200-response.d.ts.map +1 -0
  19. package/dist/adminapi/models/admin-create-redis-key-analysis200-response.js +16 -0
  20. package/dist/adminapi/models/admin-create-redis-key-analysis200-response.js.map +1 -0
  21. package/dist/adminapi/models/index.d.ts +7 -0
  22. package/dist/adminapi/models/index.d.ts.map +1 -1
  23. package/dist/adminapi/models/index.js +7 -0
  24. package/dist/adminapi/models/index.js.map +1 -1
  25. package/dist/adminapi/models/redis-key-analysis-report-parameters.d.ts +43 -0
  26. package/dist/adminapi/models/redis-key-analysis-report-parameters.d.ts.map +1 -0
  27. package/dist/adminapi/models/redis-key-analysis-report-parameters.js +16 -0
  28. package/dist/adminapi/models/redis-key-analysis-report-parameters.js.map +1 -0
  29. package/dist/adminapi/models/redis-key-analysis-report-type-stat-value.d.ts +31 -0
  30. package/dist/adminapi/models/redis-key-analysis-report-type-stat-value.d.ts.map +1 -0
  31. package/dist/adminapi/models/redis-key-analysis-report-type-stat-value.js +16 -0
  32. package/dist/adminapi/models/redis-key-analysis-report-type-stat-value.js.map +1 -0
  33. package/dist/adminapi/models/redis-key-analysis-report.d.ts +110 -0
  34. package/dist/adminapi/models/redis-key-analysis-report.d.ts.map +1 -0
  35. package/dist/adminapi/models/redis-key-analysis-report.js +16 -0
  36. package/dist/adminapi/models/redis-key-analysis-report.js.map +1 -0
  37. package/dist/adminapi/models/redis-key-entry.d.ts +85 -0
  38. package/dist/adminapi/models/redis-key-entry.d.ts.map +1 -0
  39. package/dist/adminapi/models/redis-key-entry.js +16 -0
  40. package/dist/adminapi/models/redis-key-entry.js.map +1 -0
  41. package/dist/openapi/api.d.ts +1 -0
  42. package/dist/openapi/api.d.ts.map +1 -1
  43. package/dist/openapi/api.js +1 -0
  44. package/dist/openapi/api.js.map +1 -1
  45. package/dist/openapi/apis/redis-key-analysis-api.d.ts +264 -0
  46. package/dist/openapi/apis/redis-key-analysis-api.d.ts.map +1 -0
  47. package/dist/openapi/apis/redis-key-analysis-api.js +300 -0
  48. package/dist/openapi/apis/redis-key-analysis-api.js.map +1 -0
  49. package/dist/openapi/models/create-redis-key-analysis-request-parameters.d.ts +43 -0
  50. package/dist/openapi/models/create-redis-key-analysis-request-parameters.d.ts.map +1 -0
  51. package/dist/openapi/models/create-redis-key-analysis-request-parameters.js +16 -0
  52. package/dist/openapi/models/create-redis-key-analysis-request-parameters.js.map +1 -0
  53. package/dist/openapi/models/create-redis-key-analysis-request.d.ts +26 -0
  54. package/dist/openapi/models/create-redis-key-analysis-request.d.ts.map +1 -0
  55. package/dist/openapi/models/create-redis-key-analysis-request.js +16 -0
  56. package/dist/openapi/models/create-redis-key-analysis-request.js.map +1 -0
  57. package/dist/openapi/models/create-redis-key-analysis200-response.d.ts +31 -0
  58. package/dist/openapi/models/create-redis-key-analysis200-response.d.ts.map +1 -0
  59. package/dist/openapi/models/create-redis-key-analysis200-response.js +16 -0
  60. package/dist/openapi/models/create-redis-key-analysis200-response.js.map +1 -0
  61. package/dist/openapi/models/index.d.ts +7 -0
  62. package/dist/openapi/models/index.d.ts.map +1 -1
  63. package/dist/openapi/models/index.js +7 -0
  64. package/dist/openapi/models/index.js.map +1 -1
  65. package/dist/openapi/models/redis-key-analysis-report-parameters.d.ts +43 -0
  66. package/dist/openapi/models/redis-key-analysis-report-parameters.d.ts.map +1 -0
  67. package/dist/openapi/models/redis-key-analysis-report-parameters.js +16 -0
  68. package/dist/openapi/models/redis-key-analysis-report-parameters.js.map +1 -0
  69. package/dist/openapi/models/redis-key-analysis-report-type-stat-value.d.ts +31 -0
  70. package/dist/openapi/models/redis-key-analysis-report-type-stat-value.d.ts.map +1 -0
  71. package/dist/openapi/models/redis-key-analysis-report-type-stat-value.js +16 -0
  72. package/dist/openapi/models/redis-key-analysis-report-type-stat-value.js.map +1 -0
  73. package/dist/openapi/models/redis-key-analysis-report.d.ts +110 -0
  74. package/dist/openapi/models/redis-key-analysis-report.d.ts.map +1 -0
  75. package/dist/openapi/models/redis-key-analysis-report.js +16 -0
  76. package/dist/openapi/models/redis-key-analysis-report.js.map +1 -0
  77. package/dist/openapi/models/redis-key-entry.d.ts +85 -0
  78. package/dist/openapi/models/redis-key-entry.d.ts.map +1 -0
  79. package/dist/openapi/models/redis-key-entry.js +16 -0
  80. package/dist/openapi/models/redis-key-entry.js.map +1 -0
  81. package/package.json +1 -1
  82. package/src/adminapi/.openapi-generator/FILES +8 -0
  83. package/src/adminapi/api.ts +1 -0
  84. package/src/adminapi/apis/redis-key-analysis-api.ts +448 -0
  85. package/src/adminapi/models/admin-create-redis-key-analysis-request-parameters.ts +48 -0
  86. package/src/adminapi/models/admin-create-redis-key-analysis-request.ts +33 -0
  87. package/src/adminapi/models/admin-create-redis-key-analysis200-response.ts +36 -0
  88. package/src/adminapi/models/index.ts +7 -0
  89. package/src/adminapi/models/redis-key-analysis-report-parameters.ts +48 -0
  90. package/src/adminapi/models/redis-key-analysis-report-type-stat-value.ts +36 -0
  91. package/src/adminapi/models/redis-key-analysis-report.ts +111 -0
  92. package/src/adminapi/models/redis-key-entry.ts +90 -0
  93. package/src/adminapi.yaml +262 -0
  94. package/src/openapi/.openapi-generator/FILES +8 -0
  95. package/src/openapi/api.ts +1 -0
  96. package/src/openapi/apis/redis-key-analysis-api.ts +448 -0
  97. package/src/openapi/models/create-redis-key-analysis-request-parameters.ts +48 -0
  98. package/src/openapi/models/create-redis-key-analysis-request.ts +33 -0
  99. package/src/openapi/models/create-redis-key-analysis200-response.ts +36 -0
  100. package/src/openapi/models/index.ts +7 -0
  101. package/src/openapi/models/redis-key-analysis-report-parameters.ts +48 -0
  102. package/src/openapi/models/redis-key-analysis-report-type-stat-value.ts +36 -0
  103. package/src/openapi/models/redis-key-analysis-report.ts +111 -0
  104. package/src/openapi/models/redis-key-entry.ts +90 -0
  105. package/src/openapi.yaml +266 -0
@@ -0,0 +1,448 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * KubeBlocks Cloud API
5
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources. The API is organized around REST. Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs. We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from '../configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
22
+ // @ts-ignore
23
+ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
+ // @ts-ignore
25
+ import type { APIErrorResponse } from '../models';
26
+ // @ts-ignore
27
+ import type { CreateRedisKeyAnalysis200Response } from '../models';
28
+ // @ts-ignore
29
+ import type { CreateRedisKeyAnalysisRequest } from '../models';
30
+ // @ts-ignore
31
+ import type { RedisKeyAnalysisReport } from '../models';
32
+ /**
33
+ * RedisKeyAnalysisApi - axios parameter creator
34
+ * @export
35
+ */
36
+ export const RedisKeyAnalysisApiAxiosParamCreator = function (configuration?: Configuration) {
37
+ return {
38
+ /**
39
+ * Submits the redis-rdr-keys-analysis OpsDefinition. After the operation succeeds, the platform reads /data/rdr-report.json from every primary pod and persists one report row per shard. Poll the task and then call the report API with the returned taskId.
40
+ * @summary Create a Redis keys analysis task
41
+ * @param {string} orgName
42
+ * @param {string} clusterName
43
+ * @param {CreateRedisKeyAnalysisRequest} [createRedisKeyAnalysisRequest]
44
+ * @param {*} [options] Override http request option.
45
+ * @throws {RequiredError}
46
+ */
47
+ createRedisKeyAnalysis: async (orgName: string, clusterName: string, createRedisKeyAnalysisRequest?: CreateRedisKeyAnalysisRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
48
+ // verify required parameter 'orgName' is not null or undefined
49
+ assertParamExists('createRedisKeyAnalysis', 'orgName', orgName)
50
+ // verify required parameter 'clusterName' is not null or undefined
51
+ assertParamExists('createRedisKeyAnalysis', 'clusterName', clusterName)
52
+ const localVarPath = `/api/v1/organizations/{orgName}/clusters/{clusterName}/redis/keyAnalysis`
53
+ .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
54
+ .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
55
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
56
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
57
+ let baseOptions;
58
+ if (configuration) {
59
+ baseOptions = configuration.baseOptions;
60
+ }
61
+
62
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
63
+ const localVarHeaderParameter = {} as any;
64
+ const localVarQueryParameter = {} as any;
65
+
66
+ // authentication BearerToken required
67
+ // http bearer authentication required
68
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
69
+
70
+ // authentication DigestAuth required
71
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
72
+
73
+
74
+
75
+ localVarHeaderParameter['Content-Type'] = 'application/json';
76
+
77
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
78
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
79
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
80
+ localVarRequestOptions.data = serializeDataIfNeeded(createRedisKeyAnalysisRequest, localVarRequestOptions, configuration)
81
+
82
+ return {
83
+ url: toPathString(localVarUrlObj),
84
+ options: localVarRequestOptions,
85
+ };
86
+ },
87
+ /**
88
+ *
89
+ * @summary Delete a Redis keys analysis report
90
+ * @param {string} orgName
91
+ * @param {string} clusterName
92
+ * @param {string} taskId
93
+ * @param {*} [options] Override http request option.
94
+ * @throws {RequiredError}
95
+ */
96
+ deleteRedisKeyAnalysisReport: async (orgName: string, clusterName: string, taskId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
97
+ // verify required parameter 'orgName' is not null or undefined
98
+ assertParamExists('deleteRedisKeyAnalysisReport', 'orgName', orgName)
99
+ // verify required parameter 'clusterName' is not null or undefined
100
+ assertParamExists('deleteRedisKeyAnalysisReport', 'clusterName', clusterName)
101
+ // verify required parameter 'taskId' is not null or undefined
102
+ assertParamExists('deleteRedisKeyAnalysisReport', 'taskId', taskId)
103
+ const localVarPath = `/api/v1/organizations/{orgName}/clusters/{clusterName}/redis/keyAnalysis/{taskId}`
104
+ .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
105
+ .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
106
+ .replace(`{${"taskId"}}`, encodeURIComponent(String(taskId)));
107
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
108
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
109
+ let baseOptions;
110
+ if (configuration) {
111
+ baseOptions = configuration.baseOptions;
112
+ }
113
+
114
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
115
+ const localVarHeaderParameter = {} as any;
116
+ const localVarQueryParameter = {} as any;
117
+
118
+ // authentication BearerToken required
119
+ // http bearer authentication required
120
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
121
+
122
+ // authentication DigestAuth required
123
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
124
+
125
+
126
+
127
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
128
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
129
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
130
+
131
+ return {
132
+ url: toPathString(localVarUrlObj),
133
+ options: localVarRequestOptions,
134
+ };
135
+ },
136
+ /**
137
+ * Returns one persisted row per shard. For a cluster with multiple shards, one additional aggregate row with isSummary=true is appended; it is not persisted.
138
+ * @summary Get a Redis keys analysis report
139
+ * @param {string} orgName
140
+ * @param {string} clusterName
141
+ * @param {string} taskId Platform TaskFlow task ID.
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ */
145
+ getRedisKeyAnalysisReport: async (orgName: string, clusterName: string, taskId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
146
+ // verify required parameter 'orgName' is not null or undefined
147
+ assertParamExists('getRedisKeyAnalysisReport', 'orgName', orgName)
148
+ // verify required parameter 'clusterName' is not null or undefined
149
+ assertParamExists('getRedisKeyAnalysisReport', 'clusterName', clusterName)
150
+ // verify required parameter 'taskId' is not null or undefined
151
+ assertParamExists('getRedisKeyAnalysisReport', 'taskId', taskId)
152
+ const localVarPath = `/api/v1/organizations/{orgName}/clusters/{clusterName}/redis/keyAnalysis/{taskId}`
153
+ .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
154
+ .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
155
+ .replace(`{${"taskId"}}`, encodeURIComponent(String(taskId)));
156
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
157
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
158
+ let baseOptions;
159
+ if (configuration) {
160
+ baseOptions = configuration.baseOptions;
161
+ }
162
+
163
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
164
+ const localVarHeaderParameter = {} as any;
165
+ const localVarQueryParameter = {} as any;
166
+
167
+ // authentication BearerToken required
168
+ // http bearer authentication required
169
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
170
+
171
+ // authentication DigestAuth required
172
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
173
+
174
+
175
+
176
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
177
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
178
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
179
+
180
+ return {
181
+ url: toPathString(localVarUrlObj),
182
+ options: localVarRequestOptions,
183
+ };
184
+ },
185
+ }
186
+ };
187
+
188
+ /**
189
+ * RedisKeyAnalysisApi - functional programming interface
190
+ * @export
191
+ */
192
+ export const RedisKeyAnalysisApiFp = function(configuration?: Configuration) {
193
+ const localVarAxiosParamCreator = RedisKeyAnalysisApiAxiosParamCreator(configuration)
194
+ return {
195
+ /**
196
+ * Submits the redis-rdr-keys-analysis OpsDefinition. After the operation succeeds, the platform reads /data/rdr-report.json from every primary pod and persists one report row per shard. Poll the task and then call the report API with the returned taskId.
197
+ * @summary Create a Redis keys analysis task
198
+ * @param {string} orgName
199
+ * @param {string} clusterName
200
+ * @param {CreateRedisKeyAnalysisRequest} [createRedisKeyAnalysisRequest]
201
+ * @param {*} [options] Override http request option.
202
+ * @throws {RequiredError}
203
+ */
204
+ async createRedisKeyAnalysis(orgName: string, clusterName: string, createRedisKeyAnalysisRequest?: CreateRedisKeyAnalysisRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRedisKeyAnalysis200Response>> {
205
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createRedisKeyAnalysis(orgName, clusterName, createRedisKeyAnalysisRequest, options);
206
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
207
+ const localVarOperationServerBasePath = operationServerMap['RedisKeyAnalysisApi.createRedisKeyAnalysis']?.[localVarOperationServerIndex]?.url;
208
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
209
+ },
210
+ /**
211
+ *
212
+ * @summary Delete a Redis keys analysis report
213
+ * @param {string} orgName
214
+ * @param {string} clusterName
215
+ * @param {string} taskId
216
+ * @param {*} [options] Override http request option.
217
+ * @throws {RequiredError}
218
+ */
219
+ async deleteRedisKeyAnalysisReport(orgName: string, clusterName: string, taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
220
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRedisKeyAnalysisReport(orgName, clusterName, taskId, options);
221
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
222
+ const localVarOperationServerBasePath = operationServerMap['RedisKeyAnalysisApi.deleteRedisKeyAnalysisReport']?.[localVarOperationServerIndex]?.url;
223
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
224
+ },
225
+ /**
226
+ * Returns one persisted row per shard. For a cluster with multiple shards, one additional aggregate row with isSummary=true is appended; it is not persisted.
227
+ * @summary Get a Redis keys analysis report
228
+ * @param {string} orgName
229
+ * @param {string} clusterName
230
+ * @param {string} taskId Platform TaskFlow task ID.
231
+ * @param {*} [options] Override http request option.
232
+ * @throws {RequiredError}
233
+ */
234
+ async getRedisKeyAnalysisReport(orgName: string, clusterName: string, taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RedisKeyAnalysisReport>>> {
235
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getRedisKeyAnalysisReport(orgName, clusterName, taskId, options);
236
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
237
+ const localVarOperationServerBasePath = operationServerMap['RedisKeyAnalysisApi.getRedisKeyAnalysisReport']?.[localVarOperationServerIndex]?.url;
238
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
239
+ },
240
+ }
241
+ };
242
+
243
+ /**
244
+ * RedisKeyAnalysisApi - factory interface
245
+ * @export
246
+ */
247
+ export const RedisKeyAnalysisApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
248
+ const localVarFp = RedisKeyAnalysisApiFp(configuration)
249
+ return {
250
+ /**
251
+ * Submits the redis-rdr-keys-analysis OpsDefinition. After the operation succeeds, the platform reads /data/rdr-report.json from every primary pod and persists one report row per shard. Poll the task and then call the report API with the returned taskId.
252
+ * @summary Create a Redis keys analysis task
253
+ * @param {RedisKeyAnalysisApiCreateRedisKeyAnalysisRequest} requestParameters Request parameters.
254
+ * @param {*} [options] Override http request option.
255
+ * @throws {RequiredError}
256
+ */
257
+ createRedisKeyAnalysis(requestParameters: RedisKeyAnalysisApiCreateRedisKeyAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateRedisKeyAnalysis200Response> {
258
+ return localVarFp.createRedisKeyAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.createRedisKeyAnalysisRequest, options).then((request) => request(axios, basePath));
259
+ },
260
+ /**
261
+ *
262
+ * @summary Delete a Redis keys analysis report
263
+ * @param {RedisKeyAnalysisApiDeleteRedisKeyAnalysisReportRequest} requestParameters Request parameters.
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ */
267
+ deleteRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiDeleteRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
268
+ return localVarFp.deleteRedisKeyAnalysisReport(requestParameters.orgName, requestParameters.clusterName, requestParameters.taskId, options).then((request) => request(axios, basePath));
269
+ },
270
+ /**
271
+ * Returns one persisted row per shard. For a cluster with multiple shards, one additional aggregate row with isSummary=true is appended; it is not persisted.
272
+ * @summary Get a Redis keys analysis report
273
+ * @param {RedisKeyAnalysisApiGetRedisKeyAnalysisReportRequest} requestParameters Request parameters.
274
+ * @param {*} [options] Override http request option.
275
+ * @throws {RequiredError}
276
+ */
277
+ getRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiGetRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RedisKeyAnalysisReport>> {
278
+ return localVarFp.getRedisKeyAnalysisReport(requestParameters.orgName, requestParameters.clusterName, requestParameters.taskId, options).then((request) => request(axios, basePath));
279
+ },
280
+ };
281
+ };
282
+
283
+ /**
284
+ * RedisKeyAnalysisApi - interface
285
+ * @export
286
+ * @interface RedisKeyAnalysisApi
287
+ */
288
+ export interface RedisKeyAnalysisApiInterface {
289
+ /**
290
+ * Submits the redis-rdr-keys-analysis OpsDefinition. After the operation succeeds, the platform reads /data/rdr-report.json from every primary pod and persists one report row per shard. Poll the task and then call the report API with the returned taskId.
291
+ * @summary Create a Redis keys analysis task
292
+ * @param {RedisKeyAnalysisApiCreateRedisKeyAnalysisRequest} requestParameters Request parameters.
293
+ * @param {*} [options] Override http request option.
294
+ * @throws {RequiredError}
295
+ * @memberof RedisKeyAnalysisApiInterface
296
+ */
297
+ createRedisKeyAnalysis(requestParameters: RedisKeyAnalysisApiCreateRedisKeyAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateRedisKeyAnalysis200Response>;
298
+
299
+ /**
300
+ *
301
+ * @summary Delete a Redis keys analysis report
302
+ * @param {RedisKeyAnalysisApiDeleteRedisKeyAnalysisReportRequest} requestParameters Request parameters.
303
+ * @param {*} [options] Override http request option.
304
+ * @throws {RequiredError}
305
+ * @memberof RedisKeyAnalysisApiInterface
306
+ */
307
+ deleteRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiDeleteRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
308
+
309
+ /**
310
+ * Returns one persisted row per shard. For a cluster with multiple shards, one additional aggregate row with isSummary=true is appended; it is not persisted.
311
+ * @summary Get a Redis keys analysis report
312
+ * @param {RedisKeyAnalysisApiGetRedisKeyAnalysisReportRequest} requestParameters Request parameters.
313
+ * @param {*} [options] Override http request option.
314
+ * @throws {RequiredError}
315
+ * @memberof RedisKeyAnalysisApiInterface
316
+ */
317
+ getRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiGetRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RedisKeyAnalysisReport>>;
318
+
319
+ }
320
+
321
+ /**
322
+ * Request parameters for createRedisKeyAnalysis operation in RedisKeyAnalysisApi.
323
+ * @export
324
+ * @interface RedisKeyAnalysisApiCreateRedisKeyAnalysisRequest
325
+ */
326
+ export interface RedisKeyAnalysisApiCreateRedisKeyAnalysisRequest {
327
+ /**
328
+ *
329
+ * @type {string}
330
+ * @memberof RedisKeyAnalysisApiCreateRedisKeyAnalysis
331
+ */
332
+ readonly orgName: string
333
+
334
+ /**
335
+ *
336
+ * @type {string}
337
+ * @memberof RedisKeyAnalysisApiCreateRedisKeyAnalysis
338
+ */
339
+ readonly clusterName: string
340
+
341
+ /**
342
+ *
343
+ * @type {CreateRedisKeyAnalysisRequest}
344
+ * @memberof RedisKeyAnalysisApiCreateRedisKeyAnalysis
345
+ */
346
+ readonly createRedisKeyAnalysisRequest?: CreateRedisKeyAnalysisRequest
347
+ }
348
+
349
+ /**
350
+ * Request parameters for deleteRedisKeyAnalysisReport operation in RedisKeyAnalysisApi.
351
+ * @export
352
+ * @interface RedisKeyAnalysisApiDeleteRedisKeyAnalysisReportRequest
353
+ */
354
+ export interface RedisKeyAnalysisApiDeleteRedisKeyAnalysisReportRequest {
355
+ /**
356
+ *
357
+ * @type {string}
358
+ * @memberof RedisKeyAnalysisApiDeleteRedisKeyAnalysisReport
359
+ */
360
+ readonly orgName: string
361
+
362
+ /**
363
+ *
364
+ * @type {string}
365
+ * @memberof RedisKeyAnalysisApiDeleteRedisKeyAnalysisReport
366
+ */
367
+ readonly clusterName: string
368
+
369
+ /**
370
+ *
371
+ * @type {string}
372
+ * @memberof RedisKeyAnalysisApiDeleteRedisKeyAnalysisReport
373
+ */
374
+ readonly taskId: string
375
+ }
376
+
377
+ /**
378
+ * Request parameters for getRedisKeyAnalysisReport operation in RedisKeyAnalysisApi.
379
+ * @export
380
+ * @interface RedisKeyAnalysisApiGetRedisKeyAnalysisReportRequest
381
+ */
382
+ export interface RedisKeyAnalysisApiGetRedisKeyAnalysisReportRequest {
383
+ /**
384
+ *
385
+ * @type {string}
386
+ * @memberof RedisKeyAnalysisApiGetRedisKeyAnalysisReport
387
+ */
388
+ readonly orgName: string
389
+
390
+ /**
391
+ *
392
+ * @type {string}
393
+ * @memberof RedisKeyAnalysisApiGetRedisKeyAnalysisReport
394
+ */
395
+ readonly clusterName: string
396
+
397
+ /**
398
+ * Platform TaskFlow task ID.
399
+ * @type {string}
400
+ * @memberof RedisKeyAnalysisApiGetRedisKeyAnalysisReport
401
+ */
402
+ readonly taskId: string
403
+ }
404
+
405
+ /**
406
+ * RedisKeyAnalysisApi - object-oriented interface
407
+ * @export
408
+ * @class RedisKeyAnalysisApi
409
+ * @extends {BaseAPI}
410
+ */
411
+ export class RedisKeyAnalysisApi extends BaseAPI implements RedisKeyAnalysisApiInterface {
412
+ /**
413
+ * Submits the redis-rdr-keys-analysis OpsDefinition. After the operation succeeds, the platform reads /data/rdr-report.json from every primary pod and persists one report row per shard. Poll the task and then call the report API with the returned taskId.
414
+ * @summary Create a Redis keys analysis task
415
+ * @param {RedisKeyAnalysisApiCreateRedisKeyAnalysisRequest} requestParameters Request parameters.
416
+ * @param {*} [options] Override http request option.
417
+ * @throws {RequiredError}
418
+ * @memberof RedisKeyAnalysisApi
419
+ */
420
+ public createRedisKeyAnalysis(requestParameters: RedisKeyAnalysisApiCreateRedisKeyAnalysisRequest, options?: RawAxiosRequestConfig) {
421
+ return RedisKeyAnalysisApiFp(this.configuration).createRedisKeyAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.createRedisKeyAnalysisRequest, options).then((request) => request(this.axios, this.basePath));
422
+ }
423
+
424
+ /**
425
+ *
426
+ * @summary Delete a Redis keys analysis report
427
+ * @param {RedisKeyAnalysisApiDeleteRedisKeyAnalysisReportRequest} requestParameters Request parameters.
428
+ * @param {*} [options] Override http request option.
429
+ * @throws {RequiredError}
430
+ * @memberof RedisKeyAnalysisApi
431
+ */
432
+ public deleteRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiDeleteRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig) {
433
+ return RedisKeyAnalysisApiFp(this.configuration).deleteRedisKeyAnalysisReport(requestParameters.orgName, requestParameters.clusterName, requestParameters.taskId, options).then((request) => request(this.axios, this.basePath));
434
+ }
435
+
436
+ /**
437
+ * Returns one persisted row per shard. For a cluster with multiple shards, one additional aggregate row with isSummary=true is appended; it is not persisted.
438
+ * @summary Get a Redis keys analysis report
439
+ * @param {RedisKeyAnalysisApiGetRedisKeyAnalysisReportRequest} requestParameters Request parameters.
440
+ * @param {*} [options] Override http request option.
441
+ * @throws {RequiredError}
442
+ * @memberof RedisKeyAnalysisApi
443
+ */
444
+ public getRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiGetRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig) {
445
+ return RedisKeyAnalysisApiFp(this.configuration).getRedisKeyAnalysisReport(requestParameters.orgName, requestParameters.clusterName, requestParameters.taskId, options).then((request) => request(this.axios, this.basePath));
446
+ }
447
+ }
448
+
@@ -0,0 +1,48 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * KubeBlocks Cloud API
5
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources. The API is organized around REST. Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs. We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CreateRedisKeyAnalysisRequestParameters
21
+ */
22
+ export interface CreateRedisKeyAnalysisRequestParameters {
23
+ /**
24
+ *
25
+ * @type {number}
26
+ * @memberof CreateRedisKeyAnalysisRequestParameters
27
+ */
28
+ 'topBigKey'?: number;
29
+ /**
30
+ *
31
+ * @type {number}
32
+ * @memberof CreateRedisKeyAnalysisRequestParameters
33
+ */
34
+ 'numOfElemMin'?: number;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof CreateRedisKeyAnalysisRequestParameters
39
+ */
40
+ 'bigKeySizeMin'?: string;
41
+ /**
42
+ *
43
+ * @type {number}
44
+ * @memberof CreateRedisKeyAnalysisRequestParameters
45
+ */
46
+ 'topSlot'?: number;
47
+ }
48
+
@@ -0,0 +1,33 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * KubeBlocks Cloud API
5
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources. The API is organized around REST. Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs. We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { CreateRedisKeyAnalysisRequestParameters } from './create-redis-key-analysis-request-parameters';
19
+
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface CreateRedisKeyAnalysisRequest
24
+ */
25
+ export interface CreateRedisKeyAnalysisRequest {
26
+ /**
27
+ *
28
+ * @type {CreateRedisKeyAnalysisRequestParameters}
29
+ * @memberof CreateRedisKeyAnalysisRequest
30
+ */
31
+ 'parameters'?: CreateRedisKeyAnalysisRequestParameters;
32
+ }
33
+
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * KubeBlocks Cloud API
5
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources. The API is organized around REST. Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs. We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CreateRedisKeyAnalysis200Response
21
+ */
22
+ export interface CreateRedisKeyAnalysis200Response {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof CreateRedisKeyAnalysis200Response
27
+ */
28
+ 'taskId': string;
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof CreateRedisKeyAnalysis200Response
33
+ */
34
+ 'status'?: string;
35
+ }
36
+
@@ -234,6 +234,9 @@ export * from './consumer-group-describe';
234
234
  export * from './create-clickhouse-account-request';
235
235
  export * from './create-ipwhitelist-request';
236
236
  export * from './create-pg-extension-resp';
237
+ export * from './create-redis-key-analysis200-response';
238
+ export * from './create-redis-key-analysis-request';
239
+ export * from './create-redis-key-analysis-request-parameters';
237
240
  export * from './create-topic-request';
238
241
  export * from './custom-endpoint';
239
242
  export * from './custom-endpoint-create';
@@ -848,8 +851,12 @@ export * from './redis-dangerous-operation-request';
848
851
  export * from './redis-data-capabilities';
849
852
  export * from './redis-data-context';
850
853
  export * from './redis-info-response';
854
+ export * from './redis-key-analysis-report';
855
+ export * from './redis-key-analysis-report-parameters';
856
+ export * from './redis-key-analysis-report-type-stat-value';
851
857
  export * from './redis-key-detail';
852
858
  export * from './redis-key-detail-request';
859
+ export * from './redis-key-entry';
853
860
  export * from './redis-key-mutate-request';
854
861
  export * from './redis-key-mutate-response';
855
862
  export * from './redis-key-scan-progress';
@@ -0,0 +1,48 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * KubeBlocks Cloud API
5
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources. The API is organized around REST. Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs. We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * Parameters for a Redis keys analysis task. topBigKey and topSlot are capped at 500. numOfElemMin filters keys whose element count is below the threshold. bigKeySizeMin filters keys whose memory usage is below the threshold (for example \"10kb\").
19
+ * @export
20
+ * @interface RedisKeyAnalysisReportParameters
21
+ */
22
+ export interface RedisKeyAnalysisReportParameters {
23
+ /**
24
+ *
25
+ * @type {number}
26
+ * @memberof RedisKeyAnalysisReportParameters
27
+ */
28
+ 'topBigKey'?: number;
29
+ /**
30
+ *
31
+ * @type {number}
32
+ * @memberof RedisKeyAnalysisReportParameters
33
+ */
34
+ 'numOfElemMin'?: number;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof RedisKeyAnalysisReportParameters
39
+ */
40
+ 'bigKeySizeMin'?: string;
41
+ /**
42
+ *
43
+ * @type {number}
44
+ * @memberof RedisKeyAnalysisReportParameters
45
+ */
46
+ 'topSlot'?: number;
47
+ }
48
+
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * KubeBlocks Cloud API
5
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources. The API is organized around REST. Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs. We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface RedisKeyAnalysisReportTypeStatValue
21
+ */
22
+ export interface RedisKeyAnalysisReportTypeStatValue {
23
+ /**
24
+ *
25
+ * @type {number}
26
+ * @memberof RedisKeyAnalysisReportTypeStatValue
27
+ */
28
+ 'count'?: number;
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof RedisKeyAnalysisReportTypeStatValue
33
+ */
34
+ 'bytes'?: string;
35
+ }
36
+