@alicloud/polardb20170801 8.3.0 → 8.3.2

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 (31) hide show
  1. package/dist/client.d.ts +10 -10
  2. package/dist/client.js +13 -10
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/DescribeAidbclusterAttributeResponseBody.d.ts +55 -39
  5. package/dist/models/DescribeAidbclusterAttributeResponseBody.js +4 -0
  6. package/dist/models/DescribeAidbclusterAttributeResponseBody.js.map +1 -1
  7. package/dist/models/DescribeApplicationsRequest.d.ts +14 -13
  8. package/dist/models/DescribeApplicationsRequest.js.map +1 -1
  9. package/dist/models/DescribeApplicationsResponseBody.d.ts +8 -7
  10. package/dist/models/DescribeApplicationsResponseBody.js +2 -0
  11. package/dist/models/DescribeApplicationsResponseBody.js.map +1 -1
  12. package/dist/models/DescribeAvailableModelsRequest.d.ts +8 -0
  13. package/dist/models/DescribeAvailableModelsRequest.js +2 -0
  14. package/dist/models/DescribeAvailableModelsRequest.js.map +1 -1
  15. package/dist/models/DescribeAvailableModelsResponseBody.d.ts +56 -0
  16. package/dist/models/DescribeAvailableModelsResponseBody.js +14 -0
  17. package/dist/models/DescribeAvailableModelsResponseBody.js.map +1 -1
  18. package/dist/models/ModifyDbclusterEndpointRequest.d.ts +59 -87
  19. package/dist/models/ModifyDbclusterEndpointRequest.js.map +1 -1
  20. package/dist/models/RetrievalKnowledgeBaseRequest.d.ts +2 -2
  21. package/dist/models/RetrievalKnowledgeBaseResponseBody.d.ts +6 -6
  22. package/package.json +1 -1
  23. package/src/client.ts +14 -10
  24. package/src/models/DescribeAidbclusterAttributeResponseBody.ts +59 -39
  25. package/src/models/DescribeApplicationsRequest.ts +14 -13
  26. package/src/models/DescribeApplicationsResponseBody.ts +10 -7
  27. package/src/models/DescribeAvailableModelsRequest.ts +10 -0
  28. package/src/models/DescribeAvailableModelsResponseBody.ts +70 -0
  29. package/src/models/ModifyDbclusterEndpointRequest.ts +59 -87
  30. package/src/models/RetrievalKnowledgeBaseRequest.ts +2 -2
  31. package/src/models/RetrievalKnowledgeBaseResponseBody.ts +6 -6
