@alicloud/agentcore20260804 2.0.1 → 2.1.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 (178) hide show
  1. package/dist/client.d.ts +118 -70
  2. package/dist/client.js +178 -70
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateAgentImchannelRequest.d.ts +4 -5
  5. package/dist/models/CreateAgentImchannelRequest.js.map +1 -1
  6. package/dist/models/CreateAgentImchannelResponseBody.d.ts +5 -7
  7. package/dist/models/CreateAgentImchannelResponseBody.js.map +1 -1
  8. package/dist/models/CreateAgentImchannelShrinkRequest.d.ts +1 -1
  9. package/dist/models/CreateAgentSpecVersionRequest.d.ts +2 -2
  10. package/dist/models/CreateExternalAgentBootstrapTokenResponseBody.d.ts +6 -6
  11. package/dist/models/CreateIdentityProviderRequest.d.ts +7 -5
  12. package/dist/models/CreateIdentityProviderRequest.js.map +1 -1
  13. package/dist/models/CreateIdentityProviderResponseBody.d.ts +4 -2
  14. package/dist/models/CreateIdentityProviderResponseBody.js.map +1 -1
  15. package/dist/models/CreateManagedAgentRequest.d.ts +33 -12
  16. package/dist/models/CreateManagedAgentRequest.js.map +1 -1
  17. package/dist/models/CreateManagedAgentResponseBody.d.ts +40 -19
  18. package/dist/models/CreateManagedAgentResponseBody.js.map +1 -1
  19. package/dist/models/CreateUserRequest.d.ts +4 -4
  20. package/dist/models/CreateUserResponseBody.d.ts +7 -7
  21. package/dist/models/CreateWorkspaceRequest.d.ts +9 -0
  22. package/dist/models/CreateWorkspaceRequest.js.map +1 -1
  23. package/dist/models/CreateWorkspaceResponseBody.d.ts +13 -4
  24. package/dist/models/CreateWorkspaceResponseBody.js.map +1 -1
  25. package/dist/models/DeleteAgentImchannelRequest.d.ts +1 -1
  26. package/dist/models/DisableConnectorResponseBody.d.ts +2 -2
  27. package/dist/models/DownloadAgentSpecViaOssRequest.d.ts +1 -1
  28. package/dist/models/DownloadAgentSpecViaOssResponseBody.d.ts +1 -1
  29. package/dist/models/EnableConnectorRequest.d.ts +1 -1
  30. package/dist/models/EnableConnectorResponseBody.d.ts +4 -4
  31. package/dist/models/GetExternalAgentResponseBody.d.ts +31 -6
  32. package/dist/models/GetExternalAgentResponseBody.js.map +1 -1
  33. package/dist/models/GetManagedAgentResponseBody.d.ts +48 -27
  34. package/dist/models/GetManagedAgentResponseBody.js.map +1 -1
  35. package/dist/models/GetServiceEndpointResponseBody.d.ts +8 -12
  36. package/dist/models/GetServiceEndpointResponseBody.js.map +1 -1
  37. package/dist/models/GetUserResponseBody.d.ts +15 -9
  38. package/dist/models/GetUserResponseBody.js.map +1 -1
  39. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlRequest.d.ts +43 -0
  40. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlRequest.js +62 -0
  41. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlRequest.js.map +1 -0
  42. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlResponse.d.ts +19 -0
  43. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlResponse.js +69 -0
  44. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlResponse.js.map +1 -0
  45. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.d.ts +110 -0
  46. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.js +98 -0
  47. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.js.map +1 -0
  48. package/dist/models/GetWorkspaceResponseBody.d.ts +16 -12
  49. package/dist/models/GetWorkspaceResponseBody.js.map +1 -1
  50. package/dist/models/ListAgentImchannelsRequest.d.ts +6 -6
  51. package/dist/models/ListAgentImchannelsResponseBody.d.ts +13 -13
  52. package/dist/models/ListAgentTeamsResponseBody.d.ts +3 -3
  53. package/dist/models/ListConnectorModelsRequest.d.ts +3 -3
  54. package/dist/models/ListConnectorModelsResponseBody.d.ts +7 -9
  55. package/dist/models/ListConnectorModelsResponseBody.js.map +1 -1
  56. package/dist/models/ListConnectorsRequest.d.ts +2 -2
  57. package/dist/models/ListConnectorsResponseBody.d.ts +6 -6
  58. package/dist/models/ListCredentialsResponseBody.d.ts +2 -2
  59. package/dist/models/ListIdentityProvidersResponseBody.d.ts +12 -23
  60. package/dist/models/ListIdentityProvidersResponseBody.js.map +1 -1
  61. package/dist/models/ListManagedAgentsResponseBody.d.ts +3 -9
  62. package/dist/models/ListManagedAgentsResponseBody.js.map +1 -1
  63. package/dist/models/ListSandboxSessionsRequest.d.ts +4 -1
  64. package/dist/models/ListSandboxSessionsRequest.js.map +1 -1
  65. package/dist/models/ListSandboxSessionsResponseBody.d.ts +80 -0
  66. package/dist/models/ListSandboxSessionsResponseBody.js.map +1 -1
  67. package/dist/models/ListSandboxesRequest.d.ts +6 -3
  68. package/dist/models/ListSandboxesRequest.js.map +1 -1
  69. package/dist/models/ListSandboxesResponseBody.d.ts +108 -0
  70. package/dist/models/ListSandboxesResponseBody.js.map +1 -1
  71. package/dist/models/ListServiceEndpointsRequest.d.ts +1 -1
  72. package/dist/models/ListServiceEndpointsResponseBody.d.ts +9 -9
  73. package/dist/models/ListTeamsRequest.d.ts +2 -2
  74. package/dist/models/ListTeamsResponseBody.d.ts +5 -5
  75. package/dist/models/ListUsersRequest.d.ts +12 -0
  76. package/dist/models/ListUsersRequest.js.map +1 -1
  77. package/dist/models/ListUsersResponseBody.d.ts +64 -2
  78. package/dist/models/ListUsersResponseBody.js.map +1 -1
  79. package/dist/models/ResetUserPasswordResponseBody.d.ts +1 -1
  80. package/dist/models/UpdateAgentSpecResponseBody.d.ts +1 -1
  81. package/dist/models/UpdateConnectorRequest.d.ts +1 -1
  82. package/dist/models/UpdateConnectorResponseBody.d.ts +3 -3
  83. package/dist/models/UpdateCredentialResponseBody.d.ts +1 -1
  84. package/dist/models/UpdateManagedAgentRequest.d.ts +59 -20
  85. package/dist/models/UpdateManagedAgentRequest.js.map +1 -1
  86. package/dist/models/UpdateManagedAgentResponseBody.d.ts +73 -27
  87. package/dist/models/UpdateManagedAgentResponseBody.js.map +1 -1
  88. package/dist/models/UpdateManagedAgentShrinkRequest.d.ts +1 -1
  89. package/dist/models/UpdateUserResponseBody.d.ts +1 -1
  90. package/dist/models/UpdateWorkspaceRequest.d.ts +2 -2
  91. package/dist/models/UpdateWorkspaceResponseBody.d.ts +13 -4
  92. package/dist/models/UpdateWorkspaceResponseBody.js.map +1 -1
  93. package/dist/models/VerifyConnectorRequest.d.ts +1 -1
  94. package/dist/models/VerifyConnectorResponseBody.d.ts +2 -2
  95. package/dist/models/VerifyWorkspaceAcrRamAuthorizationRequest.d.ts +43 -0
  96. package/dist/models/VerifyWorkspaceAcrRamAuthorizationRequest.js +62 -0
  97. package/dist/models/VerifyWorkspaceAcrRamAuthorizationRequest.js.map +1 -0
  98. package/dist/models/VerifyWorkspaceAcrRamAuthorizationResponse.d.ts +19 -0
  99. package/dist/models/VerifyWorkspaceAcrRamAuthorizationResponse.js +69 -0
  100. package/dist/models/VerifyWorkspaceAcrRamAuthorizationResponse.js.map +1 -0
  101. package/dist/models/VerifyWorkspaceAcrRamAuthorizationResponseBody.d.ts +134 -0
  102. package/dist/models/VerifyWorkspaceAcrRamAuthorizationResponseBody.js +104 -0
  103. package/dist/models/VerifyWorkspaceAcrRamAuthorizationResponseBody.js.map +1 -0
  104. package/dist/models/VerifyWorkspaceOssMountRamAuthorizationRequest.d.ts +4 -1
  105. package/dist/models/VerifyWorkspaceOssMountRamAuthorizationRequest.js.map +1 -1
  106. package/dist/models/VerifyWorkspaceOssMountRamAuthorizationResponseBody.d.ts +15 -0
  107. package/dist/models/VerifyWorkspaceOssMountRamAuthorizationResponseBody.js.map +1 -1
  108. package/dist/models/model.d.ts +8 -0
  109. package/dist/models/model.js +31 -15
  110. package/dist/models/model.js.map +1 -1
  111. package/package.json +1 -1
  112. package/src/client.ts +188 -70
  113. package/src/models/CreateAgentImchannelRequest.ts +4 -5
  114. package/src/models/CreateAgentImchannelResponseBody.ts +5 -7
  115. package/src/models/CreateAgentImchannelShrinkRequest.ts +1 -1
  116. package/src/models/CreateAgentSpecVersionRequest.ts +2 -2
  117. package/src/models/CreateExternalAgentBootstrapTokenResponseBody.ts +6 -6
  118. package/src/models/CreateIdentityProviderRequest.ts +7 -5
  119. package/src/models/CreateIdentityProviderResponseBody.ts +4 -2
  120. package/src/models/CreateManagedAgentRequest.ts +33 -12
  121. package/src/models/CreateManagedAgentResponseBody.ts +40 -19
  122. package/src/models/CreateUserRequest.ts +4 -4
  123. package/src/models/CreateUserResponseBody.ts +7 -7
  124. package/src/models/CreateWorkspaceRequest.ts +9 -0
  125. package/src/models/CreateWorkspaceResponseBody.ts +13 -4
  126. package/src/models/DeleteAgentImchannelRequest.ts +1 -1
  127. package/src/models/DisableConnectorResponseBody.ts +2 -2
  128. package/src/models/DownloadAgentSpecViaOssRequest.ts +1 -1
  129. package/src/models/DownloadAgentSpecViaOssResponseBody.ts +1 -1
  130. package/src/models/EnableConnectorRequest.ts +1 -1
  131. package/src/models/EnableConnectorResponseBody.ts +4 -4
  132. package/src/models/GetExternalAgentResponseBody.ts +31 -6
  133. package/src/models/GetManagedAgentResponseBody.ts +48 -27
  134. package/src/models/GetServiceEndpointResponseBody.ts +8 -12
  135. package/src/models/GetUserResponseBody.ts +15 -9
  136. package/src/models/GetWorkspaceAcrRamAuthorizeUrlRequest.ts +60 -0
  137. package/src/models/GetWorkspaceAcrRamAuthorizeUrlResponse.ts +40 -0
  138. package/src/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.ts +154 -0
  139. package/src/models/GetWorkspaceResponseBody.ts +16 -12
  140. package/src/models/ListAgentImchannelsRequest.ts +6 -6
  141. package/src/models/ListAgentImchannelsResponseBody.ts +13 -13
  142. package/src/models/ListAgentTeamsResponseBody.ts +3 -3
  143. package/src/models/ListConnectorModelsRequest.ts +3 -3
  144. package/src/models/ListConnectorModelsResponseBody.ts +7 -9
  145. package/src/models/ListConnectorsRequest.ts +2 -2
  146. package/src/models/ListConnectorsResponseBody.ts +6 -6
  147. package/src/models/ListCredentialsResponseBody.ts +2 -2
  148. package/src/models/ListIdentityProvidersResponseBody.ts +12 -23
  149. package/src/models/ListManagedAgentsResponseBody.ts +3 -9
  150. package/src/models/ListSandboxSessionsRequest.ts +4 -1
  151. package/src/models/ListSandboxSessionsResponseBody.ts +80 -0
  152. package/src/models/ListSandboxesRequest.ts +6 -3
  153. package/src/models/ListSandboxesResponseBody.ts +108 -0
  154. package/src/models/ListServiceEndpointsRequest.ts +1 -1
  155. package/src/models/ListServiceEndpointsResponseBody.ts +9 -9
  156. package/src/models/ListTeamsRequest.ts +2 -2
  157. package/src/models/ListTeamsResponseBody.ts +5 -5
  158. package/src/models/ListUsersRequest.ts +12 -0
  159. package/src/models/ListUsersResponseBody.ts +64 -2
  160. package/src/models/ResetUserPasswordResponseBody.ts +1 -1
  161. package/src/models/UpdateAgentSpecResponseBody.ts +1 -1
  162. package/src/models/UpdateConnectorRequest.ts +1 -1
  163. package/src/models/UpdateConnectorResponseBody.ts +3 -3
  164. package/src/models/UpdateCredentialResponseBody.ts +1 -1
  165. package/src/models/UpdateManagedAgentRequest.ts +59 -20
  166. package/src/models/UpdateManagedAgentResponseBody.ts +73 -27
  167. package/src/models/UpdateManagedAgentShrinkRequest.ts +1 -1
  168. package/src/models/UpdateUserResponseBody.ts +1 -1
  169. package/src/models/UpdateWorkspaceRequest.ts +2 -2
  170. package/src/models/UpdateWorkspaceResponseBody.ts +13 -4
  171. package/src/models/VerifyConnectorRequest.ts +1 -1
  172. package/src/models/VerifyConnectorResponseBody.ts +2 -2
  173. package/src/models/VerifyWorkspaceAcrRamAuthorizationRequest.ts +60 -0
  174. package/src/models/VerifyWorkspaceAcrRamAuthorizationResponse.ts +40 -0
  175. package/src/models/VerifyWorkspaceAcrRamAuthorizationResponseBody.ts +184 -0
  176. package/src/models/VerifyWorkspaceOssMountRamAuthorizationRequest.ts +4 -1
  177. package/src/models/VerifyWorkspaceOssMountRamAuthorizationResponseBody.ts +15 -0
  178. package/src/models/model.ts +8 -0
