# Alibaba Cloud CloudPhone API > Alibaba Cloud CloudPhone API on Apizie: 138 endpoints (Activates an edge agent device, Attaches an Android Debug Bridge (ADB) key pair to one or more cloud phone instances, Authorize/unauthorize Android instances for users, Creates a full backup of a Cloud Phone instance. The backup includes installed applications and properties, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-eds-aic/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-eds-aic` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/eds-aic - Page: https://apizie.tech/api/cloud/aliyun-eds-aic - OpenAPI: https://apizie.tech/api/cloud/aliyun-eds-aic/openapi.json Alibaba Cloud OpenAPI for CloudPhone (eds-aic, version 2023-09-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Activates an edge agent device `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/activate-edge-mobile-agent` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | LicenseKey | string | yes | The license key | | DeviceClass | string | no | The device form factor. Valid values: BOX PHONE PAD OTHER | | DeviceId | string | yes | The unique identifier of the device | | DeviceMeta | string | no | The extended device metadata in JSON format. The string contains information such as fingerprint, deviceModel, and firmwareVersion | ### Attaches an Android Debug Bridge (ADB) key pair to one or more cloud phone instances `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/attach-key-pair` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | KeyPairId | string | yes | The ID of the ADB key pair | | InstanceIds | string | no | The IDs of the cloud phone instances. You can specify a maximum of 50 cloud phone instances (JSON-encoded) | ### Authorize/unauthorize Android instances for users `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/authorize-android-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIds | string | no | List of instance IDs (JSON-encoded) | | AuthorizeUserId | string | no | User ID to be assigned | | UnAuthorizeUserId | string | no | User ID to be unassigned | ### Creates a full backup of a Cloud Phone instance. The backup includes installed applications and properties `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/backup-android-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIdList | string | yes | A list of instance IDs (JSON-encoded) | | Description | string | no | The description of the full instance backup | | UploadEndpoint | string | yes | The region where the backup is stored | | BackupFilePath | string | yes | The upload URL for the backup file | | BackupFileName | string | no | The name of the backup file | ### Backs up specified applications on a cloud phone instance. The backup includes the application and its cache `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/backup-app` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIdList | string | yes | A list of instance IDs (JSON-encoded) | | Description | string | no | The description of the application backup | | UploadEndpoint | string | yes | Specifies the region where the backup is created | | BackupFilePath | string | yes | The URL of the backup file | | BackupFileName | string | no | The name of the backup file | | SourceAppList | string | yes | A list of package names for the applications to back up (JSON-encoded) | ### Generates a backup file and uploads it to remote storage. Scenarios: You can perform regular backups for… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/backup-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIdList | string | yes | The list of instance IDs (JSON-encoded) | | Description | string | no | The description of the backup file | | SourceFilePathList | string | no | The list of file paths to back up (JSON-encoded) | | SourceAppList | string | no | The list of application package names to back up (JSON-encoded) | | UploadType | string | no | The backup type | | UploadEndpoint | string | no | The domain name of the backup endpoint. If you upload the backup file to an OSS bucket, call the describeBuckets operation to obtain the… | | BackupFilePath | string | yes | The upload path of the backup file. If you upload the backup file to an OSS bucket, call the describeBuckets operation to obtain the… | | BackupFileName | string | no | The name of the backup file | | BackupAll | string | no | Specifies whether to back up the entire instance | | ExcludeSourceFilePathList | string | no | The list of file paths in the Android container to exclude from the backup (JSON-encoded) | ### Retrieves connection credentials in batches. This operation asynchronously generates tickets. In most cases,… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/batch-get-acp-connection-ticket` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceGroupId | string | no | The instance group ID | | InstanceIds | string | no | The list of Cloud Phone instance IDs. You can specify 1 to 100 IDs (JSON-encoded) | | EndUserId | string | no | The ID of the assigned user. If you do not specify this parameter, the system user assigned in the background is used to obtain the… | | ConnectionMode | string | no | The connection mode | | InstanceTasks | string | no | The instance connection tasks. This parameter is used to query whether the ticket retrieval task is completed (JSON-encoded) | | Ports | string | no | The list of custom connection ports (JSON-encoded) | ### Cancels running agent tasks on a mobile node `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/cancel-agent-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | TaskIds | string | yes | A list of task IDs (JSON-encoded) | ### Modifies the configuration of a cloud phone matrix. Currently, only the instance type and the number of… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/change-cloud-phone-node` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | NodeId | string | no | The ID of the cloud phone matrix | | InstanceType | string | no | The instance type | | PhoneCount | integer | no | The number of cloud phone instances. You can call the https://help.aliyun.com/document_detail/2807299.html operation to query the maximum… | | UpBandwidthLimit | integer | no | The upstream bandwidth throttling. Unit: Mbit/s | | DownBandwidthLimit | integer | no | The downstream bandwidth throttling. Unit: Mbit/s | | PhoneDataVolume | integer | no | The local storage size. Valid values: 10 to 4000. Unit: GiB. If this parameter is left empty, the original size is retained | | AutoPay | string | no | Specifies whether to enable automatic payment. Default value: false | | PromotionId | string | no | The ID of the promotion | | DisplayConfig | string | no | The display settings | | SwapSize | integer | no | The size of the swap space | | ShareDataVolume | integer | no | The size of the shared storage. Unit: GiB | ### Checks the inventory status of cloud phone resources. Before creating an instance, you can use this… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/check-resource-stock` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | yes | The region ID | | ZoneId | string | no | The zone to which the resource belongs | | AcpSpecId | string | no | The specification ID | | GpuAcceleration | string | no | Specifies whether to enable GPU acceleration | | Amount | integer | no | The number of cloud phone instances | ### Creates an AI cloud phone `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-aicloud-phone` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | Amount | integer | yes | The quantity to purchase | | BandwidthPackageId | string | yes | The bandwidth package ID | | BizRegionId | string | yes | The region ID for the purchase | | ImageId | string | yes | The image ID | | InstanceGroupName | string | yes | The instance group name | | InstanceGroupSpec | string | yes | The instance group specification. Valid values: STANDARD: standard. MEDIUM: advanced | | Period | integer | yes | The purchase duration | | PeriodUnit | string | yes | The unit of the purchase duration | | PolicyGroupId | string | no | The policy group ID | | PromotionId | string | no | The coupon ID | | AutoPay | string | no | Specifies whether to enable automatic payment | ### Creates a custom skill `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-agent-skill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | IconKey | string | no | The icon of the custom skill | | SkillName | string | no | The skill name | | SkillDescription | string | no | The skill description | | PackageOssKey | string | no | The OSS path of the skill package. This parameter is reserved by the system and does not need to be specified | | SkillPackageUrl | string | no | The OSS download URL of the skill package. This parameter is required for API calls | | FileList | string | no | The list of files in the skill package (JSON-encoded) | ### Creates a pay-as-you-go or subscription cloud phone instance group. An instance group can manage multiple… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-android-instance-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | yes | The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where cloud phones are… | | InstanceGroupName | string | no | The name of the instance group. The name can be up to 30 characters in length. It must start with a letter or a Chinese character, and… | | NumberOfInstances | integer | no | The number of instances in the instance group. Maximum value: 100 | | ChargeType | string | no | The billing method | | Period | integer | no | The subscription duration of the resource. The unit is specified by PeriodUnit | | PeriodUnit | string | no | The unit of the subscription duration | | InstanceGroupSpec | string | yes | The specifications of the instance group. You can call the [DescribeSpec](~~DescribeSpec~~) operation to query the available… | | AutoPay | string | no | Specifies whether to enable automatic payment. Default value: false | | AutoRenew | string | no | Specifies whether to enable auto-renewal. Default value: false | | OfficeSiteId | string | no | The network ID. To create a shared network instance: The network ID is optional. Enter the network ID of the Shared Network type on the… | | VSwitchId | string | no | The vSwitch ID. You can call the https://help.aliyun.com/document_detail/448774.html operation to query the vSwitch list. To create a… | | PolicyGroupId | string | no | The policy ID. You can call the [ListPolicyGroups](~~ListPolicyGroups~~) operation to query the policy list | | ImageId | string | yes | The image ID. You can call the [DescribeImageList](~~DescribeImageList~~) operation to query the image list for cloud phones | | Amount | integer | no | The number of instance groups. Default value: 1. Maximum value: 100 | | GpuAcceleration | string | no | Specifies whether to enable GPU acceleration | | KeyPairId | string | no | The key pair ID. When creating an instance group, if you specify a valid key pair ID, the key pair is bound to all successfully created… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate requests. The token can be up to 100… | | EnableIpv6 | string | no | This parameter is not available to the public | | Ipv6Bandwidth | integer | no | This parameter is not available to the public | | Tag | string | no | The tags of the resource (JSON-encoded) | | NetworkInfo | string | no | The network and bandwidth plan configurations of the instance group (JSON-encoded) | | BandwidthPackageType | string | no | The bandwidth type | | BandwidthPackageId | string | no | The bandwidth plan ID | | NetworkType | string | no | The network type of the instance | | PromotionId | string | no | The promotion activity ID | | StreamMode | integer | no | The streaming mode of the instances in the instance group. If this parameter is not specified, the default mode is preemptive mode | | PaidCallBackUrl | string | no | The redirect URL for the payment success page | | SaleMode | string | no | The sales mode | | InstanceVersion | string | no | The instance version. A value of basic indicates a Wuying cloud phone instance, and a value of EnterpriseAi indicates a JVS Mobile instance | | ChannelCookie | string | no | The channel cookie, which is passed through to the sales system when an order is placed | ### Creates an Android application. Before you can install an application, you must use this API operation to… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-app` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AppName | string | no | The application name | | FileName | string | no | The name of the application file stored in Object Storage Service (OSS). This parameter and `FilePath` together determine the unique OSS… | | FilePath | string | no | The storage address of the application file in an OSS bucket. This parameter and `FileName` together determine the unique OSS address. If… | | IconUrl | string | no | The URL of the application icon | | OssAppUrl | string | no | The OSS address of the application. If you pass an application from the WUYING Workspace app center, you must pass `FileName` and… | | BizRegionId | string | no | The region ID | | InstallParam | string | no | The installation parameters. The `-r` installation parameter is included by default when you install the application | | Description | string | no | The application description | | CustomAppInfo | string | no | The custom application information. If you pass a custom application, pass the `CustomAppInfo` parameter. All six fields in this object… | | SignApk | string | no | Specifies whether to perform a system signature | ### Creates a cloud phone matrix. In the Wuying Cloud Phone system, a matrix (Cloud Phone Server) is a logical… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-cloud-phone-node` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | yes | The region ID | | NodeName | string | no | The name of the cloud phone matrix | | ServerType | string | yes | The specification of the cloud phone matrix | | InstanceType | string | no | The instance type. To purchase additional specifications, contact pre-sales support… | | ChargeType | string | no | The billing method. Only the subscription billing method is supported | | PeriodUnit | string | no | The unit of the subscription period | | Period | integer | no | The subscription period. The unit is specified by PeriodUnit. If PeriodUnit is set to year, the only valid value is 1. If PeriodUnit is… | | AutoPay | string | no | Specifies whether to enable automatic payment | | AutoRenew | string | no | Specifies whether to enable auto-renewal | | ImageId | string | no | The image ID | | Count | string | no | The Quantity of the cloud phone matrix | | NetworkId | string | no | The ID of the office network | | VSwitchId | string | no | The ID of the vSwitch | | Tag | string | no | The resource tags (JSON-encoded) | | PhoneDataVolume | integer | no | The size of the independent internal storage. Unit: GiB | | ServerShareDataVolume | integer | no | The size of the shared internal storage. Unit: GiB. The minimum size of the shared internal storage must be greater than the number of… | | ResolutionHeight | integer | no | The resolution height. Unit: pixels | | ResolutionWidth | integer | no | The resolution width. Unit: pixels | | PhoneCount | integer | no | The number of cloud phone instances to create in a single matrix | | DisplayConfig | string | no | The display settings (JSON-encoded) | | StreamMode | integer | no | The streaming mode for instances in the cloud phone matrix. If this parameter is not specified, the preemptive mode is used by default | | NetworkType | string | no | The network type of the instance | | NetworkInfo | string | no | The network mapping information for the instance (JSON-encoded) | | BandwidthPackageType | string | no | The bandwidth type | | BandwidthPackageId | string | no | The ID of the Internet Shared Bandwidth instance | | UpBandwidthLimit | integer | no | The upstream bandwidth throttling. Unit: Mbit/s | | DownBandwidthLimit | integer | no | The downstream bandwidth throttling. Unit: Mbit/s | | UseTemplate | string | no | Specifies whether to use a template during creation. To use a random template from the template list, set the value to Random. To use a… | | PromotionId | string | no | The promotion ID | | PaidCallBackUrl | string | no | The redirect URL of the payment success page | | SwapSize | integer | no | The size of the swap space | | IsSingleImgDisk | string | no | Specifies whether to use a single image disk. Default value: false. A value of false indicates that the system disk and the shared… | | ChannelCookie | string | no | The channel cookie that is passed through to the sales system when an order is placed | ### Purchases a credit package `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-credit-package` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | Period | integer | no | The subscription period of the resource. The unit is specified by PeriodUnit | | PeriodUnit | string | no | The unit of the subscription period. Valid values: Month: months. Year: years | | AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. Make sure that your account balance is… | | CreditAmount | string | no | The number of credits | | PromotionId | string | no | The ID of the promotion | | ChannelCookie | string | no | The channel cookie. This parameter is passed through to the sales system when you place an order | | PackageAmount | string | no | The number of credit packages to purchase | ### Creates a custom image from a cloud phone instance. Then, you can use the image to create more cloud phones… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-custom-image` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the cloud phone instance | | ImageName | string | yes | The name of the custom image | | Description | string | no | The description of the custom image | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. By default, this parameter is left empty. The token cannot exceed… | ### Places an order to purchase an edge agent package `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-edge-mobile-agent-package` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | yes | The region where the agent is located | | Quantity | integer | yes | The number of packages | | Period | integer | yes | The subscription duration of the resource. The unit is specified by `PeriodUnit` | | PeriodUnit | string | yes | The unit of the subscription duration. Valid values: Month: month. Year: year | | AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: Enable auto-renewal. false (default): Disable auto-renewal | | AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: Enable automatic payment. Make sure that your account balance is… | | ClientToken | string | no | The idempotency token | | PromotionId | string | no | The promotion ID | | DeviceClass | string | yes | The device form factor | ### You can connect to Cloud Phones using the Android Debug Bridge (ADB). ADB lets you manage devices and… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-key-pair` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | KeyPairName | string | yes | The name of the key pair. The name must be 2 to 128 characters in length. The name can contain letters, Chinese characters, digits, colons… | ### Places an order for a resource plan `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-mobile-agent-package` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | Period | integer | no | The subscription duration of the resource. The unit is specified by PeriodUnit | | PeriodUnit | string | no | The unit of the subscription duration. Valid values: Month: Months. Year: Years | | AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: Automatic payment. You must ensure that your account balance is… | | CreditAmount | string | no | The credit amount | | PromotionId | string | no | The promotion ID | | MobileAgentPackageSpec | string | no | The specification of the resource plan | | InstanceName | string | no | The name of the node instance | | CreditConfig | string | no | The credit limit configuration | | Amount | string | no | The number of resource plans | | PaidCallbackUrl | string | no | The redirect URL for the payment success page | | AutoRenew | string | no | Specifies whether to enable auto-renewal for the instance. Valid values: true: Yes. false (default): No | | BizRegionId | string | no | The region where the instance resides. Only cn-hangzhou is supported | | ImageId | string | no | The image ID | | PackageSpecId | integer | no | The PackageSpecId | | ChannelCookie | string | no | The ChannelCookie | | BandwidthPackageId | string | no | The bandwidth package ID, which is used to associate an existing bandwidth package when creating an instance. The value must be prefixed… | | Tag | string | no | The tags (JSON-encoded) | ### Creates an agent task `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-mobile-agent-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | Name | string | no | The task name | | Type | string | no | The task type | | InputParam | string | no | The task input | | AgentId | string | no | The agent ID | | NodeIds | string | no | The list of node IDs | | SessionId | string | no | The session ID. Tasks with the same session ID share the same context | ### Creates a policy that applies unified settings to cloud phones. These settings include features such as… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-policy-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | Html5FileTransfer | string | no | The file transfer policy for the web client | | LocalDrive | string | no | The local disk mapping permission | | PolicyGroupName | string | no | The policy name | | CameraRedirect | string | no | Specifies whether to enable local camera redirection | | Clipboard | string | no | The clipboard permission | | ResolutionHeight | integer | no | The resolution height, in pixels | | ResolutionWidth | integer | no | The resolution width, in pixels | | LockResolution | string | no | Specifies whether to lock the resolution | | NetRedirectPolicy | string | no | Network redirection (JSON-encoded) | | PolicyType | string | no | The policy type | | Watermark | string | no | Screen watermark (JSON-encoded) | ### Creates a scheduled task for an agent `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-scheduled-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | TaskName | string | yes | The name of the task | | UserPrompt | string | yes | The user prompt | | CronExpression | string | yes | The cron expression | | InstanceIds | string | yes | The list of instance IDs (JSON-encoded) | | MaxExecutions | integer | no | The maximum number of executions | | RunConfig | string | no | The run configuration (JSON-encoded) | ### This asynchronous API operation generates a screenshot of a cloud phone `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-screenshot` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIdList | string | yes | The list of instance IDs. Batch screenshots are supported (JSON-encoded) | | OssBucketName | string | no | The custom OSS bucket. The bucket name must start with the cloudphone-saved-bucket- prefix. The cloud phone instance and the OSS bucket… | | SkipCheckPolicyConfig | string | no | Specifies whether to skip the screenshot policy check. The default value is false | | ScreenshotId | string | no | The screenshot ID. The generated screenshot is named "ScreenshotId_AndroidInstanceId.png." The ScreenshotId must be 2 to 128 characters… | ### Creates a system property template. The key-value pairs defined in the template are sent to cloud phones and… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/create-system-property-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | TemplateName | string | no | The name of the template. The name must meet the following requirements: Be 2 to 32 characters in length. Start with an uppercase or… | | SystemPropertyInfo | string | no | The information about the system property template (JSON-encoded) | | FilePath | string | no | The URL of the property template file. The API parses the file synchronously. An error is returned if the file format is invalid. The file… | | EnableAuto | string | no | Specifies whether to automatically generate preset system properties | ### Deletes custom skills `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-agent-skill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | SkillIds | string | no | The list of skill IDs (JSON-encoded) | ### Deletes an Android instance group. All instances in the group are also deleted. This operation cannot be… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-android-instance-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceGroupIds | string | no | A list of instance group IDs (JSON-encoded) | ### Deletes an application. Before you delete an application, make sure that the application is not installed on… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-apps` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AppIdList | string | no | The IDs of the applications (JSON-encoded) | ### Deletes backup files in batches `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-backup-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BackupFileIdList | string | yes | The list of backup file IDs (JSON-encoded) | ### Deletes a cloud phone matrix `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-cloud-phone-nodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | NodeIds | string | no | The cloud phone matrix IDs (JSON-encoded) | ### Deletes a custom image `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-images` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | ImageIds | string | yes | The IDs of the images (JSON-encoded) | ### Deletes Android Debug Bridge (ADB) key pairs `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-key-pairs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | KeyPairIds | string | no | The IDs of the ADB key pairs (JSON-encoded) | ### Deletes a node package `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-mobile-agent-package` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | PackageIds | string | no | The list of packages (JSON-encoded) | ### Deletes one or more policy groups `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-policy-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | PolicyGroupIds | string | yes | A list of policy group IDs. If any specified policy group is associated with an existing instance group, the entire operation fails… | ### Deletes a scheduled task of an agent `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-scheduled-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | ScheduledId | string | yes | The ID of the scheduled task | ### Deletes system property templates `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/delete-system-property-templates` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | TemplateIds | string | no | The IDs of the property templates (JSON-encoded) | ### Queries the details of agent tasks `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-agent-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | TaskIds | string | no | The list of task IDs (JSON-encoded) | ### Queries the details of cloud phone instance groups `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-android-instance-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | no | The region ID | | InstanceGroupIds | string | no | The list of instance group IDs (JSON-encoded) | | InstanceGroupName | string | no | The instance group name. Fuzzy match is supported | | Status | string | no | The status of the instance group | | SaleMode | string | no | The purchase mode of the cloud phone | | ChargeType | string | no | The billing method | | PolicyGroupId | string | no | The policy ID | | KeyPairId | string | no | The ID of the key pair | | MaxResults | integer | no | The maximum number of entries to return per page in a paging query. Valid values: 1 to 100. Default value: 100 | | NextToken | string | no | The pagination token that specifies the starting position of the query. If you leave this parameter empty, the query starts from the… | | Tags | string | no | The tags of the instance group. You can add up to 20 tags to each instance (JSON-encoded) | | InstanceVersion | string | no | The instance version. A value of basic indicates a Wuying Cloud Phone instance, and a value of EnterpriseAi indicates a JVS Mobile instance | | SortKey | string | no | The sort field. A value of CreationTime indicates the creation time, and a value of ExpiredTime indicates the expiration time | | SortType | string | no | The sort order. A value of ASC indicates ascending order, and a value of DESC indicates descending order | ### Queries the details of cloud phone instances `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-android-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceGroupId | string | no | The ID of the instance group | | KeyPairId | string | no | The ID of the associated key pair | | AndroidInstanceIds | string | no | The list of instance IDs (JSON-encoded) | | AndroidInstanceName | string | no | The name of the instance | | Status | string | no | The instance status | | SaleMode | string | no | The sale mode | | MaxResults | integer | no | The maximum number of entries per page for paging. Valid values: 1 to 100. Default value: 100 | | NextToken | string | no | The token that specifies the starting position for the next query. An empty value indicates that the query starts from the beginning | | InstanceGroupIds | string | no | The list of instance group IDs (JSON-encoded) | | InstanceGroupName | string | no | The name of the instance group | | ChargeType | string | no | The billing method | | Tag | string | no | The tags of the resource (JSON-encoded) | | BizRegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/2807298.html operation to query the list of regions where… | | NodeId | string | no | The matrix ID. This parameter is not publicly available. | | NodeName | string | no | The name of the matrix. This parameter is not publicly available. | | OfficeSiteIds | string | no | The ID of the cloud phone network (JSON-encoded) | | AuthorizedUserId | string | no | The ID of the user assigned to the instance, which is the Wuying convenience user ID | | QosRuleIds | string | no | The ID of the public network throttling rule group. This specifies the throttling rules for instances in the basic shared network… | | AppManagePolicyId | string | no | The ID of the application control rule | | PrivateIpAddress | string | no | The private IP address of the instance | | SortKey | string | no | The sort key used when querying resources. This parameter must be used together with SortType. Valid values: CreationTime and ExpiredTime.… | | SortType | string | no | The sort order. Default value: DESC. Valid values: ASC: ascending order DESC: descending order | | InstanceVersion | string | no | The instance version. Default value: basic, which queries Wuying cloud phone instances | ### Queries applications `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-apps` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AppIdList | string | no | The IDs of the applications (JSON-encoded) | | AppName | string | no | The name of the application | | BizRegionId | string | no | Region id | | Status | string | no | The status of the application | | InstallationStatus | string | no | The installation/uninstallation status of the application. Valid values: INSTALLFAILED: The application failed to be installed.… | | MaxResults | integer | no | The maximum number of entries per page. Valid values: 1 to 100. Default value: 10 | | NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. If the parameter is left empty, the data is… | | MD5 | string | no | The value of MD5 | | AppType | string | no | This parameter is for internal use now | ### Queries a list of backup files `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-backup-files` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BackupFileId | string | no | The ID of the backup file | | BackupFileName | string | no | The name of the backup file. Fuzzy match is supported | | InstanceGroupId | string | no | The ID of the instance group | | AndroidInstanceId | string | no | The instance ID | | AndroidInstanceName | string | no | The name of the instance. Fuzzy match is supported | | Description | string | no | The description. Fuzzy match is supported | | StatusList | string | no | The list of backup file statuses (JSON-encoded) | | StartTime | string | no | The start time to query backup files. Specify the time in the YYYY-MM-DD HH:mm:ss format | | EndTime | string | no | The end time to query backup files. Specify the time in the YYYY-MM-DD HH:mm:ss format | | EndUserId | string | no | The owner of the backup file | | BackupAll | string | no | Specifies whether the backup is a full device backup | | MaxResults | integer | no | The maximum number of entries to return per page in a paging query. Valid values: 1 to 100. Default value: 10 | | NextToken | string | no | The token that specifies the starting position of the query. An empty value indicates that the query starts from the beginning | | SaleMode | string | no | The sales mode. Instance indicates the cloud phone instance mode, and Node indicates the cloud phone matrix mode | ### 带宽包询价 `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-bandwidth-package-price` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | yes | The BizRegionId | | Bandwidth | integer | yes | The Bandwidth | | InternetChargeType | string | no | The InternetChargeType | | Period | integer | no | The Period | | PeriodUnit | string | no | The PeriodUnit | | PromotionId | string | no | The PromotionId | | PurchaseChannelType | string | no | The PurchaseChannelType | ### Queries the list of buckets whose names start with cloudphone-saved-bucket- `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-buckets` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | FileType | string | no | The OSS file type. This parameter is not yet available | ### 云手机节点询价 `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-cloud-phone-node-price` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | yes | The BizRegionId | | ServerType | string | yes | The ServerType | | ChargeType | string | no | The ChargeType | | PeriodUnit | string | no | The PeriodUnit | | Period | string | no | The Period | | Count | string | no | The Count | | PhoneDataVolume | integer | no | The PhoneDataVolume | | ServerShareDataVolume | integer | no | The ServerShareDataVolume | | PhoneCount | integer | no | The PhoneCount | | PromotionId | string | no | The PromotionId | | SwapSize | integer | no | The SwapSize | | IsSingleImgDisk | string | no | The IsSingleImgDisk | ### 云手机节点续费询价 `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-cloud-phone-node-renew-price` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | NodeIds | string | no | The NodeIds (JSON-encoded) | | PeriodUnit | string | no | The PeriodUnit | | Period | integer | no | The Period | | PromotionId | string | no | The PromotionId | ### Queries the details of cloud phone matrices. In the Wuying Cloud Phone system, a matrix (cloud phone server)… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-cloud-phone-nodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | no | The region ID | | MaxResults | string | no | The maximum number of entries to return per page in a paging query. Maximum value: 100. Default value: 20 | | NextToken | string | no | The pagination token for the next query. If a query does not return all results, the returned NextToken is not empty. You can use the… | | NodeIds | string | no | The IDs of the cloud phone matrices (JSON-encoded) | | NodeName | string | no | The name of the cloud phone matrix | | Status | string | no | The status of the cloud phone matrix | | ServerType | string | no | The specifications of the cloud phone matrix | | ChargeType | string | no | The billing method. Only the subscription billing method is supported | | BandwidthPackageId | string | no | The instance ID of the bandwidth plan | | NodeNameList | string | no | The list of names used to filter cloud phone matrices (JSON-encoded) | | Tags | string | no | The tags of the node (JSON-encoded) | | SortKey | string | no | The field used for sorting. A value of CreationTime indicates the creation time, and a value of ExpiredTime indicates the expiration time | | SortType | string | no | The sort order. A value of ASC indicates ascending order, and a value of DESC indicates descending order | ### Queries all credit change records `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-credit-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | PageNum | string | no | The page number. Default value: 1 | | PageSize | string | no | The number of entries per page | | StartTime | integer | no | The start time. The time is a UNIX timestamp in milliseconds | | EndTime | integer | no | The end time. The time is a UNIX timestamp in milliseconds | | InstanceIds | string | no | The list of instance IDs (JSON-encoded) | | PackageIds | string | no | The list of package IDs (JSON-encoded) | | TaskIds | string | no | The list of task IDs. This parameter is used to filter credit details by task (JSON-encoded) | | NextToken | string | no | The token for the next query. If a query does not return all results, the returned NextToken is not empty. You can pass the returned… | | MaxResults | integer | no | The maximum number of entries to return for this request | | AgentTypes | string | no | The list of agent types. This parameter is used to filter credit change details by agent type (JSON-encoded) | ### Queries credit packages `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-credit-package` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | CreditPackageId | string | no | The ID of the credit package | | CreditPackageStatus | string | no | The status of the credit package | ### 积分包询价 `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-credit-package-price` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | PeriodUnit | string | no | The PeriodUnit | | Period | string | no | The Period | | PromotionId | string | no | The PromotionId | | CreditAmount | integer | no | The CreditAmount | | PackageAmount | string | no | The PackageAmount | ### Queries the display settings `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-display-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIds | string | no | A list of instance IDs (JSON-encoded) | ### Queries the details of edge agent packages `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-edge-mobile-agent-packages` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | PackageIds | string | no | The list of package IDs. Separate multiple IDs with commas | | LicenseKeys | string | no | The list of license keys. Separate multiple keys with commas | | DeviceClass | string | no | The device class filter. Valid values: BOX, PHONE, PAD, and OTHER | | Status | string | no | The package status filter | | NextToken | string | no | The pagination token. Leave this parameter empty for the first query. For subsequent queries, obtain the token from the previous response | | MaxResults | integer | no | The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 20 | ### Queries images `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-image-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | ImageId | string | no | The image ID | | ImageType | string | yes | The image type | | ImageName | string | no | The image name | | Status | string | no | The status of the image | | NextToken | string | no | The token that specifies the starting position for the query. If this parameter is empty, the query starts from the beginning | | MaxResults | integer | no | The maximum number of entries to return per page during paging in a paged query. Valid values: 1 to 100. Default value: 20 | | ImagePackageType | string | no | This parameter is not publicly available | | InstanceType | string | no | The instance type | | ImageBizTags | string | no | The array of tag objects (JSON-encoded) | | SystemType | string | no | The operating system type | ### 查询安卓实例组价格 `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-instance-group-price` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | NumberOfInstances | integer | no | The NumberOfInstances | | Amount | integer | no | The Amount | | BizRegionId | string | yes | The BizRegionId | | InstanceGroupSpec | string | yes | The InstanceGroupSpec | | PeriodUnit | string | no | The PeriodUnit | | Period | integer | no | The Period | | OrderType | string | no | The OrderType | | Bandwidth | integer | no | The Bandwidth | | ImageId | string | no | The ImageId | | PromotionId | string | no | The PromotionId | | SaleMode | string | no | The SaleMode | | InstanceVersion | string | no | The InstanceVersion | ### Queries the renewal price of an instance group `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-instance-group-price-for-renew` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceGroupIds | string | yes | The list of instance group IDs (JSON-encoded) | | PeriodUnit | string | no | The unit of the subscription period. Valid values: Month: month Year: year | | Period | integer | no | The subscription period of the resource. The unit is specified by PeriodUnit. Valid values: 1 month, 2 months, 3 months, 6 months, and 1… | | PromotionId | string | no | The promotion ID | ### Queries the command execution results of the RunCommand operation `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-invocations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceIds | string | yes | The list of cloud phone instance IDs. You can query the execution results of up to 50 instances in a single request (JSON-encoded) | | InvocationId | string | yes | The command execution ID. You can use this ID and the cloud phone instance ID to query the result of a command execution | ### Queries JVS instance information `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-jvsinstance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceIds | string | no | The list of instance IDs (JSON-encoded) | | MaxResults | integer | no | The maximum number of results per page | | NextToken | string | no | The pagination token | ### Queries one or more key pairs `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-key-pairs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | KeyPairIds | string | no | The IDs of the ADB key pairs (JSON-encoded) | | KeyPairName | string | no | The name of the ADB key pair | | MaxResults | integer | no | The maximum number of entries per page. Valid values: 1 to 100. Default value: 10 | | NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. If the parameter is left empty, the data is… | ### Queries the latest monitoring data of instances or matrices. Supports querying monitoring data such as CPU,… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-metric-last` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | MetricNames | string | yes | The list of monitoring metrics (JSON-encoded) | | AndroidInstanceIds | string | no | The list of cloud phone instance IDs for instance-level monitoring. The list of matrix IDs for matrix-level monitoring. (JSON-encoded) | | Period | integer | no | The statistical period for the monitoring data. Valid values: 60, 900, and 3600. Unit: seconds | | StartTime | string | no | The start time for querying the monitoring metric. The time format is YYYY-MM-DD HH:mm:ss | | EndTime | string | no | The end time for querying the monitoring metric. The time format is YYYY-MM-DD HH:mm:ss | | NextToken | string | no | The token that marks the position from which to start reading. An empty value indicates that the query starts from the beginning | | Length | string | no | The page size of the returned monitoring data, used for paged query. Default value: 1000, indicating 1,000 monitoring data entries per page | | InstanceIds | string | no | The list of instance IDs (JSON-encoded) | ### Queries the monitoring data of specified metrics, such as network bandwidth `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-metric-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | MetricNames | string | yes | The list of monitoring metrics (JSON-encoded) | | AndroidInstanceIds | string | no | For instance-level monitoring, specify a list of cloud phone instance IDs. For matrix-level monitoring, specify a list of matrix IDs.… | | InstanceIds | string | no | The list of instance IDs (JSON-encoded) | | ProcessInfos | string | no | The list of process monitoring metrics (JSON-encoded) | | Period | integer | no | The statistical period of the monitoring data. Valid values: 60, 900, and 3600. Unit: seconds | | StartTime | string | no | The start time of the query. The time is in the YYYY-MM-DD HH:mm:ss format | | EndTime | string | no | The end time of the query. The time is in the YYYY-MM-DD HH:mm:ss format | | NextToken | string | no | The token that marks the position from which the query starts. If this parameter is left empty, the query starts from the beginning | | Length | string | no | The number of monitoring data entries to return on each page for paging in a paged query. Default value: 1000, which means 1,000… | ### Queries the latest sorted monitoring data and supports querying monitoring data such as instance network… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-metric-top` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | MetricNames | string | yes | The list of monitoring metrics (JSON-encoded) | | AndroidInstanceIds | string | no | For instance-level monitoring, specify a list of cloud phone instance IDs. For matrix-level monitoring, specify a list of matrix IDs.… | | Period | integer | no | The statistical period of the monitoring data. Unit: seconds | | StartTime | string | no | The start time of the query for the monitoring metric. Specify the time in the YYYY-MM-DD HH:mm:ss format | | EndTime | string | no | The end time of the query for the monitoring metric. Specify the time in the YYYY-MM-DD HH:mm:ss format | | NextToken | string | no | The token that marks the position from which to start reading. If this parameter is left empty, the query starts from the beginning | | Length | string | no | The number of entries to return on each page for the monitoring data. This parameter is used for paging in a paged query. If the… | | InstanceIds | string | no | The list of instance IDs (JSON-encoded) | ### Queries the details of node packages `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-mobile-agent-package` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | PackageIds | string | no | The package IDs (JSON-encoded) | | InstanceIds | string | no | The node instance IDs (JSON-encoded) | | PackageSpec | string | no | The package specification | | PackageStatus | string | no | The package status | | PageNum | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page | ### mobileAgent套餐包询价 `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-mobile-agent-package-price` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | PeriodUnit | string | no | The PeriodUnit | | Period | string | no | The Period | | PromotionId | string | no | The PromotionId | | CreditAmount | integer | no | The CreditAmount | | MobileAgentPackageSpec | string | no | The MobileAgentPackageSpec | | Amount | string | no | The Amount | | BizRegionId | string | no | The BizRegionId | ### MobileAgent套餐包续费询价 `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-mobile-agent-package-price-for-renew` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | PeriodUnit | string | no | The PeriodUnit | | Period | string | no | The Period | | PromotionId | string | no | The PromotionId | | MobileAgentPackageIds | string | no | The MobileAgentPackageIds (JSON-encoded) | ### Query available regions `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-regions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AcceptLanguage | string | no | The display language of the console. Valid values: cn: Simplified Chinese en: English | | SaleMode | string | no | The sales mode. Valid values: Instance: the instance group mode. [Default] Node: the matrix mode. [Whitelist required] | ### Queries the execution records of an agent scheduled task `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-scheduled-task-executions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | ScheduledId | string | yes | The ID of the scheduled task | | InstanceId | string | no | The instance ID | | Status | string | no | The status of the scheduled task | | StartTime | string | no | The start time of the time range in ISO 8601 format | | EndTime | string | no | The end time of the time range in ISO 8601 format | | NextToken | string | no | The pagination token. Leave this parameter empty for the first request | | MaxResults | integer | no | The maximum number of results to return per request. Default value: 20. Maximum value: 100 | ### Queries a list of scheduled tasks for an agent `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-scheduled-tasks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | ScheduledIds | string | no | The filter for scheduled task IDs (JSON-encoded) | | Status | string | no | The status filter. Valid values: ACTIVE, DISABLED | | TaskName | string | no | The task name | | InstanceIds | string | no | The list of instance IDs (JSON-encoded) | | PageNumber | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 100 | | MaxResults | integer | no | The maximum number of entries to return in this request | | NextToken | string | no | The token that specifies the starting position for the current read operation. An empty value indicates that the read operation starts… | ### Queries skill information `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-skills` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | Keyword | string | no | The keyword in the skill name or skill description | | Type | string | no | The skill type | | PageNumber | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 10. Maximum value: 100 | | Language | string | no | The language type. The skill description is returned in the specified language. Valid values: en: English. zh-CN: Chinese | | SkillId | string | no | The skill ID | | StatusFilter | string | no | The status filter | ### Queries the available specifications for cloud phones. Creating an instance requires specifying… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-spec` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | no | The region ID | | SpecIds | string | no | The list of specification IDs (JSON-encoded) | | SpecType | string | no | The specification type | | SpecStatus | string | no | The specification status | | SaleMode | string | no | The purchasing mode of the cloud phone | | MaxResults | integer | no | The maximum number of entries per page for a paged query. Valid values: 1 to 100. Default value: 100 | | NextToken | string | no | The token that specifies the position from which to start reading. An empty value indicates that the reading starts from the beginning | | MatrixSpec | string | no | The cloud phone matrix specification | | ChargeType | string | no | The billing method. A value of PrePaid indicates subscription. A value of PostPaid indicates pay-as-you-go | ### Describes system property templates `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-system-property-templates` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | MaxResults | integer | no | The maximum number of entries to return for a single request | | NextToken | string | no | The starting position for reading. If this parameter is empty, reading starts from the beginning | | TemplateIds | string | no | The property template ID (JSON-encoded) | | TemplateName | string | no | The template name | ### Queries the current task list of cloud phone instances. Many operations on cloud phones, such as creation… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/describe-tasks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InvokeId | string | no | The command execution ID. You can enter the requestId returned by the previous operation | | ResourceIds | string | no | The list of resource IDs (JSON-encoded) | | TaskIds | string | no | The list of task IDs (JSON-encoded) | | ParentTaskId | string | no | The parent task ID | | TaskType | string | no | The task type | | TaskTypes | string | no | The list of task types (JSON-encoded) | | TaskStatus | string | no | The task status | | TaskStatuses | string | no | The list of task statuses (JSON-encoded) | | Level | integer | no | The task level. A value of 1 indicates a batch task. A value of 2 indicates an instance-level task | | InstanceId | string | no | The instance ID | | InstanceName | string | no | The instance name | | Param | string | no | The extended field | | MaxResults | integer | no | The maximum number of entries per page for a paged query. Valid values: 1 to 100. Default value: 10 | | NextToken | string | no | The token that specifies the starting position for reading. If this parameter is left empty, the reading starts from the beginning | ### Detaches an Android Debug Bridge (ADB) key pair from one or more cloud phone instances `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/detach-key-pair` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | KeyPairId | string | yes | The ID of the ADB key pair | | InstanceIds | string | no | The IDs of the cloud phone instances. You can specify up to 50 instance IDs (JSON-encoded) | ### Disconnects a connected instance or disassociates an instance that is associated with another user `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/disconnect-android-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceIds | string | no | A list of instance IDs. You can specify 1 to 100 IDs (JSON-encoded) | | EndUserId | string | no | If you use the Cloud Phone Matrix Edition and the instance stream pattern is collaborative mode, you can specify `EndUserId` to disconnect… | ### Distributes an image to one or more regions. This lets you use the image to create cloud phones in regions… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/distribute-image` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | DistributeRegionList | string | yes | The list of destination regions (JSON-encoded) | | ImageId | string | yes | The ID of the image | ### Downgrades an instance group. Currently, this operation allows you to only delete specific cloud phone… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/downgrade-android-instance-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceGroupId | string | yes | The ID of the instance group | | AndroidInstanceIds | string | no | The IDs of the cloud phone instances that you want to delete (JSON-encoded) | | AutoPay | string | no | Specifies whether to enable the auto-payment feature. Default value: false. Valid values: true: enables the auto-payment feature. Ensure… | ### Ends all coordination tasks for a cloud phone instance and invalidates the coordination code `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/end-coordination` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | OwnerUserId | string | no | The user ID of the coordination initiator | | CoordinatorUserId | string | no | The user ID of the coordination participant | | InstanceId | string | no | The ID of the instance that is in a coordination session | ### Expands the storage of a cloud phone matrix. You can expand the shared device storage used to store… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/expand-data-volume` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | no | The region ID | | NodeIds | string | no | The IDs of the cloud phone matrices (JSON-encoded) | | ShareDataVolume | integer | no | The size of the shared storage for the matrix. Unit: GiB | | PhoneDataVolume | integer | no | The size of the device storage for the instance. Unit: GiB | | AutoPay | string | no | Specifies whether to enable automatic payment. Default value: false | | PromotionId | string | no | The ID of the promotion | | PaidCallBackUrl | string | no | The redirect URL for the payment success page | ### Expands the independent device storage of a matrix instance `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/expand-phone-data-volume` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BizRegionId | string | no | The region ID | | InstanceIds | string | no | The IDs of the cloud phone matrix instances. You can specify 1 to 100 instance IDs (JSON-encoded) | | PhoneDataVolume | integer | no | The expected size of the independent device storage after the expansion. Unit: GiB.> The new value must be greater than the original… | | AutoPay | string | no | Specifies whether to enable automatic payment. Default value: false | | PromotionId | string | no | The promotion ID | | PaidCallBackUrl | string | no | The redirect URL to the payment success page | ### Fetches files from a cloud phone to Object Storage Service (OSS) `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/fetch-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIdList | string | yes | A list of cloud phone instance IDs (JSON-encoded) | | SourceFilePath | string | yes | The path of the file or folder to fetch from the cloud phone | | UploadType | string | yes | The type of storage service for the fetched file. Currently, only Object Storage Service (OSS) is supported | | UploadEndpoint | string | yes | The endpoint for uploading files to OSS. If the cloud phone and the destination OSS bucket are in the same region, you can use an internal… | | UploadUrl | string | yes | The destination URL in OSS. The destination bucket name must be prefixed with `cloudphone-saved-bucket-`. For example,… | | ClientToken | string | no | A client-generated token, up to 100 characters long, that ensures the idempotency of the request | ### By default, you can only use the BatchGetAcpConnectionTicket operation to get the ticket for a connection to… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/generate-coordination-code` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | OwnerUserId | string | no | The ID of the user to whom the current instance is assigned | | InstanceId | string | no | The ID of the instance | ### Retrieves the properties of an instance. This operation runs the android getprop command to retrieve all… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/get-instance-properties` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceId | string | no | The instance ID | ### Queries the network access blacklist for IP addresses and domain names `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/get-network-blacklist` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | Type | string | no | The query type. Valid values: IP and Domain. If you do not specify this parameter, information for both types is returned | ### Imports a custom image `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/import-image` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | ImageFileURL | string | no | The URL of the image. The URL must be an Alibaba Cloud Object Storage Service (OSS) address | | ImageName | string | no | The name of the image | | ImageDescription | string | no | The description of the image | | BaseImageId | string | no | The ID of the base image | ### Imports the public key of an Android Debug Bridge (ADB) key pair `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/import-key-pair` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | KeyPairName | string | yes | The name of the ADB key pair | | PublicKeyBody | string | yes | The public key of the ADB key pair | ### Installs applications on multiple Wuying Cloud Phone instances in batches `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/install-app` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AppIdList | string | no | The list of application IDs (JSON-encoded) | | InstanceGroupIdList | string | no | The list of instance groups (JSON-encoded) | | InstanceIdList | string | no | The list of instances (JSON-encoded) | ### Installs the monitoring plugin in a single step. An instance can generate monitoring data only after the… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/install-monitor-agent` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIds | string | no | A list of instance IDs (JSON-encoded) | | SaleMode | string | no | The monitoring type. Instance mode: Instance Node mode: Node | ### Installs skills to instances `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/install-skills` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | SkillIds | string | no | The list of skill IDs. You can specify 1 to 10 skill IDs (JSON-encoded) | | InstanceIds | string | no | The list of cloud phone instance IDs. You can specify 1 to 200 instance IDs (JSON-encoded) | ### Diagnoses and recovers cloud phone matrix instances. This operation clears the system log files of an… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/instance-healer` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceIdList | string | yes | The list of instances (JSON-encoded) | | Timeout | integer | no | The timeout period in seconds. If you do not specify this parameter, the default value is 30 | | Strategy | string | no | The policy type. The only supported value is Clean | ### Queries the Android Debug Bridge (ADB) connection information for instances. This operation is available… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/list-instance-adb-attributes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceIds | string | no | The list of cloud phone instance IDs. You can specify from 1 to 100 IDs (JSON-encoded) | | ExternalIp | string | no | The public IP address | | InternalIp | string | no | The private IP address | | InternalPort | string | no | The ADB port number | | IpProtocol | string | no | The network protocol type | | MaxResults | integer | no | The maximum number of records to return on each page for a paged query. Valid values: 1 to 100. Default value: 100 | | NextToken | string | no | The token that indicates the position from which the query starts. If you leave this parameter empty, the query starts from the beginning | ### Queries the details of a policy `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/list-policy-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | PolicyGroupIds | string | no | The list of policy IDs (JSON-encoded) | | PolicyGroupName | string | no | The policy name | | MaxResults | integer | no | The maximum number of entries to return on each page for a paging query. Valid values: 1 to 100. Default value: 20 | | NextToken | string | no | The token used to mark the position from which to start reading. An empty value indicates that the query starts from the beginning | | PolicyType | string | no | The policy type | ### Queries the tags that are associated with Cloud Phone instances `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/list-tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID. Set the value of this parameter to `cn-shanghai`. Set the value of this parameter to `ap-southeast-1`. | | ResourceType | string | yes | The resource type | | MaxResults | integer | no | The number of entries to return on each page for a paged query | | NextToken | string | no | The token that marks the position from which to start the query. If you leave this parameter empty, the query starts from the beginning | | ResourceId | string | no | A list of resource IDs. This is a list of cloud phone instance IDs. You can specify 1 to 50 IDs (JSON-encoded) | | Tag | string | no | A list of tags (JSON-encoded) | ### Modifies the information of an Android instance. Currently, this operation can be used to modify only the… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-android-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceId | string | no | The ID of a single instance. If you specify this parameter, InstanceIds is ignored | | NewAndroidInstanceName | string | no | The new name for the instance. The name can be up to 30 characters long. It must start with a letter or a Chinese character and cannot… | | InstanceIds | string | no | The list of Android instance IDs. You can specify from 1 to 100 IDs (JSON-encoded) | | UpBandwidthLimit | integer | no | The limit for upstream bandwidth. Unit: Mbps | | DownBandwidthLimit | integer | no | The limit for downstream bandwidth. Unit: Mbps | ### Modifies attributes of an instance group `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-android-instance-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceGroupId | string | no | The ID of the instance group | | NewInstanceGroupName | string | no | The new name of the instance group. The name can be up to 30 characters in length. It can contain letters, digits, colons (:), underscores… | | PolicyGroupId | string | no | The ID of the policy | | StreamMode | integer | no | Specifies the streaming mode for instances within the instance group. If this parameter is omitted, the mode defaults to 1 (Preemptive) | ### Modify attributes of an application `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-app` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AppId | integer | no | The ID of the application | | AppName | string | no | The name of the application | | IconUrl | string | no | The URL of the icon | | Description | string | no | The description of the application | ### Modifies a cloud phone matrix. Currently, you can only modify the name of a cloud phone matrix. Note: In the… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-cloud-phone-node` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | NodeId | string | no | The ID of the cloud phone matrix | | NewNodeName | string | no | The name that you want to assign to the cloud phone matrix | | StreamMode | integer | no | Specifies the streaming mode for instances in the cloud phone matrix. If this parameter is left empty, the exclusive mode is used | ### Modifies display settings `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-display-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIds | string | no | A list of instance IDs (JSON-encoded) | | DisplayConfig | string | no | The display settings (JSON-encoded) | ### Modifies the billing method of an instance. Currently, only switching from pay-as-you-go to subscription is… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-instance-charge-type` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceGroupIds | string | yes | The list of instance group IDs (JSON-encoded) | | ChargeType | string | yes | The billing method of the instance. Currently, only switching from pay-as-you-go to subscription is supported | | Period | integer | no | The purchase duration of the resource. The unit is specified by PeriodUnit. Valid values: 1 month, 2 months, 3 months, 6 months, and 1 year | | PeriodUnit | string | no | The unit of the purchase duration. Valid values: Month: month. Year: year | | AutoPay | string | no | Specifies whether to enable automatic payment. Default value: false | | AutoRenew | string | no | Specifies whether to enable auto-renewal. Default value: false | | PromotionId | string | no | The promotion ID | ### Changes the specifications of instance groups. Currently, only specification upgrades are supported.… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-instance-group-spec` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceGroupIds | string | no | The list of instance group IDs (JSON-encoded) | | InstanceGroupSpec | string | yes | The instance group specification. You can call [DescribeSpec](~~DescribeSpec~~) to query the specifications available for purchase for… | | AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: Automatic payment is enabled. Make sure that your account balance is… | | PromotionId | string | no | The promotion ID | ### Modifies the configuration of a JVS instance `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-jvsinstance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceIds | string | no | The list of instance IDs (JSON-encoded) | | CreditConfig | string | no | The credit limit configuration. Subsequent configurations overwrite previous ones (JSON-encoded) | | ApplyToAll | string | no | Specifies whether to apply the configuration to all instances | | InstanceName | string | no | The instance name | | ImageId | string | no | The image ID | | AgentVersion | string | no | The target version of AI Engine, such as 2607W1. You can also set this parameter to latest to automatically resolve to the latest… | ### Modifies Android Debug Bridge (ADB) key pairs `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-key-pair-name` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | KeyPairId | string | yes | The ID of the ADB key pair | | NewKeyPairName | string | yes | The name of the ADB key pair | ### Modifies a package `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-mobile-agent-package` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | PackageId | string | no | The package ID | | Tag | string | no | The list of tags. You can specify 1 to 20 tags (JSON-encoded) | ### Modifies the information of a policy group `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-policy-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | Html5FileTransfer | string | no | The file transfer policy for the Wuying web client | | LocalDrive | string | no | The local disk mapping permission | | CameraRedirect | string | no | Specifies whether to enable local camera redirection | | Clipboard | string | no | The clipboard permission | | PolicyGroupId | string | no | The policy ID | | PolicyGroupName | string | no | The policy name | | ResolutionHeight | integer | no | The height of the resolution. Unit: pixels | | ResolutionWidth | integer | no | The width of the resolution. Unit: pixels | | LockResolution | string | no | Specifies whether to lock the resolution | | NetRedirectPolicy | string | no | Network redirection (JSON-encoded) | | Watermark | string | no | The screen watermark (JSON-encoded) | ### Updates a scheduled task for an agent `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-scheduled-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | ScheduledId | string | yes | The ID of the scheduled task | | TaskVersion | integer | yes | The CAS version number | | TaskName | string | no | The name of the task | | UserPrompt | string | no | The user prompt | | CronExpression | string | no | The cron expression | | InstanceIds | string | no | The list of instance IDs (JSON-encoded) | | Status | string | no | The status toggle. Valid values: ACTIVE and DISABLED | | RunConfig | string | no | The run configuration (JSON-encoded) | ### Modifies a property template `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/modify-system-property-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | TemplateId | string | no | The ID of the property template | | TemplateName | string | no | The name of the template | | SystemPropertyInfo | string | no | The information about the system property template (JSON-encoded) | | FilePath | string | no | The URL of the property template file. The system synchronously parses the file. If the file format is invalid, a parsing error is… | | EnableAuto | string | no | Specifies whether to automatically generate preset system properties | ### Operates apps in a cloud phone, such as opening, closing, and reopening apps `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/operate-app` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceIdList | string | no | The IDs of the cloud phone instances (JSON-encoded) | | AppId | integer | no | The ID of the app | | OperateType | string | no | The type of the operation | ### Pauses running agent tasks on Mobile nodes `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/pause-agent-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | TaskIds | string | yes | A list of task IDs (JSON-encoded) | ### Restarts one or more cloud phone instances `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/reboot-android-instances-in-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIds | string | no | The list of instance IDs (JSON-encoded) | | ForceStop | string | no | Specifies whether to force a restart. You can force a restart if a cloud phone cannot be shut down due to system or network exceptions.… | | SaleMode | string | no | [Deprecated] The sales mode | | IgnoreParamValidation | string | no | Specifies whether to skip parameter validation. A value of true indicates that validation is skipped. If the value is false or not… | ### 重启矩阵 `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/reboot-cloud-phone-nodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | NodeIds | string | no | 云手机矩阵 ID 列表，N 的取值范围：1~100 (JSON-encoded) | | Force | string | no | 是否强制重启。true：强制重启（不等实例优雅退出）；false：优雅重启（默认） | ### Restores a full instance backup to another cloud phone instance `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/recover-android-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BackupFileId | string | no | The ID of the backup file | | AndroidInstanceIdList | string | yes | A list of instance IDs (JSON-encoded) | | UploadEndpoint | string | no | The region where the backup is located | | UploadType | string | yes | The upload type | | BackupFilePath | string | yes | The OSS URL where the backup file is uploaded | ### Recovers an application from a backup file to another cloud phone instance `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/recover-app` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BackupFileId | string | yes | The ID of the backup file | | AndroidInstanceIdList | string | yes | The list of instance IDs (JSON-encoded) | | UploadEndpoint | string | no | The backup region | | UploadType | string | yes | The backup type | | BackupFilePath | string | yes | The OSS URL where the backup file is uploaded | ### Restores backup files `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/recovery-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | BackupFileId | string | no | The ID of the backup file | | AndroidInstanceIdList | string | yes | The IDs of the instances (JSON-encoded) | | UploadType | string | no | The type of the backup | | UploadEndpoint | string | no | The endpoint of the OSS bucket that stores the backup file. : When calling the DescribeBuckets operation to query buckets, retrieve the… | | BackupFilePath | string | no | The OSS path to which the backup file is uploaded. When calling the describeBuckets operation to retrieve a bucket name, you must also… | | BackupAll | string | no | Specifies whether to back up the whole instance | ### Refreshes model authentication tokens `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/refresh-auth-tokens` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | LicenseKeys | string | no | The list of license keys | | InstanceIds | string | no | The list of instance IDs | | ExpireSeconds | integer | no | The validity period in seconds | ### Renews a Cloud Phone instance group. If a subscription instance group has been expired for 15 days, the… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/renew-android-instance-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceGroupIds | string | no | The list of instance group IDs (JSON-encoded) | | Period | integer | no | Specifies the renewal duration. The unit is specified by the PeriodUnit parameter | | PeriodUnit | string | no | The unit of the renewal duration, which is the unit of the Period parameter. Default value: Month | | AutoPay | string | no | Specifies whether to enable automatic payment | | PromotionId | string | no | The promotion ID | | PaidCallBackUrl | string | no | The redirect URL to the payment success page | ### Renews a cloud phone matrix `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/renew-cloud-phone-nodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | NodeIds | string | no | The list of cloud phone matrix IDs (JSON-encoded) | | PeriodUnit | string | no | The unit of the subscription period | | Period | integer | no | The subscription period of the resource. The unit is specified by PeriodUnit. If PeriodUnit is set to year, the only valid value is 1. If… | | AutoRenew | string | no | Specifies whether to enable auto-renewal | | AutoPay | string | no | Specifies whether to enable automatic payment. Default value: false | | PromotionId | string | no | The promotion ID | | PaidCallBackUrl | string | no | The redirect URL after a successful payment | ### Renews a resource plan `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/renew-mobile-agent-package` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | Period | integer | no | The subscription duration of the resource. The unit is specified by PeriodUnit | | PeriodUnit | string | no | The unit of the subscription duration of the resource. Valid values: Month: Month. Year: Year | | AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: Automatic payment is enabled. Make sure that your account balance is… | | PromotionId | string | no | The ID of the promotion | | ClientToken | string | no | The idempotency key | | MobileAgentPackageIds | string | no | The list of resource plan IDs (JSON-encoded) | | PaidCallbackUrl | string | no | The redirect URL for the payment success page | | AutoRenew | string | no | Specifies whether to enable auto-renewal. Default value: false | ### Resets a cloud phone instance. The reset process reinstalls the system by using the image of the cloud… `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/reset-android-instances-in-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIds | string | no | The list of instance IDs (JSON-encoded) | | SaleMode | string | no | [Deprecated] The sale mode | | SettingResetType | integer | no | Specifies whether to retain property settings during the reset. If this parameter is not specified, property configurations are not… | | IgnoreParamValidation | string | no | Specifies whether to skip parameter validation. A value of true indicates that parameter validation is skipped. A value of false or no… | | TargetDataDiskSize | integer | no | For instances in a cloud phone matrix, specify this parameter if you need to reduce the storage capacity during the reset. This feature is… | | AutoPay | string | no | Specifies whether to enable automatic payment. Default value: false | | PromotionId | string | no | The promotion ID | ### Resumes the running agent automation tasks on a Mobile node `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/resume-agent-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | TaskIds | string | yes | The list of task IDs (JSON-encoded) | | AdditionalPrompt | string | no | The additional prompt. This parameter takes effect only when the task is passively paused, such as pausing to wait for user confirmation | | ClarificationAnswers | string | no | The list of clarification answers submitted when resuming the task (JSON-encoded) | | ToolCallId | string | no | The ID of the tool invoke to resume | ### Triggers an agent on a Mobile node to execute an AI automation task `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/run-agent-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceIds | string | no | The list of Mobile node IDs. A single request supports up to 100 nodes (JSON-encoded) | | UserPrompt | string | no | The user prompt in natural language based on which the agent performs operations | | MaxSteps | integer | no | The maximum number of execution steps for the task to prevent infinite loops. Valid values: 50 to 1000. Default value: 50 | | TimeoutSeconds | integer | no | The timeout period for the task in seconds. Valid values: 300 to 3600. Default value: 3600 | | BizRegionId | string | no | The region ID of the Mobile node | | TaskConfigId | string | no | The task configuration ID used to trigger a task with the specified configuration | | ScheduleId | string | no | The scheduling plan ID. If specified, the execute record is associated with the corresponding scheduled node to facilitate aggregate query… | | RunConfig | string | no | The runtime configuration that carries the runtime parameters such as skills for the current task (JSON-encoded) | | Targets | string | no | The Targets array. Each element is an object that contains InstanceId and SessionId (JSON-encoded) | | SaveArtifacts | string | no | Specifies whether to write the task artifacts to the user's OSS | ### Executes a command on cloud phone instances `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/run-command` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceIds | string | no | The list of instance IDs. A single request supports up to 50 instances (JSON-encoded) | | CommandContent | string | no | The command content | | Timeout | integer | no | The timeout period. Unit: seconds. If the command is not completed within this period, the command execution status is set to timeout. If… | | AgentType | string | no | The channel type used to execute the command | | ContentEncoding | string | no | The encoding method of the command content (`CommandContent`). This parameter is case-insensitive. If the specified value is not within… | ### Executes a command on a cloud phone and attempts to return the result `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/run-sync-command` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | InstanceIds | string | no | The list of cloud phone instance IDs. A single request supports up to 50 instances (JSON-encoded) | | CommandContent | string | no | The content of the command | | WaitTime | integer | no | The wait time in milliseconds. Valid values: 500 to 3000. Default value: 1000 | | ContentEncoding | string | no | The encoding method of the script content. If the specified value is not within the valid values, the default value `PlainText` is used | ### Pushes files from Object Storage Service (OSS) or a public download link to one or more cloud phones `POST https://apizie.tech/v1/cloud:aliyun-eds-aic/send-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://eds-aic.ap-southeast-1.aliyuncs.com | | AndroidInstanceIdList | string | yes | The IDs of one or more cloud phone instances (JSON-encoded) | | SourceFilePath | string | yes | The destination path on the cloud phone. If `UploadType` is `OSS` or `OSS_BRIDGED`, `SourceFilePath` must specify a directory, for… | | UploadType | string | yes | The storage type of the source file. Valid values: OSS: The file is stored in Object Storage Service (OSS). DOWNLOAD_URL: The file is… | | UploadEndpoint | string | no | The service endpoint of Object Storage Service (OSS). This parameter is required if `UploadType` is `OSS` or `OSS_BRIDGED`. If the cloud… | | UploadUrl | string | yes | If `UploadType` is `OSS`, this parameter specifies the URI of the source object in Object Storage Service (OSS). The URI must be in the… | | TargetFileName | string | no | The name for the destination file on the cloud phone. This parameter is optional and takes effect only when `UploadType` is set to `OSS`… | | AutoInstall | string | no | Specifies whether to automatically install the application after the file is uploaded | | ClientToken | string | no | A client-generated token that ensures request idempotence and prevents duplicate submissions. The token can contain up to 100 characters | | FileMd5 | string | no | 传入文件的md5值 | …and 18 more. See the OpenAPI spec. ## Example ``` curl "https://apizie.tech/v1/cloud:aliyun-eds-aic/activate-edge-mobile-agent" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud CloudPhone API? Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-eds-aic/activate-edge-mobile-agent with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud CloudPhone API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud CloudPhone itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud CloudPhone API? Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-eds-aic. ### What is the status of the Alibaba Cloud CloudPhone API? Needs your own provider key (bring your own key)