@@ -2,11 +2,10 @@ import * as $dara from '@darabonba/typescript';
2
2
  export declare class ModifyDBClusterEndpointRequest extends $dara.Model {
3
3
  /**
4
4
  * @remarks
5
- * Specifies whether to automatically add new nodes to the endpoint. Valid values:
5
+ * Specifies whether new nodes are automatically added to the endpoint. Valid values:
6
6
  *
7
- * - **Enable**: Automatically adds new nodes.
8
- *
9
- * - **Disable**: Does not automatically add new nodes. This is the default value.
7
+ * - **Enable**: New nodes are automatically added.
8
+ * - **Disable**: New nodes are not automatically added. (Default)
10
9
  *
11
10
  * @example
12
11
  * Enable
@@ -32,7 +31,7 @@ export declare class ModifyDBClusterEndpointRequest extends $dara.Model {
32
31
  DBEndpointDescription?: string;
33
32
  /**
34
33
  * @remarks
35
- * The ID of the cluster endpoint.
34
+ * The cluster endpoint ID.
36
35
  *
37
36
  * This parameter is required.
38
37
  *
@@ -42,83 +41,60 @@ export declare class ModifyDBClusterEndpointRequest extends $dara.Model {
42
41
  DBEndpointId?: string;
43
42
  /**
44
43
  * @remarks
45
- * The advanced configurations of the cluster endpoint in JSON format. You can set the consistency level, transaction splitting, whether the primary node accepts read requests, the connection pool, and other settings.
46
- *
47
- * - Sets the load balancing policy. Format: `{\\"LoadBalancePolicy\\":\\"policy\\"}`. Valid values:
48
- *
49
- * - **0**: Connections-based load balancing (default)
50
- *
51
- * - **1**: Active requests-based load balancing
52
- *
53
- * - Specifies whether the primary node accepts read requests. Format: `{\\"MasterAcceptReads\\":\\"value\\"}`. Valid values:
54
- *
55
- * - **on**: The primary node accepts read requests (default).
56
- *
57
- * - **off**: The primary node does not accept read requests.
58
- *
59
- * - Enables or disables transaction splitting. Format: `{\\"DistributedTransaction\\":\\"value\\"}`. Valid values:
60
- *
61
- * - **on**: Enables transaction splitting (default).
62
- *
63
- * - **off**: Disables transaction splitting.
64
- *
65
- * - Sets the consistency level. Format: `{\\"ConsistLevel\\":\\"level\\"}`. Valid values:
44
+ * The advanced configuration of the cluster endpoint in JSON format. You can configure the consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling.
66
45
  *
67
- * - **0**: Eventual consistency (weak)
46
+ * * To set the load balancing policy, use the format `{\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}`. Valid values:
47
+ * * **0**: connection-based load balancing (default)
48
+ * * **1**: active-request-based load balancing
68
49
  *
69
- * - **1**: Session consistency (medium) (default)
50
+ * * To set whether the primary node accepts read requests, use the format `{\\"MasterAcceptReads\\":\\"Whether the primary node accepts reads\\"}`. Valid values:
51
+ * * **on**: The primary node accepts read requests. (Default)
52
+ * * **off**: The primary node does not accept read requests.
70
53
  *
71
- * - **2**: Global consistency (strong)
54
+ * * To set transaction splitting, use the format `{\\"DistributedTransaction\\":\\"Transaction splitting\\"}`. Valid values:
55
+ * * **on**: Transaction splitting is enabled. (Default)
56
+ * * **off**: Transaction splitting is disabled.
72
57
  *
73
- * - Sets the timeout period for a global consistency read. Format: `{\\"ConsistTimeout\\":\\"timeout\\"}`. Valid values: 0 to 60000. Default value: 20. Unit: ms.
58
+ * * To set the consistency level, use the format `{\\"ConsistLevel\\":\\"Consistency level\\"}`. Valid values:
59
+ * * **0**: eventual consistency (weak)
60
+ * * **1**: session consistency (medium) (default)
61
+ * * **2**: global consistency (strong)
74
62
  *
75
- * - Sets the timeout period for a session consistency read. Format: `{\\"ConsistSessionTimeout\\":\\"timeout\\"}`. Valid values: 0 to 60000. Default value: 0. Unit: ms.
63
+ * * To set the global consistency read timeout period, use the format `{\\"ConsistTimeout\\":\\"Global consistency read timeout\\"}`. Valid values: 0 to 60000. Default value: 20. Unit: ms.
76
64
  *
77
- * - Sets the policy for handling timeouts of global or session consistency reads. Format: `{\\"ConsistTimeoutAction\\":\\"policy\\"}`. Valid values:
65
+ * * To set the session consistency read timeout period, use the format `{\\"ConsistSessionTimeout\\":\\"Session consistency read timeout\\"}`. Valid values: 0 to 60000. Default value: 0. Unit: ms.
78
66
  *
79
- * - **0**: Forwards read requests to the primary node (default).
67
+ * * To set the global (or session) consistency read timeout policy, use the format `{\\"ConsistTimeoutAction\\":\\"Global consistency read timeout policy\\"}`. Valid values:
68
+ * * **0**: Forward the read request to the primary node. (Default)
69
+ * * **1**: The proxy returns the error message `wait replication complete timeout, please retry` to the application.
80
70
  *
81
- * - **1**: The proxy returns the error message \\`wait replication complete timeout, please retry\\` to the application.
71
+ * * To set the connection pool, use the format `{\\"ConnectionPersist\\":\\"Connection pool\\"}`. Valid values:
72
+ * * **off**: The connection pool is disabled. (Default)
73
+ * * **Session**: The session-level connection pool is enabled.
74
+ * * **Transaction**: The transaction-level connection pooling is enabled.
82
75
  *
83
- * - Sets the connection pool type. Format: `{\\"ConnectionPersist\\":\\"type\\"}`. Valid values:
76
+ * * To set parallel query, use the format `{\\"MaxParallelDegree\\":\\"Parallel query\\"}`. Valid values:
77
+ * * **on**: Parallel query is enabled.
78
+ * * **off**: Parallel query is disabled. (Default)
84
79
  *
85
- * - **off**: Disables the connection pool (default).
80
+ * * To set automatic request distribution among row offload reads from primary nodes, use the format `{\\"EnableHtapImci\\":\\"Automatic request distribution among row store and column store\\"}`. Valid values:
81
+ * * **on**: Automatic request distribution among row offload reads from primary nodes is enabled.
82
+ * * **off**: Automatic request distribution among row offload reads from primary nodes is disabled. (Default)
86
83
  *
87
- * - **Session**: Enables the session-level connection pool.
88
84
  *
89
- * - **Transaction**: Enables the transaction-level connection pool.
85
+ * * To set whether to enable overload protection, use the format `{\\"EnableOverloadThrottle\\":\\"Whether to enable overload protection\\"}`. Valid values:
86
+ * * **on**: Overload protection is enabled.
87
+ * * **off**: Overload protection is disabled. (Default)
90
88
  *
91
- * - Enables or disables parallel query. Format: `{\\"MaxParallelDegree\\":\\"value\\"}`. Valid values:
89
+ * * To set node weights, use the format `{\\"NodesWeight\\":{\\"Node ID\\":\\"Weight value\\"}}`.
92
90
  *
93
- * - **on**: Enables parallel query.
94
- *
95
- * - **off**: Disables parallel query (default).
96
- *
97
- * - Enables or disables automatic routing of requests to the row store or column store. Format: `{\\"EnableHtapImci\\":\\"value\\"}`. Valid values:
98
- *
99
- * - **on**: Enables automatic routing.
100
- *
101
- * - **off**: Disables automatic routing (default).
102
- *
103
- * - Enables or disables overload protection. Format: `{\\"EnableOverloadThrottle\\":\\"value\\"}`. Valid values:
104
- *
105
- * - **on**: Enables overload protection.
106
- *
107
- * - **off**: Disables overload protection (default).
108
- *
109
- * > * You can set transaction splitting, whether the primary node accepts read requests, the connection pool, and overload protection only when the read/write mode of the cluster endpoint for PolarDB for MySQL is set to ReadWrite (automatic read/write splitting).
110
- * >
111
- * > * If the read/write mode of a cluster endpoint for PolarDB for MySQL is **ReadOnly**, both **connections-based** and **active requests-based** load balancing policies are supported. If the read/write mode is **ReadWrite** (automatic read/write splitting), only the **active requests-based** load balancing policy is supported.
112
- * >
113
- * > * You can enable automatic routing to the row store or 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**.
114
- * >
115
- * > * Only PolarDB for MySQL supports global consistency.
116
- * >
117
- * > * If you set the **ReadWriteMode** parameter to **ReadOnly**, you can only set the consistency level to **0**.
118
- * >
119
- * > * You can set the consistency level, transaction splitting, whether the primary node accepts read requests, and the connection pool at the same time. For example: `{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`.
120
- * >
121
- * > * The transaction splitting setting is constrained by the consistency level. For example, you cannot enable transaction splitting if the consistency level is **0** (eventual consistency). You can enable transaction splitting if the consistency level is **1** (session consistency) or **2** (global consistency).
91
+ * > * Transaction splitting, whether the primary node accepts read requests, connection pooling, 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)**.
92
+ * > * 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** policies are supported. The **ReadWrite (automatic read/write splitting)** mode supports only the **active-request-based load balancing** policy.
93
+ * > * Automatic request distribution among row offload reads from primary 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**.
94
+ * > * Only PolarDB for MySQL supports setting the consistency level to global consistency.
95
+ * > * If **ReadWriteMode** is set to **ReadOnly**, the consistency level can only be set to **0**.
96
+ * > * You can configure the consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling at the same time. Example: `{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`.
97
+ * > * 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**.
122
98
  *
123
99
  * @example
124
100
  * {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}
@@ -126,17 +102,14 @@ export declare class ModifyDBClusterEndpointRequest extends $dara.Model {
126
102
  endpointConfig?: string;
127
103
  /**
128
104
  * @remarks
129
- * The nodes to be added to the endpoint for read request distribution. Separate multiple node IDs with commas (,). The original nodes are used by default.
130
- *
131
- * > - For PolarDB for MySQL, specify the node IDs.
132
- * >
133
- * > - For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Oracle Compatible), specify the node roles, such as `Writer,Reader1,Reader2`.
134
- * >
135
- * > - If you set **ReadWriteMode** to **ReadOnly**, you can attach only one node. However, if this node fails, the endpoint may be unavailable for up to one hour. Do not use this configuration in a production environment. Select at least two nodes to improve availability.
136
- * >
137
- * > - If you set **ReadWriteMode** to **ReadWrite**, you must select at least two nodes.
138
- * > \\* For PolarDB for MySQL, you can select any two nodes. If both nodes are read-only nodes, write requests are sent to the primary node.
139
- * > \\* For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Oracle Compatible), you must include the primary node.
105
+ * The read load nodes to add to the endpoint. Separate multiple nodes with commas (,). Default value: the existing nodes.
106
+ *
107
+ * > * For PolarDB for MySQL, specify node IDs.
108
+ * > * For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), specify node role names, such as `Writer,Reader1,Reader2`.
109
+ * > * 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.
110
+ * > * If **ReadWriteMode** is set to **ReadWrite**, select at least 2 nodes.
111
+ * * PolarDB for MySQL allows you to select any two nodes. If both nodes are read-only nodes, write requests are forwarded to the primary node.
112
+ * * PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle) require the primary node to be included.
140
113
  *
141
114
  * @example
142
115
  * pi-**************,pi-*************
@@ -146,11 +119,11 @@ export declare class ModifyDBClusterEndpointRequest extends $dara.Model {
146
119
  ownerId?: number;
147
120
  /**
148
121
  * @remarks
149
- * The policy for handling global consistency timeouts. Valid values:
122
+ * The timeout policy for global consistency. Valid values:
150
123
  *
151
- * - **0**: Forwards the request to the primary node.
124
+ * - **0**: Send the request to the primary node.
152
125
  *
153
- * - **2**: Degrades the request. If a global consistency read times out, the query is automatically degraded to a regular request. The client does not receive an error message.
126
+ * - **2**: Timeout degradation. When the global consistency read times out, the query is automatically degraded to regular requests, and the client does not receive an error message.
154
127
  *
155
128
  * @example
156
129
  * 0
@@ -168,9 +141,8 @@ export declare class ModifyDBClusterEndpointRequest extends $dara.Model {
168
141
  * @remarks
169
142
  * The read/write mode. Valid values:
170
143
  *
171
- * - **ReadWrite**: Read/write (automatic read/write splitting)
172
- *
173
- * - **ReadOnly**: Read-only
144
+ * - **ReadWrite**: read/write (automatic read/write splitting)
145
+ * - **ReadOnly**: read-only
174
146
  *
175
147
  * @example
176
148
  * ReadWrite
@@ -182,9 +154,9 @@ export declare class ModifyDBClusterEndpointRequest extends $dara.Model {
182
154
  * @remarks
183
155
  * Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values:
184
156
  *
185
- * - **ON**: Enable
157
+ * - **ON**: Enabled.
186
158
  *
187
- * - **OFF**: Disable
159
+ * - **OFF**: Disabled.
188
160
  *
189
161
  * @example
190
162
  * on
@@ -1 +1 @@
1
- {"version":3,"file":"ModifyDbclusterEndpointRequest.js","sourceRoot":"","sources":["../../src/models/ModifyDbclusterEndpointRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,8BAA+B,SAAQ,KAAK,CAAC,KAAK;IA+L7D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,iBAAiB;YAClC,WAAW,EAAE,aAAa;YAC1B,qBAAqB,EAAE,uBAAuB;YAC9C,YAAY,EAAE,cAAc;YAC5B,cAAc,EAAE,gBAAgB;YAChC,KAAK,EAAE,OAAO;YACd,YAAY,EAAE,cAAc;YAC5B,OAAO,EAAE,SAAS;YAClB,qBAAqB,EAAE,uBAAuB;YAC9C,mBAAmB,EAAE,qBAAqB;YAC1C,aAAa,EAAE,eAAe;YAC9B,oBAAoB,EAAE,sBAAsB;YAC5C,eAAe,EAAE,iBAAiB;YAClC,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,WAAW,EAAE,QAAQ;YACrB,qBAAqB,EAAE,QAAQ;YAC/B,YAAY,EAAE,QAAQ;YACtB,cAAc,EAAE,QAAQ;YACxB,KAAK,EAAE,QAAQ;YACf,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,QAAQ;YACjB,qBAAqB,EAAE,QAAQ;YAC/B,mBAAmB,EAAE,QAAQ;YAC7B,aAAa,EAAE,QAAQ;YACvB,oBAAoB,EAAE,QAAQ;YAC9B,eAAe,EAAE,QAAQ;YACzB,OAAO,EAAE,QAAQ;SAClB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA5OD,wEA4OC"}
1
+ {"version":3,"file":"ModifyDbclusterEndpointRequest.js","sourceRoot":"","sources":["../../src/models/ModifyDbclusterEndpointRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,8BAA+B,SAAQ,KAAK,CAAC,KAAK;IAmK7D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,iBAAiB;YAClC,WAAW,EAAE,aAAa;YAC1B,qBAAqB,EAAE,uBAAuB;YAC9C,YAAY,EAAE,cAAc;YAC5B,cAAc,EAAE,gBAAgB;YAChC,KAAK,EAAE,OAAO;YACd,YAAY,EAAE,cAAc;YAC5B,OAAO,EAAE,SAAS;YAClB,qBAAqB,EAAE,uBAAuB;YAC9C,mBAAmB,EAAE,qBAAqB;YAC1C,aAAa,EAAE,eAAe;YAC9B,oBAAoB,EAAE,sBAAsB;YAC5C,eAAe,EAAE,iBAAiB;YAClC,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,WAAW,EAAE,QAAQ;YACrB,qBAAqB,EAAE,QAAQ;YAC/B,YAAY,EAAE,QAAQ;YACtB,cAAc,EAAE,QAAQ;YACxB,KAAK,EAAE,QAAQ;YACf,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,QAAQ;YACjB,qBAAqB,EAAE,QAAQ;YAC/B,mBAAmB,EAAE,QAAQ;YAC7B,aAAa,EAAE,QAAQ;YACvB,oBAAoB,EAAE,QAAQ;YAC9B,eAAe,EAAE,QAAQ;YACzB,OAAO,EAAE,QAAQ;SAClB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAhND,wEAgNC"}
@@ -2,12 +2,12 @@ import * as $dara from '@darabonba/typescript';
2
2
  export declare class RetrievalKnowledgeBaseRequest extends $dara.Model {
3
3
  /**
4
4
  * @remarks
5
- * The unique ID of the knowledge base.
5
+ * The unique identifier of the knowledge base. You can specify multiple knowledge bases separated by commas. A maximum of 50 knowledge bases can be specified.
6
6
  *
7
7
  * This parameter is required.
8
8
  *
9
9
  * @example
10
- * pkb-xxxxx
10
+ * pkb-1xxxxx,pkb-2xxxxx
11
11
  */
12
12
  knowledgeBaseId?: string;
13
13
  /**
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
2
2
  export declare class RetrievalKnowledgeBaseResponseBodyResultsImageResources extends $dara.Model {
3
3
  /**
4
4
  * @remarks
5
- * The index of the source document that the image belongs to, starting from 0.
5
+ * The index of the source document to which the image belongs, starting from 0.
6
6
  *
7
7
  * @example
8
8
  * 0
@@ -10,7 +10,7 @@ export declare class RetrievalKnowledgeBaseResponseBodyResultsImageResources ext
10
10
  documentIndex?: number;
11
11
  /**
12
12
  * @remarks
13
- * The unique ID of the image resource.
13
+ * The unique identifier of the image resource.
14
14
  *
15
15
  * @example
16
16
  * document-0/pictures/1
@@ -59,12 +59,12 @@ export declare class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Mod
59
59
  captions?: string[];
60
60
  /**
61
61
  * @remarks
62
- * The list of Docling source document structured element references associated with the chunk. You can use these references to precisely locate original elements.
62
+ * The list of Docling source document structured element references associated with the chunk. You can use these references to precisely locate elements in the original document.
63
63
  */
64
64
  docItems?: string[];
65
65
  /**
66
66
  * @remarks
67
- * The unique ID of the file.
67
+ * The unique identifier of the file.
68
68
  *
69
69
  * @example
70
70
  * 91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
@@ -80,7 +80,7 @@ export declare class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Mod
80
80
  fileName?: string;
81
81
  /**
82
82
  * @remarks
83
- * The chain of section headings that the chunk belongs to.
83
+ * The chain of section headings to which the chunk belongs.
84
84
  */
85
85
  headings?: string[];
86
86
  /**
@@ -98,7 +98,7 @@ export declare class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Mod
98
98
  metadata?: string;
99
99
  /**
100
100
  * @remarks
101
- * The list of page numbers that the chunk belongs to.
101
+ * The list of page numbers to which the chunk belongs.
102
102
  */
103
103
  pageNumbers?: number[];
104
104
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alicloud/polardb20170801",
3
- "version": "8.3.0",
3
+ "version": "8.3.2",
4
4
  "description": "",
5
5
  "main": "dist/client.js",
6
6
  "scripts": {
package/src/client.ts CHANGED
@@ -10189,7 +10189,7 @@ export default class Client extends OpenApi {
10189
10189
  }
10190
10190
 
10191
10191
  /**
10192
- * Queries the detailed attributes of a custom instance.
10192
+ * Queries the details of a custom instance.
10193
10193
  *
10194
10194
  * @param request - DescribeAIDBClusterAttributeRequest
10195
10195
  * @param runtime - runtime options for this request RuntimeOptions
@@ -10236,7 +10236,7 @@ export default class Client extends OpenApi {
10236
10236
  }
10237
10237
 
10238
10238
  /**
10239
- * Queries the detailed attributes of a custom instance.
10239
+ * Queries the details of a custom instance.
10240
10240
  *
10241
10241
  * @param request - DescribeAIDBClusterAttributeRequest
10242
10242
  * @returns DescribeAIDBClusterAttributeResponse
@@ -12453,7 +12453,7 @@ export default class Client extends OpenApi {
12453
12453
  }
12454
12454
 
12455
12455
  /**
12456
- * Gets the list of applications for all PolarDB instances in a specified region.
12456
+ * Retrieves the list of applications for all PolarDB instances in a specified region.
12457
12457
  *
12458
12458
  * @param request - DescribeApplicationsRequest
12459
12459
  * @param runtime - runtime options for this request RuntimeOptions
@@ -12508,7 +12508,7 @@ export default class Client extends OpenApi {
12508
12508
  }
12509
12509
 
12510
12510
  /**
12511
- * Gets the list of applications for all PolarDB instances in a specified region.
12511
+ * Retrieves the list of applications for all PolarDB instances in a specified region.
12512
12512
  *
12513
12513
  * @param request - DescribeApplicationsRequest
12514
12514
  * @returns DescribeApplicationsResponse
@@ -12655,7 +12655,7 @@ export default class Client extends OpenApi {
12655
12655
  }
12656
12656
 
12657
12657
  /**
12658
- * Retrieves the list of AI cluster models.
12658
+ * Retrieves the list of models in an AI cluster.
12659
12659
  *
12660
12660
  * @param request - DescribeAvailableModelsRequest
12661
12661
  * @param runtime - runtime options for this request RuntimeOptions
@@ -12668,6 +12668,10 @@ export default class Client extends OpenApi {
12668
12668
  query["KubeType"] = request.kubeType;
12669
12669
  }
12670
12670
 
12671
+ if (!$dara.isNull(request.modelType)) {
12672
+ query["ModelType"] = request.modelType;
12673
+ }
12674
+
12671
12675
  if (!$dara.isNull(request.regionId)) {
12672
12676
  query["RegionId"] = request.regionId;
12673
12677
  }
@@ -12690,7 +12694,7 @@ export default class Client extends OpenApi {
12690
12694
  }
12691
12695
 
12692
12696
  /**
12693
- * Retrieves the list of AI cluster models.
12697
+ * Retrieves the list of models in an AI cluster.
12694
12698
  *
12695
12699
  * @param request - DescribeAvailableModelsRequest
12696
12700
  * @returns DescribeAvailableModelsResponse
@@ -25743,7 +25747,7 @@ export default class Client extends OpenApi {
25743
25747
  }
25744
25748
 
25745
25749
  /**
25746
- * This operation modifies the properties of a PolarDB cluster endpoint. You can configure settings such as the read/write mode, automatic node addition, consistency level, transaction splitting, the connection pool, and whether the primary node accepts read requests.
25750
+ * Modifies the cluster endpoint attributes of a PolarDB cluster, including the read/write mode, whether new nodes are automatically added to the endpoint, the consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling.
25747
25751
  *
25748
25752
  * @param request - ModifyDBClusterEndpointRequest
25749
25753
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25826,7 +25830,7 @@ export default class Client extends OpenApi {
25826
25830
  }
25827
25831
 
25828
25832
  /**
25829
- * This operation modifies the properties of a PolarDB cluster endpoint. You can configure settings such as the read/write mode, automatic node addition, consistency level, transaction splitting, the connection pool, and whether the primary node accepts read requests.
25833
+ * Modifies the cluster endpoint attributes of a PolarDB cluster, including the read/write mode, whether new nodes are automatically added to the endpoint, the consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling.
25830
25834
  *
25831
25835
  * @param request - ModifyDBClusterEndpointRequest
25832
25836
  * @returns ModifyDBClusterEndpointResponse
@@ -30467,7 +30471,7 @@ export default class Client extends OpenApi {
30467
30471
  }
30468
30472
 
30469
30473
  /**
30470
- * Retrieves knowledge base search results.
30474
+ * Retrieves information from a knowledge base.
30471
30475
  *
30472
30476
  * @param request - RetrievalKnowledgeBaseRequest
30473
30477
  * @param runtime - runtime options for this request RuntimeOptions
@@ -30518,7 +30522,7 @@ export default class Client extends OpenApi {
30518
30522
  }
30519
30523
 
30520
30524
  /**
30521
- * Retrieves knowledge base search results.
30525
+ * Retrieves information from a knowledge base.
30522
30526
  *
30523
30527
  * @param request - RetrievalKnowledgeBaseRequest
30524
30528
  * @returns RetrievalKnowledgeBaseResponse
@@ -13,7 +13,7 @@ export class DescribeAIDBClusterAttributeResponseBodyDBNodesChildVolumes extends
13
13
  mountPath?: string;
14
14
  /**
15
15
  * @remarks
16
- * The disk name.
16
+ * The cloud disk name.
17
17
  *
18
18
  * @example
19
19
  * jueming
@@ -21,7 +21,7 @@ export class DescribeAIDBClusterAttributeResponseBodyDBNodesChildVolumes extends
21
21
  name?: string;
22
22
  /**
23
23
  * @remarks
24
- * The storage size.
24
+ * The size of the storage cloud disk.
25
25
  *
26
26
  * @example
27
27
  * 8192
@@ -37,7 +37,7 @@ export class DescribeAIDBClusterAttributeResponseBodyDBNodesChildVolumes extends
37
37
  storageCategory?: string;
38
38
  /**
39
39
  * @remarks
40
- * The storage class.
40
+ * The storage category.
41
41
  *
42
42
  * @example
43
43
  * PL1
@@ -165,16 +165,16 @@ export class DescribeAIDBClusterAttributeResponseBodyDBNodes extends $dara.Model
165
165
  /**
166
166
  * @remarks
167
167
  * The node status. Valid values:
168
- * * **Creating**: Being created.
169
- * * **Running**: Running.
170
- * * **Deleting**: Being deleted.
171
- * * **Rebooting**: Restarting.
172
- * * **DBNodeCreating**: Adding a node.
173
- * * **DBNodeDeleting**: Deleting a node.
174
- * * **ClassChanging**: Changing node specifications.
175
- * * **MinorVersionUpgrading**: Performing a minor version upgrade.
176
- * * **Maintaining**: Under maintenance.
177
- * * **Switching**: Switching.
168
+ * * **Creating**: The node is being created.
169
+ * * **Running**: The node is running.
170
+ * * **Deleting**: The node is being deleted.
171
+ * * **Rebooting**: The node is being restarted.
172
+ * * **DBNodeCreating**: A node is being added.
173
+ * * **DBNodeDeleting**: A node is being deleted.
174
+ * * **ClassChanging**: The node specifications are being changed.
175
+ * * **MinorVersionUpgrading**: A minor engine version update is in progress.
176
+ * * **Maintaining**: The instance is under maintenance.
177
+ * * **Switching**: A switchover is in progress.
178
178
  *
179
179
  * @example
180
180
  * Running
@@ -220,7 +220,7 @@ export class DescribeAIDBClusterAttributeResponseBodyDBNodes extends $dara.Model
220
220
  supportedApis?: DescribeAIDBClusterAttributeResponseBodyDBNodesSupportedApis[];
221
221
  /**
222
222
  * @remarks
223
- * The Kubernetes virtual node ID.
223
+ * The ID of the Kubernetes virtual node.
224
224
  *
225
225
  * @example
226
226
  * vn-***************
@@ -321,9 +321,9 @@ export class DescribeAIDBClusterAttributeResponseBodyEndpointListNetInfoItems ex
321
321
  /**
322
322
  * @remarks
323
323
  * The network type of the connection string. Valid values:
324
- * * **Public**: public endpoint.
325
- * * **Private**: private endpoint.
326
- * * **Inner**: private endpoint (classic network).
324
+ * * **Public**: public endpoint
325
+ * * **Private**: private endpoint
326
+ * * **Inner**: private endpoint (classic network)
327
327
  *
328
328
  * @example
329
329
  * Public
@@ -542,7 +542,7 @@ export class DescribeAIDBClusterAttributeResponseBodyVolumes extends $dara.Model
542
542
  mountPath?: string;
543
543
  /**
544
544
  * @remarks
545
- * The disk name.
545
+ * The cloud disk name.
546
546
  *
547
547
  * @example
548
548
  * jueming
@@ -566,7 +566,7 @@ export class DescribeAIDBClusterAttributeResponseBodyVolumes extends $dara.Model
566
566
  storageCategory?: string;
567
567
  /**
568
568
  * @remarks
569
- * The storage class.
569
+ * The storage category.
570
570
  *
571
571
  * @example
572
572
  * PolarFs
@@ -605,9 +605,9 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
605
605
  /**
606
606
  * @remarks
607
607
  * The node type. Valid values:
608
- * - vnode: ACK-managed.
609
- * - container: loginable container.
610
- * - maas: model service.
608
+ * - vnode: managed by ACK
609
+ * - container: loginable container
610
+ * - maas: model service
611
611
  *
612
612
  * @example
613
613
  * vnode
@@ -623,12 +623,20 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
623
623
  apiKey?: string;
624
624
  /**
625
625
  * @remarks
626
- * The cluster creation time.
626
+ * The time when the cluster was created.
627
627
  *
628
628
  * @example
629
629
  * 2020-08-14T05:58:42Z
630
630
  */
631
631
  creationTime?: string;
632
+ /**
633
+ * @remarks
634
+ * The custom model OSS path currently used by the instance.
635
+ *
636
+ * @example
637
+ * /my-model-bucket/models/qwen3
638
+ */
639
+ customOssPath?: string;
632
640
  /**
633
641
  * @remarks
634
642
  * The cluster description. Fuzzy match is supported.
@@ -649,13 +657,13 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
649
657
  * @remarks
650
658
  * The cluster status. Valid values:
651
659
  *
652
- * - **Creating**: Being created.
653
- * - **Running**: Running.
654
- * - **Deleting**: Being released.
655
- * - **DBNodeCreating**: Adding a node.
656
- * - **DBNodeDeleting**: Deleting a node.
657
- * - **ClassChanging**: Changing node specifications.
658
- * - **Deleted**: Released.
660
+ * - **Creating**: The cluster is being created.
661
+ * - **Running**: The cluster is running.
662
+ * - **Deleting**: The cluster is being released.
663
+ * - **DBNodeCreating**: A node is being added.
664
+ * - **DBNodeDeleting**: A node is being deleted.
665
+ * - **ClassChanging**: The node specifications are being changed.
666
+ * - **Deleted**: The cluster has been released.
659
667
  *
660
668
  * @example
661
669
  * Running
@@ -664,7 +672,7 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
664
672
  DBInstanceStatusDesc?: string;
665
673
  /**
666
674
  * @remarks
667
- * The node information.
675
+ * The details of the nodes.
668
676
  */
669
677
  DBNodes?: DescribeAIDBClusterAttributeResponseBodyDBNodes[];
670
678
  /**
@@ -697,9 +705,9 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
697
705
  endpointList?: DescribeAIDBClusterAttributeResponseBodyEndpointList[];
698
706
  /**
699
707
  * @remarks
700
- * The cluster expiration time.
708
+ * The expiration time of the cluster.
701
709
  *
702
- * > Only clusters with the billing method set to **Prepaid** (subscription) return a specific value. **Postpaid** (pay-as-you-go) clusters return an empty value.
710
+ * > Only clusters whose billing method is **Prepaid** (subscription) return a specific value. **Postpaid** (pay-as-you-go) clusters return an empty value.
703
711
  *
704
712
  * @example
705
713
  * 2020-11-14T16:00:00Z
@@ -745,7 +753,7 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
745
753
  kubeClusterId?: string;
746
754
  /**
747
755
  * @remarks
748
- * The instance lock mode. The value **lock** indicates that the instance is automatically expired or has an overdue payment.
756
+ * The lock mode of the instance. The value **lock** indicates that the instance is automatically expired or has an overdue payment.
749
757
  *
750
758
  * @example
751
759
  * Unlock
@@ -788,6 +796,14 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
788
796
  * Postpaid
789
797
  */
790
798
  payType?: string;
799
+ /**
800
+ * @remarks
801
+ * The custom model OSS path before the last change.
802
+ *
803
+ * @example
804
+ * /my-model-bucket/models/qwen2
805
+ */
806
+ previousCustomOssPath?: string;
791
807
  /**
792
808
  * @remarks
793
809
  * The public IP address.
@@ -815,8 +831,8 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
815
831
  /**
816
832
  * @remarks
817
833
  * The architecture type. Valid values:
818
- * - container: AI container.
819
- * - ainode: AI node.
834
+ * - container: AI container
835
+ * - ainode: AI node
820
836
  *
821
837
  * @example
822
838
  * container
@@ -824,11 +840,11 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
824
840
  runType?: string;
825
841
  /**
826
842
  * @remarks
827
- * The storage type for Enterprise Edition. Valid values:
843
+ * Valid values for Enterprise Edition storage type:
828
844
  * - **PSL5**
829
845
  * - **PSL4**
830
846
  *
831
- * The storage type for Standard Edition. Valid values:
847
+ * Valid values for Standard Edition storage type:
832
848
  * - **ESSDPL0**
833
849
  * - **ESSDPL1**
834
850
  * - **ESSDPL2**
@@ -843,7 +859,7 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
843
859
  timeSlicesType?: string;
844
860
  /**
845
861
  * @remarks
846
- * The VPC ID specified for the zone switchover.
862
+ * The VPC ID that can be specified for cross-zone switchover.
847
863
  *
848
864
  * @example
849
865
  * vpc-*******************
@@ -886,6 +902,7 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
886
902
  aiNodeType: 'AiNodeType',
887
903
  apiKey: 'ApiKey',
888
904
  creationTime: 'CreationTime',
905
+ customOssPath: 'CustomOssPath',
889
906
  DBClusterDescription: 'DBClusterDescription',
890
907
  DBClusterId: 'DBClusterId',
891
908
  DBClusterStatus: 'DBClusterStatus',
@@ -909,6 +926,7 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
909
926
  modelSpaceName: 'ModelSpaceName',
910
927
  modelType: 'ModelType',
911
928
  payType: 'PayType',
929
+ previousCustomOssPath: 'PreviousCustomOssPath',
912
930
  publicIp: 'PublicIp',
913
931
  regionId: 'RegionId',
914
932
  requestId: 'RequestId',
@@ -930,6 +948,7 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
930
948
  aiNodeType: 'string',
931
949
  apiKey: 'string',
932
950
  creationTime: 'string',
951
+ customOssPath: 'string',
933
952
  DBClusterDescription: 'string',
934
953
  DBClusterId: 'string',
935
954
  DBClusterStatus: 'string',
@@ -953,6 +972,7 @@ export class DescribeAIDBClusterAttributeResponseBody extends $dara.Model {
953
972
  modelSpaceName: 'string',
954
973
  modelType: 'string',
955
974
  payType: 'string',
975
+ previousCustomOssPath: 'string',
956
976
  publicIp: 'string',
957
977
  regionId: 'string',
958
978
  requestId: 'string',