@alicloud/polardb20170801 7.3.0 → 7.5.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 (137) hide show
  1. package/dist/client.d.ts +70 -44
  2. package/dist/client.js +237 -44
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateAccountRequest.d.ts +39 -53
  5. package/dist/models/CreateAccountRequest.js.map +1 -1
  6. package/dist/models/CreateAidbclusterTaskRequest.d.ts +13 -17
  7. package/dist/models/CreateAidbclusterTaskRequest.js +2 -0
  8. package/dist/models/CreateAidbclusterTaskRequest.js.map +1 -1
  9. package/dist/models/CreateAidbclusterTaskResponseBody.d.ts +2 -2
  10. package/dist/models/CreateBackupRequest.d.ts +2 -1
  11. package/dist/models/CreateBackupRequest.js +2 -0
  12. package/dist/models/CreateBackupRequest.js.map +1 -1
  13. package/dist/models/CreateBackupResponseBody.d.ts +1 -1
  14. package/dist/models/CreateDbclusterEndpointRequest.d.ts +67 -92
  15. package/dist/models/CreateDbclusterEndpointRequest.js.map +1 -1
  16. package/dist/models/DescribeAgenticDbcomputeClustersRequest.d.ts +13 -0
  17. package/dist/models/DescribeAgenticDbcomputeClustersRequest.js.map +1 -1
  18. package/dist/models/DescribeAgenticDbcomputeClustersResponseBody.d.ts +64 -0
  19. package/dist/models/DescribeAgenticDbcomputeClustersResponseBody.js.map +1 -1
  20. package/dist/models/DescribeAidbclusterAttributeResponseBody.d.ts +91 -18
  21. package/dist/models/DescribeAidbclusterAttributeResponseBody.js +127 -1
  22. package/dist/models/DescribeAidbclusterAttributeResponseBody.js.map +1 -1
  23. package/dist/models/DescribeAidbclusterTaskAttributeRequest.d.ts +3 -3
  24. package/dist/models/DescribeAidbclusterTaskAttributeResponseBody.d.ts +37 -45
  25. package/dist/models/DescribeAidbclusterTaskAttributeResponseBody.js +2 -0
  26. package/dist/models/DescribeAidbclusterTaskAttributeResponseBody.js.map +1 -1
  27. package/dist/models/DescribeAidbclusterTasksRequest.d.ts +2 -2
  28. package/dist/models/DescribeAidbclusterTasksResponseBody.d.ts +18 -17
  29. package/dist/models/DescribeAidbclusterTasksResponseBody.js +2 -0
  30. package/dist/models/DescribeAidbclusterTasksResponseBody.js.map +1 -1
  31. package/dist/models/DescribeApplicationLogsRequest.d.ts +10 -10
  32. package/dist/models/DescribeApplicationLogsResponseBody.d.ts +2 -6
  33. package/dist/models/DescribeApplicationLogsResponseBody.js.map +1 -1
  34. package/dist/models/DescribeAvailableModelsRequest.d.ts +1 -1
  35. package/dist/models/DescribeAvailableModelsResponseBody.d.ts +7 -6
  36. package/dist/models/DescribeAvailableModelsResponseBody.js +2 -0
  37. package/dist/models/DescribeAvailableModelsResponseBody.js.map +1 -1
  38. package/dist/models/DescribeBackupsRequest.d.ts +12 -19
  39. package/dist/models/DescribeBackupsRequest.js.map +1 -1
  40. package/dist/models/DescribeBackupsResponseBody.d.ts +5 -7
  41. package/dist/models/DescribeBackupsResponseBody.js +2 -0
  42. package/dist/models/DescribeBackupsResponseBody.js.map +1 -1
  43. package/dist/models/DescribeBudgetPoliciesRequest.d.ts +10 -14
  44. package/dist/models/DescribeBudgetPoliciesRequest.js +2 -0
  45. package/dist/models/DescribeBudgetPoliciesRequest.js.map +1 -1
  46. package/dist/models/DescribeBudgetPoliciesResponseBody.d.ts +18 -22
  47. package/dist/models/DescribeBudgetPoliciesResponseBody.js.map +1 -1
  48. package/dist/models/DescribeConsumersRequest.d.ts +10 -10
  49. package/dist/models/DescribeConsumersRequest.js +4 -0
  50. package/dist/models/DescribeConsumersRequest.js.map +1 -1
  51. package/dist/models/DescribeConsumersResponseBody.d.ts +17 -17
  52. package/dist/models/DescribeDbclusterAccessWhitelistRequest.d.ts +5 -0
  53. package/dist/models/DescribeDbclusterAccessWhitelistRequest.js +2 -0
  54. package/dist/models/DescribeDbclusterAccessWhitelistRequest.js.map +1 -1
  55. package/dist/models/DescribeDbclusterPriceRequest.d.ts +244 -0
  56. package/dist/models/DescribeDbclusterPriceRequest.js +125 -0
  57. package/dist/models/DescribeDbclusterPriceRequest.js.map +1 -0
  58. package/dist/models/DescribeDbclusterPriceResponse.d.ts +19 -0
  59. package/dist/models/DescribeDbclusterPriceResponse.js +69 -0
  60. package/dist/models/DescribeDbclusterPriceResponse.js.map +1 -0
  61. package/dist/models/DescribeDbclusterPriceResponseBody.d.ts +161 -0
  62. package/dist/models/DescribeDbclusterPriceResponseBody.js +217 -0
  63. package/dist/models/DescribeDbclusterPriceResponseBody.js.map +1 -0
  64. package/dist/models/DescribeDbclusterPriceShrinkRequest.d.ts +216 -0
  65. package/dist/models/DescribeDbclusterPriceShrinkRequest.js +101 -0
  66. package/dist/models/DescribeDbclusterPriceShrinkRequest.js.map +1 -0
  67. package/dist/models/DescribeDbclusterSslrequest.d.ts +6 -2
  68. package/dist/models/DescribeDbclusterSslrequest.js +2 -0
  69. package/dist/models/DescribeDbclusterSslrequest.js.map +1 -1
  70. package/dist/models/DescribeDbclusterSslresponseBody.d.ts +13 -14
  71. package/dist/models/DescribeDbclusterSslresponseBody.js.map +1 -1
  72. package/dist/models/DescribePolarFsAttributeResponseBody.d.ts +75 -19
  73. package/dist/models/DescribePolarFsAttributeResponseBody.js +73 -1
  74. package/dist/models/DescribePolarFsAttributeResponseBody.js.map +1 -1
  75. package/dist/models/DescribePolarFsRequest.d.ts +118 -0
  76. package/dist/models/DescribePolarFsRequest.js +98 -0
  77. package/dist/models/DescribePolarFsRequest.js.map +1 -0
  78. package/dist/models/DescribePolarFsResponse.d.ts +19 -0
  79. package/dist/models/DescribePolarFsResponse.js +69 -0
  80. package/dist/models/DescribePolarFsResponse.js.map +1 -0
  81. package/dist/models/DescribePolarFsResponseBody.d.ts +175 -0
  82. package/dist/models/DescribePolarFsResponseBody.js +280 -0
  83. package/dist/models/DescribePolarFsResponseBody.js.map +1 -0
  84. package/dist/models/ModifyDbclusterAccessWhitelistRequest.d.ts +27 -32
  85. package/dist/models/ModifyDbclusterAccessWhitelistRequest.js +2 -0
  86. package/dist/models/ModifyDbclusterAccessWhitelistRequest.js.map +1 -1
  87. package/dist/models/ModifyDbclusterSslrequest.d.ts +28 -27
  88. package/dist/models/ModifyDbclusterSslrequest.js +4 -0
  89. package/dist/models/ModifyDbclusterSslrequest.js.map +1 -1
  90. package/dist/models/VerifyAgenticDbtenantApiKeyRequest.d.ts +4 -0
  91. package/dist/models/VerifyAgenticDbtenantApiKeyRequest.js.map +1 -1
  92. package/dist/models/VerifyAgenticDbtenantApiKeyResponseBody.d.ts +25 -0
  93. package/dist/models/VerifyAgenticDbtenantApiKeyResponseBody.js.map +1 -1
  94. package/dist/models/model.d.ts +29 -0
  95. package/dist/models/model.js +98 -40
  96. package/dist/models/model.js.map +1 -1
  97. package/package.json +1 -1
  98. package/src/client.ts +282 -44
  99. package/src/models/CreateAccountRequest.ts +39 -53
  100. package/src/models/CreateAidbclusterTaskRequest.ts +15 -17
  101. package/src/models/CreateAidbclusterTaskResponseBody.ts +2 -2
  102. package/src/models/CreateBackupRequest.ts +4 -1
  103. package/src/models/CreateBackupResponseBody.ts +1 -1
  104. package/src/models/CreateDbclusterEndpointRequest.ts +68 -93
  105. package/src/models/DescribeAgenticDbcomputeClustersRequest.ts +13 -0
  106. package/src/models/DescribeAgenticDbcomputeClustersResponseBody.ts +64 -0
  107. package/src/models/DescribeAidbclusterAttributeResponseBody.ts +172 -18
  108. package/src/models/DescribeAidbclusterTaskAttributeRequest.ts +3 -3
  109. package/src/models/DescribeAidbclusterTaskAttributeResponseBody.ts +39 -45
  110. package/src/models/DescribeAidbclusterTasksRequest.ts +2 -2
  111. package/src/models/DescribeAidbclusterTasksResponseBody.ts +20 -17
  112. package/src/models/DescribeApplicationLogsRequest.ts +10 -10
  113. package/src/models/DescribeApplicationLogsResponseBody.ts +2 -6
  114. package/src/models/DescribeAvailableModelsRequest.ts +1 -1
  115. package/src/models/DescribeAvailableModelsResponseBody.ts +9 -6
  116. package/src/models/DescribeBackupsRequest.ts +14 -21
  117. package/src/models/DescribeBackupsResponseBody.ts +7 -7
  118. package/src/models/DescribeBudgetPoliciesRequest.ts +13 -15
  119. package/src/models/DescribeBudgetPoliciesResponseBody.ts +19 -23
  120. package/src/models/DescribeConsumersRequest.ts +14 -10
  121. package/src/models/DescribeConsumersResponseBody.ts +17 -17
  122. package/src/models/DescribeDbclusterAccessWhitelistRequest.ts +7 -0
  123. package/src/models/DescribeDbclusterPriceRequest.ts +315 -0
  124. package/src/models/DescribeDbclusterPriceResponse.ts +40 -0
  125. package/src/models/DescribeDbclusterPriceResponseBody.ts +279 -0
  126. package/src/models/DescribeDbclusterPriceShrinkRequest.ts +272 -0
  127. package/src/models/DescribeDbclusterSslrequest.ts +8 -2
  128. package/src/models/DescribeDbclusterSslresponseBody.ts +13 -14
  129. package/src/models/DescribePolarFsAttributeResponseBody.ts +129 -19
  130. package/src/models/DescribePolarFsRequest.ts +162 -0
  131. package/src/models/DescribePolarFsResponse.ts +40 -0
  132. package/src/models/DescribePolarFsResponseBody.ts +347 -0
  133. package/src/models/ModifyDbclusterAccessWhitelistRequest.ts +29 -32
  134. package/src/models/ModifyDbclusterSslrequest.ts +32 -27
  135. package/src/models/VerifyAgenticDbtenantApiKeyRequest.ts +4 -0
  136. package/src/models/VerifyAgenticDbtenantApiKeyResponseBody.ts +25 -0
  137. package/src/models/model.ts +29 -0
