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
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
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 { AdminCreateRedisKeyAnalysis200Response } from '../models';
28
+ // @ts-ignore
29
+ import type { AdminCreateRedisKeyAnalysisRequest } 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
+ * Admin variant of createRedisKeyAnalysis.
40
+ * @summary Create a Redis keys analysis task
41
+ * @param {string} orgName
42
+ * @param {string} clusterName
43
+ * @param {AdminCreateRedisKeyAnalysisRequest} [adminCreateRedisKeyAnalysisRequest]
44
+ * @param {*} [options] Override http request option.
45
+ * @throws {RequiredError}
46
+ */
47
+ adminCreateRedisKeyAnalysis: async (orgName: string, clusterName: string, adminCreateRedisKeyAnalysisRequest?: AdminCreateRedisKeyAnalysisRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
48
+ // verify required parameter 'orgName' is not null or undefined
49
+ assertParamExists('adminCreateRedisKeyAnalysis', 'orgName', orgName)
50
+ // verify required parameter 'clusterName' is not null or undefined
51
+ assertParamExists('adminCreateRedisKeyAnalysis', 'clusterName', clusterName)
52
+ const localVarPath = `/admin/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(adminCreateRedisKeyAnalysisRequest, 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
+ adminDeleteRedisKeyAnalysisReport: async (orgName: string, clusterName: string, taskId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
97
+ // verify required parameter 'orgName' is not null or undefined
98
+ assertParamExists('adminDeleteRedisKeyAnalysisReport', 'orgName', orgName)
99
+ // verify required parameter 'clusterName' is not null or undefined
100
+ assertParamExists('adminDeleteRedisKeyAnalysisReport', 'clusterName', clusterName)
101
+ // verify required parameter 'taskId' is not null or undefined
102
+ assertParamExists('adminDeleteRedisKeyAnalysisReport', 'taskId', taskId)
103
+ const localVarPath = `/admin/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 plus one non-persisted aggregate row with isSummary=true when more than one row is returned.
138
+ * @summary Get a Redis keys analysis report
139
+ * @param {string} orgName
140
+ * @param {string} clusterName
141
+ * @param {string} taskId
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ */
145
+ adminGetRedisKeyAnalysisReport: async (orgName: string, clusterName: string, taskId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
146
+ // verify required parameter 'orgName' is not null or undefined
147
+ assertParamExists('adminGetRedisKeyAnalysisReport', 'orgName', orgName)
148
+ // verify required parameter 'clusterName' is not null or undefined
149
+ assertParamExists('adminGetRedisKeyAnalysisReport', 'clusterName', clusterName)
150
+ // verify required parameter 'taskId' is not null or undefined
151
+ assertParamExists('adminGetRedisKeyAnalysisReport', 'taskId', taskId)
152
+ const localVarPath = `/admin/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
+ * Admin variant of createRedisKeyAnalysis.
197
+ * @summary Create a Redis keys analysis task
198
+ * @param {string} orgName
199
+ * @param {string} clusterName
200
+ * @param {AdminCreateRedisKeyAnalysisRequest} [adminCreateRedisKeyAnalysisRequest]
201
+ * @param {*} [options] Override http request option.
202
+ * @throws {RequiredError}
203
+ */
204
+ async adminCreateRedisKeyAnalysis(orgName: string, clusterName: string, adminCreateRedisKeyAnalysisRequest?: AdminCreateRedisKeyAnalysisRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminCreateRedisKeyAnalysis200Response>> {
205
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminCreateRedisKeyAnalysis(orgName, clusterName, adminCreateRedisKeyAnalysisRequest, options);
206
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
207
+ const localVarOperationServerBasePath = operationServerMap['RedisKeyAnalysisApi.adminCreateRedisKeyAnalysis']?.[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 adminDeleteRedisKeyAnalysisReport(orgName: string, clusterName: string, taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
220
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminDeleteRedisKeyAnalysisReport(orgName, clusterName, taskId, options);
221
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
222
+ const localVarOperationServerBasePath = operationServerMap['RedisKeyAnalysisApi.adminDeleteRedisKeyAnalysisReport']?.[localVarOperationServerIndex]?.url;
223
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
224
+ },
225
+ /**
226
+ * Returns one persisted row per shard plus one non-persisted aggregate row with isSummary=true when more than one row is returned.
227
+ * @summary Get a Redis keys analysis report
228
+ * @param {string} orgName
229
+ * @param {string} clusterName
230
+ * @param {string} taskId
231
+ * @param {*} [options] Override http request option.
232
+ * @throws {RequiredError}
233
+ */
234
+ async adminGetRedisKeyAnalysisReport(orgName: string, clusterName: string, taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RedisKeyAnalysisReport>>> {
235
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminGetRedisKeyAnalysisReport(orgName, clusterName, taskId, options);
236
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
237
+ const localVarOperationServerBasePath = operationServerMap['RedisKeyAnalysisApi.adminGetRedisKeyAnalysisReport']?.[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
+ * Admin variant of createRedisKeyAnalysis.
252
+ * @summary Create a Redis keys analysis task
253
+ * @param {RedisKeyAnalysisApiAdminCreateRedisKeyAnalysisRequest} requestParameters Request parameters.
254
+ * @param {*} [options] Override http request option.
255
+ * @throws {RequiredError}
256
+ */
257
+ adminCreateRedisKeyAnalysis(requestParameters: RedisKeyAnalysisApiAdminCreateRedisKeyAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminCreateRedisKeyAnalysis200Response> {
258
+ return localVarFp.adminCreateRedisKeyAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.adminCreateRedisKeyAnalysisRequest, options).then((request) => request(axios, basePath));
259
+ },
260
+ /**
261
+ *
262
+ * @summary Delete a Redis keys analysis report
263
+ * @param {RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReportRequest} requestParameters Request parameters.
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ */
267
+ adminDeleteRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
268
+ return localVarFp.adminDeleteRedisKeyAnalysisReport(requestParameters.orgName, requestParameters.clusterName, requestParameters.taskId, options).then((request) => request(axios, basePath));
269
+ },
270
+ /**
271
+ * Returns one persisted row per shard plus one non-persisted aggregate row with isSummary=true when more than one row is returned.
272
+ * @summary Get a Redis keys analysis report
273
+ * @param {RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReportRequest} requestParameters Request parameters.
274
+ * @param {*} [options] Override http request option.
275
+ * @throws {RequiredError}
276
+ */
277
+ adminGetRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RedisKeyAnalysisReport>> {
278
+ return localVarFp.adminGetRedisKeyAnalysisReport(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
+ * Admin variant of createRedisKeyAnalysis.
291
+ * @summary Create a Redis keys analysis task
292
+ * @param {RedisKeyAnalysisApiAdminCreateRedisKeyAnalysisRequest} requestParameters Request parameters.
293
+ * @param {*} [options] Override http request option.
294
+ * @throws {RequiredError}
295
+ * @memberof RedisKeyAnalysisApiInterface
296
+ */
297
+ adminCreateRedisKeyAnalysis(requestParameters: RedisKeyAnalysisApiAdminCreateRedisKeyAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminCreateRedisKeyAnalysis200Response>;
298
+
299
+ /**
300
+ *
301
+ * @summary Delete a Redis keys analysis report
302
+ * @param {RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReportRequest} requestParameters Request parameters.
303
+ * @param {*} [options] Override http request option.
304
+ * @throws {RequiredError}
305
+ * @memberof RedisKeyAnalysisApiInterface
306
+ */
307
+ adminDeleteRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
308
+
309
+ /**
310
+ * Returns one persisted row per shard plus one non-persisted aggregate row with isSummary=true when more than one row is returned.
311
+ * @summary Get a Redis keys analysis report
312
+ * @param {RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReportRequest} requestParameters Request parameters.
313
+ * @param {*} [options] Override http request option.
314
+ * @throws {RequiredError}
315
+ * @memberof RedisKeyAnalysisApiInterface
316
+ */
317
+ adminGetRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RedisKeyAnalysisReport>>;
318
+
319
+ }
320
+
321
+ /**
322
+ * Request parameters for adminCreateRedisKeyAnalysis operation in RedisKeyAnalysisApi.
323
+ * @export
324
+ * @interface RedisKeyAnalysisApiAdminCreateRedisKeyAnalysisRequest
325
+ */
326
+ export interface RedisKeyAnalysisApiAdminCreateRedisKeyAnalysisRequest {
327
+ /**
328
+ *
329
+ * @type {string}
330
+ * @memberof RedisKeyAnalysisApiAdminCreateRedisKeyAnalysis
331
+ */
332
+ readonly orgName: string
333
+
334
+ /**
335
+ *
336
+ * @type {string}
337
+ * @memberof RedisKeyAnalysisApiAdminCreateRedisKeyAnalysis
338
+ */
339
+ readonly clusterName: string
340
+
341
+ /**
342
+ *
343
+ * @type {AdminCreateRedisKeyAnalysisRequest}
344
+ * @memberof RedisKeyAnalysisApiAdminCreateRedisKeyAnalysis
345
+ */
346
+ readonly adminCreateRedisKeyAnalysisRequest?: AdminCreateRedisKeyAnalysisRequest
347
+ }
348
+
349
+ /**
350
+ * Request parameters for adminDeleteRedisKeyAnalysisReport operation in RedisKeyAnalysisApi.
351
+ * @export
352
+ * @interface RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReportRequest
353
+ */
354
+ export interface RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReportRequest {
355
+ /**
356
+ *
357
+ * @type {string}
358
+ * @memberof RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReport
359
+ */
360
+ readonly orgName: string
361
+
362
+ /**
363
+ *
364
+ * @type {string}
365
+ * @memberof RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReport
366
+ */
367
+ readonly clusterName: string
368
+
369
+ /**
370
+ *
371
+ * @type {string}
372
+ * @memberof RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReport
373
+ */
374
+ readonly taskId: string
375
+ }
376
+
377
+ /**
378
+ * Request parameters for adminGetRedisKeyAnalysisReport operation in RedisKeyAnalysisApi.
379
+ * @export
380
+ * @interface RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReportRequest
381
+ */
382
+ export interface RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReportRequest {
383
+ /**
384
+ *
385
+ * @type {string}
386
+ * @memberof RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReport
387
+ */
388
+ readonly orgName: string
389
+
390
+ /**
391
+ *
392
+ * @type {string}
393
+ * @memberof RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReport
394
+ */
395
+ readonly clusterName: string
396
+
397
+ /**
398
+ *
399
+ * @type {string}
400
+ * @memberof RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReport
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
+ * Admin variant of createRedisKeyAnalysis.
414
+ * @summary Create a Redis keys analysis task
415
+ * @param {RedisKeyAnalysisApiAdminCreateRedisKeyAnalysisRequest} requestParameters Request parameters.
416
+ * @param {*} [options] Override http request option.
417
+ * @throws {RequiredError}
418
+ * @memberof RedisKeyAnalysisApi
419
+ */
420
+ public adminCreateRedisKeyAnalysis(requestParameters: RedisKeyAnalysisApiAdminCreateRedisKeyAnalysisRequest, options?: RawAxiosRequestConfig) {
421
+ return RedisKeyAnalysisApiFp(this.configuration).adminCreateRedisKeyAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.adminCreateRedisKeyAnalysisRequest, options).then((request) => request(this.axios, this.basePath));
422
+ }
423
+
424
+ /**
425
+ *
426
+ * @summary Delete a Redis keys analysis report
427
+ * @param {RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReportRequest} requestParameters Request parameters.
428
+ * @param {*} [options] Override http request option.
429
+ * @throws {RequiredError}
430
+ * @memberof RedisKeyAnalysisApi
431
+ */
432
+ public adminDeleteRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiAdminDeleteRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig) {
433
+ return RedisKeyAnalysisApiFp(this.configuration).adminDeleteRedisKeyAnalysisReport(requestParameters.orgName, requestParameters.clusterName, requestParameters.taskId, options).then((request) => request(this.axios, this.basePath));
434
+ }
435
+
436
+ /**
437
+ * Returns one persisted row per shard plus one non-persisted aggregate row with isSummary=true when more than one row is returned.
438
+ * @summary Get a Redis keys analysis report
439
+ * @param {RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReportRequest} requestParameters Request parameters.
440
+ * @param {*} [options] Override http request option.
441
+ * @throws {RequiredError}
442
+ * @memberof RedisKeyAnalysisApi
443
+ */
444
+ public adminGetRedisKeyAnalysisReport(requestParameters: RedisKeyAnalysisApiAdminGetRedisKeyAnalysisReportRequest, options?: RawAxiosRequestConfig) {
445
+ return RedisKeyAnalysisApiFp(this.configuration).adminGetRedisKeyAnalysisReport(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
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
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 AdminCreateRedisKeyAnalysisRequestParameters
21
+ */
22
+ export interface AdminCreateRedisKeyAnalysisRequestParameters {
23
+ /**
24
+ *
25
+ * @type {number}
26
+ * @memberof AdminCreateRedisKeyAnalysisRequestParameters
27
+ */
28
+ 'topBigKey'?: number;
29
+ /**
30
+ *
31
+ * @type {number}
32
+ * @memberof AdminCreateRedisKeyAnalysisRequestParameters
33
+ */
34
+ 'numOfElemMin'?: number;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof AdminCreateRedisKeyAnalysisRequestParameters
39
+ */
40
+ 'bigKeySizeMin'?: string;
41
+ /**
42
+ *
43
+ * @type {number}
44
+ * @memberof AdminCreateRedisKeyAnalysisRequestParameters
45
+ */
46
+ 'topSlot'?: number;
47
+ }
48
+
@@ -0,0 +1,33 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
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 { AdminCreateRedisKeyAnalysisRequestParameters } from './admin-create-redis-key-analysis-request-parameters';
19
+
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface AdminCreateRedisKeyAnalysisRequest
24
+ */
25
+ export interface AdminCreateRedisKeyAnalysisRequest {
26
+ /**
27
+ *
28
+ * @type {AdminCreateRedisKeyAnalysisRequestParameters}
29
+ * @memberof AdminCreateRedisKeyAnalysisRequest
30
+ */
31
+ 'parameters'?: AdminCreateRedisKeyAnalysisRequestParameters;
32
+ }
33
+
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
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 AdminCreateRedisKeyAnalysis200Response
21
+ */
22
+ export interface AdminCreateRedisKeyAnalysis200Response {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof AdminCreateRedisKeyAnalysis200Response
27
+ */
28
+ 'taskId': string;
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof AdminCreateRedisKeyAnalysis200Response
33
+ */
34
+ 'status'?: string;
35
+ }
36
+
@@ -8,6 +8,9 @@ export * from './account-list-role-type';
8
8
  export * from './account-option';
9
9
  export * from './account-role-type';
10
10
  export * from './add-administrators-user-role-request';
11
+ export * from './admin-create-redis-key-analysis200-response';
12
+ export * from './admin-create-redis-key-analysis-request';
13
+ export * from './admin-create-redis-key-analysis-request-parameters';
11
14
  export * from './admin-permission';
12
15
  export * from './admin-permission-list';
13
16
  export * from './admin-role';
@@ -966,8 +969,12 @@ export * from './redis-dangerous-operation-request';
966
969
  export * from './redis-data-capabilities';
967
970
  export * from './redis-data-context';
968
971
  export * from './redis-info-response';
972
+ export * from './redis-key-analysis-report';
973
+ export * from './redis-key-analysis-report-parameters';
974
+ export * from './redis-key-analysis-report-type-stat-value';
969
975
  export * from './redis-key-detail';
970
976
  export * from './redis-key-detail-request';
977
+ export * from './redis-key-entry';
971
978
  export * from './redis-key-mutate-request';
972
979
  export * from './redis-key-mutate-response';
973
980
  export * from './redis-key-scan-progress';
@@ -0,0 +1,48 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
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
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
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
+