ActivateEdgeMobileAgent - Cloud Phone - Alibaba Cloud Documentation Center

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
LicenseKey	string	Yes	The license key.	lic-ez197xvdf0j5eo0*****
DeviceClass	string	No	The device form factor. Valid values: BOX PHONE PAD OTHER	BOX
DeviceId	string	Yes	The unique identifier of the device.	sn-0001eevqa6jeapl*****
DeviceMeta	string	No	The extended device metadata in JSON format. The string contains information such as fingerprint, deviceModel, and firmwareVersion.	{"frmwareVersion": "1.0.0"}

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	5C5CEF0A-D6E1-58D3-8750-67DB4F82****
Data	object	The response data object.
DeviceId	string	The device ID.	sn-0001eevqa6jeapl*****
InstanceId	string	The EdgeMobile instance ID.	em-uto81vfd8t8z****
AuthToken	string	The assigned API key. The plaintext value is returned only upon the first activation.	cpk-81vfd8t8zdfxdf*****
Idempotent	boolean	Indicates whether the request is an idempotent duplicate request.	false

Examples

Success response

JSON format

{
  "RequestId": "5C5CEF0A-D6E1-58D3-8750-67DB4F82****",
  "Data": {
    "DeviceId": "sn-0001eevqa6jeapl*****",
    "InstanceId": "em-uto81vfd8t8z****",
    "AuthToken": "cpk-81vfd8t8zdfxdf*****",
    "Idempotent": false
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.