@alicloud/polardb20170801 7.6.0 → 7.8.0

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 (69) hide show
  1. package/dist/client.d.ts +56 -10
  2. package/dist/client.js +131 -12
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AddPolarFsPathMappingRequest.d.ts +6 -4
  5. package/dist/models/AddPolarFsPathMappingRequest.js +4 -0
  6. package/dist/models/AddPolarFsPathMappingRequest.js.map +1 -1
  7. package/dist/models/AddPolarFsPathMappingResponseBody.d.ts +1 -1
  8. package/dist/models/CreateBatchConsumerRequest.d.ts +19 -7
  9. package/dist/models/CreateBatchConsumerRequest.js +4 -0
  10. package/dist/models/CreateBatchConsumerRequest.js.map +1 -1
  11. package/dist/models/CreateBatchConsumerResponseBody.d.ts +90 -2
  12. package/dist/models/CreateBatchConsumerResponseBody.js +22 -0
  13. package/dist/models/CreateBatchConsumerResponseBody.js.map +1 -1
  14. package/dist/models/CreateDbclusterRequest.d.ts +47 -261
  15. package/dist/models/CreateDbclusterRequest.js.map +1 -1
  16. package/dist/models/CreateDbclusterResponseBody.d.ts +14 -0
  17. package/dist/models/CreateDbclusterResponseBody.js.map +1 -1
  18. package/dist/models/CreateGwConsumerOrderRequest.d.ts +76 -0
  19. package/dist/models/CreateGwConsumerOrderRequest.js +68 -0
  20. package/dist/models/CreateGwConsumerOrderRequest.js.map +1 -0
  21. package/dist/models/CreateGwConsumerOrderResponse.d.ts +19 -0
  22. package/dist/models/CreateGwConsumerOrderResponse.js +69 -0
  23. package/dist/models/CreateGwConsumerOrderResponse.js.map +1 -0
  24. package/dist/models/CreateGwConsumerOrderResponseBody.d.ts +53 -0
  25. package/dist/models/CreateGwConsumerOrderResponseBody.js +66 -0
  26. package/dist/models/CreateGwConsumerOrderResponseBody.js.map +1 -0
  27. package/dist/models/DescribeApplicationAttributeResponseBody.d.ts +75 -110
  28. package/dist/models/DescribeApplicationAttributeResponseBody.js +2 -0
  29. package/dist/models/DescribeApplicationAttributeResponseBody.js.map +1 -1
  30. package/dist/models/DescribeApplicationLogsRequest.d.ts +4 -4
  31. package/dist/models/DescribeApplicationPerformanceRequest.d.ts +38 -15
  32. package/dist/models/DescribeApplicationPerformanceRequest.js.map +1 -1
  33. package/dist/models/DescribeApplicationPerformanceResponseBody.d.ts +7 -4
  34. package/dist/models/DescribeApplicationPerformanceResponseBody.js.map +1 -1
  35. package/dist/models/ModifyDbclusterSslrequest.d.ts +14 -9
  36. package/dist/models/ModifyDbclusterSslrequest.js +2 -0
  37. package/dist/models/ModifyDbclusterSslrequest.js.map +1 -1
  38. package/dist/models/RestartPolarClawGatewayRequest.d.ts +33 -0
  39. package/dist/models/RestartPolarClawGatewayRequest.js +60 -0
  40. package/dist/models/RestartPolarClawGatewayRequest.js.map +1 -0
  41. package/dist/models/RestartPolarClawGatewayResponse.d.ts +19 -0
  42. package/dist/models/RestartPolarClawGatewayResponse.js +69 -0
  43. package/dist/models/RestartPolarClawGatewayResponse.js.map +1 -0
  44. package/dist/models/RestartPolarClawGatewayResponseBody.d.ts +109 -0
  45. package/dist/models/RestartPolarClawGatewayResponseBody.js +80 -0
  46. package/dist/models/RestartPolarClawGatewayResponseBody.js.map +1 -0
  47. package/dist/models/model.d.ts +6 -0
  48. package/dist/models/model.js +35 -23
  49. package/dist/models/model.js.map +1 -1
  50. package/package.json +2 -2
  51. package/src/client.ts +146 -12
  52. package/src/models/AddPolarFsPathMappingRequest.ts +10 -4
  53. package/src/models/AddPolarFsPathMappingResponseBody.ts +1 -1
  54. package/src/models/CreateBatchConsumerRequest.ts +23 -7
  55. package/src/models/CreateBatchConsumerResponseBody.ts +112 -2
  56. package/src/models/CreateDbclusterRequest.ts +51 -265
  57. package/src/models/CreateDbclusterResponseBody.ts +14 -0
  58. package/src/models/CreateGwConsumerOrderRequest.ts +99 -0
  59. package/src/models/CreateGwConsumerOrderResponse.ts +40 -0
  60. package/src/models/CreateGwConsumerOrderResponseBody.ts +74 -0
  61. package/src/models/DescribeApplicationAttributeResponseBody.ts +77 -110
  62. package/src/models/DescribeApplicationLogsRequest.ts +4 -4
  63. package/src/models/DescribeApplicationPerformanceRequest.ts +38 -15
  64. package/src/models/DescribeApplicationPerformanceResponseBody.ts +7 -4
  65. package/src/models/ModifyDbclusterSslrequest.ts +16 -9
  66. package/src/models/RestartPolarClawGatewayRequest.ts +48 -0
  67. package/src/models/RestartPolarClawGatewayResponse.ts +40 -0
  68. package/src/models/RestartPolarClawGatewayResponseBody.ts +144 -0
  69. package/src/models/model.ts +6 -0
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DescribeApplicationPerformanceRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The ID of the application cluster.
8
+ * The application cluster ID.
9
9
  *