@@ -7,9 +7,8 @@ export class CreateAccountRequest extends $dara.Model {
7
7
  * @remarks
8
8
  * The description of the account. The description must meet the following requirements:
9
9
  *
10
- * - It cannot start with `http://` or `https://`.
11
- *
12
- * - It must be 2 to 256 characters in length.
10
+ * - Cannot start with `http://` or `https://`.
11
+ * - Is 2 to 256 characters in length.
13
12
  *
14
13
  * @example
15
14
  * testdes
@@ -17,15 +16,12 @@ export class CreateAccountRequest extends $dara.Model {
17
16
  accountDescription?: string;
18
17
  /**
19
18
  * @remarks
20
- * The name of the database account. The name must meet the following requirements:
21
- *
22
- * - It must start with a lowercase letter and end with a letter or a digit.
23
- *
24
- * - It can contain lowercase letters, digits, and underscores (_).
19
+ * The account name. The name must meet the following requirements:
25
20
  *
26
- * - It must be 2 to 16 characters in length.
27
- *
28
- * - It cannot be a reserved keyword, such as root or admin.
21
+ * * Starts with a lowercase letter and ends with a letter or digit.
22
+ * * Contains only lowercase letters, digits, or underscores (_).
23
+ * * Is 2 to 16 characters in length.
24
+ * * Cannot use certain reserved usernames such as root or admin.
29
25
  *
30
26
  * This parameter is required.
31
27
  *
@@ -35,13 +31,10 @@ export class CreateAccountRequest extends $dara.Model {
35
31
  accountName?: string;
36
32
  /**
37
33
  * @remarks
38
- * The password of the database account. The password must meet the following requirements:
39
- *
40
- * - It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
41
- *
42
- * - It must be 8 to 32 characters in length.
43
- *
44
- * - The special characters are `!@#$%^&*()_+-=`.
34
+ * The account password. The password must meet the following requirements:
35
+ * * Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
36
+ * * Is 8 to 32 characters in length.
37
+ * * Special characters include `!@#$%^&*()_+-=`.
45
38
  *
46
39
  * This parameter is required.
47
40
  *
@@ -51,23 +44,17 @@ export class CreateAccountRequest extends $dara.Model {
51
44
  accountPassword?: string;
52
45
  /**
53
46
  * @remarks
54
- * The privilege level to grant on the specified databases. Valid values:
55
- *
56
- * - **ReadWrite**: read and write permissions
57
- *
58
- * - **ReadOnly**: read-only permissions
47
+ * The permissions of the account. Valid values:
59
48
  *
60
- * - **DMLOnly**: DML permissions only
49
+ * * **ReadWrite**: read and write
50
+ * * **ReadOnly**: read-only
51
+ * * **DMLOnly**: DML only
52
+ * * **DDLOnly**: DDL only
53
+ * * **ReadIndex**: read-only and index
61
54
  *
62
- * - **DDLOnly**: DDL permissions only
63
- *
64
- * - **ReadIndex**: read-only and index permissions
65
- *
66
- * > * This parameter takes effect only when you specify the `DBName` parameter.
67
- * >
68
- * > * If you specify multiple databases in `DBName`, you must specify a corresponding permission for each in `AccountPrivilege`, separated by commas. The `AccountPrivilege` string cannot exceed 900 characters. For example, to grant read and write permissions to database DB1 and read-only permissions to database DB2, set `DBName` to `DB1,DB2` and set `AccountPrivilege` to `ReadWrite,ReadOnly`.
69
- * >
70
- * > * This parameter applies only to standard accounts on PolarDB for MySQL clusters.
55
+ * >* The DBName parameter must be specified for AccountPrivilege to take effect.
56
+ * >* If you specify multiple database names for the DBName parameter, you must grant the corresponding permissions to each database. Separate multiple permissions with commas (,) and make sure that the total length of the AccountPrivilege string does not exceed 900 characters. For example, to grant read and write permissions on database DB1 and read-only permissions on database DB2, set DBName to `DB1,DB2` and set AccountPrivilege to `ReadWrite,ReadOnly`.
57
+ * > * This parameter is supported only for standard accounts of PolarDB for MySQL clusters.
71
58
  *
72
59
  * @example
73
60
  * ReadWrite
@@ -75,17 +62,18 @@ export class CreateAccountRequest extends $dara.Model {
75
62
  accountPrivilege?: string;
76
63
  /**
77
64
  * @remarks
78
- * The type of the account. Valid values:
65
+ * The account type. Valid values:
79
66
  *
80
- * - **Normal**: a standard account.
67
+ * - **Normal**: standard account.
68
+ * - **Super**: privileged account.
69
+ * - **DynamoDB**: DynamoDB account.
81
70
  *
82
- * - **Super**: a privileged account.
83
71
  *
84
- * > * If you do not specify this parameter, the system creates a **Super** account by default.
85
- * >
86
- * > * You can create multiple privileged accounts on PolarDB for PostgreSQL (Oracle-Compatible) and PolarDB for PostgreSQL clusters. A privileged account has more permissions than a standard account. For more information, see [Create database accounts](https://help.aliyun.com/document_detail/68508.html).
87
- * >
88
- * > * For a PolarDB for MySQL cluster, you can create only one privileged account. For more information, see [Create database accounts](https://help.aliyun.com/document_detail/68508.html).
72
+ *
73
+ * > * If this parameter is left empty, a **Super** account is created by default.
74
+ * > * If the cluster is a PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL cluster, you can create multiple privileged accounts for each cluster. Privileged accounts have more permissions than standard accounts. For more information, see [Create a database account](https://help.aliyun.com/document_detail/68508.html).
75
+ * > * If the cluster is a PolarDB for MySQL cluster, you can create at most one privileged account for each cluster. Privileged accounts have more permissions than standard accounts. For more information, see [Create a database account](https://help.aliyun.com/document_detail/68508.html).
76
+ * > * DynamoDB accounts are dedicated accounts created for the DynamoDB compatibility feature of PolarDB for PostgreSQL. For more information, see [DynamoDB usage instructions](https://help.aliyun.com/document_detail/2979941.html).
89
77
  *
90
78
  * @example
91
79
  * Normal
@@ -93,7 +81,7 @@ export class CreateAccountRequest extends $dara.Model {
93
81
  accountType?: string;
94
82
  /**
95
83
  * @remarks
96
- * A client-generated token to ensure request idempotency. The token must be unique across requests. It is case-sensitive and can be up to 64 ASCII characters long.
84
+ * The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters in length.
97
85
  *
98
86
  * @example
99
87
  * 6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
@@ -111,9 +99,9 @@ export class CreateAccountRequest extends $dara.Model {
111
99
  DBClusterId?: string;
112
100
  /**
113
101
  * @remarks
114
- * The name of the database that the account can access. To specify multiple databases, separate the database names with a comma (,).
102
+ * The name of the database that the account is authorized to access. You can specify multiple database names separated by commas (,).
115
103
  *
116
- * > This parameter applies only to standard accounts on PolarDB for MySQL clusters.
104
+ * > This parameter is supported only for standard accounts of PolarDB for MySQL clusters.
117
105
  *
118
106
  * @example
119
107
  * testdb
@@ -121,9 +109,9 @@ export class CreateAccountRequest extends $dara.Model {
121
109
  DBName?: string;
122
110
  /**
123
111
  * @remarks
124
- * The type of the node. Valid values:
112
+ * The node type. Valid values:
125
113
  *
126
- * - **Search**: For creating an account on a PolarDB Search node.
114
+ * - Search: required when creating an account for a PolarDB Search node
127
115
  *
128
116
  * @example
129
117
  * Search
@@ -133,15 +121,13 @@ export class CreateAccountRequest extends $dara.Model {
133
121
  ownerId?: number;
134
122
  /**
135
123
  * @remarks
136
- * Specifies whether to grant the account permissions on all current and future databases in the cluster. Valid values:
137
- *
138
- * - **0 or do not specify**: The specified permissions are not granted to all databases.
124
+ * Specifies whether to grant permissions on all existing databases and all new databases in the current cluster. Valid values:
139
125
  *
140
- * - **1**: Grants the specified permissions to all current and future databases.
126
+ * - **0 or empty**: does not grant permissions.
141
127
  *
142
- * > * This parameter takes effect only when you specify the `AccountPrivilege` parameter.
143
- * >
144
- * > * If you set this parameter to `1`, the permissions specified in `AccountPrivilege` are granted to all databases.
128
+ * - **1**: grants permissions.
129
+ * >* The AccountPrivilege parameter must be specified for this parameter to take effect.
130
+ * >* If this parameter is set to `1`, the permissions specified by AccountPrivilege are granted on all databases.
145
131
  *
146
132
  * @example
147
133
  * 0
@@ -23,7 +23,7 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
23
23
  DBInstanceClass?: string;
24
24
  /**
25
25
  * @remarks
26
- * The ID of the training dataset. This parameter is required for fine-tuning.
26
+ * The training dataset ID. This parameter is required for fine-tuning.
27
27
  *
28
28
  * @example
29
29
  * pds-2zetrain***
@@ -31,7 +31,7 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
31
31
  datasetPath?: string;
32
32
  /**
33
33
  * @remarks
34
- * The ID of the validation dataset. This parameter is required for evaluation.
34
+ * The validation dataset ID. This parameter is required for evaluation.
35
35
  *
36
36
  * @example
37
37
  * pds-2zetrain***
@@ -39,9 +39,8 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
39
39
  evalDatasetPath?: string;
40
40
  /**
41
41
  * @remarks
42
- * The type of model service. Valid values:
43
- *
44
- * - **aitrain**: For model operator tuning.
42
+ * The model service type. Valid values:
43
+ * * **aitrain**: model operator tuning
45
44
  *
46
45
  * This parameter is required.
47
46
  *
@@ -52,10 +51,8 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
52
51
  /**
53
52
  * @remarks
54
53
  * The model name.
55
- *
56
- * - For a **preset model**, specify the model name.
57
- *
58
- * - For a **custom model**, specify the path to the model. This option is for models trained in a cold storage edition instance.
54
+ * * **For a preset model, specify the name of the selected model.**
55
+ * * **For a custom model, specify the path where the model is stored (the model trained in a cold storage instance).**
59
56
  *
60
57
  * This parameter is required.
61
58
  *
@@ -66,10 +63,8 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
66
63
  /**
67
64
  * @remarks
68
65
  * The model source. Valid values:
69
- *
70
- * - **public**: A preset model.
71
- *
72
- * - **custom**: A custom model.
66
+ * * **public**: preset model
67
+ * * **custom**: custom model
73
68
  *
74
69
  * This parameter is required.
75
70
  *
@@ -79,7 +74,7 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
79
74
  modelSource?: string;
80
75
  /**
81
76
  * @remarks
82
- * The type of the custom model.
77
+ * The custom model type.
83
78
  *
84
79
  * @example
85
80
  * qwen3
@@ -99,7 +94,7 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
99
94
  resourceOwnerId?: number;
100
95
  /**
101
96
  * @remarks
102
- * The runtime parameters, specified as a JSON string.
97
+ * The running parameters in JSON string format.
103
98
  *
104
99
  * This parameter is required.
105
100
  *
@@ -117,15 +112,16 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
117
112
  securityGroupId?: string;
118
113
  /**
119
114
  * @remarks
120
- * The name of the task.
115
+ * The description of the model service.
121
116
  *
122
117
  * @example
123
118
  * xxxx
124
119
  */
125
120
  taskName?: string;
121
+ tuneArch?: string;
126
122
  /**
127
123
  * @remarks
128
- * The VPC ID.
124
+ * The virtual private cloud (VPC) ID.
129
125
  *
130
126
  * @example
131
127
  * vpc-*******************
@@ -165,6 +161,7 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
165
161
  runningParameter: 'RunningParameter',
166
162
  securityGroupId: 'SecurityGroupId',
167
163
  taskName: 'TaskName',
164
+ tuneArch: 'TuneArch',
168
165
  VPCId: 'VPCId',
169
166
  vSwitchId: 'VSwitchId',
170
167
  zoneId: 'ZoneId',
@@ -189,6 +186,7 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
189
186
  runningParameter: 'string',
190
187
  securityGroupId: 'string',
191
188
  taskName: 'string',
189
+ tuneArch: 'string',
192
190
  VPCId: 'string',
193
191
  vSwitchId: 'string',
194
192
  zoneId: 'string',
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateAIDBClusterTaskResponseBody extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The ID of the model operator instance.
8
+ * The instance ID of the generated model service.
9
9
  *
10
10
  * @example
11
11
  * pm-2zo88***
@@ -21,7 +21,7 @@ export class CreateAIDBClusterTaskResponseBody extends $dara.Model {
21
21
  orderId?: string;
22
22
  /**
23
23
  * @remarks
24
- * The request ID.
24
+ * Id of the request
25
25
  *
26
26
  * @example
27
27
  * CED079B7-A408-41A1-BFF1-EC608E******
@@ -5,12 +5,13 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateBackupRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * A client token to ensure the idempotence of the request. The client generates this value, which must be unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters.
8
+ * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token is case-sensitive and can contain only ASCII characters. The token can be up to 64 characters in length.
9
9
  *
10
10
  * @example
11
11
  * 6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
12
12
  */
13
13
  clientToken?: string;
14
+ comment?: string;
14
15
  /**
15
16
  * @remarks
16
17
  * The cluster ID.
@@ -28,6 +29,7 @@ export class CreateBackupRequest extends $dara.Model {
28
29
  static names(): { [key: string]: string } {
29
30
  return {
30
31
  clientToken: 'ClientToken',
32
+ comment: 'Comment',
31
33
  DBClusterId: 'DBClusterId',
32
34
  ownerAccount: 'OwnerAccount',
33
35
  ownerId: 'OwnerId',
@@ -39,6 +41,7 @@ export class CreateBackupRequest extends $dara.Model {
39
41
  static types(): { [key: string]: any } {
40
42
  return {
41
43
  clientToken: 'string',
44
+ comment: 'string',
42
45
  DBClusterId: 'string',
43
46
  ownerAccount: 'string',
44
47
  ownerId: 'number',
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateBackupResponseBody extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The backup job ID.
8
+ * The backup set ID.
9
9
  *
10
10
  * @example
11
11
  * 11111111
@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateDBClusterEndpointRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * Specifies whether to automatically add new nodes to the endpoint. Valid values:
9
- *
10
- * - **Enable**: Automatically adds new nodes to the endpoint.
11
- *
12
- * - **Disable** (default): Does not automatically add new nodes to the endpoint.
8
+ * Specifies whether new nodes are automatically added to this endpoint. Valid values:
9
+ * * **Enable**: New nodes are automatically added to this endpoint.
10
+ * * **Disable** (default): New nodes are not automatically added to this endpoint.
13
11
  *
14
12
  * @example
15
13
  * Disable
@@ -17,7 +15,7 @@ export class CreateDBClusterEndpointRequest extends $dara.Model {
17
15
  autoAddNewNodes?: string;
18
16
  /**
19
17
  * @remarks
20
- * A client-generated token to ensure the idempotence of the request. The token must be unique, case-sensitive, and a maximum of 64 ASCII characters.
18
+ * The client token that is used to ensure the idempotence of the request and prevent repeated submissions. The token is generated by the client, must be unique across requests, is case-sensitive, and cannot exceed 64 ASCII characters in length.
21
19
  *
22
20
  * @example
23
21
  * 6000170000591aed949d0f******************
@@ -43,73 +41,41 @@ export class CreateDBClusterEndpointRequest extends $dara.Model {
43
41
  DBEndpointDescription?: string;
44
42
  /**
45
43
  * @remarks
46
- * The advanced configurations for the custom cluster endpoint, specified as a JSON string. You can configure features such as consistency level, transaction splitting, whether the primary node accepts read requests, connection pool, and load balancing policy.
47
- *
48
- * - Specifies the load balancing policy. The format is {"LoadBalancePolicy":"policy"}. Valid values:
49
- *
50
- * - **0**: connections-based load balancing (default).
51
- *
52
- * - **1**: active requests-based load balancing.
53
- *
54
- * - Specifies the consistency level. The format is `{"ConsistLevel":"level"}`. Valid values:
55
- *
56
- * - **0**: eventual consistency.
57
- *
58
- * - **1**: session consistency (default).
59
- *
60
- * - **2**: global consistency.
61
- *
62
- * - Specifies whether to enable transaction splitting. The format is `{"DistributedTransaction":"status"}`. Valid values:
63
- *
64
- * - **on**: enables transaction splitting (default).
65
- *
66
- * - **off**: disables transaction splitting.
67
- *
68
- * - Specifies whether the primary node accepts read requests. The format is `{"MasterAcceptReads":"status"}`. Valid values:
69
- *
70
- * - **on**: The primary node accepts read requests.
71
- *
72
- * - **off**: The primary node does not accept read requests (default).
73
- *
74
- * - Specifies whether to enable the connection pool. The format is `{"ConnectionPersist":"status"}`. Valid values:
75
- *
76
- * - **off**: disables the connection pool (default).
77
- *
78
- * - **Session**: enables the session-level connection pool.
79
- *
80
- * - **Transaction**: enables the transaction-level connection pool.
81
- *
82
- * - Specifies the degree of parallelism for a parallel query. The format is {"MaxParallelDegree":"degree"}. Valid values:
83
- *
84
- * - A specific integer that specifies the degree of parallelism. For example: "MaxParallelDegree":"2".
85
- *
86
- * - **off**: disables parallel query (default).
87
- *
88
- * - Specifies whether to enable automatic routing between row store and column store. The format is {"EnableHtapImci":"status"}. Valid values:
89
- *
90
- * - **on**: enables automatic routing.
91
- *
92
- * - **off**: disables automatic routing (default).
93
- *
94
- * - Specifies whether to enable overload protection. The format is {"EnableOverloadThrottle":"status"}. Valid values:
95
- *
96
- * - **on**: enables overload protection.
97
- *
98
- * - **off**: disables overload protection (default).
99
- *
100
- * > * You can configure transaction splitting, whether the primary node accepts read requests, the connection pool, and overload protection only for a PolarDB for MySQL endpoint in **ReadWrite** (automatic read/write splitting) mode.
101
- * >
102
- * > * A PolarDB for MySQL cluster endpoint in **ReadOnly** mode supports both **connections-based load balancing** and **active requests-based load balancing**. An endpoint in **ReadWrite** (automatic read/write splitting) mode supports only **active requests-based load balancing**.
103
- * >
104
- * > * You can enable automatic routing between row store and column store if the read/write mode of the cluster endpoint for PolarDB for MySQL is **ReadWrite** (automatic read/write splitting), or if the read/write mode is **ReadOnly** and the load balancing policy is **active requests-based load balancing**.
105
- * >
106
- * > * Only PolarDB for MySQL clusters support global consistency.
107
- * >
108
- * > * If you set **ReadWriteMode** to **ReadOnly**, the consistency level must be **0** (eventual consistency).
109
- * >
110
- * > * You can configure the consistency level, transaction splitting, whether the primary node accepts read requests, and the connection pool at the same time. Example: `{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`.
111
- * >
112
- * > * The setting for transaction splitting depends on the consistency level. For example, if you set the consistency level to **0** (eventual consistency), you cannot enable transaction splitting. If you set the consistency level to **1** (session consistency) or **2** (global consistency), you can enable transaction splitting.
44
+ * The advanced configurations of the cluster endpoint in JSON format. You can configure the consistency level, transaction splitting, offload reads from primary node, and connection pool settings.
45
+ * * Load balancing policy. Format: {\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}. Valid values:
46
+ * * **0**: connection-based load balancing (default).
47
+ * * **1**: active-request-based load balancing.
48
+ * * Consistency level. Format: `{"ConsistLevel":"Consistency level"}`. Valid values:
49
+ * * **0**: eventual consistency.
50
+ * * **1**: session consistency (default).
51
+ * * **2**: global consistency.
52
+ * * Transaction splitting. Format: `{"DistributedTransaction":"Transaction splitting"}`. Valid values:
53
+ * * **on**: enables transaction splitting (default).
54
+ * * **off**: disables transaction splitting.
55
+ * * Offload reads from primary node. Format: `{"MasterAcceptReads":"Offload reads from primary node"}`. Valid values:
56
+ * * **on**: the primary node accepts read requests.
57
+ * * **off**: the primary node does not accept read requests (default).
58
+ * * Connection pool. Format: `{"ConnectionPersist":"Connection pool"}`. Valid values:
59
+ * * **off**: disables the connection pool (default).
60
+ * * **Session**: enables session-level connection pooling.
61
+ * * **Transaction**: enables transaction-level connection pooling.
62
+ * * Parallel query. Format: {\\"MaxParallelDegree\\":\\"Parallel query\\"}. Valid values:
63
+ * * A specific degree of parallelism. Example: "MaxParallelDegree":"2".
64
+ * * **off**: disables parallel query (default).
65
+ * * Automatic request distribution among row store and column store nodes. Format: {\\"EnableHtapImci\\":\\"Automatic request distribution among row store and column store nodes\\"}. Valid values:
66
+ * * **on**: enables automatic request distribution among row store and column store nodes.
67
+ * * **off**: disables automatic request distribution among row store and column store nodes (default).
68
+ * * Overload protection. Format: {\\"EnableOverloadThrottle\\":\\"Overload protection\\"}. Valid values:
69
+ * * **on**: enables overload protection.
70
+ * * **off**: disables overload protection (default).
71
+ *
72
+ * > * Transaction splitting, offload reads from primary node, connection pool, and overload protection can be configured only when the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadWrite (automatic read/write splitting)**.
73
+ * >* When the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadOnly**, both **connection-based load balancing** and **active-request-based load balancing** are supported. The **ReadWrite (automatic read/write splitting)** mode supports only **active-request-based load balancing**.
74
+ * >* Automatic request distribution among row store and column store nodes can be configured when the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadWrite (automatic read/write splitting)**, or when the read/write mode is **ReadOnly** and the load balancing policy is **active-request-based load balancing**.
75
+ * >* Only PolarDB for MySQL supports setting the consistency level to global consistency.
76
+ * >* If **ReadWriteMode** is set to **ReadOnly**, the consistency level can only be set to **0**.
77
+ * >* You can configure the consistency level, transaction splitting, offload reads from primary node, and connection pool at the same time. Example: `{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`.
78
+ * >* Transaction splitting is constrained by the consistency level. For example, transaction splitting cannot be enabled when the consistency level is **0**. Transaction splitting can be enabled when the consistency level is **1** or **2**.
113
79
  *
114
80
  * @example
115
81
  * {"ConsistLevel": "1","DistributedTransaction": "on"}
@@ -117,7 +83,11 @@ export class CreateDBClusterEndpointRequest extends $dara.Model {
117
83
  endpointConfig?: string;
118
84
  /**
119
85
  * @remarks
120
- * The type of the custom cluster endpoint. Set the value to **Custom**.
86
+ * The type of the custom cluster endpoint. Valid values:
87
+ *
88
+ * - **Custom**: custom cluster endpoint.
89
+ *
90
+ * - **DynamoDB**: DynamoDB endpoint.
121
91
  *
122
92
  * This parameter is required.
123
93
  *
@@ -127,17 +97,14 @@ export class CreateDBClusterEndpointRequest extends $dara.Model {
127
97
  endpointType?: string;
128
98
  /**
129
99
  * @remarks
130
- * The nodes to associate with the endpoint. Separate multiple node IDs with a comma (,). If you omit this parameter, all nodes in the cluster are added by default.
100
+ * The read load nodes to add to the endpoint. Separate multiple nodes with commas (,). By default, all nodes are added.
131
101
  *
132
- * > - For a PolarDB for MySQL cluster, specify the node IDs.
133
- * >
134
- * > - For a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (compatible with Oracle) cluster, specify the roles of the nodes, such as `Writer,Reader1,Reader2`.
135
- * >
136
- * > - If you set **ReadWriteMode** to **ReadOnly**, you can associate only one node with the endpoint. If this node fails, the endpoint may be unavailable for up to 1 hour. This configuration is not recommended for a production environment. To improve availability, associate at least two nodes with the endpoint.
137
- * >
138
- * > - If you set **ReadWriteMode** to **ReadWrite**, you must associate at least two nodes with the endpoint.
139
- * > \\* For a PolarDB for MySQL cluster, you can select any two nodes. If both nodes are read-only nodes, write requests are routed to the primary node.
140
- * > \\* For a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (compatible with Oracle) cluster, the primary node must be included.
102
+ * > * For PolarDB for MySQL, specify node IDs.
103
+ * >* For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), specify node role names, such as `Writer,Reader1,Reader2`.
104
+ * >* If **ReadWriteMode** is set to **ReadOnly**, you can mount only one node. However, if this node fails, the endpoint may be unavailable for up to 1 hour. Do not use this configuration in production environments. Select at least 2 nodes to improve availability.
105
+ * >* If **ReadWriteMode** is set to **ReadWrite**, select at least 2 nodes.
106
+ * * For PolarDB for MySQL, you can select any two nodes. If both nodes are read-only nodes, write requests are forwarded to the primary node.
107
+ * * For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), the primary node must be included.
141
108
  *
142
109
  * @example
143
110
  * pi-**********,pi-*********
@@ -146,17 +113,20 @@ export class CreateDBClusterEndpointRequest extends $dara.Model {
146
113
  ownerAccount?: string;
147
114
  ownerId?: number;
148
115
  /**
116
+ * @remarks
117
+ * The PolarFs instance ID.
118
+ *
149
119
  * @example
150
120
  * pfs-test****
151
121
  */
152
122
  polarFsInstanceId?: string;
153
123
  /**
154
124
  * @remarks
155
- * The policy for handling global consistency read timeouts. Valid values:
125
+ * The timeout policy for global consistency. Valid values:
156
126
  *
157
- * - **0**: Send the request to the primary node.
127
+ * - **0**: sends the request to the primary node.
158
128
  *
159
- * - **2**: Downgrade to a regular request. If a global consistency read times out, the query is automatically downgraded, and the client does not receive an error.
129
+ * - **2**: timeout degradation. After a global consistency read times out, the query is automatically degraded to regular requests, and the client does not receive an error message.
160
130
  *
161
131
  * @example
162
132
  * 0
@@ -172,10 +142,9 @@ export class CreateDBClusterEndpointRequest extends $dara.Model {
172
142
  polarSccWaitTimeout?: string;
173
143
  /**
174
144
  * @remarks
175
- * The read/write mode. Valid values:
176
- *
177
- * - **ReadWrite**: read/write (automatic read/write splitting).
145
+ * The read/write mode. Valid values:
178
146
  *
147
+ * - **ReadWrite**: read/write (automatic read/write splitting).
179
148
  * - **ReadOnly** (default): read-only.
180
149
  *
181
150
  * @example
@@ -186,22 +155,28 @@ export class CreateDBClusterEndpointRequest extends $dara.Model {
186
155
  resourceOwnerId?: number;
187
156
  /**
188
157
  * @remarks
189
- * Specifies whether to enable global consistency (high-performance mode). Valid values:
158
+ * Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values:
190
159
  *
191
- * - **ON**: Enables the feature.
160
+ * - **ON**: enabled.
192
161
  *
193
- * - **OFF**: Disables the feature.
162
+ * - **OFF**: disabled.
194
163
  *
195
164
  * @example
196
165
  * on
197
166
  */
198
167
  sccMode?: string;
199
168
  /**
169
+ * @remarks
170
+ * The VPC ID.
171
+ *
200
172
  * @example
201
173
  * vpc-2zehr7ghqovftils0****
202
174
  */
203
175
  VPCId?: string;
204
176
  /**
177
+ * @remarks
178
+ * The vSwitch ID.
179
+ *
205
180
  * @example
206
181
  * vsw-2ze775gnf7jn33ua****
207
182
  */
@@ -10,6 +10,8 @@ export class DescribeAgenticDBComputeClustersRequest extends $dara.Model {
10
10
  computeClusterId?: string;
11
11
  /**
12
12
  * @remarks
13
+ * The AgenticDB cluster ID.
14
+ *
13
15
  * This parameter is required.
14
16
  *
15
17
  * @example
@@ -17,17 +19,25 @@ export class DescribeAgenticDBComputeClustersRequest extends $dara.Model {
17
19
  */
18
20
  DBClusterId?: string;
19
21
  /**
22
+ * @remarks
23
+ * The page number. Default value: 1.
24
+ *
20
25
  * @example
21
26
  * 1
22
27
  */
23
28
  pageNumber?: number;
24
29
  /**
30
+ * @remarks
31
+ * The number of entries per page. Default value: 30. Maximum value: 100.
32
+ *
25
33
  * @example
26
34
  * 30
27
35
  */
28
36
  pageSize?: number;
29
37
  /**
30
38
  * @remarks
39
+ * The region ID.
40
+ *
31
41
  * This parameter is required.
32
42
  *
33
43
  * @example
@@ -35,6 +45,9 @@ export class DescribeAgenticDBComputeClustersRequest extends $dara.Model {
35
45
  */
36
46
  regionId?: string;
37
47
  /**
48
+ * @remarks
49
+ * The status filter. Valid values: Running, Stopped, and Waiting.
50
+ *
38
51
  * @example
39
52
  * Running
40
53
  */