@alicloud/agentcore20260804 2.5.0 → 2.6.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.
- package/dist/client.d.ts +762 -70
- package/dist/client.js +1001 -70
- package/dist/client.js.map +1 -1
- package/dist/models/AddMemoriesRequest.d.ts +10 -10
- package/dist/models/AddMemoriesResponseBody.d.ts +4 -4
- package/dist/models/AddMemoriesShrinkRequest.d.ts +1 -1
- package/dist/models/CreateCustomAgentRequest.d.ts +43 -43
- package/dist/models/CreateCustomAgentResponseBody.d.ts +118 -61
- package/dist/models/CreateCustomAgentResponseBody.js +33 -1
- package/dist/models/CreateCustomAgentResponseBody.js.map +1 -1
- package/dist/models/CreateIdentityProviderRequest.d.ts +50 -9
- package/dist/models/CreateIdentityProviderRequest.js +32 -1
- package/dist/models/CreateIdentityProviderRequest.js.map +1 -1
- package/dist/models/CreateIdentityProviderResponseBody.d.ts +183 -9
- package/dist/models/CreateIdentityProviderResponseBody.js +103 -1
- package/dist/models/CreateIdentityProviderResponseBody.js.map +1 -1
- package/dist/models/CreateIdentityProviderShrinkRequest.d.ts +1 -1
- package/dist/models/CreateIdentityProviderSyncJobRequest.d.ts +13 -0
- package/dist/models/CreateIdentityProviderSyncJobRequest.js +54 -0
- package/dist/models/CreateIdentityProviderSyncJobRequest.js.map +1 -0
- package/dist/models/CreateIdentityProviderSyncJobResponse.d.ts +19 -0
- package/dist/models/CreateIdentityProviderSyncJobResponse.js +69 -0
- package/dist/models/CreateIdentityProviderSyncJobResponse.js.map +1 -0
- package/dist/models/CreateIdentityProviderSyncJobResponseBody.d.ts +121 -0
- package/dist/models/CreateIdentityProviderSyncJobResponseBody.js +100 -0
- package/dist/models/CreateIdentityProviderSyncJobResponseBody.js.map +1 -0
- package/dist/models/CreateMemoryStoreRequest.d.ts +6 -6
- package/dist/models/CreateMemoryStoreResponseBody.d.ts +7 -7
- package/dist/models/CreateMemoryStoreShrinkRequest.d.ts +2 -2
- package/dist/models/DeleteIdentityProviderResponseBody.d.ts +144 -19
- package/dist/models/DeleteIdentityProviderResponseBody.js +74 -1
- package/dist/models/DeleteIdentityProviderResponseBody.js.map +1 -1
- package/dist/models/DeleteMemoryStoreResponseBody.d.ts +3 -3
- package/dist/models/GetAgentCodePackageDownloadUrlRequest.d.ts +13 -0
- package/dist/models/GetAgentCodePackageDownloadUrlRequest.js +54 -0
- package/dist/models/GetAgentCodePackageDownloadUrlRequest.js.map +1 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponse.d.ts +19 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponse.js +69 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponse.js.map +1 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponseBody.d.ts +131 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponseBody.js +104 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponseBody.js.map +1 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.d.ts +23 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.js +58 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.js.map +1 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.d.ts +19 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.js +69 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.js.map +1 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.d.ts +99 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.js +96 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.js.map +1 -0
- package/dist/models/GetAgentCodePackageUploadUrlRequest.d.ts +62 -0
- package/dist/models/GetAgentCodePackageUploadUrlRequest.js +84 -0
- package/dist/models/GetAgentCodePackageUploadUrlRequest.js.map +1 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponse.d.ts +19 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponse.js +69 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponse.js.map +1 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponseBody.d.ts +114 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponseBody.js +103 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponseBody.js.map +1 -0
- package/dist/models/GetAgentCodePackageUploadUrlShrinkRequest.d.ts +20 -0
- package/dist/models/GetAgentCodePackageUploadUrlShrinkRequest.js +58 -0
- package/dist/models/GetAgentCodePackageUploadUrlShrinkRequest.js.map +1 -0
- package/dist/models/GetCustomAgentResponseBody.d.ts +105 -48
- package/dist/models/GetCustomAgentResponseBody.js +33 -1
- package/dist/models/GetCustomAgentResponseBody.js.map +1 -1
- package/dist/models/GetIdentityProviderResponseBody.d.ts +217 -11
- package/dist/models/GetIdentityProviderResponseBody.js +111 -1
- package/dist/models/GetIdentityProviderResponseBody.js.map +1 -1
- package/dist/models/GetIdentityProviderSyncJobRequest.d.ts +13 -0
- package/dist/models/GetIdentityProviderSyncJobRequest.js +54 -0
- package/dist/models/GetIdentityProviderSyncJobRequest.js.map +1 -0
- package/dist/models/GetIdentityProviderSyncJobResponse.d.ts +19 -0
- package/dist/models/GetIdentityProviderSyncJobResponse.js +69 -0
- package/dist/models/GetIdentityProviderSyncJobResponse.js.map +1 -0
- package/dist/models/GetIdentityProviderSyncJobResponseBody.d.ts +128 -0
- package/dist/models/GetIdentityProviderSyncJobResponseBody.js +100 -0
- package/dist/models/GetIdentityProviderSyncJobResponseBody.js.map +1 -0
- package/dist/models/GetIdentityProviderSyncScopeRequest.d.ts +13 -0
- package/dist/models/GetIdentityProviderSyncScopeRequest.js +54 -0
- package/dist/models/GetIdentityProviderSyncScopeRequest.js.map +1 -0
- package/dist/models/GetIdentityProviderSyncScopeResponse.d.ts +19 -0
- package/dist/models/GetIdentityProviderSyncScopeResponse.js +69 -0
- package/dist/models/GetIdentityProviderSyncScopeResponse.js.map +1 -0
- package/dist/models/GetIdentityProviderSyncScopeResponseBody.d.ts +177 -0
- package/dist/models/GetIdentityProviderSyncScopeResponseBody.js +151 -0
- package/dist/models/GetIdentityProviderSyncScopeResponseBody.js.map +1 -0
- package/dist/models/GetMemoryResponseBody.d.ts +4 -4
- package/dist/models/GetMemoryStoreResponseBody.d.ts +3 -3
- package/dist/models/ListAgentCodeRuntimesRequest.d.ts +29 -0
- package/dist/models/ListAgentCodeRuntimesRequest.js +60 -0
- package/dist/models/ListAgentCodeRuntimesRequest.js.map +1 -0
- package/dist/models/ListAgentCodeRuntimesResponse.d.ts +19 -0
- package/dist/models/ListAgentCodeRuntimesResponse.js +69 -0
- package/dist/models/ListAgentCodeRuntimesResponse.js.map +1 -0
- package/dist/models/ListAgentCodeRuntimesResponseBody.d.ts +115 -0
- package/dist/models/ListAgentCodeRuntimesResponseBody.js +100 -0
- package/dist/models/ListAgentCodeRuntimesResponseBody.js.map +1 -0
- package/dist/models/ListCustomAgentsRequest.d.ts +2 -2
- package/dist/models/ListCustomAgentsResponseBody.d.ts +221 -25
- package/dist/models/ListCustomAgentsResponseBody.js +119 -1
- package/dist/models/ListCustomAgentsResponseBody.js.map +1 -1
- package/dist/models/ListIdentityProviderDepartmentsRequest.d.ts +37 -0
- package/dist/models/ListIdentityProviderDepartmentsRequest.js +62 -0
- package/dist/models/ListIdentityProviderDepartmentsRequest.js.map +1 -0
- package/dist/models/ListIdentityProviderDepartmentsResponse.d.ts +19 -0
- package/dist/models/ListIdentityProviderDepartmentsResponse.js +69 -0
- package/dist/models/ListIdentityProviderDepartmentsResponse.js.map +1 -0
- package/dist/models/ListIdentityProviderDepartmentsResponseBody.d.ts +137 -0
- package/dist/models/ListIdentityProviderDepartmentsResponseBody.js +104 -0
- package/dist/models/ListIdentityProviderDepartmentsResponseBody.js.map +1 -0
- package/dist/models/ListIdentityProvidersRequest.d.ts +2 -2
- package/dist/models/ListIdentityProvidersResponseBody.d.ts +226 -20
- package/dist/models/ListIdentityProvidersResponseBody.js +111 -1
- package/dist/models/ListIdentityProvidersResponseBody.js.map +1 -1
- package/dist/models/ListMemoriesResponseBody.d.ts +1 -1
- package/dist/models/ListMemorySessionMessagesRequest.d.ts +3 -3
- package/dist/models/ListMemorySessionsRequest.d.ts +2 -2
- package/dist/models/ListMemorySessionsResponseBody.d.ts +1 -1
- package/dist/models/ListMemoryStoresResponseBody.d.ts +2 -2
- package/dist/models/SearchMemoriesRequest.d.ts +3 -3
- package/dist/models/SearchMemoriesResponseBody.d.ts +3 -3
- package/dist/models/UpdateCustomAgentRequest.d.ts +49 -49
- package/dist/models/UpdateCustomAgentResponseBody.d.ts +124 -77
- package/dist/models/UpdateCustomAgentResponseBody.js +33 -1
- package/dist/models/UpdateCustomAgentResponseBody.js.map +1 -1
- package/dist/models/UpdateCustomAgentShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateIdentityProviderRequest.d.ts +128 -8
- package/dist/models/UpdateIdentityProviderRequest.js +71 -1
- package/dist/models/UpdateIdentityProviderRequest.js.map +1 -1
- package/dist/models/UpdateIdentityProviderResponseBody.d.ts +181 -16
- package/dist/models/UpdateIdentityProviderResponseBody.js +103 -1
- package/dist/models/UpdateIdentityProviderResponseBody.js.map +1 -1
- package/dist/models/UpdateIdentityProviderShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateMemoryRequest.d.ts +3 -3
- package/dist/models/UpdateMemoryShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateMemoryStoreRequest.d.ts +2 -2
- package/dist/models/UpdateMemoryStoreResponseBody.d.ts +1 -1
- package/dist/models/ValidateAgentCodePackageFromOssRequest.d.ts +52 -0
- package/dist/models/ValidateAgentCodePackageFromOssRequest.js +82 -0
- package/dist/models/ValidateAgentCodePackageFromOssRequest.js.map +1 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponse.d.ts +19 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponse.js +69 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponse.js.map +1 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponseBody.d.ts +99 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponseBody.js +96 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponseBody.js.map +1 -0
- package/dist/models/ValidateAgentCodePackageFromOssShrinkRequest.d.ts +20 -0
- package/dist/models/ValidateAgentCodePackageFromOssShrinkRequest.js +58 -0
- package/dist/models/ValidateAgentCodePackageFromOssShrinkRequest.js.map +1 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.d.ts +23 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.js +58 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.js.map +1 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponse.d.ts +19 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponse.js +69 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponse.js.map +1 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.d.ts +73 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.js +96 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.js.map +1 -0
- package/dist/models/model.d.ts +70 -0
- package/dist/models/model.js +256 -115
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +1032 -70
- package/src/models/AddMemoriesRequest.ts +10 -10
- package/src/models/AddMemoriesResponseBody.ts +4 -4
- package/src/models/AddMemoriesShrinkRequest.ts +1 -1
- package/src/models/CreateCustomAgentRequest.ts +43 -43
- package/src/models/CreateCustomAgentResponseBody.ts +141 -61
- package/src/models/CreateIdentityProviderRequest.ts +72 -9
- package/src/models/CreateIdentityProviderResponseBody.ts +258 -9
- package/src/models/CreateIdentityProviderShrinkRequest.ts +1 -1
- package/src/models/CreateIdentityProviderSyncJobRequest.ts +24 -0
- package/src/models/CreateIdentityProviderSyncJobResponse.ts +40 -0
- package/src/models/CreateIdentityProviderSyncJobResponseBody.ts +167 -0
- package/src/models/CreateMemoryStoreRequest.ts +6 -6
- package/src/models/CreateMemoryStoreResponseBody.ts +7 -7
- package/src/models/CreateMemoryStoreShrinkRequest.ts +2 -2
- package/src/models/DeleteIdentityProviderResponseBody.ts +199 -19
- package/src/models/DeleteMemoryStoreResponseBody.ts +3 -3
- package/src/models/GetAgentCodePackageDownloadUrlRequest.ts +24 -0
- package/src/models/GetAgentCodePackageDownloadUrlResponse.ts +40 -0
- package/src/models/GetAgentCodePackageDownloadUrlResponseBody.ts +181 -0
- package/src/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.ts +36 -0
- package/src/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.ts +40 -0
- package/src/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.ts +141 -0
- package/src/models/GetAgentCodePackageUploadUrlRequest.ts +92 -0
- package/src/models/GetAgentCodePackageUploadUrlResponse.ts +40 -0
- package/src/models/GetAgentCodePackageUploadUrlResponseBody.ts +161 -0
- package/src/models/GetAgentCodePackageUploadUrlShrinkRequest.ts +33 -0
- package/src/models/GetCustomAgentResponseBody.ts +128 -48
- package/src/models/GetIdentityProviderResponseBody.ts +300 -11
- package/src/models/GetIdentityProviderSyncJobRequest.ts +24 -0
- package/src/models/GetIdentityProviderSyncJobResponse.ts +40 -0
- package/src/models/GetIdentityProviderSyncJobResponseBody.ts +174 -0
- package/src/models/GetIdentityProviderSyncScopeRequest.ts +24 -0
- package/src/models/GetIdentityProviderSyncScopeResponse.ts +40 -0
- package/src/models/GetIdentityProviderSyncScopeResponseBody.ts +256 -0
- package/src/models/GetMemoryResponseBody.ts +4 -4
- package/src/models/GetMemoryStoreResponseBody.ts +3 -3
- package/src/models/ListAgentCodeRuntimesRequest.ts +44 -0
- package/src/models/ListAgentCodeRuntimesResponse.ts +40 -0
- package/src/models/ListAgentCodeRuntimesResponseBody.ts +161 -0
- package/src/models/ListCustomAgentsRequest.ts +2 -2
- package/src/models/ListCustomAgentsResponseBody.ts +303 -25
- package/src/models/ListIdentityProviderDepartmentsRequest.ts +54 -0
- package/src/models/ListIdentityProviderDepartmentsResponse.ts +40 -0
- package/src/models/ListIdentityProviderDepartmentsResponseBody.ts +187 -0
- package/src/models/ListIdentityProvidersRequest.ts +2 -2
- package/src/models/ListIdentityProvidersResponseBody.ts +309 -20
- package/src/models/ListMemoriesResponseBody.ts +1 -1
- package/src/models/ListMemorySessionMessagesRequest.ts +3 -3
- package/src/models/ListMemorySessionsRequest.ts +2 -2
- package/src/models/ListMemorySessionsResponseBody.ts +1 -1
- package/src/models/ListMemoryStoresResponseBody.ts +2 -2
- package/src/models/SearchMemoriesRequest.ts +3 -3
- package/src/models/SearchMemoriesResponseBody.ts +3 -3
- package/src/models/UpdateCustomAgentRequest.ts +49 -49
- package/src/models/UpdateCustomAgentResponseBody.ts +147 -77
- package/src/models/UpdateCustomAgentShrinkRequest.ts +1 -1
- package/src/models/UpdateIdentityProviderRequest.ts +180 -8
- package/src/models/UpdateIdentityProviderResponseBody.ts +256 -16
- package/src/models/UpdateIdentityProviderShrinkRequest.ts +1 -1
- package/src/models/UpdateMemoryRequest.ts +3 -3
- package/src/models/UpdateMemoryShrinkRequest.ts +1 -1
- package/src/models/UpdateMemoryStoreRequest.ts +2 -2
- package/src/models/UpdateMemoryStoreResponseBody.ts +1 -1
- package/src/models/ValidateAgentCodePackageFromOssRequest.ts +80 -0
- package/src/models/ValidateAgentCodePackageFromOssResponse.ts +40 -0
- package/src/models/ValidateAgentCodePackageFromOssResponseBody.ts +141 -0
- package/src/models/ValidateAgentCodePackageFromOssShrinkRequest.ts +33 -0
- package/src/models/VerifyAgentCodePackageOssRamAuthorizationRequest.ts +36 -0
- package/src/models/VerifyAgentCodePackageOssRamAuthorizationResponse.ts +40 -0
- package/src/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.ts +115 -0
- package/src/models/model.ts +70 -0
package/src/client.ts
CHANGED
|
@@ -30,10 +30,10 @@ export default class Client extends OpenApi {
|
|
|
30
30
|
}
|
|
31
31
|
|
|
32
32
|
/**
|
|
33
|
-
* Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId
|
|
33
|
+
* Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
|
|
34
34
|
*
|
|
35
35
|
* @remarks
|
|
36
|
-
* Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId
|
|
36
|
+
* Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
|
|
37
37
|
*
|
|
38
38
|
* @param tmpReq - AddMemoriesRequest
|
|
39
39
|
* @param headers - map
|
|
@@ -72,10 +72,10 @@ export default class Client extends OpenApi {
|
|
|
72
72
|
}
|
|
73
73
|
|
|
74
74
|
/**
|
|
75
|
-
* Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId
|
|
75
|
+
* Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
|
|
76
76
|
*
|
|
77
77
|
* @remarks
|
|
78
|
-
* Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId
|
|
78
|
+
* Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
|
|
79
79
|
*
|
|
80
80
|
* @param request - AddMemoriesRequest
|
|
81
81
|
* @returns AddMemoriesResponse
|
|
@@ -498,13 +498,15 @@ export default class Client extends OpenApi {
|
|
|
498
498
|
}
|
|
499
499
|
|
|
500
500
|
/**
|
|
501
|
-
* Creates a custom agent in a specified workspace and
|
|
501
|
+
* Creates a custom agent in a specified workspace. Container image and code package deployments are supported. The creation process is asynchronous. You can call GetCustomAgent to query the deployment result.
|
|
502
502
|
*
|
|
503
503
|
* @remarks
|
|
504
|
-
* Before you call this operation, prepare a writable workspace, a RAM role ARN,
|
|
505
|
-
*
|
|
506
|
-
*
|
|
507
|
-
* The
|
|
504
|
+
* Before you call this operation, prepare a writable workspace, a RAM role ARN, a container image or code package, and runtime configurations. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
|
|
505
|
+
* In container mode, use artifact.container and specify artifact.port. The image must have the required access permissions and be accessible over the network allowed by the workspace.
|
|
506
|
+
* In code package pattern, specify artifact.port, and the sourceUri, languageRuntime, and entrypoint of artifact.code. Do not specify container at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported. The compressed package size cannot exceed 500,000,000 bytes. You can call ListAgentCodeRuntimes to query the runtime environment identity. The sourceUri parameter supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, call GetAgentCodePackageUploadUrl to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
507
|
+
* When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not mean that the agent is ready to run.
|
|
508
|
+
* The creation process is asynchronous. A successful response indicates that the request is accepted. You can use the returned agentId to call GetCustomAgent and check the latestVersionStatus, latestExecutionError, and status corresponding to latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure the access endpoint.
|
|
509
|
+
* The clientToken parameter does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not take effect. Omit this parameter.
|
|
508
510
|
*
|
|
509
511
|
* @param tmpReq - CreateCustomAgentRequest
|
|
510
512
|
* @param headers - map
|
|
@@ -549,13 +551,15 @@ export default class Client extends OpenApi {
|
|
|
549
551
|
}
|
|
550
552
|
|
|
551
553
|
/**
|
|
552
|
-
* Creates a custom agent in a specified workspace and
|
|
554
|
+
* Creates a custom agent in a specified workspace. Container image and code package deployments are supported. The creation process is asynchronous. You can call GetCustomAgent to query the deployment result.
|
|
553
555
|
*
|
|
554
556
|
* @remarks
|
|
555
|
-
* Before you call this operation, prepare a writable workspace, a RAM role ARN,
|
|
556
|
-
*
|
|
557
|
-
*
|
|
558
|
-
* The
|
|
557
|
+
* Before you call this operation, prepare a writable workspace, a RAM role ARN, a container image or code package, and runtime configurations. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
|
|
558
|
+
* In container mode, use artifact.container and specify artifact.port. The image must have the required access permissions and be accessible over the network allowed by the workspace.
|
|
559
|
+
* In code package pattern, specify artifact.port, and the sourceUri, languageRuntime, and entrypoint of artifact.code. Do not specify container at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported. The compressed package size cannot exceed 500,000,000 bytes. You can call ListAgentCodeRuntimes to query the runtime environment identity. The sourceUri parameter supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, call GetAgentCodePackageUploadUrl to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
560
|
+
* When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not mean that the agent is ready to run.
|
|
561
|
+
* The creation process is asynchronous. A successful response indicates that the request is accepted. You can use the returned agentId to call GetCustomAgent and check the latestVersionStatus, latestExecutionError, and status corresponding to latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure the access endpoint.
|
|
562
|
+
* The clientToken parameter does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not take effect. Omit this parameter.
|
|
559
563
|
*
|
|
560
564
|
* @param request - CreateCustomAgentRequest
|
|
561
565
|
* @returns CreateCustomAgentResponse
|
|
@@ -681,7 +685,34 @@ export default class Client extends OpenApi {
|
|
|
681
685
|
}
|
|
682
686
|
|
|
683
687
|
/**
|
|
684
|
-
* Binds an external identity provider to a specified workspace
|
|
688
|
+
* Binds an external identity provider to a specified workspace for single sign-on and organization member synchronization of workspace users. You can bind up to one external identity provider to each workspace. The binding is an asynchronous operation. After the API returns, you can call GetIdentityProvider to query the status and track the progress.
|
|
689
|
+
*
|
|
690
|
+
* @remarks
|
|
691
|
+
* ## Features and prerequisites
|
|
692
|
+
* A workspace can be bound to only one external identity provider. The identityProviderType parameter supports DingTalk, Feishu, and CustomSSO. CustomSSO only initializes the shared user pool. Do not pass non-empty metadata, and do not pass true for loginEnabled or syncEnabled. By default, both switches are turned off. Protocols and SAML configurations are saved by calling UpdateIdentityProvider. SCIM is configured through a separate API. You do not need to save SAML first. After the request is accepted and CONFIGURED is returned, call GetIdentityProvider and wait for the user pool initialization to complete. READY only indicates that the resource is ready, not that SAML is configured. If the same CustomSSO binding is in the CONFIGURED or READY state, the existing binding can be returned. You cannot treat all states as repeatable creations.
|
|
693
|
+
* For DingTalk, the metadata parameter requires appKey, appSecret, and corpId. For Feishu, appId and appSecret are required. The vendor logon switch is enabled by default, and the synchronization switch is disabled by default. When synchronization is enabled, encryptKey and verificationToken are also required. The vendor syncOnBind and syncScope parameters retain the existing department-based synchronization definitions. Do not use these vendor pull parameters to replace SCIM configurations during CustomSSO initialization.
|
|
694
|
+
* ## Requests and examples
|
|
695
|
+
* POST /workspaces/{workspaceId}/identity-providers
|
|
696
|
+
* Call conventions: Call the API based on the region of the target workspace. Use an AccessKey pair or STS token that has permissions on the identity provider resources of the corresponding workspace. The ws-example, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example only shows the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
697
|
+
* ```text
|
|
698
|
+
* POST /workspaces/ws-example/identity-providers
|
|
699
|
+
* {"identityProviderType": "CustomSSO"}
|
|
700
|
+
* ```
|
|
701
|
+
* ## Response example
|
|
702
|
+
* ```json
|
|
703
|
+
* {
|
|
704
|
+
* "data": {
|
|
705
|
+
* "workspaceId": "ws-example",
|
|
706
|
+
* "identityProviderType": "CustomSSO",
|
|
707
|
+
* "loginEnabled": false,
|
|
708
|
+
* "syncEnabled": false,
|
|
709
|
+
* "status": "CONFIGURED"
|
|
710
|
+
* }
|
|
711
|
+
* }
|
|
712
|
+
* ```
|
|
713
|
+
* ## Errors and handling
|
|
714
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call to the upstream service may return 503 IdentityProviderProvisioningUnavailable if it fails. Keep the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
715
|
+
* 409 IdentityProviderAlreadyBound: An external binding already exists. Query and reuse the correct binding first. Do not automatically unbind the entire binding. Asynchronous initialization failure does not equal HTTP request failure. You must continue to query the status.
|
|
685
716
|
*
|
|
686
717
|
* @param tmpReq - CreateIdentityProviderRequest
|
|
687
718
|
* @param headers - map
|
|
@@ -720,7 +751,34 @@ export default class Client extends OpenApi {
|
|
|
720
751
|
}
|
|
721
752
|
|
|
722
753
|
/**
|
|
723
|
-
* Binds an external identity provider to a specified workspace
|
|
754
|
+
* Binds an external identity provider to a specified workspace for single sign-on and organization member synchronization of workspace users. You can bind up to one external identity provider to each workspace. The binding is an asynchronous operation. After the API returns, you can call GetIdentityProvider to query the status and track the progress.
|
|
755
|
+
*
|
|
756
|
+
* @remarks
|
|
757
|
+
* ## Features and prerequisites
|
|
758
|
+
* A workspace can be bound to only one external identity provider. The identityProviderType parameter supports DingTalk, Feishu, and CustomSSO. CustomSSO only initializes the shared user pool. Do not pass non-empty metadata, and do not pass true for loginEnabled or syncEnabled. By default, both switches are turned off. Protocols and SAML configurations are saved by calling UpdateIdentityProvider. SCIM is configured through a separate API. You do not need to save SAML first. After the request is accepted and CONFIGURED is returned, call GetIdentityProvider and wait for the user pool initialization to complete. READY only indicates that the resource is ready, not that SAML is configured. If the same CustomSSO binding is in the CONFIGURED or READY state, the existing binding can be returned. You cannot treat all states as repeatable creations.
|
|
759
|
+
* For DingTalk, the metadata parameter requires appKey, appSecret, and corpId. For Feishu, appId and appSecret are required. The vendor logon switch is enabled by default, and the synchronization switch is disabled by default. When synchronization is enabled, encryptKey and verificationToken are also required. The vendor syncOnBind and syncScope parameters retain the existing department-based synchronization definitions. Do not use these vendor pull parameters to replace SCIM configurations during CustomSSO initialization.
|
|
760
|
+
* ## Requests and examples
|
|
761
|
+
* POST /workspaces/{workspaceId}/identity-providers
|
|
762
|
+
* Call conventions: Call the API based on the region of the target workspace. Use an AccessKey pair or STS token that has permissions on the identity provider resources of the corresponding workspace. The ws-example, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example only shows the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
763
|
+
* ```text
|
|
764
|
+
* POST /workspaces/ws-example/identity-providers
|
|
765
|
+
* {"identityProviderType": "CustomSSO"}
|
|
766
|
+
* ```
|
|
767
|
+
* ## Response example
|
|
768
|
+
* ```json
|
|
769
|
+
* {
|
|
770
|
+
* "data": {
|
|
771
|
+
* "workspaceId": "ws-example",
|
|
772
|
+
* "identityProviderType": "CustomSSO",
|
|
773
|
+
* "loginEnabled": false,
|
|
774
|
+
* "syncEnabled": false,
|
|
775
|
+
* "status": "CONFIGURED"
|
|
776
|
+
* }
|
|
777
|
+
* }
|
|
778
|
+
* ```
|
|
779
|
+
* ## Errors and handling
|
|
780
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call to the upstream service may return 503 IdentityProviderProvisioningUnavailable if it fails. Keep the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
781
|
+
* 409 IdentityProviderAlreadyBound: An external binding already exists. Query and reuse the correct binding first. Do not automatically unbind the entire binding. Asynchronous initialization failure does not equal HTTP request failure. You must continue to query the status.
|
|
724
782
|
*
|
|
725
783
|
* @param request - CreateIdentityProviderRequest
|
|
726
784
|
* @returns CreateIdentityProviderResponse
|
|
@@ -731,6 +789,87 @@ export default class Client extends OpenApi {
|
|
|
731
789
|
return await this.createIdentityProviderWithOptions(workspaceId, request, headers, runtime);
|
|
732
790
|
}
|
|
733
791
|
|
|
792
|
+
/**
|
|
793
|
+
* Initiates a manual synchronization of an identity provider.
|
|
794
|
+
*
|
|
795
|
+
* @remarks
|
|
796
|
+
* Initiates a one-time user synchronization based on the saved scope without saving the configuration or requiring syncEnabled=true. Prerequisites: the identity provider is in the READY or SYNC_FAILED state, a user pool exists, and no other pending identity provider operations are in progress. The returned taskId only indicates that the request is accepted. Call GetIdentityProviderSyncJob to poll the status until it reaches SUCCESS, FAILED, or CANCELED. If the task fails, check the failureReason. The workspace user quota still applies, and previously synchronized users are not automatically deleted if the scope is reduced.
|
|
797
|
+
* Authorization information: RAM action agentcore:CreateIdentityProviderSyncJob, access level Write, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is required for authorization.
|
|
798
|
+
* Idempotency and retry: This operation does not provide a ClientToken parameter for conditional idempotency. Repeated submissions do not guarantee the same task is returned. If an operation is already in progress, an operation conflict is returned. Submitting again after the task ends creates a new synchronization task. If a submission times out, query the identity provider status first to avoid blindly resubmitting the request.
|
|
799
|
+
* Calling this API is free of charge, and operation records support ActionTrail auditing.
|
|
800
|
+
* Initial selective synchronization process: CreateIdentityProvider (syncOnBind=false, it is recommended to keep syncEnabled=false initially) → GetIdentityProvider and wait for READY → ListIdentityProviderDepartments to select departments → UpdateIdentityProvider to save syncScope and wait for READY → CreateIdentityProviderSyncJob → GetIdentityProviderSyncJob to query the terminal state. If incremental synchronization is required, configure callbacks and event subscriptions, and then update syncEnabled=true.
|
|
801
|
+
* Response example:
|
|
802
|
+
* ```json
|
|
803
|
+
* {
|
|
804
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
805
|
+
* "message": "success",
|
|
806
|
+
* "httpStatusCode": 200,
|
|
807
|
+
* "code": "SUCCESS",
|
|
808
|
+
* "success": true,
|
|
809
|
+
* "data": {
|
|
810
|
+
* "taskId": "12345678-1234-4234-8234-123456789abc",
|
|
811
|
+
* "status": "PENDING"
|
|
812
|
+
* }
|
|
813
|
+
* }
|
|
814
|
+
* ```
|
|
815
|
+
*
|
|
816
|
+
* @param request - CreateIdentityProviderSyncJobRequest
|
|
817
|
+
* @param headers - map
|
|
818
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
819
|
+
* @returns CreateIdentityProviderSyncJobResponse
|
|
820
|
+
*/
|
|
821
|
+
async createIdentityProviderSyncJobWithOptions(workspaceId: string, identityProviderType: string, request: $_model.CreateIdentityProviderSyncJobRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIdentityProviderSyncJobResponse> {
|
|
822
|
+
request.validate();
|
|
823
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
824
|
+
headers: headers,
|
|
825
|
+
});
|
|
826
|
+
let params = new $OpenApiUtil.Params({
|
|
827
|
+
action: "CreateIdentityProviderSyncJob",
|
|
828
|
+
version: "2026-08-04",
|
|
829
|
+
protocol: "HTTPS",
|
|
830
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}/sync-jobs`,
|
|
831
|
+
method: "POST",
|
|
832
|
+
authType: "AK",
|
|
833
|
+
style: "ROA",
|
|
834
|
+
reqBodyType: "json",
|
|
835
|
+
bodyType: "json",
|
|
836
|
+
});
|
|
837
|
+
return $dara.cast<$_model.CreateIdentityProviderSyncJobResponse>(await this.callApi(params, req, runtime), new $_model.CreateIdentityProviderSyncJobResponse({}));
|
|
838
|
+
}
|
|
839
|
+
|
|
840
|
+
/**
|
|
841
|
+
* Initiates a manual synchronization of an identity provider.
|
|
842
|
+
*
|
|
843
|
+
* @remarks
|
|
844
|
+
* Initiates a one-time user synchronization based on the saved scope without saving the configuration or requiring syncEnabled=true. Prerequisites: the identity provider is in the READY or SYNC_FAILED state, a user pool exists, and no other pending identity provider operations are in progress. The returned taskId only indicates that the request is accepted. Call GetIdentityProviderSyncJob to poll the status until it reaches SUCCESS, FAILED, or CANCELED. If the task fails, check the failureReason. The workspace user quota still applies, and previously synchronized users are not automatically deleted if the scope is reduced.
|
|
845
|
+
* Authorization information: RAM action agentcore:CreateIdentityProviderSyncJob, access level Write, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is required for authorization.
|
|
846
|
+
* Idempotency and retry: This operation does not provide a ClientToken parameter for conditional idempotency. Repeated submissions do not guarantee the same task is returned. If an operation is already in progress, an operation conflict is returned. Submitting again after the task ends creates a new synchronization task. If a submission times out, query the identity provider status first to avoid blindly resubmitting the request.
|
|
847
|
+
* Calling this API is free of charge, and operation records support ActionTrail auditing.
|
|
848
|
+
* Initial selective synchronization process: CreateIdentityProvider (syncOnBind=false, it is recommended to keep syncEnabled=false initially) → GetIdentityProvider and wait for READY → ListIdentityProviderDepartments to select departments → UpdateIdentityProvider to save syncScope and wait for READY → CreateIdentityProviderSyncJob → GetIdentityProviderSyncJob to query the terminal state. If incremental synchronization is required, configure callbacks and event subscriptions, and then update syncEnabled=true.
|
|
849
|
+
* Response example:
|
|
850
|
+
* ```json
|
|
851
|
+
* {
|
|
852
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
853
|
+
* "message": "success",
|
|
854
|
+
* "httpStatusCode": 200,
|
|
855
|
+
* "code": "SUCCESS",
|
|
856
|
+
* "success": true,
|
|
857
|
+
* "data": {
|
|
858
|
+
* "taskId": "12345678-1234-4234-8234-123456789abc",
|
|
859
|
+
* "status": "PENDING"
|
|
860
|
+
* }
|
|
861
|
+
* }
|
|
862
|
+
* ```
|
|
863
|
+
*
|
|
864
|
+
* @param request - CreateIdentityProviderSyncJobRequest
|
|
865
|
+
* @returns CreateIdentityProviderSyncJobResponse
|
|
866
|
+
*/
|
|
867
|
+
async createIdentityProviderSyncJob(workspaceId: string, identityProviderType: string, request: $_model.CreateIdentityProviderSyncJobRequest): Promise<$_model.CreateIdentityProviderSyncJobResponse> {
|
|
868
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
869
|
+
let headers : {[key: string ]: string} = { };
|
|
870
|
+
return await this.createIdentityProviderSyncJobWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
871
|
+
}
|
|
872
|
+
|
|
734
873
|
/**
|
|
735
874
|
* Creates an image cache.
|
|
736
875
|
*
|
|
@@ -1679,7 +1818,31 @@ export default class Client extends OpenApi {
|
|
|
1679
1818
|
}
|
|
1680
1819
|
|
|
1681
1820
|
/**
|
|
1682
|
-
*
|
|
1821
|
+
* Disconnects the external identity provider from a specified workspace and cleans up the users synchronized by the identity provider. The disconnection is an asynchronous operation. After the API returns a response, you can call GetIdentityProvider to query the status and track the progress.
|
|
1822
|
+
*
|
|
1823
|
+
* @remarks
|
|
1824
|
+
* ## Features and prerequisites
|
|
1825
|
+
* This is a complete disconnection, not just disabling logon. Disconnecting CustomSSO cleans up the AC users imported from this identity source, remote shared user pools and related resources, logon publishing configurations, and bindings. Therefore, both SAML and SCIM are affected. It does not delete the enterprise applications created by users on external platforms such as Azure. The system first checks the references between users and Teams. If references exist, the disconnection is rejected.
|
|
1826
|
+
* After the request is accepted, the system returns DISCONNECTING. You can call GetIdentityProvider to query the status. The cleanup is complete only when the binding does not exist (IdentityProviderNotFound). The binding should also no longer appear in the list. DISCONNECT_FAILED indicates that a partial cleanup may have occurred and the state cannot be restored to a brand new unconfigured state. You can retry based on the returned status. If the binding does not exist in the first place, the API returns a placeholder result indicating no binding without creating new resources. An ongoing disconnection task may return the current binding. Do not use this API as a substitute for setting loginEnabled=false, syncEnabled=false, or deleting a single token.
|
|
1827
|
+
* ## Requests and examples
|
|
1828
|
+
* DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
1829
|
+
* Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or STS credential that has permissions on the identity source resources of the workspace. The ws-example, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameter content of the public API, not the extra body wrapper of the backend direct connection API. The response example only shows the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
1830
|
+
* ```text
|
|
1831
|
+
* DELETE /workspaces/ws-example/identity-providers/CustomSSO
|
|
1832
|
+
* ```
|
|
1833
|
+
* ## Response examples
|
|
1834
|
+
* ```json
|
|
1835
|
+
* {
|
|
1836
|
+
* "data": {
|
|
1837
|
+
* "workspaceId": "ws-example",
|
|
1838
|
+
* "identityProviderType": "CustomSSO",
|
|
1839
|
+
* "status": "DISCONNECTING"
|
|
1840
|
+
* }
|
|
1841
|
+
* }
|
|
1842
|
+
* ```
|
|
1843
|
+
* ## Errors and handling
|
|
1844
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call failure to the upstream may return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
1845
|
+
* 409 IdentityProvider.Disconnect.Conflict: Users of this identity source still belong to a Team. Remove the references first. 409 IdentityProviderOperationConflict: The current status does not allow disconnection. 404 IdentityProviderNotFound: An external binding exists but the type does not match. An asynchronous failure may result in a partial cleanup. You cannot claim completion based solely on the first response.
|
|
1683
1846
|
*
|
|
1684
1847
|
* @param request - DeleteIdentityProviderRequest
|
|
1685
1848
|
* @param headers - map
|
|
@@ -1712,7 +1875,31 @@ export default class Client extends OpenApi {
|
|
|
1712
1875
|
}
|
|
1713
1876
|
|
|
1714
1877
|
/**
|
|
1715
|
-
*
|
|
1878
|
+
* Disconnects the external identity provider from a specified workspace and cleans up the users synchronized by the identity provider. The disconnection is an asynchronous operation. After the API returns a response, you can call GetIdentityProvider to query the status and track the progress.
|
|
1879
|
+
*
|
|
1880
|
+
* @remarks
|
|
1881
|
+
* ## Features and prerequisites
|
|
1882
|
+
* This is a complete disconnection, not just disabling logon. Disconnecting CustomSSO cleans up the AC users imported from this identity source, remote shared user pools and related resources, logon publishing configurations, and bindings. Therefore, both SAML and SCIM are affected. It does not delete the enterprise applications created by users on external platforms such as Azure. The system first checks the references between users and Teams. If references exist, the disconnection is rejected.
|
|
1883
|
+
* After the request is accepted, the system returns DISCONNECTING. You can call GetIdentityProvider to query the status. The cleanup is complete only when the binding does not exist (IdentityProviderNotFound). The binding should also no longer appear in the list. DISCONNECT_FAILED indicates that a partial cleanup may have occurred and the state cannot be restored to a brand new unconfigured state. You can retry based on the returned status. If the binding does not exist in the first place, the API returns a placeholder result indicating no binding without creating new resources. An ongoing disconnection task may return the current binding. Do not use this API as a substitute for setting loginEnabled=false, syncEnabled=false, or deleting a single token.
|
|
1884
|
+
* ## Requests and examples
|
|
1885
|
+
* DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
1886
|
+
* Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or STS credential that has permissions on the identity source resources of the workspace. The ws-example, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameter content of the public API, not the extra body wrapper of the backend direct connection API. The response example only shows the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
1887
|
+
* ```text
|
|
1888
|
+
* DELETE /workspaces/ws-example/identity-providers/CustomSSO
|
|
1889
|
+
* ```
|
|
1890
|
+
* ## Response examples
|
|
1891
|
+
* ```json
|
|
1892
|
+
* {
|
|
1893
|
+
* "data": {
|
|
1894
|
+
* "workspaceId": "ws-example",
|
|
1895
|
+
* "identityProviderType": "CustomSSO",
|
|
1896
|
+
* "status": "DISCONNECTING"
|
|
1897
|
+
* }
|
|
1898
|
+
* }
|
|
1899
|
+
* ```
|
|
1900
|
+
* ## Errors and handling
|
|
1901
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call failure to the upstream may return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
1902
|
+
* 409 IdentityProvider.Disconnect.Conflict: Users of this identity source still belong to a Team. Remove the references first. 409 IdentityProviderOperationConflict: The current status does not allow disconnection. 404 IdentityProviderNotFound: An external binding exists but the type does not match. An asynchronous failure may result in a partial cleanup. You cannot claim completion based solely on the first response.
|
|
1716
1903
|
*
|
|
1717
1904
|
* @param request - DeleteIdentityProviderRequest
|
|
1718
1905
|
* @returns DeleteIdentityProviderResponse
|
|
@@ -1910,10 +2097,10 @@ export default class Client extends OpenApi {
|
|
|
1910
2097
|
}
|
|
1911
2098
|
|
|
1912
2099
|
/**
|
|
1913
|
-
* Asynchronously deletes a MemoryStore and all
|
|
2100
|
+
* Asynchronously deletes a MemoryStore and all long-term memory within it.
|
|
1914
2101
|
*
|
|
1915
2102
|
* @remarks
|
|
1916
|
-
* Asynchronously deletes a MemoryStore and all
|
|
2103
|
+
* Asynchronously deletes a MemoryStore and all long-term memory within it.
|
|
1917
2104
|
*
|
|
1918
2105
|
* @param request - DeleteMemoryStoreRequest
|
|
1919
2106
|
* @param headers - map
|
|
@@ -1940,10 +2127,10 @@ export default class Client extends OpenApi {
|
|
|
1940
2127
|
}
|
|
1941
2128
|
|
|
1942
2129
|
/**
|
|
1943
|
-
* Asynchronously deletes a MemoryStore and all
|
|
2130
|
+
* Asynchronously deletes a MemoryStore and all long-term memory within it.
|
|
1944
2131
|
*
|
|
1945
2132
|
* @remarks
|
|
1946
|
-
* Asynchronously deletes a MemoryStore and all
|
|
2133
|
+
* Asynchronously deletes a MemoryStore and all long-term memory within it.
|
|
1947
2134
|
*
|
|
1948
2135
|
* @param request - DeleteMemoryStoreRequest
|
|
1949
2136
|
* @returns DeleteMemoryStoreResponse
|
|
@@ -2534,6 +2721,163 @@ export default class Client extends OpenApi {
|
|
|
2534
2721
|
return await this.forcePublishSkillVersionWithOptions(workspaceId, skillName, skillVersion, request, headers, runtime);
|
|
2535
2722
|
}
|
|
2536
2723
|
|
|
2724
|
+
/**
|
|
2725
|
+
* Retrieves the download URL for the saved code package of an agent.
|
|
2726
|
+
*
|
|
2727
|
+
* @remarks
|
|
2728
|
+
* Generates a time-limited, read-only download URL for the code package referenced by the currently saved agent configuration. This applies to code packages uploaded locally or imported from Object Storage Service (OSS). The operation uses workspaceId and agentId for locating and does not accept arbitrary bucket, object key, or historical version parameters. The current configuration must reference an available, fixed code package, and does not require waiting for a running instance to be ready. An error is returned if the code package does not exist, has changed, or is unreadable. The link is valid for up to 10 minutes and does not exceed the underlying credential expiration time. Call the operation again after it expires. The resourceVersionId indicates the saved configuration version corresponding to this download. The sample download link is redacted. Use the downloadUrl in the response.
|
|
2729
|
+
*
|
|
2730
|
+
* @param request - GetAgentCodePackageDownloadUrlRequest
|
|
2731
|
+
* @param headers - map
|
|
2732
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2733
|
+
* @returns GetAgentCodePackageDownloadUrlResponse
|
|
2734
|
+
*/
|
|
2735
|
+
async getAgentCodePackageDownloadUrlWithOptions(workspaceId: string, agentId: string, request: $_model.GetAgentCodePackageDownloadUrlRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentCodePackageDownloadUrlResponse> {
|
|
2736
|
+
request.validate();
|
|
2737
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
2738
|
+
headers: headers,
|
|
2739
|
+
});
|
|
2740
|
+
let params = new $OpenApiUtil.Params({
|
|
2741
|
+
action: "GetAgentCodePackageDownloadUrl",
|
|
2742
|
+
version: "2026-08-04",
|
|
2743
|
+
protocol: "HTTPS",
|
|
2744
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/custom-agents/${$dara.URL.percentEncode(agentId)}/code-package/download-url`,
|
|
2745
|
+
method: "GET",
|
|
2746
|
+
authType: "AK",
|
|
2747
|
+
style: "ROA",
|
|
2748
|
+
reqBodyType: "json",
|
|
2749
|
+
bodyType: "json",
|
|
2750
|
+
});
|
|
2751
|
+
return $dara.cast<$_model.GetAgentCodePackageDownloadUrlResponse>(await this.callApi(params, req, runtime), new $_model.GetAgentCodePackageDownloadUrlResponse({}));
|
|
2752
|
+
}
|
|
2753
|
+
|
|
2754
|
+
/**
|
|
2755
|
+
* Retrieves the download URL for the saved code package of an agent.
|
|
2756
|
+
*
|
|
2757
|
+
* @remarks
|
|
2758
|
+
* Generates a time-limited, read-only download URL for the code package referenced by the currently saved agent configuration. This applies to code packages uploaded locally or imported from Object Storage Service (OSS). The operation uses workspaceId and agentId for locating and does not accept arbitrary bucket, object key, or historical version parameters. The current configuration must reference an available, fixed code package, and does not require waiting for a running instance to be ready. An error is returned if the code package does not exist, has changed, or is unreadable. The link is valid for up to 10 minutes and does not exceed the underlying credential expiration time. Call the operation again after it expires. The resourceVersionId indicates the saved configuration version corresponding to this download. The sample download link is redacted. Use the downloadUrl in the response.
|
|
2759
|
+
*
|
|
2760
|
+
* @param request - GetAgentCodePackageDownloadUrlRequest
|
|
2761
|
+
* @returns GetAgentCodePackageDownloadUrlResponse
|
|
2762
|
+
*/
|
|
2763
|
+
async getAgentCodePackageDownloadUrl(workspaceId: string, agentId: string, request: $_model.GetAgentCodePackageDownloadUrlRequest): Promise<$_model.GetAgentCodePackageDownloadUrlResponse> {
|
|
2764
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
2765
|
+
let headers : {[key: string ]: string} = { };
|
|
2766
|
+
return await this.getAgentCodePackageDownloadUrlWithOptions(workspaceId, agentId, request, headers, runtime);
|
|
2767
|
+
}
|
|
2768
|
+
|
|
2769
|
+
/**
|
|
2770
|
+
* Retrieves the OSS RAM authorization URL for the agent code package.
|
|
2771
|
+
*
|
|
2772
|
+
* @remarks
|
|
2773
|
+
* Generates a RAM authorization URL for the resource role of the current workspace for a specified source bucket. The client cannot specify or override the role. After you open the authorizeUrl and confirm the authorization, call VerifyAgentCodePackageOssRamAuthorization to check the policy binding, and call ValidateAgentCodePackageFromOss to check specific objects.
|
|
2774
|
+
* This authorization reuses the OSSObjectRestoreCustom template, which includes permissions to read, write, and delete objects, and is not a read-only authorization. Retrieving the URL itself does not complete the authorization, transfer the code package, or modify the default OSS binding of the workspace. Existing authorizations for the same role and bucket can be reused. The example URL is provided to demonstrate the format. Use the actual authorization URL returned by the API operation.
|
|
2775
|
+
*
|
|
2776
|
+
* @param request - GetAgentCodePackageOssRamAuthorizeUrlRequest
|
|
2777
|
+
* @param headers - map
|
|
2778
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2779
|
+
* @returns GetAgentCodePackageOssRamAuthorizeUrlResponse
|
|
2780
|
+
*/
|
|
2781
|
+
async getAgentCodePackageOssRamAuthorizeUrlWithOptions(workspaceId: string, request: $_model.GetAgentCodePackageOssRamAuthorizeUrlRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentCodePackageOssRamAuthorizeUrlResponse> {
|
|
2782
|
+
request.validate();
|
|
2783
|
+
let query : {[key: string ]: any} = { };
|
|
2784
|
+
if (!$dara.isNull(request.ossBucketName)) {
|
|
2785
|
+
query["ossBucketName"] = request.ossBucketName;
|
|
2786
|
+
}
|
|
2787
|
+
|
|
2788
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
2789
|
+
headers: headers,
|
|
2790
|
+
query: OpenApiUtil.query(query),
|
|
2791
|
+
});
|
|
2792
|
+
let params = new $OpenApiUtil.Params({
|
|
2793
|
+
action: "GetAgentCodePackageOssRamAuthorizeUrl",
|
|
2794
|
+
version: "2026-08-04",
|
|
2795
|
+
protocol: "HTTPS",
|
|
2796
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/agent-code-packages/oss/authorize`,
|
|
2797
|
+
method: "GET",
|
|
2798
|
+
authType: "AK",
|
|
2799
|
+
style: "ROA",
|
|
2800
|
+
reqBodyType: "json",
|
|
2801
|
+
bodyType: "json",
|
|
2802
|
+
});
|
|
2803
|
+
return $dara.cast<$_model.GetAgentCodePackageOssRamAuthorizeUrlResponse>(await this.callApi(params, req, runtime), new $_model.GetAgentCodePackageOssRamAuthorizeUrlResponse({}));
|
|
2804
|
+
}
|
|
2805
|
+
|
|
2806
|
+
/**
|
|
2807
|
+
* Retrieves the OSS RAM authorization URL for the agent code package.
|
|
2808
|
+
*
|
|
2809
|
+
* @remarks
|
|
2810
|
+
* Generates a RAM authorization URL for the resource role of the current workspace for a specified source bucket. The client cannot specify or override the role. After you open the authorizeUrl and confirm the authorization, call VerifyAgentCodePackageOssRamAuthorization to check the policy binding, and call ValidateAgentCodePackageFromOss to check specific objects.
|
|
2811
|
+
* This authorization reuses the OSSObjectRestoreCustom template, which includes permissions to read, write, and delete objects, and is not a read-only authorization. Retrieving the URL itself does not complete the authorization, transfer the code package, or modify the default OSS binding of the workspace. Existing authorizations for the same role and bucket can be reused. The example URL is provided to demonstrate the format. Use the actual authorization URL returned by the API operation.
|
|
2812
|
+
*
|
|
2813
|
+
* @param request - GetAgentCodePackageOssRamAuthorizeUrlRequest
|
|
2814
|
+
* @returns GetAgentCodePackageOssRamAuthorizeUrlResponse
|
|
2815
|
+
*/
|
|
2816
|
+
async getAgentCodePackageOssRamAuthorizeUrl(workspaceId: string, request: $_model.GetAgentCodePackageOssRamAuthorizeUrlRequest): Promise<$_model.GetAgentCodePackageOssRamAuthorizeUrlResponse> {
|
|
2817
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
2818
|
+
let headers : {[key: string ]: string} = { };
|
|
2819
|
+
return await this.getAgentCodePackageOssRamAuthorizeUrlWithOptions(workspaceId, request, headers, runtime);
|
|
2820
|
+
}
|
|
2821
|
+
|
|
2822
|
+
/**
|
|
2823
|
+
* Retrieves the upload URL for an agent code package.
|
|
2824
|
+
*
|
|
2825
|
+
* @remarks
|
|
2826
|
+
* Retrieves a time-limited upload URL for a code package without uploading the file content. The fileName must be a ZIP or TAR.GZ filename without directories. The format must match the file extension. The fileSize is in bytes, with valid values ranging from 1 to 500,000,000.
|
|
2827
|
+
* Use the uploadMethod, uploadUrl, and headers from the response to upload the file directly. After the upload is complete, pass the sourceUri to the artifact.code.sourceUri parameter of CreateCustomAgent or UpdateCustomAgent. The actual object and size are verified and a fixed copy is saved during creation or update. The upload URL is valid for up to 10 minutes and does not exceed the expiration time of the underlying temporary credentials. Retrieve a new URL after it expires. The example URL is desensitized and cannot be used for actual uploads. Use the original URL and request headers from this response.
|
|
2828
|
+
*
|
|
2829
|
+
* @param tmpReq - GetAgentCodePackageUploadUrlRequest
|
|
2830
|
+
* @param headers - map
|
|
2831
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2832
|
+
* @returns GetAgentCodePackageUploadUrlResponse
|
|
2833
|
+
*/
|
|
2834
|
+
async getAgentCodePackageUploadUrlWithOptions(workspaceId: string, tmpReq: $_model.GetAgentCodePackageUploadUrlRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentCodePackageUploadUrlResponse> {
|
|
2835
|
+
tmpReq.validate();
|
|
2836
|
+
let request = new $_model.GetAgentCodePackageUploadUrlShrinkRequest({ });
|
|
2837
|
+
OpenApiUtil.convert(tmpReq, request);
|
|
2838
|
+
if (!$dara.isNull(tmpReq.body)) {
|
|
2839
|
+
request.bodyShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.body, "body", "json");
|
|
2840
|
+
}
|
|
2841
|
+
|
|
2842
|
+
let body : {[key: string ]: any} = { };
|
|
2843
|
+
if (!$dara.isNull(request.bodyShrink)) {
|
|
2844
|
+
body["body"] = request.bodyShrink;
|
|
2845
|
+
}
|
|
2846
|
+
|
|
2847
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
2848
|
+
headers: headers,
|
|
2849
|
+
body: OpenApiUtil.parseToMap(body),
|
|
2850
|
+
});
|
|
2851
|
+
let params = new $OpenApiUtil.Params({
|
|
2852
|
+
action: "GetAgentCodePackageUploadUrl",
|
|
2853
|
+
version: "2026-08-04",
|
|
2854
|
+
protocol: "HTTPS",
|
|
2855
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/agent-code-packages/upload-url`,
|
|
2856
|
+
method: "POST",
|
|
2857
|
+
authType: "AK",
|
|
2858
|
+
style: "ROA",
|
|
2859
|
+
reqBodyType: "formData",
|
|
2860
|
+
bodyType: "json",
|
|
2861
|
+
});
|
|
2862
|
+
return $dara.cast<$_model.GetAgentCodePackageUploadUrlResponse>(await this.callApi(params, req, runtime), new $_model.GetAgentCodePackageUploadUrlResponse({}));
|
|
2863
|
+
}
|
|
2864
|
+
|
|
2865
|
+
/**
|
|
2866
|
+
* Retrieves the upload URL for an agent code package.
|
|
2867
|
+
*
|
|
2868
|
+
* @remarks
|
|
2869
|
+
* Retrieves a time-limited upload URL for a code package without uploading the file content. The fileName must be a ZIP or TAR.GZ filename without directories. The format must match the file extension. The fileSize is in bytes, with valid values ranging from 1 to 500,000,000.
|
|
2870
|
+
* Use the uploadMethod, uploadUrl, and headers from the response to upload the file directly. After the upload is complete, pass the sourceUri to the artifact.code.sourceUri parameter of CreateCustomAgent or UpdateCustomAgent. The actual object and size are verified and a fixed copy is saved during creation or update. The upload URL is valid for up to 10 minutes and does not exceed the expiration time of the underlying temporary credentials. Retrieve a new URL after it expires. The example URL is desensitized and cannot be used for actual uploads. Use the original URL and request headers from this response.
|
|
2871
|
+
*
|
|
2872
|
+
* @param request - GetAgentCodePackageUploadUrlRequest
|
|
2873
|
+
* @returns GetAgentCodePackageUploadUrlResponse
|
|
2874
|
+
*/
|
|
2875
|
+
async getAgentCodePackageUploadUrl(workspaceId: string, request: $_model.GetAgentCodePackageUploadUrlRequest): Promise<$_model.GetAgentCodePackageUploadUrlResponse> {
|
|
2876
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
2877
|
+
let headers : {[key: string ]: string} = { };
|
|
2878
|
+
return await this.getAgentCodePackageUploadUrlWithOptions(workspaceId, request, headers, runtime);
|
|
2879
|
+
}
|
|
2880
|
+
|
|
2537
2881
|
/**
|
|
2538
2882
|
* Queries the details of a specified agent IM channel.
|
|
2539
2883
|
*
|
|
@@ -2822,8 +3166,8 @@ export default class Client extends OpenApi {
|
|
|
2822
3166
|
* Queries the details of a custom agent in a specified workspace, including deployment configurations, the execute status of the latest configuration version, and the running instance status statistics.
|
|
2823
3167
|
*
|
|
2824
3168
|
* @remarks
|
|
2825
|
-
* After
|
|
2826
|
-
* The returned configuration is the
|
|
3169
|
+
* After creating or updating a custom agent, you can poll this operation to query the execution result of the latest configuration version. latestVersionStatus corresponds to latestSpecVersion. latestExecutionError indicates the cause of the pending or failed status for this version. If retryable is true, you can query again later.
|
|
3170
|
+
* The returned configuration is the latest submitted configuration and may not have taken effect. Verify the deployment and running status by checking latestVersionStatus, the overall agent status, and the running instance statistics sandboxPhaseCounts.
|
|
2827
3171
|
* If the queried custom agent does not exist, has been deleted, or does not belong to the specified workspace, a resource not found error is returned.
|
|
2828
3172
|
*
|
|
2829
3173
|
* @param request - GetCustomAgentRequest
|
|
@@ -2854,8 +3198,8 @@ export default class Client extends OpenApi {
|
|
|
2854
3198
|
* Queries the details of a custom agent in a specified workspace, including deployment configurations, the execute status of the latest configuration version, and the running instance status statistics.
|
|
2855
3199
|
*
|
|
2856
3200
|
* @remarks
|
|
2857
|
-
* After
|
|
2858
|
-
* The returned configuration is the
|
|
3201
|
+
* After creating or updating a custom agent, you can poll this operation to query the execution result of the latest configuration version. latestVersionStatus corresponds to latestSpecVersion. latestExecutionError indicates the cause of the pending or failed status for this version. If retryable is true, you can query again later.
|
|
3202
|
+
* The returned configuration is the latest submitted configuration and may not have taken effect. Verify the deployment and running status by checking latestVersionStatus, the overall agent status, and the running instance statistics sandboxPhaseCounts.
|
|
2859
3203
|
* If the queried custom agent does not exist, has been deleted, or does not belong to the specified workspace, a resource not found error is returned.
|
|
2860
3204
|
*
|
|
2861
3205
|
* @param request - GetCustomAgentRequest
|
|
@@ -2958,7 +3302,33 @@ export default class Client extends OpenApi {
|
|
|
2958
3302
|
}
|
|
2959
3303
|
|
|
2960
3304
|
/**
|
|
2961
|
-
* Queries the binding details of
|
|
3305
|
+
* Queries the binding details of an external identity provider for a specified workspace, including the binding status, application configurations, and the callback URL to be configured on the identity provider side. Application secret configurations are not returned.
|
|
3306
|
+
*
|
|
3307
|
+
* @remarks
|
|
3308
|
+
* ## Features and prerequisites
|
|
3309
|
+
* Reads existing bindings by type. For CustomSSO, the API returns the saved protocol, standardized SAML, expected loginEnabled, syncEnabled, and shared binding status. If SAML is not configured, the saml and configuration fields may not be returned. If SAML is configured, the API additionally queries AgentIdentity, and the configuration field represents the actual SSO/JIT configuration. The saml field serves as the data source for the edit form. The status switches in the configuration field are Enabled and Disabled. If the upstream query fails, an error is returned. This failure must not be treated as an unconfigured state.
|
|
3310
|
+
* Only this API reads back the actual SAML configuration. The list and write APIs do not guarantee that the configuration field is returned. A READY user pool does not indicate that SAML is configured. The UPDATING and UPDATE_FAILED statuses describe logon configuration tasks, not SCIM tasks. The vendor callback URL for CustomSSO is empty. Use GetIdentityProviderSCIM.operationStatus to query SCIM operation results.
|
|
3311
|
+
* ## Requests and examples
|
|
3312
|
+
* GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
3313
|
+
* Calling convention: Call this API in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity source resources of the workspace. The ws-example, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API, rather than the extra body wrapper of the backend direct-connection API. The response example shows only the business data. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not imply that the HTTP request uses a persistent connection to wait for completion.
|
|
3314
|
+
* ```text
|
|
3315
|
+
* GET /workspaces/ws-example/identity-providers/CustomSSO
|
|
3316
|
+
* ```
|
|
3317
|
+
* ## Response example
|
|
3318
|
+
* ```json
|
|
3319
|
+
* {
|
|
3320
|
+
* "data": {
|
|
3321
|
+
* "workspaceId": "ws-example",
|
|
3322
|
+
* "identityProviderType": "CustomSSO",
|
|
3323
|
+
* "status": "READY",
|
|
3324
|
+
* "loginEnabled": false,
|
|
3325
|
+
* "syncEnabled": false
|
|
3326
|
+
* }
|
|
3327
|
+
* }
|
|
3328
|
+
* ```
|
|
3329
|
+
* ## Errors and handling
|
|
3330
|
+
* Error handling: A 400 InvalidParameter error indicates that the parameters or current configuration prerequisites are not met. A 404 IdentityProviderNotFound error indicates that no binding of the specified type exists. Synchronous calls to the upstream service may return a 503 IdentityProviderProvisioningUnavailable error if they fail. Retain the request ID for troubleshooting and do not interpret read failures as an unconfigured state. Authentication errors and workspace-not-found errors follow common error handling procedures.
|
|
3331
|
+
* 404 IdentityProviderNotFound: No binding exists, or the specified type is inconsistent with the current binding. If SAML is already configured, an upstream read failure does not degrade to a successful empty configuration.
|
|
2962
3332
|
*
|
|
2963
3333
|
* @param request - GetIdentityProviderRequest
|
|
2964
3334
|
* @param headers - map
|
|
@@ -2985,7 +3355,33 @@ export default class Client extends OpenApi {
|
|
|
2985
3355
|
}
|
|
2986
3356
|
|
|
2987
3357
|
/**
|
|
2988
|
-
* Queries the binding details of
|
|
3358
|
+
* Queries the binding details of an external identity provider for a specified workspace, including the binding status, application configurations, and the callback URL to be configured on the identity provider side. Application secret configurations are not returned.
|
|
3359
|
+
*
|
|
3360
|
+
* @remarks
|
|
3361
|
+
* ## Features and prerequisites
|
|
3362
|
+
* Reads existing bindings by type. For CustomSSO, the API returns the saved protocol, standardized SAML, expected loginEnabled, syncEnabled, and shared binding status. If SAML is not configured, the saml and configuration fields may not be returned. If SAML is configured, the API additionally queries AgentIdentity, and the configuration field represents the actual SSO/JIT configuration. The saml field serves as the data source for the edit form. The status switches in the configuration field are Enabled and Disabled. If the upstream query fails, an error is returned. This failure must not be treated as an unconfigured state.
|
|
3363
|
+
* Only this API reads back the actual SAML configuration. The list and write APIs do not guarantee that the configuration field is returned. A READY user pool does not indicate that SAML is configured. The UPDATING and UPDATE_FAILED statuses describe logon configuration tasks, not SCIM tasks. The vendor callback URL for CustomSSO is empty. Use GetIdentityProviderSCIM.operationStatus to query SCIM operation results.
|
|
3364
|
+
* ## Requests and examples
|
|
3365
|
+
* GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
3366
|
+
* Calling convention: Call this API in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity source resources of the workspace. The ws-example, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API, rather than the extra body wrapper of the backend direct-connection API. The response example shows only the business data. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not imply that the HTTP request uses a persistent connection to wait for completion.
|
|
3367
|
+
* ```text
|
|
3368
|
+
* GET /workspaces/ws-example/identity-providers/CustomSSO
|
|
3369
|
+
* ```
|
|
3370
|
+
* ## Response example
|
|
3371
|
+
* ```json
|
|
3372
|
+
* {
|
|
3373
|
+
* "data": {
|
|
3374
|
+
* "workspaceId": "ws-example",
|
|
3375
|
+
* "identityProviderType": "CustomSSO",
|
|
3376
|
+
* "status": "READY",
|
|
3377
|
+
* "loginEnabled": false,
|
|
3378
|
+
* "syncEnabled": false
|
|
3379
|
+
* }
|
|
3380
|
+
* }
|
|
3381
|
+
* ```
|
|
3382
|
+
* ## Errors and handling
|
|
3383
|
+
* Error handling: A 400 InvalidParameter error indicates that the parameters or current configuration prerequisites are not met. A 404 IdentityProviderNotFound error indicates that no binding of the specified type exists. Synchronous calls to the upstream service may return a 503 IdentityProviderProvisioningUnavailable error if they fail. Retain the request ID for troubleshooting and do not interpret read failures as an unconfigured state. Authentication errors and workspace-not-found errors follow common error handling procedures.
|
|
3384
|
+
* 404 IdentityProviderNotFound: No binding exists, or the specified type is inconsistent with the current binding. If SAML is already configured, an upstream read failure does not degrade to a successful empty configuration.
|
|
2989
3385
|
*
|
|
2990
3386
|
* @param request - GetIdentityProviderRequest
|
|
2991
3387
|
* @returns GetIdentityProviderResponse
|
|
@@ -2996,6 +3392,198 @@ export default class Client extends OpenApi {
|
|
|
2996
3392
|
return await this.getIdentityProviderWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
2997
3393
|
}
|
|
2998
3394
|
|
|
3395
|
+
/**
|
|
3396
|
+
* Queries an identity provider synchronization task.
|
|
3397
|
+
*
|
|
3398
|
+
* @remarks
|
|
3399
|
+
* Queries the status, current step, number of processed users, and failure cause of a manual synchronization task by using the local taskId of AgentCore. The taskId must be obtained from CreateIdentityProviderSyncJob in the same workspace and identity provider. It is not the synchronizationJobId of AgentIdentity. Poll the task until the status is SUCCESS, FAILED, or CANCELED. The PENDING, RUNNING, and PAUSED statuses do not indicate completion. The syncedUserCount includes updated existing users and does not equal the number of newly added users or the progress percentage.
|
|
3400
|
+
* Authorization information: The RAM operation is agentcore:GetIdentityProviderSyncJob, the access level is Read, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
|
|
3401
|
+
* Idempotence and retry: This operation is read-only and can be repeatedly queried.
|
|
3402
|
+
* Calling this API operation is free of charge, and operation records support ActionTrail auditing.
|
|
3403
|
+
* Response example:
|
|
3404
|
+
* ```json
|
|
3405
|
+
* {
|
|
3406
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
3407
|
+
* "message": "success",
|
|
3408
|
+
* "httpStatusCode": 200,
|
|
3409
|
+
* "code": "SUCCESS",
|
|
3410
|
+
* "success": true,
|
|
3411
|
+
* "data": {
|
|
3412
|
+
* "taskId": "12345678-1234-4234-8234-123456789abc",
|
|
3413
|
+
* "status": "SUCCESS",
|
|
3414
|
+
* "currentStep": "SYNC",
|
|
3415
|
+
* "synchronizationJobId": "syncjob_0123456789abcdef0123456789abcdef",
|
|
3416
|
+
* "syncedUserCount": 12
|
|
3417
|
+
* }
|
|
3418
|
+
* }
|
|
3419
|
+
* ```
|
|
3420
|
+
*
|
|
3421
|
+
* @param request - GetIdentityProviderSyncJobRequest
|
|
3422
|
+
* @param headers - map
|
|
3423
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3424
|
+
* @returns GetIdentityProviderSyncJobResponse
|
|
3425
|
+
*/
|
|
3426
|
+
async getIdentityProviderSyncJobWithOptions(workspaceId: string, identityProviderType: string, taskId: string, request: $_model.GetIdentityProviderSyncJobRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.GetIdentityProviderSyncJobResponse> {
|
|
3427
|
+
request.validate();
|
|
3428
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
3429
|
+
headers: headers,
|
|
3430
|
+
});
|
|
3431
|
+
let params = new $OpenApiUtil.Params({
|
|
3432
|
+
action: "GetIdentityProviderSyncJob",
|
|
3433
|
+
version: "2026-08-04",
|
|
3434
|
+
protocol: "HTTPS",
|
|
3435
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}/sync-jobs/${$dara.URL.percentEncode(taskId)}`,
|
|
3436
|
+
method: "GET",
|
|
3437
|
+
authType: "AK",
|
|
3438
|
+
style: "ROA",
|
|
3439
|
+
reqBodyType: "json",
|
|
3440
|
+
bodyType: "json",
|
|
3441
|
+
});
|
|
3442
|
+
return $dara.cast<$_model.GetIdentityProviderSyncJobResponse>(await this.callApi(params, req, runtime), new $_model.GetIdentityProviderSyncJobResponse({}));
|
|
3443
|
+
}
|
|
3444
|
+
|
|
3445
|
+
/**
|
|
3446
|
+
* Queries an identity provider synchronization task.
|
|
3447
|
+
*
|
|
3448
|
+
* @remarks
|
|
3449
|
+
* Queries the status, current step, number of processed users, and failure cause of a manual synchronization task by using the local taskId of AgentCore. The taskId must be obtained from CreateIdentityProviderSyncJob in the same workspace and identity provider. It is not the synchronizationJobId of AgentIdentity. Poll the task until the status is SUCCESS, FAILED, or CANCELED. The PENDING, RUNNING, and PAUSED statuses do not indicate completion. The syncedUserCount includes updated existing users and does not equal the number of newly added users or the progress percentage.
|
|
3450
|
+
* Authorization information: The RAM operation is agentcore:GetIdentityProviderSyncJob, the access level is Read, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
|
|
3451
|
+
* Idempotence and retry: This operation is read-only and can be repeatedly queried.
|
|
3452
|
+
* Calling this API operation is free of charge, and operation records support ActionTrail auditing.
|
|
3453
|
+
* Response example:
|
|
3454
|
+
* ```json
|
|
3455
|
+
* {
|
|
3456
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
3457
|
+
* "message": "success",
|
|
3458
|
+
* "httpStatusCode": 200,
|
|
3459
|
+
* "code": "SUCCESS",
|
|
3460
|
+
* "success": true,
|
|
3461
|
+
* "data": {
|
|
3462
|
+
* "taskId": "12345678-1234-4234-8234-123456789abc",
|
|
3463
|
+
* "status": "SUCCESS",
|
|
3464
|
+
* "currentStep": "SYNC",
|
|
3465
|
+
* "synchronizationJobId": "syncjob_0123456789abcdef0123456789abcdef",
|
|
3466
|
+
* "syncedUserCount": 12
|
|
3467
|
+
* }
|
|
3468
|
+
* }
|
|
3469
|
+
* ```
|
|
3470
|
+
*
|
|
3471
|
+
* @param request - GetIdentityProviderSyncJobRequest
|
|
3472
|
+
* @returns GetIdentityProviderSyncJobResponse
|
|
3473
|
+
*/
|
|
3474
|
+
async getIdentityProviderSyncJob(workspaceId: string, identityProviderType: string, taskId: string, request: $_model.GetIdentityProviderSyncJobRequest): Promise<$_model.GetIdentityProviderSyncJobResponse> {
|
|
3475
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
3476
|
+
let headers : {[key: string ]: string} = { };
|
|
3477
|
+
return await this.getIdentityProviderSyncJobWithOptions(workspaceId, identityProviderType, taskId, request, headers, runtime);
|
|
3478
|
+
}
|
|
3479
|
+
|
|
3480
|
+
/**
|
|
3481
|
+
* Queries the synchronization scope of an identity provider.
|
|
3482
|
+
*
|
|
3483
|
+
* @remarks
|
|
3484
|
+
* Queries the saved synchronization scope, the validity of selected departments, and the estimated user count downstream of the identity provider. This operation is not used for real-time estimation of unsaved selections. AllAuthorized indicates the address book scope authorized for the application, which is not equivalent to the entire enterprise organization. An empty selectedDepartments array does not prove that the organization has no sub-departments. The estimation can be used only when estimateStatus is Ready and a count is returned. A missing count does not indicate 0.
|
|
3485
|
+
* Authorization information: RAM operation agentcore:GetIdentityProviderSyncScope, access level Read, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
|
|
3486
|
+
* Idempotence and retry: This operation is read-only and can be queried repeatedly.
|
|
3487
|
+
* Calling this API operation is free of charge. Operation records support ActionTrail auditing.
|
|
3488
|
+
* Sample response:
|
|
3489
|
+
* ```json
|
|
3490
|
+
* {
|
|
3491
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
3492
|
+
* "message": "success",
|
|
3493
|
+
* "httpStatusCode": 200,
|
|
3494
|
+
* "code": "SUCCESS",
|
|
3495
|
+
* "success": true,
|
|
3496
|
+
* "data": {
|
|
3497
|
+
* "syncScope": {
|
|
3498
|
+
* "mode": "SelectedDepartments",
|
|
3499
|
+
* "departmentIds": [
|
|
3500
|
+
* "10001"
|
|
3501
|
+
* ]
|
|
3502
|
+
* },
|
|
3503
|
+
* "selectedDepartments": [
|
|
3504
|
+
* {
|
|
3505
|
+
* "id": "10001",
|
|
3506
|
+
* "name": "R&D Department",
|
|
3507
|
+
* "exists": true
|
|
3508
|
+
* }
|
|
3509
|
+
* ],
|
|
3510
|
+
* "estimateStatus": "Ready",
|
|
3511
|
+
* "expandedDepartmentCount": 2,
|
|
3512
|
+
* "estimatedUserCount": 12
|
|
3513
|
+
* }
|
|
3514
|
+
* }
|
|
3515
|
+
* ```
|
|
3516
|
+
*
|
|
3517
|
+
* @param request - GetIdentityProviderSyncScopeRequest
|
|
3518
|
+
* @param headers - map
|
|
3519
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3520
|
+
* @returns GetIdentityProviderSyncScopeResponse
|
|
3521
|
+
*/
|
|
3522
|
+
async getIdentityProviderSyncScopeWithOptions(workspaceId: string, identityProviderType: string, request: $_model.GetIdentityProviderSyncScopeRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.GetIdentityProviderSyncScopeResponse> {
|
|
3523
|
+
request.validate();
|
|
3524
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
3525
|
+
headers: headers,
|
|
3526
|
+
});
|
|
3527
|
+
let params = new $OpenApiUtil.Params({
|
|
3528
|
+
action: "GetIdentityProviderSyncScope",
|
|
3529
|
+
version: "2026-08-04",
|
|
3530
|
+
protocol: "HTTPS",
|
|
3531
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}/sync-scope`,
|
|
3532
|
+
method: "GET",
|
|
3533
|
+
authType: "AK",
|
|
3534
|
+
style: "ROA",
|
|
3535
|
+
reqBodyType: "json",
|
|
3536
|
+
bodyType: "json",
|
|
3537
|
+
});
|
|
3538
|
+
return $dara.cast<$_model.GetIdentityProviderSyncScopeResponse>(await this.callApi(params, req, runtime), new $_model.GetIdentityProviderSyncScopeResponse({}));
|
|
3539
|
+
}
|
|
3540
|
+
|
|
3541
|
+
/**
|
|
3542
|
+
* Queries the synchronization scope of an identity provider.
|
|
3543
|
+
*
|
|
3544
|
+
* @remarks
|
|
3545
|
+
* Queries the saved synchronization scope, the validity of selected departments, and the estimated user count downstream of the identity provider. This operation is not used for real-time estimation of unsaved selections. AllAuthorized indicates the address book scope authorized for the application, which is not equivalent to the entire enterprise organization. An empty selectedDepartments array does not prove that the organization has no sub-departments. The estimation can be used only when estimateStatus is Ready and a count is returned. A missing count does not indicate 0.
|
|
3546
|
+
* Authorization information: RAM operation agentcore:GetIdentityProviderSyncScope, access level Read, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
|
|
3547
|
+
* Idempotence and retry: This operation is read-only and can be queried repeatedly.
|
|
3548
|
+
* Calling this API operation is free of charge. Operation records support ActionTrail auditing.
|
|
3549
|
+
* Sample response:
|
|
3550
|
+
* ```json
|
|
3551
|
+
* {
|
|
3552
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
3553
|
+
* "message": "success",
|
|
3554
|
+
* "httpStatusCode": 200,
|
|
3555
|
+
* "code": "SUCCESS",
|
|
3556
|
+
* "success": true,
|
|
3557
|
+
* "data": {
|
|
3558
|
+
* "syncScope": {
|
|
3559
|
+
* "mode": "SelectedDepartments",
|
|
3560
|
+
* "departmentIds": [
|
|
3561
|
+
* "10001"
|
|
3562
|
+
* ]
|
|
3563
|
+
* },
|
|
3564
|
+
* "selectedDepartments": [
|
|
3565
|
+
* {
|
|
3566
|
+
* "id": "10001",
|
|
3567
|
+
* "name": "R&D Department",
|
|
3568
|
+
* "exists": true
|
|
3569
|
+
* }
|
|
3570
|
+
* ],
|
|
3571
|
+
* "estimateStatus": "Ready",
|
|
3572
|
+
* "expandedDepartmentCount": 2,
|
|
3573
|
+
* "estimatedUserCount": 12
|
|
3574
|
+
* }
|
|
3575
|
+
* }
|
|
3576
|
+
* ```
|
|
3577
|
+
*
|
|
3578
|
+
* @param request - GetIdentityProviderSyncScopeRequest
|
|
3579
|
+
* @returns GetIdentityProviderSyncScopeResponse
|
|
3580
|
+
*/
|
|
3581
|
+
async getIdentityProviderSyncScope(workspaceId: string, identityProviderType: string, request: $_model.GetIdentityProviderSyncScopeRequest): Promise<$_model.GetIdentityProviderSyncScopeResponse> {
|
|
3582
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
3583
|
+
let headers : {[key: string ]: string} = { };
|
|
3584
|
+
return await this.getIdentityProviderSyncScopeWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
3585
|
+
}
|
|
3586
|
+
|
|
2999
3587
|
/**
|
|
3000
3588
|
* Queries the details of an image cache.
|
|
3001
3589
|
*
|
|
@@ -4048,6 +4636,63 @@ export default class Client extends OpenApi {
|
|
|
4048
4636
|
return await this.installWorkspacePluginWithOptions(workspaceId, pluginName, request, headers, runtime);
|
|
4049
4637
|
}
|
|
4050
4638
|
|
|
4639
|
+
/**
|
|
4640
|
+
* Queries the runtime environments supported for code deployment.
|
|
4641
|
+
*
|
|
4642
|
+
* @remarks
|
|
4643
|
+
* Queries the directories in the current workspace that can be used to create code package agents or switch runtime environments. Runtime environments are dynamically provided based on the current version configuration, and internal image addresses are not returned.
|
|
4644
|
+
* If maxResults is omitted or set to 0, the default value is 10. If the value is greater than 100, it is processed as 100. Omit nextToken in the first request. For subsequent requests, use the token returned in the previous response as is, and keep the workspace unchanged. If a directory change invalidates the token, query from the first page again. An empty nextToken indicates that there are no more pages. Existing agents continue to use the saved images for restarts, scaling, and regular updates.
|
|
4645
|
+
*
|
|
4646
|
+
* @param request - ListAgentCodeRuntimesRequest
|
|
4647
|
+
* @param headers - map
|
|
4648
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
4649
|
+
* @returns ListAgentCodeRuntimesResponse
|
|
4650
|
+
*/
|
|
4651
|
+
async listAgentCodeRuntimesWithOptions(workspaceId: string, request: $_model.ListAgentCodeRuntimesRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentCodeRuntimesResponse> {
|
|
4652
|
+
request.validate();
|
|
4653
|
+
let query : {[key: string ]: any} = { };
|
|
4654
|
+
if (!$dara.isNull(request.maxResults)) {
|
|
4655
|
+
query["maxResults"] = request.maxResults;
|
|
4656
|
+
}
|
|
4657
|
+
|
|
4658
|
+
if (!$dara.isNull(request.nextToken)) {
|
|
4659
|
+
query["nextToken"] = request.nextToken;
|
|
4660
|
+
}
|
|
4661
|
+
|
|
4662
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
4663
|
+
headers: headers,
|
|
4664
|
+
query: OpenApiUtil.query(query),
|
|
4665
|
+
});
|
|
4666
|
+
let params = new $OpenApiUtil.Params({
|
|
4667
|
+
action: "ListAgentCodeRuntimes",
|
|
4668
|
+
version: "2026-08-04",
|
|
4669
|
+
protocol: "HTTPS",
|
|
4670
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/agent-code-runtimes`,
|
|
4671
|
+
method: "GET",
|
|
4672
|
+
authType: "AK",
|
|
4673
|
+
style: "ROA",
|
|
4674
|
+
reqBodyType: "json",
|
|
4675
|
+
bodyType: "json",
|
|
4676
|
+
});
|
|
4677
|
+
return $dara.cast<$_model.ListAgentCodeRuntimesResponse>(await this.callApi(params, req, runtime), new $_model.ListAgentCodeRuntimesResponse({}));
|
|
4678
|
+
}
|
|
4679
|
+
|
|
4680
|
+
/**
|
|
4681
|
+
* Queries the runtime environments supported for code deployment.
|
|
4682
|
+
*
|
|
4683
|
+
* @remarks
|
|
4684
|
+
* Queries the directories in the current workspace that can be used to create code package agents or switch runtime environments. Runtime environments are dynamically provided based on the current version configuration, and internal image addresses are not returned.
|
|
4685
|
+
* If maxResults is omitted or set to 0, the default value is 10. If the value is greater than 100, it is processed as 100. Omit nextToken in the first request. For subsequent requests, use the token returned in the previous response as is, and keep the workspace unchanged. If a directory change invalidates the token, query from the first page again. An empty nextToken indicates that there are no more pages. Existing agents continue to use the saved images for restarts, scaling, and regular updates.
|
|
4686
|
+
*
|
|
4687
|
+
* @param request - ListAgentCodeRuntimesRequest
|
|
4688
|
+
* @returns ListAgentCodeRuntimesResponse
|
|
4689
|
+
*/
|
|
4690
|
+
async listAgentCodeRuntimes(workspaceId: string, request: $_model.ListAgentCodeRuntimesRequest): Promise<$_model.ListAgentCodeRuntimesResponse> {
|
|
4691
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
4692
|
+
let headers : {[key: string ]: string} = { };
|
|
4693
|
+
return await this.listAgentCodeRuntimesWithOptions(workspaceId, request, headers, runtime);
|
|
4694
|
+
}
|
|
4695
|
+
|
|
4051
4696
|
/**
|
|
4052
4697
|
* Queries the list of IM channels for a specified agent.
|
|
4053
4698
|
*
|
|
@@ -4429,12 +5074,12 @@ export default class Client extends OpenApi {
|
|
|
4429
5074
|
}
|
|
4430
5075
|
|
|
4431
5076
|
/**
|
|
4432
|
-
*
|
|
5077
|
+
* Performs a paged query for paging through the custom agent summary in a specified workspace. For the complete configuration and the latest execute results, call GetCustomAgent.
|
|
4433
5078
|
*
|
|
4434
5079
|
* @remarks
|
|
4435
|
-
* The default value of maxResults is 20
|
|
4436
|
-
* Omit nextToken in the first request.
|
|
4437
|
-
* This operation returns the summaries of the current page and does not return the complete deployment
|
|
5080
|
+
* The default value of maxResults is 20 and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
|
|
5081
|
+
* Omit nextToken in the first request. For subsequent requests, pass the nextToken returned in the previous response as is and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. An empty token in the response indicates that there are no more pages.
|
|
5082
|
+
* This operation returns the summaries of the current page and does not return the complete deployment configurations or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId in items.
|
|
4438
5083
|
*
|
|
4439
5084
|
* @param request - ListCustomAgentsRequest
|
|
4440
5085
|
* @param headers - map
|
|
@@ -4471,12 +5116,12 @@ export default class Client extends OpenApi {
|
|
|
4471
5116
|
}
|
|
4472
5117
|
|
|
4473
5118
|
/**
|
|
4474
|
-
*
|
|
5119
|
+
* Performs a paged query for paging through the custom agent summary in a specified workspace. For the complete configuration and the latest execute results, call GetCustomAgent.
|
|
4475
5120
|
*
|
|
4476
5121
|
* @remarks
|
|
4477
|
-
* The default value of maxResults is 20
|
|
4478
|
-
* Omit nextToken in the first request.
|
|
4479
|
-
* This operation returns the summaries of the current page and does not return the complete deployment
|
|
5122
|
+
* The default value of maxResults is 20 and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
|
|
5123
|
+
* Omit nextToken in the first request. For subsequent requests, pass the nextToken returned in the previous response as is and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. An empty token in the response indicates that there are no more pages.
|
|
5124
|
+
* This operation returns the summaries of the current page and does not return the complete deployment configurations or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId in items.
|
|
4480
5125
|
*
|
|
4481
5126
|
* @param request - ListCustomAgentsRequest
|
|
4482
5127
|
* @returns ListCustomAgentsResponse
|
|
@@ -4542,9 +5187,98 @@ export default class Client extends OpenApi {
|
|
|
4542
5187
|
return await this.listExternalAgentsWithOptions(workspaceId, request, headers, runtime);
|
|
4543
5188
|
}
|
|
4544
5189
|
|
|
5190
|
+
/**
|
|
5191
|
+
* Queries the departments of an identity provider by page.
|
|
5192
|
+
*
|
|
5193
|
+
* @remarks
|
|
5194
|
+
* Queries DingTalk or Feishu departments by hierarchy and page. Prerequisites include a bound identity provider, a user pool, valid application credentials, and address book read authorization. If you do not specify parentDepartmentId, the root hierarchy is queried. When expanding a node, specify the ID of the node to query its direct child departments. The hasChildren field indicates whether the node can be expanded and does not mean that child nodes are returned. The nextToken field is used only to query the next page of child departments under the current parent department. This query only reads the directory. It does not save the synchronization scope or import users. If a new department is added to a DingTalk or Feishu organization, re-query the corresponding parent department because the previous list does not reflect the latest directory.\\n\\nAuthorization information: The RAM action is agentcore:ListIdentityProviderDepartments, the access level is List, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is required for authorization.\\n\\nIdempotency and retry: This operation is read-only and can be called repeatedly.\\n\\nCalling this API is free of charge. Operation records support ActionTrail auditing.\\n\\nResponse example:\\n```json\\n{\\n "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",\\n "message": "success",\\n "httpStatusCode": 200,\\n "code": "SUCCESS",\\n "success": true,\\n "maxResults": 50,\\n "nextToken": "",\\n "items": [\\n {\\n "id": "10001",\\n "name": "R&D Department",\\n "parentId": "1",\\n "memberCount": 12,\\n "hasChildren": true\\n }\\n ]\\n}\\n```
|
|
5195
|
+
*
|
|
5196
|
+
* @param request - ListIdentityProviderDepartmentsRequest
|
|
5197
|
+
* @param headers - map
|
|
5198
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
5199
|
+
* @returns ListIdentityProviderDepartmentsResponse
|
|
5200
|
+
*/
|
|
5201
|
+
async listIdentityProviderDepartmentsWithOptions(workspaceId: string, identityProviderType: string, request: $_model.ListIdentityProviderDepartmentsRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.ListIdentityProviderDepartmentsResponse> {
|
|
5202
|
+
request.validate();
|
|
5203
|
+
let query : {[key: string ]: any} = { };
|
|
5204
|
+
if (!$dara.isNull(request.maxResults)) {
|
|
5205
|
+
query["maxResults"] = request.maxResults;
|
|
5206
|
+
}
|
|
5207
|
+
|
|
5208
|
+
if (!$dara.isNull(request.nextToken)) {
|
|
5209
|
+
query["nextToken"] = request.nextToken;
|
|
5210
|
+
}
|
|
5211
|
+
|
|
5212
|
+
if (!$dara.isNull(request.parentDepartmentId)) {
|
|
5213
|
+
query["parentDepartmentId"] = request.parentDepartmentId;
|
|
5214
|
+
}
|
|
5215
|
+
|
|
5216
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
5217
|
+
headers: headers,
|
|
5218
|
+
query: OpenApiUtil.query(query),
|
|
5219
|
+
});
|
|
5220
|
+
let params = new $OpenApiUtil.Params({
|
|
5221
|
+
action: "ListIdentityProviderDepartments",
|
|
5222
|
+
version: "2026-08-04",
|
|
5223
|
+
protocol: "HTTPS",
|
|
5224
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}/departments`,
|
|
5225
|
+
method: "GET",
|
|
5226
|
+
authType: "AK",
|
|
5227
|
+
style: "ROA",
|
|
5228
|
+
reqBodyType: "json",
|
|
5229
|
+
bodyType: "json",
|
|
5230
|
+
});
|
|
5231
|
+
return $dara.cast<$_model.ListIdentityProviderDepartmentsResponse>(await this.callApi(params, req, runtime), new $_model.ListIdentityProviderDepartmentsResponse({}));
|
|
5232
|
+
}
|
|
5233
|
+
|
|
5234
|
+
/**
|
|
5235
|
+
* Queries the departments of an identity provider by page.
|
|
5236
|
+
*
|
|
5237
|
+
* @remarks
|
|
5238
|
+
* Queries DingTalk or Feishu departments by hierarchy and page. Prerequisites include a bound identity provider, a user pool, valid application credentials, and address book read authorization. If you do not specify parentDepartmentId, the root hierarchy is queried. When expanding a node, specify the ID of the node to query its direct child departments. The hasChildren field indicates whether the node can be expanded and does not mean that child nodes are returned. The nextToken field is used only to query the next page of child departments under the current parent department. This query only reads the directory. It does not save the synchronization scope or import users. If a new department is added to a DingTalk or Feishu organization, re-query the corresponding parent department because the previous list does not reflect the latest directory.\\n\\nAuthorization information: The RAM action is agentcore:ListIdentityProviderDepartments, the access level is List, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is required for authorization.\\n\\nIdempotency and retry: This operation is read-only and can be called repeatedly.\\n\\nCalling this API is free of charge. Operation records support ActionTrail auditing.\\n\\nResponse example:\\n```json\\n{\\n "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",\\n "message": "success",\\n "httpStatusCode": 200,\\n "code": "SUCCESS",\\n "success": true,\\n "maxResults": 50,\\n "nextToken": "",\\n "items": [\\n {\\n "id": "10001",\\n "name": "R&D Department",\\n "parentId": "1",\\n "memberCount": 12,\\n "hasChildren": true\\n }\\n ]\\n}\\n```
|
|
5239
|
+
*
|
|
5240
|
+
* @param request - ListIdentityProviderDepartmentsRequest
|
|
5241
|
+
* @returns ListIdentityProviderDepartmentsResponse
|
|
5242
|
+
*/
|
|
5243
|
+
async listIdentityProviderDepartments(workspaceId: string, identityProviderType: string, request: $_model.ListIdentityProviderDepartmentsRequest): Promise<$_model.ListIdentityProviderDepartmentsResponse> {
|
|
5244
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
5245
|
+
let headers : {[key: string ]: string} = { };
|
|
5246
|
+
return await this.listIdentityProviderDepartmentsWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
5247
|
+
}
|
|
5248
|
+
|
|
4545
5249
|
/**
|
|
4546
5250
|
* Queries the external identity providers bound to a specified workspace. Each workspace can be bound to at most one external identity provider, so the response returns at most one record. Application secret configurations are not returned.
|
|
4547
5251
|
*
|
|
5252
|
+
* @remarks
|
|
5253
|
+
* ## Features and prerequisites
|
|
5254
|
+
* Returns the local binding summary without querying the actual SAML or SCIM configurations of AgentIdentity. If no binding exists, items is an empty array. A workspace currently supports only one external binding. The default value of maxResults is 10, and the valid range is 1 to 100. Currently, nextToken must be omitted or left empty. A non-empty value returns InvalidParameter, and fictitious multi-page results are not supported.
|
|
5255
|
+
* The status of CustomSSO indicates the task status of shared resources and logon configurations. You must check protocol and saml to determine whether SAML is configured. To query SCIM configurations, independently call GetIdentityProviderSCIM. The list operation does not issue tokens and does not return the vendor appSecret, encryptKey, or verificationToken.
|
|
5256
|
+
* ## Requests and examples
|
|
5257
|
+
* GET /workspaces/{workspaceId}/identity-providers
|
|
5258
|
+
* Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or Security Token Service (STS) token that has the required permissions on the identity source resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record secrets. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
5259
|
+
* ```text
|
|
5260
|
+
* GET /workspaces/ws-example/identity-providers?maxResults=10
|
|
5261
|
+
* ```
|
|
5262
|
+
* ## Response examples
|
|
5263
|
+
* ```json
|
|
5264
|
+
* {
|
|
5265
|
+
* "items": [
|
|
5266
|
+
* {
|
|
5267
|
+
* "workspaceId": "ws-example",
|
|
5268
|
+
* "identityProviderType": "CustomSSO",
|
|
5269
|
+
* "status": "READY",
|
|
5270
|
+
* "loginEnabled": false,
|
|
5271
|
+
* "syncEnabled": false
|
|
5272
|
+
* }
|
|
5273
|
+
* ],
|
|
5274
|
+
* "maxResults": 10,
|
|
5275
|
+
* "totalCount": 1
|
|
5276
|
+
* }
|
|
5277
|
+
* ```
|
|
5278
|
+
* ## Errors and handling
|
|
5279
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to upstream services that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
|
|
5280
|
+
* 400 InvalidParameter: maxResults is out of bounds, or nextToken is not empty, which is currently not supported. If a query fails, an error is displayed instead of resetting the status to unconfigured.
|
|
5281
|
+
*
|
|
4548
5282
|
* @param request - ListIdentityProvidersRequest
|
|
4549
5283
|
* @param headers - map
|
|
4550
5284
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4582,6 +5316,36 @@ export default class Client extends OpenApi {
|
|
|
4582
5316
|
/**
|
|
4583
5317
|
* Queries the external identity providers bound to a specified workspace. Each workspace can be bound to at most one external identity provider, so the response returns at most one record. Application secret configurations are not returned.
|
|
4584
5318
|
*
|
|
5319
|
+
* @remarks
|
|
5320
|
+
* ## Features and prerequisites
|
|
5321
|
+
* Returns the local binding summary without querying the actual SAML or SCIM configurations of AgentIdentity. If no binding exists, items is an empty array. A workspace currently supports only one external binding. The default value of maxResults is 10, and the valid range is 1 to 100. Currently, nextToken must be omitted or left empty. A non-empty value returns InvalidParameter, and fictitious multi-page results are not supported.
|
|
5322
|
+
* The status of CustomSSO indicates the task status of shared resources and logon configurations. You must check protocol and saml to determine whether SAML is configured. To query SCIM configurations, independently call GetIdentityProviderSCIM. The list operation does not issue tokens and does not return the vendor appSecret, encryptKey, or verificationToken.
|
|
5323
|
+
* ## Requests and examples
|
|
5324
|
+
* GET /workspaces/{workspaceId}/identity-providers
|
|
5325
|
+
* Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or Security Token Service (STS) token that has the required permissions on the identity source resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record secrets. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
5326
|
+
* ```text
|
|
5327
|
+
* GET /workspaces/ws-example/identity-providers?maxResults=10
|
|
5328
|
+
* ```
|
|
5329
|
+
* ## Response examples
|
|
5330
|
+
* ```json
|
|
5331
|
+
* {
|
|
5332
|
+
* "items": [
|
|
5333
|
+
* {
|
|
5334
|
+
* "workspaceId": "ws-example",
|
|
5335
|
+
* "identityProviderType": "CustomSSO",
|
|
5336
|
+
* "status": "READY",
|
|
5337
|
+
* "loginEnabled": false,
|
|
5338
|
+
* "syncEnabled": false
|
|
5339
|
+
* }
|
|
5340
|
+
* ],
|
|
5341
|
+
* "maxResults": 10,
|
|
5342
|
+
* "totalCount": 1
|
|
5343
|
+
* }
|
|
5344
|
+
* ```
|
|
5345
|
+
* ## Errors and handling
|
|
5346
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to upstream services that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
|
|
5347
|
+
* 400 InvalidParameter: maxResults is out of bounds, or nextToken is not empty, which is currently not supported. If a query fails, an error is displayed instead of resetting the status to unconfigured.
|
|
5348
|
+
*
|
|
4585
5349
|
* @param request - ListIdentityProvidersRequest
|
|
4586
5350
|
* @returns ListIdentityProvidersResponse
|
|
4587
5351
|
*/
|
|
@@ -4943,10 +5707,10 @@ export default class Client extends OpenApi {
|
|
|
4943
5707
|
}
|
|
4944
5708
|
|
|
4945
5709
|
/**
|
|
4946
|
-
* Performs a paged query on long-term memory.
|
|
5710
|
+
* Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
|
|
4947
5711
|
*
|
|
4948
5712
|
* @remarks
|
|
4949
|
-
* Performs a paged query on long-term memory.
|
|
5713
|
+
* Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
|
|
4950
5714
|
*
|
|
4951
5715
|
* @param request - ListMemoriesRequest
|
|
4952
5716
|
* @param headers - map
|
|
@@ -4995,10 +5759,10 @@ export default class Client extends OpenApi {
|
|
|
4995
5759
|
}
|
|
4996
5760
|
|
|
4997
5761
|
/**
|
|
4998
|
-
* Performs a paged query on long-term memory.
|
|
5762
|
+
* Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
|
|
4999
5763
|
*
|
|
5000
5764
|
* @remarks
|
|
5001
|
-
* Performs a paged query on long-term memory.
|
|
5765
|
+
* Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
|
|
5002
5766
|
*
|
|
5003
5767
|
* @param request - ListMemoriesRequest
|
|
5004
5768
|
* @returns ListMemoriesResponse
|
|
@@ -5010,10 +5774,10 @@ export default class Client extends OpenApi {
|
|
|
5010
5774
|
}
|
|
5011
5775
|
|
|
5012
5776
|
/**
|
|
5013
|
-
* Performs a
|
|
5777
|
+
* Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
|
|
5014
5778
|
*
|
|
5015
5779
|
* @remarks
|
|
5016
|
-
* Performs a
|
|
5780
|
+
* Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
|
|
5017
5781
|
*
|
|
5018
5782
|
* @param request - ListMemorySessionMessagesRequest
|
|
5019
5783
|
* @param headers - map
|
|
@@ -5062,10 +5826,10 @@ export default class Client extends OpenApi {
|
|
|
5062
5826
|
}
|
|
5063
5827
|
|
|
5064
5828
|
/**
|
|
5065
|
-
* Performs a
|
|
5829
|
+
* Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
|
|
5066
5830
|
*
|
|
5067
5831
|
* @remarks
|
|
5068
|
-
* Performs a
|
|
5832
|
+
* Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
|
|
5069
5833
|
*
|
|
5070
5834
|
* @param request - ListMemorySessionMessagesRequest
|
|
5071
5835
|
* @returns ListMemorySessionMessagesResponse
|
|
@@ -5077,10 +5841,10 @@ export default class Client extends OpenApi {
|
|
|
5077
5841
|
}
|
|
5078
5842
|
|
|
5079
5843
|
/**
|
|
5080
|
-
* Performs a paging query for sessions in a MemoryStore
|
|
5844
|
+
* Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
|
|
5081
5845
|
*
|
|
5082
5846
|
* @remarks
|
|
5083
|
-
* Performs a paging query for sessions in a MemoryStore
|
|
5847
|
+
* Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
|
|
5084
5848
|
*
|
|
5085
5849
|
* @param request - ListMemorySessionsRequest
|
|
5086
5850
|
* @param headers - map
|
|
@@ -5125,10 +5889,10 @@ export default class Client extends OpenApi {
|
|
|
5125
5889
|
}
|
|
5126
5890
|
|
|
5127
5891
|
/**
|
|
5128
|
-
* Performs a paging query for sessions in a MemoryStore
|
|
5892
|
+
* Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
|
|
5129
5893
|
*
|
|
5130
5894
|
* @remarks
|
|
5131
|
-
* Performs a paging query for sessions in a MemoryStore
|
|
5895
|
+
* Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
|
|
5132
5896
|
*
|
|
5133
5897
|
* @param request - ListMemorySessionsRequest
|
|
5134
5898
|
* @returns ListMemorySessionsResponse
|
|
@@ -5140,10 +5904,10 @@ export default class Client extends OpenApi {
|
|
|
5140
5904
|
}
|
|
5141
5905
|
|
|
5142
5906
|
/**
|
|
5143
|
-
*
|
|
5907
|
+
* Performs a paged query for MemoryStores in a specified workspace with paging.
|
|
5144
5908
|
*
|
|
5145
5909
|
* @remarks
|
|
5146
|
-
*
|
|
5910
|
+
* Performs a paged query for MemoryStores in a specified workspace with paging.
|
|
5147
5911
|
*
|
|
5148
5912
|
* @param request - ListMemoryStoresRequest
|
|
5149
5913
|
* @param headers - map
|
|
@@ -5180,10 +5944,10 @@ export default class Client extends OpenApi {
|
|
|
5180
5944
|
}
|
|
5181
5945
|
|
|
5182
5946
|
/**
|
|
5183
|
-
*
|
|
5947
|
+
* Performs a paged query for MemoryStores in a specified workspace with paging.
|
|
5184
5948
|
*
|
|
5185
5949
|
* @remarks
|
|
5186
|
-
*
|
|
5950
|
+
* Performs a paged query for MemoryStores in a specified workspace with paging.
|
|
5187
5951
|
*
|
|
5188
5952
|
* @param request - ListMemoryStoresRequest
|
|
5189
5953
|
* @returns ListMemoryStoresResponse
|
|
@@ -6334,10 +7098,10 @@ export default class Client extends OpenApi {
|
|
|
6334
7098
|
}
|
|
6335
7099
|
|
|
6336
7100
|
/**
|
|
6337
|
-
* Retrieves long-term memory from a MemoryStore based on semantics
|
|
7101
|
+
* Retrieves long-term memory from a MemoryStore based on semantics.
|
|
6338
7102
|
*
|
|
6339
7103
|
* @remarks
|
|
6340
|
-
* Retrieves long-term memory from a MemoryStore based on semantics
|
|
7104
|
+
* Retrieves long-term memory from a MemoryStore based on semantics.
|
|
6341
7105
|
*
|
|
6342
7106
|
* @param tmpReq - SearchMemoriesRequest
|
|
6343
7107
|
* @param headers - map
|
|
@@ -6376,10 +7140,10 @@ export default class Client extends OpenApi {
|
|
|
6376
7140
|
}
|
|
6377
7141
|
|
|
6378
7142
|
/**
|
|
6379
|
-
* Retrieves long-term memory from a MemoryStore based on semantics
|
|
7143
|
+
* Retrieves long-term memory from a MemoryStore based on semantics.
|
|
6380
7144
|
*
|
|
6381
7145
|
* @remarks
|
|
6382
|
-
* Retrieves long-term memory from a MemoryStore based on semantics
|
|
7146
|
+
* Retrieves long-term memory from a MemoryStore based on semantics.
|
|
6383
7147
|
*
|
|
6384
7148
|
* @param request - SearchMemoriesRequest
|
|
6385
7149
|
* @returns SearchMemoriesResponse
|
|
@@ -6817,10 +7581,12 @@ export default class Client extends OpenApi {
|
|
|
6817
7581
|
* Updates the configuration of a specified custom agent in a workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call the GetCustomAgent operation to query the update result.
|
|
6818
7582
|
*
|
|
6819
7583
|
* @remarks
|
|
6820
|
-
*
|
|
6821
|
-
* When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field.
|
|
6822
|
-
*
|
|
6823
|
-
* The
|
|
7584
|
+
* Provide at least one top-level field to update. Omitted top-level fields retain their original configurations. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
|
|
7585
|
+
* When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field.
|
|
7586
|
+
* In code package pattern, specify artifact.port and the sourceUri, languageRuntime, and entrypoint fields of artifact.code. Do not specify the container field at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported, and the compressed package size cannot exceed 500,000,000 bytes. Query the runtime environment identity by calling the ListAgentCodeRuntimes operation. The sourceUri field supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, first call the GetAgentCodePackageUploadUrl operation to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
7587
|
+
* When submitting a new code package source, the backend rechecks read permissions, objects, and sizes. The configuration is saved only after the transfer succeeds. If the transfer fails, the current configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not indicate that the agent is ready to run.
|
|
7588
|
+
* When providing the runtime field, the compute and sessionPolicy fields must be provided at the same time. If the hpa field or its subfields are omitted, unspecified elastic configurations use default values. To retain the original elastic configurations, provide them together. When providing the network field, omitted access items are treated as allowed, but actual access is still restricted by the workspace network configurations. To retain the original restrictions, provide both accessInternet and accessVpc. When providing the healthCheck field, the port field is required, and other unspecified items use default values. When providing the logging.sls field, both project and logstore must be specified.
|
|
7589
|
+
* The update is an asynchronous process. A successful response indicates that the request is accepted. Call the GetCustomAgent operation to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
|
|
6824
7590
|
* The clientToken field currently does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold field for health checks currently does not take effect. Omit this field.
|
|
6825
7591
|
*
|
|
6826
7592
|
* @param tmpReq - UpdateCustomAgentRequest
|
|
@@ -6869,10 +7635,12 @@ export default class Client extends OpenApi {
|
|
|
6869
7635
|
* Updates the configuration of a specified custom agent in a workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call the GetCustomAgent operation to query the update result.
|
|
6870
7636
|
*
|
|
6871
7637
|
* @remarks
|
|
6872
|
-
*
|
|
6873
|
-
* When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field.
|
|
6874
|
-
*
|
|
6875
|
-
* The
|
|
7638
|
+
* Provide at least one top-level field to update. Omitted top-level fields retain their original configurations. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
|
|
7639
|
+
* When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field.
|
|
7640
|
+
* In code package pattern, specify artifact.port and the sourceUri, languageRuntime, and entrypoint fields of artifact.code. Do not specify the container field at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported, and the compressed package size cannot exceed 500,000,000 bytes. Query the runtime environment identity by calling the ListAgentCodeRuntimes operation. The sourceUri field supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, first call the GetAgentCodePackageUploadUrl operation to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
7641
|
+
* When submitting a new code package source, the backend rechecks read permissions, objects, and sizes. The configuration is saved only after the transfer succeeds. If the transfer fails, the current configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not indicate that the agent is ready to run.
|
|
7642
|
+
* When providing the runtime field, the compute and sessionPolicy fields must be provided at the same time. If the hpa field or its subfields are omitted, unspecified elastic configurations use default values. To retain the original elastic configurations, provide them together. When providing the network field, omitted access items are treated as allowed, but actual access is still restricted by the workspace network configurations. To retain the original restrictions, provide both accessInternet and accessVpc. When providing the healthCheck field, the port field is required, and other unspecified items use default values. When providing the logging.sls field, both project and logstore must be specified.
|
|
7643
|
+
* The update is an asynchronous process. A successful response indicates that the request is accepted. Call the GetCustomAgent operation to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
|
|
6876
7644
|
* The clientToken field currently does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold field for health checks currently does not take effect. Omit this field.
|
|
6877
7645
|
*
|
|
6878
7646
|
* @param request - UpdateCustomAgentRequest
|
|
@@ -6948,7 +7716,49 @@ export default class Client extends OpenApi {
|
|
|
6948
7716
|
}
|
|
6949
7717
|
|
|
6950
7718
|
/**
|
|
6951
|
-
* Updates the
|
|
7719
|
+
* Updates the logon switch, member synchronization switch, or application configuration of a specified external identity provider for a workspace. Unspecified properties remain unchanged. The update is an asynchronous operation. After the API returns, you can call GetIdentityProvider to query the status and track the progress.
|
|
7720
|
+
*
|
|
7721
|
+
* @remarks
|
|
7722
|
+
* ## Features and prerequisites
|
|
7723
|
+
* CustomSSO uses protocol=SAML and saml to save logon configurations. It does not accept legacy metadata or syncEnabled. To toggle the SCIM switch, you must call UpdateIdentityProviderSCIM. OIDC is not supported. You can either import XML or manually enter fields. If you import XML, metadataXml must be a single IdP EntityDescriptor XML text of up to 1 MiB. URLs or file paths are not accepted, and DTDs or external entities are prohibited. If you manually enter fields, you must provide entityId, loginUrl, bindingType, and a non-empty x509Certificates array at the same time. The entityId must be non-empty and up to 2,048 characters in length, and cannot be replaced after configuration. The loginUrl must be an absolute HTTPS URL without user credentials or fragments. The bindingType must be HTTP-Redirect or HTTP-POST. Signing certificates must be valid X.509 certificates, and up to 10 certificates are supported.
|
|
7724
|
+
* Saving the configuration does not automatically enable logon. A valid SAML configuration must exist before you enable logon. Setting loginEnabled=false only disables logon and does not clear SAML or SCIM configurations. You can independently pass Boolean values for jitProvisionEnabled and jitUpdateEnabled. If omitted, the existing values are retained. If omitted for the first time, the default value is false. Updating only the JIT switches also requires a valid SAML configuration. If the request is unchanged, the current binding may be returned directly without generating a new task. A successful update returns UPDATING. You can call GetIdentityProvider and wait for READY or UPDATE_FAILED. If the update fails, you can resubmit the request. An HTTP success response does not indicate that the upstream configuration has taken effect.
|
|
7725
|
+
* DingTalk and Feishu continue to use vendor metadata and logon or synchronization switches. They do not accept protocol or saml. Updating vendor metadata supports partial updates. You only need to submit the fields to be modified. Unsubmitted fields and saved credentials remain unchanged. The server merges the new and old values and then validates the complete configuration. Explicitly submitted fields cannot be null, empty strings, or blank strings. For example, you can submit only appSecret to update the secret. The existing vendor semantics of syncScope are retained. Saving the scope does not automatically trigger full synchronization.
|
|
7726
|
+
* ## Request and examples
|
|
7727
|
+
* PUT /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
7728
|
+
* Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
7729
|
+
* ```text
|
|
7730
|
+
* PUT /workspaces/ws-example/identity-providers/CustomSSO
|
|
7731
|
+
* {
|
|
7732
|
+
* "protocol": "SAML",
|
|
7733
|
+
* "saml": {
|
|
7734
|
+
* "entityId": "https://idp.example.com/entity",
|
|
7735
|
+
* "loginUrl": "https://idp.example.com/sso",
|
|
7736
|
+
* "bindingType": "HTTP-Redirect",
|
|
7737
|
+
* "x509Certificates": [
|
|
7738
|
+
* "<Valid PEM X.509 certificate text>"
|
|
7739
|
+
* ],
|
|
7740
|
+
* "jitProvisionEnabled": false,
|
|
7741
|
+
* "jitUpdateEnabled": false
|
|
7742
|
+
* }
|
|
7743
|
+
* }
|
|
7744
|
+
* Toggle logon only: {"loginEnabled": true}
|
|
7745
|
+
* ```
|
|
7746
|
+
* ## Response example
|
|
7747
|
+
* ```json
|
|
7748
|
+
* {
|
|
7749
|
+
* "data": {
|
|
7750
|
+
* "workspaceId": "ws-example",
|
|
7751
|
+
* "identityProviderType": "CustomSSO",
|
|
7752
|
+
* "protocol": "SAML",
|
|
7753
|
+
* "loginEnabled": false,
|
|
7754
|
+
* "syncEnabled": false,
|
|
7755
|
+
* "status": "UPDATING"
|
|
7756
|
+
* }
|
|
7757
|
+
* }
|
|
7758
|
+
* ```
|
|
7759
|
+
* ## Errors and handling
|
|
7760
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to the upstream may return 503 IdentityProviderProvisioningUnavailable if they fail. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
|
|
7761
|
+
* 400 InvalidParameter: XML and manual entry are mixed, manual entry items are missing, certificates are invalid, the protocol is not supported, entityId is changed, logon is enabled without configuration, or CustomSSO submits metadata or syncEnabled. 409 IdentityProviderOperationConflict: The current binding does not allow updates. CustomSSO supports resubmitting configurations from UPDATE_FAILED.
|
|
6952
7762
|
*
|
|
6953
7763
|
* @param tmpReq - UpdateIdentityProviderRequest
|
|
6954
7764
|
* @param headers - map
|
|
@@ -6987,7 +7797,49 @@ export default class Client extends OpenApi {
|
|
|
6987
7797
|
}
|
|
6988
7798
|
|
|
6989
7799
|
/**
|
|
6990
|
-
* Updates the
|
|
7800
|
+
* Updates the logon switch, member synchronization switch, or application configuration of a specified external identity provider for a workspace. Unspecified properties remain unchanged. The update is an asynchronous operation. After the API returns, you can call GetIdentityProvider to query the status and track the progress.
|
|
7801
|
+
*
|
|
7802
|
+
* @remarks
|
|
7803
|
+
* ## Features and prerequisites
|
|
7804
|
+
* CustomSSO uses protocol=SAML and saml to save logon configurations. It does not accept legacy metadata or syncEnabled. To toggle the SCIM switch, you must call UpdateIdentityProviderSCIM. OIDC is not supported. You can either import XML or manually enter fields. If you import XML, metadataXml must be a single IdP EntityDescriptor XML text of up to 1 MiB. URLs or file paths are not accepted, and DTDs or external entities are prohibited. If you manually enter fields, you must provide entityId, loginUrl, bindingType, and a non-empty x509Certificates array at the same time. The entityId must be non-empty and up to 2,048 characters in length, and cannot be replaced after configuration. The loginUrl must be an absolute HTTPS URL without user credentials or fragments. The bindingType must be HTTP-Redirect or HTTP-POST. Signing certificates must be valid X.509 certificates, and up to 10 certificates are supported.
|
|
7805
|
+
* Saving the configuration does not automatically enable logon. A valid SAML configuration must exist before you enable logon. Setting loginEnabled=false only disables logon and does not clear SAML or SCIM configurations. You can independently pass Boolean values for jitProvisionEnabled and jitUpdateEnabled. If omitted, the existing values are retained. If omitted for the first time, the default value is false. Updating only the JIT switches also requires a valid SAML configuration. If the request is unchanged, the current binding may be returned directly without generating a new task. A successful update returns UPDATING. You can call GetIdentityProvider and wait for READY or UPDATE_FAILED. If the update fails, you can resubmit the request. An HTTP success response does not indicate that the upstream configuration has taken effect.
|
|
7806
|
+
* DingTalk and Feishu continue to use vendor metadata and logon or synchronization switches. They do not accept protocol or saml. Updating vendor metadata supports partial updates. You only need to submit the fields to be modified. Unsubmitted fields and saved credentials remain unchanged. The server merges the new and old values and then validates the complete configuration. Explicitly submitted fields cannot be null, empty strings, or blank strings. For example, you can submit only appSecret to update the secret. The existing vendor semantics of syncScope are retained. Saving the scope does not automatically trigger full synchronization.
|
|
7807
|
+
* ## Request and examples
|
|
7808
|
+
* PUT /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
7809
|
+
* Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
7810
|
+
* ```text
|
|
7811
|
+
* PUT /workspaces/ws-example/identity-providers/CustomSSO
|
|
7812
|
+
* {
|
|
7813
|
+
* "protocol": "SAML",
|
|
7814
|
+
* "saml": {
|
|
7815
|
+
* "entityId": "https://idp.example.com/entity",
|
|
7816
|
+
* "loginUrl": "https://idp.example.com/sso",
|
|
7817
|
+
* "bindingType": "HTTP-Redirect",
|
|
7818
|
+
* "x509Certificates": [
|
|
7819
|
+
* "<Valid PEM X.509 certificate text>"
|
|
7820
|
+
* ],
|
|
7821
|
+
* "jitProvisionEnabled": false,
|
|
7822
|
+
* "jitUpdateEnabled": false
|
|
7823
|
+
* }
|
|
7824
|
+
* }
|
|
7825
|
+
* Toggle logon only: {"loginEnabled": true}
|
|
7826
|
+
* ```
|
|
7827
|
+
* ## Response example
|
|
7828
|
+
* ```json
|
|
7829
|
+
* {
|
|
7830
|
+
* "data": {
|
|
7831
|
+
* "workspaceId": "ws-example",
|
|
7832
|
+
* "identityProviderType": "CustomSSO",
|
|
7833
|
+
* "protocol": "SAML",
|
|
7834
|
+
* "loginEnabled": false,
|
|
7835
|
+
* "syncEnabled": false,
|
|
7836
|
+
* "status": "UPDATING"
|
|
7837
|
+
* }
|
|
7838
|
+
* }
|
|
7839
|
+
* ```
|
|
7840
|
+
* ## Errors and handling
|
|
7841
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to the upstream may return 503 IdentityProviderProvisioningUnavailable if they fail. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
|
|
7842
|
+
* 400 InvalidParameter: XML and manual entry are mixed, manual entry items are missing, certificates are invalid, the protocol is not supported, entityId is changed, logon is enabled without configuration, or CustomSSO submits metadata or syncEnabled. 409 IdentityProviderOperationConflict: The current binding does not allow updates. CustomSSO supports resubmitting configurations from UPDATE_FAILED.
|
|
6991
7843
|
*
|
|
6992
7844
|
* @param request - UpdateIdentityProviderRequest
|
|
6993
7845
|
* @returns UpdateIdentityProviderResponse
|
|
@@ -7188,10 +8040,10 @@ export default class Client extends OpenApi {
|
|
|
7188
8040
|
}
|
|
7189
8041
|
|
|
7190
8042
|
/**
|
|
7191
|
-
* Updates the long-term memory
|
|
8043
|
+
* Updates the text or metadata of a long-term memory based on the memory ID.
|
|
7192
8044
|
*
|
|
7193
8045
|
* @remarks
|
|
7194
|
-
* Updates the long-term memory
|
|
8046
|
+
* Updates the text or metadata of a long-term memory based on the memory ID.
|
|
7195
8047
|
*
|
|
7196
8048
|
* @param tmpReq - UpdateMemoryRequest
|
|
7197
8049
|
* @param headers - map
|
|
@@ -7230,10 +8082,10 @@ export default class Client extends OpenApi {
|
|
|
7230
8082
|
}
|
|
7231
8083
|
|
|
7232
8084
|
/**
|
|
7233
|
-
* Updates the long-term memory
|
|
8085
|
+
* Updates the text or metadata of a long-term memory based on the memory ID.
|
|
7234
8086
|
*
|
|
7235
8087
|
* @remarks
|
|
7236
|
-
* Updates the long-term memory
|
|
8088
|
+
* Updates the text or metadata of a long-term memory based on the memory ID.
|
|
7237
8089
|
*
|
|
7238
8090
|
* @param request - UpdateMemoryRequest
|
|
7239
8091
|
* @returns UpdateMemoryResponse
|
|
@@ -7903,6 +8755,116 @@ export default class Client extends OpenApi {
|
|
|
7903
8755
|
return await this.uploadSkillViaOssWithOptions(workspaceId, request, headers, runtime);
|
|
7904
8756
|
}
|
|
7905
8757
|
|
|
8758
|
+
/**
|
|
8759
|
+
* Validates the OSS code package source for an agent.
|
|
8760
|
+
*
|
|
8761
|
+
* @remarks
|
|
8762
|
+
* Uses the current workspace role to check whether the customer\\"s OSS object exists and is readable, and checks the file name extension and compressed size. Returns the sourceUri, file name, size, and format read in this request. The bucket and object key are passed separately, and HTTPS download URLs are not accepted.
|
|
8763
|
+
* The validation uses object metadata and read probing. It does not perform full downloads, transfers, or decompression, nor does it generate a SHA-256 hash. Passing the validation does not mean that the archive content is complete or can be started. When you submit a CreateCustomAgent or UpdateCustomAgent request, the system re-validates and transfers the package. You do not need to invoke this operation in advance as a prerequisite for submission.
|
|
8764
|
+
*
|
|
8765
|
+
* @param tmpReq - ValidateAgentCodePackageFromOssRequest
|
|
8766
|
+
* @param headers - map
|
|
8767
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
8768
|
+
* @returns ValidateAgentCodePackageFromOssResponse
|
|
8769
|
+
*/
|
|
8770
|
+
async validateAgentCodePackageFromOssWithOptions(workspaceId: string, tmpReq: $_model.ValidateAgentCodePackageFromOssRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.ValidateAgentCodePackageFromOssResponse> {
|
|
8771
|
+
tmpReq.validate();
|
|
8772
|
+
let request = new $_model.ValidateAgentCodePackageFromOssShrinkRequest({ });
|
|
8773
|
+
OpenApiUtil.convert(tmpReq, request);
|
|
8774
|
+
if (!$dara.isNull(tmpReq.body)) {
|
|
8775
|
+
request.bodyShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.body, "body", "json");
|
|
8776
|
+
}
|
|
8777
|
+
|
|
8778
|
+
let body : {[key: string ]: any} = { };
|
|
8779
|
+
if (!$dara.isNull(request.bodyShrink)) {
|
|
8780
|
+
body["body"] = request.bodyShrink;
|
|
8781
|
+
}
|
|
8782
|
+
|
|
8783
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
8784
|
+
headers: headers,
|
|
8785
|
+
body: OpenApiUtil.parseToMap(body),
|
|
8786
|
+
});
|
|
8787
|
+
let params = new $OpenApiUtil.Params({
|
|
8788
|
+
action: "ValidateAgentCodePackageFromOss",
|
|
8789
|
+
version: "2026-08-04",
|
|
8790
|
+
protocol: "HTTPS",
|
|
8791
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/agent-code-packages/validate-from-oss`,
|
|
8792
|
+
method: "POST",
|
|
8793
|
+
authType: "AK",
|
|
8794
|
+
style: "ROA",
|
|
8795
|
+
reqBodyType: "formData",
|
|
8796
|
+
bodyType: "json",
|
|
8797
|
+
});
|
|
8798
|
+
return $dara.cast<$_model.ValidateAgentCodePackageFromOssResponse>(await this.callApi(params, req, runtime), new $_model.ValidateAgentCodePackageFromOssResponse({}));
|
|
8799
|
+
}
|
|
8800
|
+
|
|
8801
|
+
/**
|
|
8802
|
+
* Validates the OSS code package source for an agent.
|
|
8803
|
+
*
|
|
8804
|
+
* @remarks
|
|
8805
|
+
* Uses the current workspace role to check whether the customer\\"s OSS object exists and is readable, and checks the file name extension and compressed size. Returns the sourceUri, file name, size, and format read in this request. The bucket and object key are passed separately, and HTTPS download URLs are not accepted.
|
|
8806
|
+
* The validation uses object metadata and read probing. It does not perform full downloads, transfers, or decompression, nor does it generate a SHA-256 hash. Passing the validation does not mean that the archive content is complete or can be started. When you submit a CreateCustomAgent or UpdateCustomAgent request, the system re-validates and transfers the package. You do not need to invoke this operation in advance as a prerequisite for submission.
|
|
8807
|
+
*
|
|
8808
|
+
* @param request - ValidateAgentCodePackageFromOssRequest
|
|
8809
|
+
* @returns ValidateAgentCodePackageFromOssResponse
|
|
8810
|
+
*/
|
|
8811
|
+
async validateAgentCodePackageFromOss(workspaceId: string, request: $_model.ValidateAgentCodePackageFromOssRequest): Promise<$_model.ValidateAgentCodePackageFromOssResponse> {
|
|
8812
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
8813
|
+
let headers : {[key: string ]: string} = { };
|
|
8814
|
+
return await this.validateAgentCodePackageFromOssWithOptions(workspaceId, request, headers, runtime);
|
|
8815
|
+
}
|
|
8816
|
+
|
|
8817
|
+
/**
|
|
8818
|
+
* 检查智能体代码包 OSS RAM 授权状态
|
|
8819
|
+
*
|
|
8820
|
+
* @remarks
|
|
8821
|
+
* 检查当前 Workspace 角色是否绑定所选源 Bucket 对应的自定义 RAM 策略,复用已有挂载授权。仅返回策略绑定状态,不验证代码包存在或可读、不修改默认桶。授权状态不能替代 ValidateAgentCodePackageFromOss 的实际对象读取校验。
|
|
8822
|
+
*
|
|
8823
|
+
* @param request - VerifyAgentCodePackageOssRamAuthorizationRequest
|
|
8824
|
+
* @param headers - map
|
|
8825
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
8826
|
+
* @returns VerifyAgentCodePackageOssRamAuthorizationResponse
|
|
8827
|
+
*/
|
|
8828
|
+
async verifyAgentCodePackageOssRamAuthorizationWithOptions(workspaceId: string, request: $_model.VerifyAgentCodePackageOssRamAuthorizationRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.VerifyAgentCodePackageOssRamAuthorizationResponse> {
|
|
8829
|
+
request.validate();
|
|
8830
|
+
let query : {[key: string ]: any} = { };
|
|
8831
|
+
if (!$dara.isNull(request.ossBucketName)) {
|
|
8832
|
+
query["ossBucketName"] = request.ossBucketName;
|
|
8833
|
+
}
|
|
8834
|
+
|
|
8835
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
8836
|
+
headers: headers,
|
|
8837
|
+
query: OpenApiUtil.query(query),
|
|
8838
|
+
});
|
|
8839
|
+
let params = new $OpenApiUtil.Params({
|
|
8840
|
+
action: "VerifyAgentCodePackageOssRamAuthorization",
|
|
8841
|
+
version: "2026-08-04",
|
|
8842
|
+
protocol: "HTTPS",
|
|
8843
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/agent-code-packages/oss/authorize/verify`,
|
|
8844
|
+
method: "POST",
|
|
8845
|
+
authType: "AK",
|
|
8846
|
+
style: "ROA",
|
|
8847
|
+
reqBodyType: "json",
|
|
8848
|
+
bodyType: "json",
|
|
8849
|
+
});
|
|
8850
|
+
return $dara.cast<$_model.VerifyAgentCodePackageOssRamAuthorizationResponse>(await this.callApi(params, req, runtime), new $_model.VerifyAgentCodePackageOssRamAuthorizationResponse({}));
|
|
8851
|
+
}
|
|
8852
|
+
|
|
8853
|
+
/**
|
|
8854
|
+
* 检查智能体代码包 OSS RAM 授权状态
|
|
8855
|
+
*
|
|
8856
|
+
* @remarks
|
|
8857
|
+
* 检查当前 Workspace 角色是否绑定所选源 Bucket 对应的自定义 RAM 策略,复用已有挂载授权。仅返回策略绑定状态,不验证代码包存在或可读、不修改默认桶。授权状态不能替代 ValidateAgentCodePackageFromOss 的实际对象读取校验。
|
|
8858
|
+
*
|
|
8859
|
+
* @param request - VerifyAgentCodePackageOssRamAuthorizationRequest
|
|
8860
|
+
* @returns VerifyAgentCodePackageOssRamAuthorizationResponse
|
|
8861
|
+
*/
|
|
8862
|
+
async verifyAgentCodePackageOssRamAuthorization(workspaceId: string, request: $_model.VerifyAgentCodePackageOssRamAuthorizationRequest): Promise<$_model.VerifyAgentCodePackageOssRamAuthorizationResponse> {
|
|
8863
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
8864
|
+
let headers : {[key: string ]: string} = { };
|
|
8865
|
+
return await this.verifyAgentCodePackageOssRamAuthorizationWithOptions(workspaceId, request, headers, runtime);
|
|
8866
|
+
}
|
|
8867
|
+
|
|
7906
8868
|
/**
|
|
7907
8869
|
* Validates whether one or more Qoder Service Account Keys are available at a specified site. This operation does not save keys or modify the Connector status.
|
|
7908
8870
|
*
|