10
10
  * This parameter is required.
11
11
  *
@@ -15,7 +15,7 @@ export class DescribeApplicationPerformanceRequest extends $dara.Model {
15
15
  applicationId?: string;
16
16
  /**
17
17
  * @remarks
18
- * The ID of the consumer.
18
+ * The user.
19
19
  *
20
20
  * @example
21
21
  * c-xxxxxxx
@@ -23,17 +23,31 @@ export class DescribeApplicationPerformanceRequest extends $dara.Model {
23
23
  consumer?: string;
24
24
  /**
25
25
  * @remarks
26
- * The ID of the consumer group.
26
+ * The user group.
27
27
  *
28
28
  * @example
29
29
  * cg-xxxxxx
30
30
  */
31
31
  consumerGroup?: string;
32
+ /**
33
+ * @remarks
34
+ * The downsampling policy.
35
+ *
36
+ * @example
37
+ * raw_sample
38
+ */
32
39
  downsample?: string;
40
+ /**
41
+ * @remarks
42
+ * The end step number.
43
+ *
44
+ * @example
45
+ * 100
46
+ */
33
47
  endStep?: number;
34
48
  /**
35
49
  * @remarks
36
- * The end time for the query. Specify the time in UTC in the `yyyy-MM-ddTHH:mmZ` format.
50
+ * The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format (UTC).
37
51
  *
38
52
  * This parameter is required.
39
53
  *
@@ -43,20 +57,13 @@ export class DescribeApplicationPerformanceRequest extends $dara.Model {
43
57
  endTime?: string;
44
58
  /**
45
59
  * @remarks
46
- * The granularity of the performance data, in seconds. Valid values:
47
- *
60
+ * The data granularity of performance data. Valid values:
48
61
  * - 5
49
- *
50
62
  * - 30
51
- *
52
63
  * - 60
53
- *
54
64
  * - 600
55
- *
56
65
  * - 1800
57
- *
58
66
  * - 3600
59
- *
60
67
  * - 86400
61
68
  *
62
69
  * @example
@@ -65,7 +72,9 @@ export class DescribeApplicationPerformanceRequest extends $dara.Model {
65
72
  interval?: string;
66
73
  /**
67
74
  * @remarks
68
- * The performance metrics to query. Separate multiple metrics with commas (,).<br>You can specify up to five performance metrics.<br>
75
+ * The performance metrics to query. Separate multiple values with commas (,).
76
+ *
77
+ * > **Note** You can specify up to 5 performance metrics.
69
78
  *
70
79
  * This parameter is required.
71
80
  *
@@ -73,19 +82,33 @@ export class DescribeApplicationPerformanceRequest extends $dara.Model {
73
82
  * PolarDBSupabaseMemUsage
74
83
  */
75
84
  key?: string;
85
+ /**
86
+ * @remarks
87
+ * The maximum number of data points to return.
88
+ *
89
+ * @example
90
+ * 1000
91
+ */
76
92
  maxPoints?: number;
77
93
  /**
78
94
  * @remarks
79
- * The ID of the model service.
95
+ * The model service.
80
96
  *
81
97
  * @example
82
98
  * ms-xxxxxx
83
99
  */
84
100
  modelService?: string;
101
+ /**
102
+ * @remarks
103
+ * The start step number.
104
+ *
105
+ * @example
106
+ * 1
107
+ */
85
108
  startStep?: number;
86
109
  /**
87
110
  * @remarks
88
- * The start time for the query. Specify the time in UTC in the `yyyy-MM-ddTHH:mmZ` format.
111
+ * The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format (UTC).
89
112
  *
90
113
  * This parameter is required.
91
114
  *
@@ -140,17 +140,20 @@ export class DescribeApplicationPerformanceResponseBody extends $dara.Model {
140
140
  applicationType?: string;
141
141
  /**
142
142
  * @remarks
143
- * The end time of the query. The time is in UTC and follows the `yyyy-MM-ddTHH:mm:ssZ` format.
143
+ * The end of the time range to query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format (UTC).
144
144
  *
145
145
  * @example
146
146
  * 2025-05-23T02:21:00Z
147
147
  */
148
148
  endTime?: string;
149
- interval?: string;
150
149
  /**
151
150
  * @remarks
152
- * The performance metrics.
151
+ * The data granularity.
152
+ *
153
+ * @example
154
+ * 60
153
155
  */
156
+ interval?: string;
154
157
  performanceKeys?: DescribeApplicationPerformanceResponseBodyPerformanceKeys;
155
158
  /**
156
159
  * @remarks
@@ -162,7 +165,7 @@ export class DescribeApplicationPerformanceResponseBody extends $dara.Model {
162
165
  requestId?: string;
163
166
  /**
164
167
  * @remarks
165
- * The start time of the query. The time is in UTC and follows the `yyyy-MM-ddTHH:mm:ssZ` format.
168
+ * The beginning of the time range to query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format (UTC).
166
169
  *
167
170
  * @example
168
171
  * 2022-11-15T16:00Z
@@ -3,6 +3,11 @@ import * as $dara from '@darabonba/typescript';
3
3
 
4
4
 
5
5
  export class ModifyDBClusterSSLRequest extends $dara.Model {
6
+ /**
7
+ * @example
8
+ * 1095
9
+ */
10
+ certValidDays?: string;
6
11
  /**
7
12
  * @example
8
13
  * xxx
@@ -23,7 +28,7 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
23
28
  * The endpoint ID.
24
29
  *
25
30
  * >* If the cluster is a PolarDB for MySQL cluster, this parameter is required.
26
- * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. SSL encryption is enabled for all endpoints by default.
31
+ * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. Secure Sockets Layer (SSL) encryption is enabled for all endpoints by default.
27
32
  * >* You can call the [DescribeDBClusterSSL](https://help.aliyun.com/document_detail/2319159.html) operation to query endpoint details.
28
33
  *
29
34
  * @example
@@ -32,13 +37,13 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
32
37
  DBEndpointId?: string;
33
38
  /**
34
39
  * @remarks
35
- * The network type of the endpoint. The value must be the same as the network type of the endpoint specified by **DBEndpointId**. Valid values:
40
+ * The network type of the endpoint. The value must be consistent with the network type of the endpoint specified by the **DBEndpointId** parameter. Valid values:
36
41
  * * **Public**: public network
37
42
  * * **Private**: private network
38
43
  * * **Inner**: private network (classic network)
39
44
  *
40
45
  * >* If the cluster is a PolarDB for MySQL cluster, this parameter is required.
41
- * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. SSL encryption is enabled for all endpoints by default.
46
+ * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. Secure Sockets Layer (SSL) encryption is enabled for all endpoints by default.
42
47
  *
43
48
  * @example
44
49
  * Public
@@ -57,9 +62,9 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
57
62
  * @remarks
58
63
  * Specifies whether to enable automatic SSL certificate rotation. Valid values:
59
64
  *
60
- * - **Enable**: enables automatic SSL certificate rotation.
65
+ * - **Enable**: Enables automatic rotation.
61
66
  *
62
- * - **Disable**: disables automatic SSL certificate rotation.
67
+ * - **Disable**: Disables automatic rotation.
63
68
  *
64
69
  * @example
65
70
  * Enable
@@ -68,11 +73,11 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
68
73
  /**
69
74
  * @remarks
70
75
  * The SSL status. Valid values:
71
- * * **Disable**: shutdown SSL encryption.
72
- * * **Enable**: enables SSL encryption.
73
- * * **Update**: updates the CA certificate.
76
+ * * **Disable**: Shutdown of Secure Sockets Layer (SSL) encryption.
77
+ * * **Enable**: Enables Secure Sockets Layer (SSL) encryption.
78
+ * * **Update**: Updates the CA certificate.
74
79
  *
75
- * > After you enable SSL encryption or update the CA certificate, you must download and configure the certificate. For details, see [Settings for SSL encryption](https://help.aliyun.com/document_detail/153182.html).
80
+ * > After you enable Secure Sockets Layer (SSL) encryption or update the CA certificate, you must download and configure the certificate. For details, see [Settings for SSL encryption](https://help.aliyun.com/document_detail/153182.html).
76
81
  *
77
82
  * @example
78
83
  * Enable
@@ -80,6 +85,7 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
80
85
  SSLEnabled?: string;
81
86
  static names(): { [key: string]: string } {
82
87
  return {
88
+ certValidDays: 'CertValidDays',
83
89
  connectionString: 'ConnectionString',
84
90
  DBClusterId: 'DBClusterId',
85
91
  DBEndpointId: 'DBEndpointId',
@@ -96,6 +102,7 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
96
102
 
97
103
  static types(): { [key: string]: any } {
98
104
  return {
105
+ certValidDays: 'string',
99
106
  connectionString: 'string',
100
107
  DBClusterId: 'string',
101
108
  DBEndpointId: 'string',
@@ -0,0 +1,48 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class RestartPolarClawGatewayRequest extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * The application ID.
9
+ *
10
+ * This parameter is required.
11
+ *
12
+ * @example
13
+ * pa-xxx
14
+ */
15
+ applicationId?: string;
16
+ /**
17
+ * @remarks
18
+ * The restart mode. Valid values:
19
+ * - in-process: lightweight restart without applying environment variable changes. This is the default value.
20
+ * - pkill: cold start that applies environment variable changes.
21
+ *
22
+ * @example
23
+ * in-process
24
+ */
25
+ mode?: string;
26
+ static names(): { [key: string]: string } {
27
+ return {
28
+ applicationId: 'ApplicationId',
29
+ mode: 'Mode',
30
+ };
31
+ }
32
+
33
+ static types(): { [key: string]: any } {
34
+ return {
35
+ applicationId: 'string',
36
+ mode: 'string',
37
+ };
38
+ }
39
+
40
+ validate() {
41
+ super.validate();
42
+ }
43
+
44
+ constructor(map?: { [key: string]: any }) {
45
+ super(map);
46
+ }
47
+ }
48
+
@@ -0,0 +1,40 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+ import { RestartPolarClawGatewayResponseBody } from "./RestartPolarClawGatewayResponseBody";
4
+
5
+
6
+ export class RestartPolarClawGatewayResponse extends $dara.Model {
7
+ headers?: { [key: string]: string };
8
+ statusCode?: number;
9
+ body?: RestartPolarClawGatewayResponseBody;
10
+ static names(): { [key: string]: string } {
11
+ return {
12
+ headers: 'headers',
13
+ statusCode: 'statusCode',
14
+ body: 'body',
15
+ };
16
+ }
17
+
18
+ static types(): { [key: string]: any } {
19
+ return {
20
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
21
+ statusCode: 'number',
22
+ body: RestartPolarClawGatewayResponseBody,
23
+ };
24
+ }
25
+
26
+ validate() {
27
+ if(this.headers) {
28
+ $dara.Model.validateMap(this.headers);
29
+ }
30
+ if(this.body && typeof (this.body as any).validate === 'function') {
31
+ (this.body as any).validate();
32
+ }
33
+ super.validate();
34
+ }
35
+
36
+ constructor(map?: { [key: string]: any }) {
37
+ super(map);
38
+ }
39
+ }
40
+
@@ -0,0 +1,144 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class RestartPolarClawGatewayResponseBody extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * The application ID.
9
+ *
10
+ * @example
11
+ * pa-xxx
12
+ */
13
+ applicationId?: string;
14
+ /**
15
+ * @remarks
16
+ * The response status code.
17
+ *
18
+ * @example
19
+ * 200
20
+ */
21
+ code?: number;
22
+ /**
23
+ * @remarks
24
+ * The approximate downtime of this restart, in milliseconds. This value is returned synchronously.
25
+ *
26
+ * @example
27
+ * 3235
28
+ */
29
+ downtimeMs?: number;
30
+ /**
31
+ * @remarks
32
+ * The gateway version after the restart. This value is returned synchronously.
33
+ *
34
+ * @example
35
+ * 2026.5.7
36
+ */
37
+ gatewayVersion?: string;
38
+ /**
39
+ * @remarks
40
+ * The response message.
41
+ *
42
+ * @example
43
+ * successful
44
+ */
45
+ message?: string;
46
+ /**
47
+ * @remarks
48
+ * The actual restart mode used.
49
+ *
50
+ * @example
51
+ * in-process
52
+ */
53
+ mode?: string;
54
+ /**
55
+ * @remarks
56
+ * Indicates whether the operation was successful.
57
+ *
58
+ * @example
59
+ * true
60
+ */
61
+ ok?: boolean;
62
+ /**
63
+ * @remarks
64
+ * The operation name. This value is returned when Async is set to true.
65
+ *
66
+ * @example
67
+ * RestartPolarClawGateway
68
+ */
69
+ operation?: string;
70
+ /**
71
+ * @remarks
72
+ * Id of the request
73
+ *
74
+ * @example
75
+ * F45FFACC-xxx
76
+ */
77
+ requestId?: string;
78
+ /**
79
+ * @remarks
80
+ * Indicates whether the gateway has been confirmed available after the restart. This value is returned synchronously.
81
+ *
82
+ * @example
83
+ * true
84
+ */
85
+ restarted?: boolean;
86
+ /**
87
+ * @remarks
88
+ * The initial state of the asynchronous task. This value is returned when Async is set to true.
89
+ *
90
+ * @example
91
+ * pending
92
+ */
93
+ state?: string;
94
+ /**
95
+ * @remarks
96
+ * The asynchronous task ID. This value is returned when Async is set to true. You can poll the task status by calling DescribePolarClawTask.
97
+ *
98
+ * @example
99
+ * 0ee00f56-f467-4d41-858c-ca4ede2c770e
100
+ */
101
+ taskId?: string;
102
+ static names(): { [key: string]: string } {
103
+ return {
104
+ applicationId: 'ApplicationId',
105
+ code: 'Code',
106
+ downtimeMs: 'DowntimeMs',
107
+ gatewayVersion: 'GatewayVersion',
108
+ message: 'Message',
109
+ mode: 'Mode',
110
+ ok: 'Ok',
111
+ operation: 'Operation',
112
+ requestId: 'RequestId',
113
+ restarted: 'Restarted',
114
+ state: 'State',
115
+ taskId: 'TaskId',
116
+ };
117
+ }
118
+
119
+ static types(): { [key: string]: any } {
120
+ return {
121
+ applicationId: 'string',
122
+ code: 'number',
123
+ downtimeMs: 'number',
124
+ gatewayVersion: 'string',
125
+ message: 'string',
126
+ mode: 'string',
127
+ ok: 'boolean',
128
+ operation: 'string',
129
+ requestId: 'string',
130
+ restarted: 'boolean',
131
+ state: 'string',
132
+ taskId: 'string',
133
+ };
134
+ }
135
+
136
+ validate() {
137
+ super.validate();
138
+ }
139
+
140
+ constructor(map?: { [key: string]: any }) {
141
+ super(map);
142
+ }
143
+ }
144
+
@@ -584,6 +584,9 @@ export { CreateGlobalDatabaseNetworkResponse } from './CreateGlobalDatabaseNetwo
584
584
  export { CreateGlobalSecurityIPGroupRequest } from './CreateGlobalSecurityIpgroupRequest';