@@ -45,7 +45,6 @@ export class CreateAgentIMChannelRequestBody extends $dara.Model {
45
45
  /**
46
46
  * @remarks
47
47
  * The IM channel type. Valid values:
48
- *
49
48
  * - DINGTALK: DingTalk.
50
49
  * - FEISHU: Lark.
51
50
  * - WECOM: WeCom.
@@ -58,19 +57,19 @@ export class CreateAgentIMChannelRequestBody extends $dara.Model {
58
57
  channelType?: string;
59
58
  /**
60
59
  * @remarks
61
- * The channel credentials. All fields must be provided and field values must be non-empty strings. DingTalk uses clientID and clientSecret. Lark uses appId and appSecret. WeCom uses botId and secret.
60
+ * The channel credential. All fields must be provided and field values must be non-empty strings. DingTalk uses clientID and clientSecret. Lark uses appId and appSecret. WeCom uses botId and secret.
62
61
  *
63
62
  * This parameter is required.
64
63
  */
65
64
  credential?: { [key: string]: string };
66
65
  /**
67
66
  * @remarks
68
- * Specifies whether to enable the IM channel. Default value: true.
67
+ * Specifies whether to enable the IM channel. Default value during creation: true.
69
68
  */
70
69
  enabled?: boolean;
71
70
  /**
72
71
  * @remarks
73
- * The ID of the ServiceEndpoint to bind. The endpoint must belong to the specified agent and its current version, be in the ready state, and have a public network address.
72
+ * The ID of the bound ServiceEndpoint. The endpoint must belong to the specified agent and its current version, be in the ready state, and have a public network address.
74
73
  *
75
74
  * This parameter is required.
76
75
  *
@@ -121,7 +120,7 @@ export class CreateAgentIMChannelRequest extends $dara.Model {
121
120
  body?: CreateAgentIMChannelRequestBody;
122
121
  /**
123
122
  * @remarks
124
- * A reserved idempotency token. The backend does not provide persistent idempotency guarantees in the current phase.
123
+ * The reserved idempotency token. The backend does not provide persistent idempotency guarantees in the current phase.
125
124
  *
126
125
  * @example
127
126
  * client-token-1
@@ -93,7 +93,6 @@ export class CreateAgentIMChannelResponseBodyData extends $dara.Model {
93
93
  /**
94
94
  * @remarks
95
95
  * The IM channel type. Valid values:
96
- *
97
96
  * - DINGTALK: DingTalk.
98
97
  * - FEISHU: Lark.
99
98
  * - WECOM: WeCom.
@@ -117,7 +116,7 @@ export class CreateAgentIMChannelResponseBodyData extends $dara.Model {
117
116
  credentialSummary?: CreateAgentIMChannelResponseBodyDataCredentialSummary;
118
117
  /**
119
118
  * @remarks
120
- * Specifies whether to enable the IM channel. Default value: true.
119
+ * Specifies whether to enable the IM channel. Default value during creation: true.
121
120
  */
122
121
  enabled?: boolean;
123
122
  /**
@@ -138,7 +137,7 @@ export class CreateAgentIMChannelResponseBodyData extends $dara.Model {
138
137
  imChannelId?: string;
139
138
  /**
140
139
  * @remarks
141
- * The ID of the ServiceEndpoint to bind. The endpoint must belong to the specified agent and its current version, be in the ready state, and have a public network address.
140
+ * The ID of the bound ServiceEndpoint. The endpoint must belong to the specified agent and its current version, be in the ready state, and have a public network address.
142
141
  *
143
142
  * @example
144
143
  * se-1
@@ -147,7 +146,6 @@ export class CreateAgentIMChannelResponseBodyData extends $dara.Model {
147
146
  /**
148
147
  * @remarks
149
148
  * The IM channel status. Valid values:
150
- *
151
149
  * - CREATING: Being created.
152
150
  * - READY: Ready.
153
151
  * - UPDATING: Being updated.
@@ -161,7 +159,7 @@ export class CreateAgentIMChannelResponseBodyData extends $dara.Model {
161
159
  status?: string;
162
160
  /**
163
161
  * @remarks
164
- * The reason for the current IM channel status.
162
+ * The reason for the current status of the IM channel.
165
163
  *
166
164
  * @example
167
165
  * AppFlow creation failed
@@ -237,7 +235,7 @@ export class CreateAgentIMChannelResponseBodyData extends $dara.Model {
237
235
  export class CreateAgentIMChannelResponseBody extends $dara.Model {
238
236
  /**
239
237
  * @remarks
240
- * The business status code. The value SUCCESS indicates success.
238
+ * The business status code. The value is SUCCESS when the request succeeds.
241
239
  *
242
240
  * @example
243
241
  * SUCCESS
@@ -250,7 +248,7 @@ export class CreateAgentIMChannelResponseBody extends $dara.Model {
250
248
  data?: CreateAgentIMChannelResponseBodyData;
251
249
  /**
252
250
  * @remarks
253
- * The HTTP status code. The value 200 indicates success.
251
+ * The HTTP status code. The value is 200 when the request succeeds.
254
252
  *
255
253
  * @example
256
254
  * 200
@@ -10,7 +10,7 @@ export class CreateAgentIMChannelShrinkRequest extends $dara.Model {
10
10
  bodyShrink?: string;
11
11
  /**
12
12
  * @remarks
13
- * A reserved idempotency token. The backend does not provide persistent idempotency guarantees in the current phase.
13
+ * The reserved idempotency token. The backend does not provide persistent idempotency guarantees in the current phase.
14
14
  *
15
15
  * @example
16
16
  * client-token-1
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateAgentSpecVersionRequestBody extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The existing version on which to base the draft.
8
+ * The existing version on which the draft is based.
9
9
  *
10
10
  * @example
11
11
  * 1.0.0
@@ -13,7 +13,7 @@ export class CreateAgentSpecVersionRequestBody extends $dara.Model {
13
13
  basedOnVersion?: string;
14
14
  /**
15
15
  * @remarks
16
- * The version number for the draft. If not specified, the version number is automatically incremented.
16
+ * The version number of the draft. If this parameter is not specified, the version number is automatically incremented.
17
17
  *
18
18
  * @example
19
19
  * 2.0.0
@@ -63,7 +63,7 @@ export class CreateExternalAgentBootstrapTokenResponseBodyData extends $dara.Mod
63
63
  agentId?: string;
64
64
  /**
65
65
  * @remarks
66
- * The Bootstrap Token used for connecting the external agent.
66
+ * The bootstrap token used for connecting the external agent.
67
67
  *
68
68
  * @example
69
69
  * bootstrap-token
@@ -86,7 +86,7 @@ export class CreateExternalAgentBootstrapTokenResponseBodyData extends $dara.Mod
86
86
  networkType?: string;
87
87
  /**
88
88
  * @remarks
89
- * The fingerprint of the Bootstrap Token.
89
+ * The fingerprint of the bootstrap token.
90
90
  *
91
91
  * @example
92
92
  * fingerprint
@@ -137,7 +137,7 @@ export class CreateExternalAgentBootstrapTokenResponseBodyData extends $dara.Mod
137
137
  export class CreateExternalAgentBootstrapTokenResponseBody extends $dara.Model {
138
138
  /**
139
139
  * @remarks
140
- * The business status code. The value SUCCESS indicates success.
140
+ * The business status code. The value SUCCESS is returned if the request is successful.
141
141
  *
142
142
  * @example
143
143
  * SUCCESS
@@ -145,12 +145,12 @@ export class CreateExternalAgentBootstrapTokenResponseBody extends $dara.Model {
145
145
  code?: string;
146
146
  /**
147
147
  * @remarks
148
- * The Bootstrap Token and CMS configuration required for connecting the external agent.
148
+ * The bootstrap token and CMS configuration required for connecting the external agent.
149
149
  */
150
150
  data?: CreateExternalAgentBootstrapTokenResponseBodyData;
151
151
  /**
152
152
  * @remarks
153
- * The HTTP status code. The value 200 indicates success.
153
+ * The HTTP status code. The value 200 is returned if the request is successful.
154
154
  *
155
155
  * @example
156
156
  * 200
@@ -158,7 +158,7 @@ export class CreateExternalAgentBootstrapTokenResponseBody extends $dara.Model {
158
158
  httpStatusCode?: number;
159
159
  /**
160
160
  * @remarks
161
- * The message indicating the request processing result.
161
+ * The message that indicates the result of the request.
162
162
  *
163
163
  * @example
164
164
  * success
@@ -21,7 +21,7 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
21
21
  appKey?: string;
22
22
  /**
23
23
  * @remarks
24
- * Required. The secret of the external identity provider application. This parameter is used only for write operations. The query API does not return this field.
24
+ * Required. The secret of the external identity provider application. This parameter is write-only and is not returned by query operations.
25
25
  *
26
26
  * @example
27
27
  * example-app-secret
@@ -29,7 +29,7 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
29
29
  appSecret?: string;
30
30
  /**
31
31
  * @remarks
32
- * The CorpId of the DingTalk enterprise. This parameter is required when the binding type is DingTalk.
32
+ * The CorpId of the DingTalk organization. This parameter is required when the binding type is DingTalk.
33
33
  *
34
34
  * @example
35
35
  * dingexamplecorpid01
@@ -37,7 +37,7 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
37
37
  corpId?: string;
38
38
  /**
39
39
  * @remarks
40
- * The data encryption key for event subscription. The value must be the same as the one configured in the external identity provider application. This parameter is used only for write operations. The query API does not return this field.
40
+ * The data encryption key for event subscriptions. The value must be the same as the one configured in the external identity provider application. This parameter is write-only and is not returned by query operations.
41
41
  *
42
42
  * @example
43
43
  * example-encrypt-key
@@ -45,7 +45,7 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
45
45
  encryptKey?: string;
46
46
  /**
47
47
  * @remarks
48
- * The verification token for event subscription. The value must be the same as the one configured in the external identity provider application. This parameter is used only for write operations. The query API does not return this field.
48
+ * The verification token for event subscriptions. The value must be the same as the one configured in the external identity provider application. This parameter is write-only and is not returned by query operations.
49
49
  *
50
50
  * @example
51
51
  * example-verification-token
@@ -85,7 +85,9 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
85
85
  export class CreateIdentityProviderRequestBody extends $dara.Model {
86
86
  /**
87
87
  * @remarks
88
- * The type of the external identity provider. Valid values: DingTalk, Feishu.
88
+ * The type of the external identity provider. Valid values:
89
+ * - DingTalk
90
+ * - Feishu
89
91
  *
90
92
  * This parameter is required.
91
93
  *
@@ -5,7 +5,9 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateIdentityProviderResponseBodyData extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The type of the external identity provider. Valid values: DingTalk, Feishu.
8
+ * The type of the external identity provider. Valid values:
9
+ * - DingTalk
10
+ * - Feishu
9
11
  *
10
12
  * @example
11
13
  * DingTalk
@@ -99,7 +101,7 @@ export class CreateIdentityProviderResponseBody extends $dara.Model {
99
101
  httpStatusCode?: number;
100
102
  /**
101
103
  * @remarks
102
- * The response message. An error description is returned if the request fails.
104
+ * The response message. An error description is returned if the request failed.
103
105
  *
104
106
  * @example
105
107
  * success
@@ -121,7 +121,7 @@ export class CreateManagedAgentRequestBodyEnvironment extends $dara.Model {
121
121
  export class CreateManagedAgentRequestBodyHarnessConfiguration extends $dara.Model {
122
122
  /**
123
123
  * @remarks
124
- * The Key ID used to bind a Service Account Key of the QoderCLI Connector. This parameter can be omitted when only one key exists, but is required when multiple keys exist.
124
+ * The connector service account key.
125
125
  *
126
126
  * @example
127
127
  * key-xxxx
@@ -129,7 +129,7 @@ export class CreateManagedAgentRequestBodyHarnessConfiguration extends $dara.Mod
129
129
  connectorServiceAccountKey?: string;
130
130
  /**
131
131
  * @remarks
132
- * The Connector Key name that is populated during queries. This parameter is not used as a binding criterion during writes.
132
+ * The connector service account name.
133
133
  *
134
134
  * @example
135
135
  * my-connector-key
@@ -161,12 +161,12 @@ export class CreateManagedAgentRequestBodyHarnessConfiguration extends $dara.Mod
161
161
  export class CreateManagedAgentRequestBodyHarness extends $dara.Model {
162
162
  /**
163
163
  * @remarks
164
- * The Connector binding configuration for the qodercli harness.
164
+ * The harness configuration.
165
165
  */
166
166
  configuration?: CreateManagedAgentRequestBodyHarnessConfiguration;
167
167
  /**
168
168
  * @remarks
169
- * The harness type. Valid values: qwenpaw and qodercli. When the type is qodercli, binding is performed based on configuration.connectorServiceAccountKey, and the name is also populated during queries.
169
+ * The harness type.
170
170
  *
171
171
  * @example
172
172
  * qodercli
@@ -281,7 +281,7 @@ export class CreateManagedAgentRequestBodyModel extends $dara.Model {
281
281
  modelName?: string;
282
282
  /**
283
283
  * @remarks
284
- * The model token quota configuration. If this parameter is not specified, no quota is configured.
284
+ * The model token quota configuration. If not specified, no quota is configured.
285
285
  */
286
286
  quota?: CreateManagedAgentRequestBodyModelQuota;
287
287
  static names(): { [key: string]: string } {
@@ -416,16 +416,25 @@ export class CreateManagedAgentRequestBodyOssMounts extends $dara.Model {
416
416
  /**
417
417
  * @remarks
418
418
  * The OSS bucket name. This parameter is required by backend validation for each mount entry.
419
+ *
420
+ * @example
421
+ * bucket-001
419
422
  */
420
423
  bucketName?: string;
421
424
  /**
422
425
  * @remarks
423
- * The absolute mount path inside the container. This parameter is required by backend validation for each mount entry.
426
+ * The absolute mount path in the container. This parameter is required by backend validation for each mount entry.
427
+ *
428
+ * @example
429
+ * /mnt/oss/datasets
424
430
  */
425
431
  mountPath?: string;
426
432
  /**
427
433
  * @remarks
428
- * The relative object prefix within the bucket. If this parameter is not specified, the entire bucket is mounted.
434
+ * The relative object prefix in the bucket. If not specified, the entire bucket is mounted.
435
+ *
436
+ * @example
437
+ * datasets
429
438
  */
430
439
  path?: string;
431
440
  /**
@@ -463,7 +472,7 @@ export class CreateManagedAgentRequestBodyOssMounts extends $dara.Model {
463
472
  export class CreateManagedAgentRequestBodyRuntimeCompute extends $dara.Model {
464
473
  /**
465
474
  * @remarks
466
- * The compute class.
475
+ * The compute specification.
467
476
  *
468
477
  * This parameter is required.
469
478
  *
@@ -501,21 +510,33 @@ export class CreateManagedAgentRequestBodyRuntimeHpa extends $dara.Model {
501
510
  /**
502
511
  * @remarks
503
512
  * The maximum number of active sessions per sandbox. This parameter is required by backend validation when hpa is present.
513
+ *
514
+ * @example
515
+ * 5
504
516
  */
505
517
  maxConcurrentSessionsPerSandbox?: number;
506
518
  /**
507
519
  * @remarks
508
520
  * The maximum number of sandboxes. This parameter is required when HPA is enabled and the value must be no less than the minimum value.
521
+ *
522
+ * @example
523
+ * 3
509
524
  */
510
525
  maxSandboxCount?: number;
511
526
  /**
512
527
  * @remarks
513
528
  * The minimum number of sandboxes. This parameter is required when HPA is enabled.
529
+ *
530
+ * @example
531
+ * 1
514
532
  */
515
533
  minSandboxCount?: number;
516
534
  /**
517
535
  * @remarks
518
- * The session reclamation time after inactivity, in seconds. This parameter is required by backend validation when hpa is present.
536
+ * The time in seconds before an inactive session is reclaimed. This parameter is required by backend validation when hpa is present.
537
+ *
538
+ * @example
539
+ * 3600
519
540
  */
520
541
  sessionTtlSeconds?: number;
521
542
  static names(): { [key: string]: string } {
@@ -863,7 +884,7 @@ export class CreateManagedAgentRequestBody extends $dara.Model {
863
884
  environment?: CreateManagedAgentRequestBodyEnvironment;
864
885
  /**
865
886
  * @remarks
866
- * The harness for the managed agent. Valid values: qwenpaw and qodercli.
887
+ * The agent harness.
867
888
  */
868
889
  harness?: CreateManagedAgentRequestBodyHarness;
869
890
  /**
@@ -898,7 +919,7 @@ export class CreateManagedAgentRequestBody extends $dara.Model {
898
919
  network?: CreateManagedAgentRequestBodyNetwork;
899
920
  /**
900
921
  * @remarks
901
- * The list of OSS mounts. A maximum of 10 entries are supported.
922
+ * The OSS mount list. A maximum of 10 entries are supported.
902
923
  */
903
924
  ossMounts?: CreateManagedAgentRequestBodyOssMounts[];
904
925
  /**
@@ -925,7 +946,7 @@ export class CreateManagedAgentRequestBody extends $dara.Model {
925
946
  template?: CreateManagedAgentRequestBodyTemplate;
926
947
  /**
927
948
  * @remarks
928
- * The tool configuration list.
949
+ * The list of tool configurations.
929
950
  */
930
951
  tools?: CreateManagedAgentRequestBodyTools[];
931
952
  static names(): { [key: string]: string } {
@@ -121,7 +121,7 @@ export class CreateManagedAgentResponseBodyDataEnvironment extends $dara.Model {
121
121
  export class CreateManagedAgentResponseBodyDataHarnessConfiguration extends $dara.Model {
122
122
  /**
123
123
  * @remarks
124
- * The Key ID used to bind a Service Account Key of the QoderCLI Connector. This parameter can be omitted when only one key exists, but is required when multiple keys exist.
124
+ * The connector service account key.
125
125
  *
126
126
  * @example
127
127
  * key-xxxx
@@ -129,7 +129,7 @@ export class CreateManagedAgentResponseBodyDataHarnessConfiguration extends $dar
129
129
  connectorServiceAccountKey?: string;
130
130
  /**
131
131
  * @remarks
132
- * The Connector Key name that is populated during queries. This parameter is not used as a binding criterion during writes.
132
+ * The connector service account name.
133
133
  *
134
134
  * @example
135
135
  * my-connector-key
@@ -161,12 +161,12 @@ export class CreateManagedAgentResponseBodyDataHarnessConfiguration extends $dar
161
161
  export class CreateManagedAgentResponseBodyDataHarness extends $dara.Model {
162
162
  /**
163
163
  * @remarks
164
- * The Connector binding configuration for the qodercli harness.
164
+ * The harness configuration.
165
165
  */
166
166
  configuration?: CreateManagedAgentResponseBodyDataHarnessConfiguration;
167
167
  /**
168
168
  * @remarks
169
- * The harness type. Valid values: qwenpaw and qodercli. When the type is qodercli, binding is performed based on configuration.connectorServiceAccountKey, and the name is also populated during queries.
169
+ * The harness type.
170
170
  *
171
171
  * @example
172
172
  * qodercli
@@ -201,7 +201,7 @@ export class CreateManagedAgentResponseBodyDataHarness extends $dara.Model {
201
201
  export class CreateManagedAgentResponseBodyDataModelQuota extends $dara.Model {
202
202
  /**
203
203
  * @remarks
204
- * Indicates whether the quota is enabled. This parameter is not returned if no quota is configured.
204
+ * Indicates whether the quota is enabled. This field is not returned if no quota is configured.
205
205
  *
206
206
  * @example
207
207
  * true
@@ -217,7 +217,7 @@ export class CreateManagedAgentResponseBodyDataModelQuota extends $dara.Model {
217
217
  limitType?: string;
218
218
  /**
219
219
  * @remarks
220
- * Indicates whether the quota has been exceeded in the current cycle. This is a read-only field returned by the backend.
220
+ * Indicates whether the quota has been exceeded in the current period. This field is read-only and returned by the backend.
221
221
  *
222
222
  * @example
223
223
  * false
@@ -225,7 +225,7 @@ export class CreateManagedAgentResponseBodyDataModelQuota extends $dara.Model {
225
225
  overLimit?: boolean;
226
226
  /**
227
227
  * @remarks
228
- * The quota statistical period. A value of day indicates a daily period. A value of month indicates a monthly period.
228
+ * The quota statistical period. The value day indicates a daily period, and the value month indicates a monthly period.
229
229
  *
230
230
  * @example
231
231
  * day
@@ -233,7 +233,7 @@ export class CreateManagedAgentResponseBodyDataModelQuota extends $dara.Model {
233
233
  periodType?: string;
234
234
  /**
235
235
  * @remarks
236
- * The gateway quota rule status. This is a read-only field returned by the backend.
236
+ * The gateway quota rule status. This field is read-only and returned by the backend.
237
237
  *
238
238
  * @example
239
239
  * ACTIVE
@@ -241,7 +241,7 @@ export class CreateManagedAgentResponseBodyDataModelQuota extends $dara.Model {
241
241
  ruleStatus?: string;
242
242
  /**
243
243
  * @remarks
244
- * The maximum number of tokens that can be consumed within a single cycle.
244
+ * The maximum number of tokens that can be consumed within a single period.
245
245
  *
246
246
  * @example
247
247
  * 1000000
@@ -249,7 +249,7 @@ export class CreateManagedAgentResponseBodyDataModelQuota extends $dara.Model {
249
249
  usageLimit?: number;
250
250
  /**
251
251
  * @remarks
252
- * The number of tokens consumed in the current cycle. This is a read-only field returned by the backend.
252
+ * The number of tokens consumed in the current period. This field is read-only and returned by the backend.
253
253
  *
254
254
  * @example
255
255
  * 12345
@@ -307,7 +307,7 @@ export class CreateManagedAgentResponseBodyDataModel extends $dara.Model {
307
307
  modelName?: string;
308
308
  /**
309
309
  * @remarks
310
- * The model token quota configuration and the quota usage status in the current cycle. This parameter is empty if no quota is configured.
310
+ * The model token quota configuration and the quota usage status in the current period. This field is empty if no quota is configured.
311
311
  */
312
312
  quota?: CreateManagedAgentResponseBodyDataModelQuota;
313
313
  static names(): { [key: string]: string } {
@@ -442,16 +442,25 @@ export class CreateManagedAgentResponseBodyDataOssMounts extends $dara.Model {
442
442
  /**
443
443
  * @remarks
444
444
  * The OSS bucket name. This parameter is required by backend validation for each mount entry.
445
+ *
446
+ * @example
447
+ * bucket-001
445
448
  */
446
449
  bucketName?: string;
447
450
  /**
448
451
  * @remarks
449
- * The absolute mount path inside the container. This parameter is required by backend validation for each mount entry.
452
+ * The absolute mount path in the container. This parameter is required by backend validation for each mount entry.
453
+ *
454
+ * @example
455
+ * /mnt/oss/datasets
450
456
  */
451
457
  mountPath?: string;
452
458
  /**
453
459
  * @remarks
454
- * The relative object prefix within the bucket. If this parameter is not specified, the entire bucket is mounted.
460
+ * The relative object prefix in the bucket. If not specified, the entire bucket is mounted.
461
+ *
462
+ * @example
463
+ * datasets
455
464
  */
456
465
  path?: string;
457
466
  /**
@@ -489,7 +498,7 @@ export class CreateManagedAgentResponseBodyDataOssMounts extends $dara.Model {
489
498
  export class CreateManagedAgentResponseBodyDataRuntimeCompute extends $dara.Model {
490
499
  /**
491
500
  * @remarks
492
- * The compute class.
501
+ * The compute specification.
493
502
  *
494
503
  * This parameter is required.
495
504
  *
@@ -527,21 +536,33 @@ export class CreateManagedAgentResponseBodyDataRuntimeHpa extends $dara.Model {
527
536
  /**
528
537
  * @remarks
529
538
  * The maximum number of active sessions per sandbox. This parameter is required by backend validation when hpa is present.
539
+ *
540
+ * @example
541
+ * 5
530
542
  */
531
543
  maxConcurrentSessionsPerSandbox?: number;
532
544
  /**
533
545
  * @remarks
534
546
  * The maximum number of sandboxes. This parameter is required when HPA is enabled and the value must be no less than the minimum value.
547
+ *
548
+ * @example
549
+ * 3
535
550
  */
536
551
  maxSandboxCount?: number;
537
552
  /**
538
553
  * @remarks
539
554
  * The minimum number of sandboxes. This parameter is required when HPA is enabled.
555
+ *
556
+ * @example
557
+ * 1
540
558
  */
541
559
  minSandboxCount?: number;
542
560
  /**
543
561
  * @remarks
544
- * The session reclamation time after inactivity, in seconds. This parameter is required by backend validation when hpa is present.
562
+ * The time in seconds before an inactive session is reclaimed. This parameter is required by backend validation when hpa is present.
563
+ *
564
+ * @example
565
+ * 3600
545
566
  */
546
567
  sessionTtlSeconds?: number;
547
568
  static names(): { [key: string]: string } {
@@ -921,7 +942,7 @@ export class CreateManagedAgentResponseBodyData extends $dara.Model {
921
942
  environment?: CreateManagedAgentResponseBodyDataEnvironment;
922
943
  /**
923
944
  * @remarks
924
- * The harness for the managed agent. Valid values: qwenpaw and qodercli.
945
+ * The agent harness.
925
946
  */
926
947
  harness?: CreateManagedAgentResponseBodyDataHarness;
927
948
  /**
@@ -968,7 +989,7 @@ export class CreateManagedAgentResponseBodyData extends $dara.Model {
968
989
  network?: CreateManagedAgentResponseBodyDataNetwork;
969
990
  /**
970
991
  * @remarks
971
- * The list of OSS mounts. A maximum of 10 entries are supported.
992
+ * The OSS mount list. A maximum of 10 entries are supported.
972
993
  */
973
994
  ossMounts?: CreateManagedAgentResponseBodyDataOssMounts[];
974
995
  /**
@@ -986,7 +1007,7 @@ export class CreateManagedAgentResponseBodyData extends $dara.Model {
986
1007
  runtime?: CreateManagedAgentResponseBodyDataRuntime;
987
1008
  /**
988
1009
  * @remarks
989
- * The number of managed agent instances grouped by sandbox phase. Current keys: PENDING (being created or initialized), RUNNING (running), HIBERNATING (entering hibernation), HIBERNATED (hibernated), RESUMING (resuming), TERMINATING (being terminated), and FAILED (runtime failure). Only phases that actually occur are returned. Missing keys are treated as 0. This field is a dynamic mapping, and new keys may be added in the future. The frontend can use FAILED > 0 to determine whether abnormal instances exist.
1010
+ * The number of managed agent instances grouped by sandbox phase. Current keys: PENDING (being created or initialized), RUNNING (running), HIBERNATING (entering hibernation), HIBERNATED (hibernated), RESUMING (resuming), TERMINATING (being terminated), and FAILED (runtime failure). Only phases that actually occur are returned. Missing keys should be treated as 0. This field is a dynamic map, and new keys may be added in the future. You can use FAILED > 0 to determine whether any instances have failed.
990
1011
  */
991
1012
  sandboxPhaseCounts?: { [key: string]: number };
992
1013
  /**
@@ -1014,7 +1035,7 @@ export class CreateManagedAgentResponseBodyData extends $dara.Model {
1014
1035
  template?: CreateManagedAgentResponseBodyDataTemplate;
1015
1036
  /**
1016
1037
  * @remarks
1017
- * The tool configuration list.
1038
+ * The list of tool configurations.
1018
1039
  */
1019
1040
  tools?: CreateManagedAgentResponseBodyDataTools[];
1020
1041
  /**
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateUserRequestBody extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The display name of the user. The display name must be 1 to 32 characters in length.
8
+ * The display name of the user. The name must be 1 to 32 characters in length.
9
9
  *
10
10
  * This parameter is required.
11
11
  *
@@ -15,7 +15,7 @@ export class CreateUserRequestBody extends $dara.Model {
15
15
  displayName?: string;
16
16
  /**
17
17
  * @remarks
18
- * The email address of the user. The email address can be up to 256 characters in length.
18
+ * The email address of the user. The address can be up to 256 characters in length.
19
19
  *
20
20
  * @example
21
21
  * user-01@example.com
@@ -23,7 +23,7 @@ export class CreateUserRequestBody extends $dara.Model {
23
23
  email?: string;
24
24
  /**
25
25
  * @remarks
26
- * The username. The username must be unique within the workspace and can contain only lowercase letters, digits, and hyphens. It must start and end with a lowercase letter or digit and be 1 to 32 characters in length. Reserved names such as manager, admin, or names starting with worker- cannot be used.
26
+ * The username. The name must be unique within the workspace and can contain only lowercase letters, digits, and hyphens. It must start and end with a lowercase letter or digit and must be 1 to 32 characters in length. Reserved names such as manager, admin, or names starting with worker- cannot be used.
27
27
  *
28
28
  * This parameter is required.
29
29
  *
@@ -41,7 +41,7 @@ export class CreateUserRequestBody extends $dara.Model {
41
41
  note?: string;
42
42
  /**
43
43
  * @remarks
44
- * The initial password of the user. The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and special characters. The password cannot contain the username. If this parameter is not specified, the server generates a random password and returns it in the initialPassword field of the response.
44
+ * The initial password of the user. The password must be 8 to 32 characters in length and must contain uppercase letters, lowercase letters, digits, and special characters. The password cannot contain the username. If this parameter is not specified, the server generates a random password and returns it in the initialPassword field of the response.
45
45
  *
46
46
  * @example
47
47
  * Example@2026