GetWorkspacePlugin

Updated at:
Copy as MD

Queries the activation status and configuration of a specified component in a workspace. The collaboration value corresponds to the Collaboration component displayed in the console.

Operation description

Queries the status and configuration of the collaboration component in a workspace to check whether the component is activated and whether the configuration takes effect.

To specify the collaboration component, set pluginName to collaboration. To activate the component, call InstallWorkspacePlugin.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

agentcore:GetWorkspacePlugin

get

*Workspace

acs:agentcore:{#regionId}:{#accountId}:workspace/{#WorkspaceId}

None None

Request syntax

GET /workspaces/{workspaceId}/plugins/{pluginName} HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

workspaceId

string

Yes

The workspace ID.

ws-123456

pluginName

string

Yes

The identifier of the workspace component. The value collaboration corresponds to the Collaboration component in the console. Other component identifiers retain their original values from the API parameter enumeration.

Valid values:

  • collaboration :

    Collaboration component.

  • agentloop :

    AgentLoop component.

collaboration

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element

Type

Description

Example

object

requestId

string

The request ID.

request-123456

message

string

The response message. An error description is returned if the request fails.

success

httpStatusCode

integer

The HTTP status code.

200

code

string

The business status code.

SUCCESS

success

boolean

Indicates whether the request is successful.

data

object

The component details.

workspaceId

string

The workspace ID.

ws-123456

pluginName

string

The component name.

Valid values:

  • collaboration :

    Collaboration component.

  • agentloop :

    AgentLoop component.

collaboration

enabled

boolean

Indicates whether the component is enabled. The value is true when the status is ENABLED.

status

string

The component status. Valid values: DISABLED, ENABLING, ENABLED, ENABLE_FAILED, DISABLING, and DISABLE_FAILED.

Valid values:

  • DISABLED :

    Not installed.

  • ENABLE_FAILED :

    Installation failed.

  • ENABLING :

    Installing.

  • ENABLED :

    Enabled.

  • DISABLING :

    Uninstalling.

  • DISABLE_FAILED :

    Uninstallation failed.

ENABLED

config

object

The user-configurable properties that currently take effect for the component. This field is empty when the component is not installed.

network

object

The network configuration of the component, including the public network access configuration and VPC configuration.

internet

object

The public network access configuration.

enabled

boolean

Indicates whether public network access is enabled.

true

vpc

object

The user VPC configuration.

enabled

boolean

Indicates whether the VPC network is currently enabled for the collaboration component.

true

vpcId

string

The ID of the VPC used for component deployment.

vpc-bp1example

vSwitchIds

array

The list of vSwitch IDs used for component deployment.

string

The vSwitch ID.

vsw-bp1234567890

agentLoop

object

The AgentLoop component configuration.

agentSpaceName

string

The name of the AgentSpace associated with the AgentLoop component.

agentcore-ws-123456

createdAt

string

The creation time of the AgentSpace, in UTC time formatted according to RFC 3339.

2026-08-12T03:04:05Z

regionId

string

The ID of the region where the AgentSpace is located.

cn-hangzhou

Examples

Success response

JSON format

{
  "requestId": "request-123456",
  "message": "success",
  "httpStatusCode": 200,
  "code": "SUCCESS",
  "success": false,
  "data": {
    "workspaceId": "ws-123456",
    "pluginName": "collaboration",
    "enabled": false,
    "status": "ENABLED",
    "config": {
      "network": {
        "internet": {
          "enabled": true
        },
        "vpc": {
          "enabled": true,
          "vpcId": "vpc-bp1example",
          "vSwitchIds": [
            "vsw-bp1234567890"
          ]
        }
      },
      "agentLoop": {
        "agentSpaceName": "agentcore-ws-123456",
        "createdAt": "2026-08-12T03:04:05Z",
        "regionId": "cn-hangzhou"
      }
    }
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter The specified request parameter is invalid.
400 PluginNotSupported The specified plugin is not supported.
404 Resource.NotFound The specified AgentCore workspace does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.