GetAgent-阿里云帮助中心

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

rtc:GetAgent

none

*App

acs:rtc::{#accountId}:app/{#AppId}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	Application ID. You can create and view this ID in the console. Only one ID is supported.	aec****
ChannelId	string	No	Channel ID.	1234
TaskId	string	No	Task ID.	yourTaskId

Response elements

Element	Type	Description	Example
	object	Response schema.
RequestId	string	Request ID.	6159ba01-6687-4fb2-a831-f0cd8d188648
StartTime	string	Start timestamp, in Unix time, measured in milliseconds.	1751513144838
StopTime	string	End timestamp, in Unix time, measured in milliseconds.	1751513144838
Status	string	Agent status. Valid values: 0 (not started), 1 (starting), 2 (running), 3 (stopping), 4 (stopped), or 5 (failed).	1
Message	string	Status message.	Success

Examples

Success response

JSON format

{
  "RequestId": "6159ba01-6687-4fb2-a831-f0cd8d188648",
  "StartTime": "1751513144838",
  "StopTime": "1751513144838",
  "Status": "1",
  "Message": "Success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.