585
585
  export { CreateGlobalSecurityIPGroupResponseBody } from './CreateGlobalSecurityIpgroupResponseBody';
586
586
  export { CreateGlobalSecurityIPGroupResponse } from './CreateGlobalSecurityIpgroupResponse';
587
+ export { CreateGwConsumerOrderRequest } from './CreateGwConsumerOrderRequest';
588
+ export { CreateGwConsumerOrderResponseBody } from './CreateGwConsumerOrderResponseBody';
589
+ export { CreateGwConsumerOrderResponse } from './CreateGwConsumerOrderResponse';
587
590
  export { CreateModelApiRequest } from './CreateModelApiRequest';
588
591
  export { CreateModelApiResponseBody } from './CreateModelApiResponseBody';
589
592
  export { CreateModelApiResponse } from './CreateModelApiResponse';
@@ -1603,6 +1606,9 @@ export { RestartDBNodeResponse } from './RestartDbnodeResponse';
1603
1606
  export { RestartDBNodeZonalRequest } from './RestartDbnodeZonalRequest';
1604
1607
  export { RestartDBNodeZonalResponseBody } from './RestartDbnodeZonalResponseBody';
1605
1608
  export { RestartDBNodeZonalResponse } from './RestartDbnodeZonalResponse';
1609
+ export { RestartPolarClawGatewayRequest } from './RestartPolarClawGatewayRequest';
1610
+ export { RestartPolarClawGatewayResponseBody } from './RestartPolarClawGatewayResponseBody';
1611
+ export { RestartPolarClawGatewayResponse } from './RestartPolarClawGatewayResponse';
1606
1612
  export { RestoreTableRequest } from './RestoreTableRequest';
1607
1613
  export { RestoreTableResponseBody } from './RestoreTableResponseBody';
1608
1614
  export { RestoreTableResponse } from './RestoreTableResponse';