GetCoordinateTicket-阿里云帮助中心

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:GetCoordinateTicket

*All Resource

*

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
CoId	string	Yes	The ID of the stream collaboration. You can obtain the value of this parameter based on the value of `Coid` that is returned by the `ApplyCoordinationForMonitoring` operation.	co-0sot77uale3****
TaskId	string	No	The ID of the cloud computer connection task. The first time you initiate the request, you do not need to specify the ID of the cloud computer connection task. If no ticket is returned after you initiate the first request, you must specify the value of taskId that is returned for the first request in the subsequent request.	39cc15e5-6998-4b9f-9b2c-7a4cc3e2****
EndUserId	string	No	The name of the convenience user account. If you initiate the request as an administrator, you do not need to specify this parameter.	alice
UserType	string	Yes	The type of the user. Set the value to TENANT_ADMIN. The value of TENANT_ADMIN specifies an administrator. Valid values: TENANT_ADMIN :	TENANT_ADMIN

Response elements

Element	Type	Description	Example
	object
CoId	string	The ID of the stream collaboration.	co-0sot77uale3****
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TaskStatus	string	The task status. Possible values: Finished Failed Running Valid values: Finished : Finished Failed : Failed Running : Running	Finished
TaskId	string	The ID of the cloud computer connection task.	39cc15e5-6998-4b9f-9b2c-7a4cc3e2****
Ticket	string	The credentials of the stream collaboration.	W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********

Examples

Success response

JSON format

{
  "CoId": "co-0sot77uale3****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TaskStatus": "Finished",
  "TaskId": "39cc15e5-6998-4b9f-9b2c-7a4cc3e2****",
  "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.