GetExternalAgentBootstrapOptions
Queries the available internal and public network access options for a managed agent.
Operation description
Queries the available public and internal network access methods for a managed agent to select the network used for subsequent connections.
Prerequisites
The managed agent must be in the running state, and the latest desired configuration must be applied. If the configuration is still being created, updated, or not fully applied, query the status first by calling GetExternalAgent.
Select an access network
In the response, the networkType in networkOptions is INTRANET or INTERNET, and available indicates whether the corresponding access endpoint is available. Select a network with available set to true and call CreateExternalAgentBootstrapToken to obtain the corresponding access information.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
agentcore:GetExternalAgentBootstrapOptions |
none |
*ExternalAgent
|
None | None |
Request syntax
GET /workspaces/{workspaceId}/external-agents/{agentId}/bootstrap/options HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspaceId |
string |
Yes |
The workspace ID. |
ws-1 |
| agentId |
string |
Yes |
The ID of the managed agent. |
agent-1 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
No parameters required.
For the specific meanings and value requirements of request parameters, see the parameter descriptions below.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The success response for querying the access networks of a managed agent. |
||
| requestId |
string |
The request ID. |
1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| message |
string |
The request processing result message. |
success |
| httpStatusCode |
integer |
The HTTP status code. The value is 200 for a successful request. |
200 |
| code |
string |
The business status code. The value is SUCCESS for a successful request. |
SUCCESS |
| success |
boolean |
Indicates whether the request is successful. |
|
| data |
object |
The available access network information for the managed agent. |
|
| workspaceId |
string |
The workspace ID. |
ws-1 |
| agentId |
string |
The ID of the managed agent. |
agent-1 |
| networkOptions |
array<object> |
The list of available access networks. |
|
|
object |
The list of available access networks. |
||
| networkType |
string |
The access network type. Valid values: INTRANET (internal network) and INTERNET (public network). Valid values:
|
INTERNET |
| available |
boolean |
Indicates whether the access network is available. |
For the meanings of the fields in a successful response, see the response parameter descriptions below.
Examples
Success response
JSON format
{
"requestId": "1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"message": "success",
"httpStatusCode": 200,
"code": "SUCCESS",
"success": false,
"data": {
"workspaceId": "ws-1",
"agentId": "agent-1",
"networkOptions": [
{
"networkType": "INTERNET",
"available": false
}
]
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 404 | Resource.NotFound | The specified ExternalAgent does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.