All Products
Search

This Product

    Elastic Desktop Service:ApplyCoordinationForMonitoring

    Document Center

    Elastic Desktop Service:ApplyCoordinationForMonitoring

    Last Updated:May 11, 2026

    Applies for coordination monitoring. This operation is mainly used in administrator assistance scenarios and education scenarios.

    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

    ecd:ApplyCoordinationForMonitoring

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    cn-hangzhou
    Uuid

    string

    Yes

    The universally unique identifier (UUID) of the device.

    3E14A18BD4D088504B9F8A8751AB****
    InitiatorType

    string

    No

    The type of the initiator.

    Set the value to ADMIN_INITIATE.

    • The value ADMIN_INITIATE specifies that the administrator initiates the coordination request.

    Valid values:

    • ADMIN_INITIATE :

    ADMIN_INITIATE
    CoordinatePolicyType

    string

    Yes

    The coordination policy.

    Set the value to FULL_CONTROL.

    • The value FULL_CONTROL specifies that the cloud desktop is shared and remote access to the cloud desktop is allowed.

    Valid values:

    • FULL_CONTROL :

    FULL_CONTROL
    ResourceCandidates

    array<object>

    Yes

    The list of cloud desktops that run the collaboration task at the same time.

    object

    No

    ResourceType

    string

    Yes

    The resource type.

    Set the value to CLOUD_DESKTOP.

    • The value CLOUD_DESKTOP specifies that the resource is a cloud desktop.

    Valid values:

    • CLOUD_DESKTOP :

    CLOUD_DESKTOP
    ResourceRegionId

    string

    Yes

    The region where the resource resides.

    cn-hangzhou
    ResourceProperties

    string

    No

    The properties of the cloud desktop.

    TestProperty
    OwnerEndUserId

    string

    No

    The ID of the current end user.

    alice
    ResourceId

    string

    Yes

    The ID of the cloud desktop.

    ecd-08zhejm3h7ilr****
    ResourceName

    string

    Yes

    The name of the cloud desktop.

    DemoComputer
    OwnerAliUid

    integer

    Yes

    The ID of the Alibaba Cloud account to which the current cloud desktop belongs.

    130247021517****
    EndUserId

    string

    No

    The ID of the end user who initiates the stream collaboration. If the initiator is the administrator, do not specify this parameter.

    alice

    Response elements

    Element

    Type

    Description

    Example

    object

    The information that is returned.

    RequestId

    string

    The request ID.

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    CoordinateFlowModels

    array<object>

    The list of stream collaboration models.

    object

    CoordinateStatus

    string

    The current status of the collaboration task.

    Valid values:

    • COORDINATING: The collaboration task is being executed.

    • TERMINATING: The collaboration task is being terminated.

    • TERMINATED: The collaboration task is terminated.

    • PENDING: The collaboration task is pending to be executed.

    Valid values:

    • COORDINATING :
    • TERMINATING :
    • TERMINATED :
    • PENDING :

    PENDING
    InitiatorType

    string

    The type of the initiator.

    Valid values:

    • ADMIN_INITIATE_FORCE: The administrator forcibly initiates the collaboration request.

    • ADMIN_INITIATE: The administrator initiates the collaboration request.

    • COORDINATOR_INITIATE_FORCE: The coordinator forcibly initiates the collaboration request.

    Valid values:

    • ADMIN_INITIATE_FORCE :
    • ADMIN_INITIATE :
    • COORDINATOR_INITIATE_FORCE :

    COORDINATOR_INITIATE_FORCE
    OwnerUserId

    string

    The ID of the Alibaba Cloud account of the end user.

    alice
    CoordinateTicket

    string

    The ticket that is used to establish the Adaptive Streaming Protocol (ASP)-based connection.

    1VDQ0VTUw0KW0Rlc2t0b3BdDQpHV1Rva2VuPTAwTzgwL3liS25zUEVGdkF6eU1Pc1ExeHZWdmk4VEE3NFJvU1V1d0dPYm1BNkNJWklDMHVNQklWcjU2NS80S0ZQekQ4aGFTR0ZHelZqMTFGbkRpWWgvUFF1Zm1xSXNGdFRFNFRWMExJNit3TkU0L2RMb04wNXBBSE5Tc3M4dWFXY3lwWE****
    CoId

    string

    The ID of the stream collaboration.

    co-0sot77uale3****
    ResourceId

    string

    The ID of the cloud desktop.

    ecd-96vi03f9emqnl****
    ResourceName

    string

    The name of the cloud desktop.

    DemoComputer

    Examples

    Success response

    JSON format

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "CoordinateFlowModels": [
    {
      "CoordinateStatus": "PENDING",
      "InitiatorType": "COORDINATOR_INITIATE_FORCE",
      "OwnerUserId": "alice",
      "CoordinateTicket": "1VDQ0VTUw0KW0Rlc2t0b3BdDQpHV1Rva2VuPTAwTzgwL3liS25zUEVGdkF6eU1Pc1ExeHZWdmk4VEE3NFJvU1V1d0dPYm1BNkNJWklDMHVNQklWcjU2NS80S0ZQekQ4aGFTR0ZHelZqMTFGbkRpWWgvUFF1Zm1xSXNGdFRFNFRWMExJNit3TkU0L2RMb04wNXBBSE5Tc3M4dWFXY3lwWE****",
      "CoId": "co-0sot77uale3****",
      "ResourceId": "ecd-96vi03f9emqnl****",
      "ResourceName": "DemoComputer"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.