### Application Management - Start App

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Start an application on an instance.

```APIDOC
## POST /vcpcloud/api/padApi/startApp

### Description
Start App.

### Method
POST

### Endpoint
/vcpcloud/api/padApi/startApp

### Request Body
- **packageName** (string) - Required - The package name of the app to start
- **instanceId** (string) - Required - The ID of the instance

### Response
#### Success Response (200)
- **code** (integer) - Response code
- **msg** (string) - Response message
```

--------------------------------

### Get Installed Apps Response

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example response structure for the 'Get All Installed Apps' API. It includes status, message, and a list of applications with their names and package names.

```json
{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "appName": "VMOSCloud",
            "packageName": "com.geniuscloud.overseas"
        },
        {
            "appName": "快手极速版",
            "packageName": "com.kuaishou.nebula"
        }
    ],
    "ts": 1746694111364
}

```

--------------------------------

### Install Application on Instances

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Installs one or more applications on specified instances. This is an asynchronous operation that supports allowlist/blocklist logic.

```json
{
 "apps":[
  {
   "appId":124,
   "appName":"AppName",
   "pkgName":"com.huluxia.gametools",
   "isGrantAllPerm":false,
   "padCodes":["AC22010020062"]
  }
 ]
}
```

--------------------------------

### Start Application on Instance

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Starts a specific application on an instance using its package name and instance code. Ensure the instance is online.

```json
{
	"padCodes": [
		"AC22010020062"
	],
	"pkgName": "xxx.test.com"
}
```

--------------------------------

### Application Management - Install App

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Install one or more apps on one or more instances at once; async operation with allowlist/blocklist support.

```APIDOC
## POST /vcpcloud/api/padApi/installApp

### Description
Install one or more apps on one or more instances at once; async operation with allowlist/blocklist support.

### Method
POST

### Endpoint
/vcpcloud/api/padApi/installApp

### Request Body
- **appUrls** (array) - Required - List of app URLs to install
- **instanceIds** (array) - Required - List of instance IDs to install apps on
- **allowlist** (array) - Optional - List of allowed app package names
- **blocklist** (array) - Optional - List of blocked app package names

### Response
#### Success Response (200)
- **code** (integer) - Response code
- **msg** (string) - Response message
- **taskId** (string) - ID of the asynchronous installation task
```

--------------------------------

### App Installation Callback JSON

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Represents the callback payload received after an application installation task completes.

```json
{
    "endTime": 1734939747000,
    "padCode": "AC22030022001",
    "taskBusinessType": 1003,
    "taskContent": "",
    "taskId": 10613,
    "taskResult": "Success",
    "taskStatus": 3
}
```

--------------------------------

### App Installation Callback

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Callback interface for receiving notifications about the status of app installations.

```APIDOC
## POST /callback/app_install

### Description
This endpoint serves as a callback interface to notify customers about the status of app installations on an instance.

### Method
POST

### Endpoint
/callback/app_install

### Parameters
#### Request Body
- **taskBusinessType** (Integer) - Required - Task business type. Example: 1003.
- **taskId** (Integer) - Required - Task ID. Example: 1.
- **apps** (Object[]) - Required - An array of app information objects.
  - **appId** (Integer) - Required - App ID. Example: 10001.
  - **appName** (String) - Required - App Name. Example: demo.
  - **pkgName** (String) - Required - Package Name. Example: com.xxx.demo.
  - **padCode** (String) - Required - Instance number. Example: AC22030022001.
  - **result** (Boolean) - Required - Installation result flag: true for success, false for failure.
  - **failMsg** (String) - Optional - Failure message if installation failed. Example: "This app is blacklisted and forbidden from installation".

### Request Example
```json
{
    "endTime": 1734939747000,
    "padCode": "AC22030022001",
    "taskBusinessType": 1003,
    "taskContent": "",
    "taskId": 10613,
    "taskResult": "Success",
    "taskStatus": 3,
    "apps": [
        {
            "appId": 10001,
            "appName": "demo",
            "pkgName": "com.xxx.demo",
            "padCode": "AC22030022001",
            "result": true,
            "failMsg": null
        }
    ]
}
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the success of the callback reception. Example: "OK".

#### Response Example
```json
{
    "status": "OK"
}
```
```

--------------------------------

### Instance Installed Application List Query

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Query the instance installed application list information.

```APIDOC
## POST /vcpcloud/api/padApi/listInstalledApp

### Description
Queries the list of applications installed on a specified instance.

### Method
POST

### Endpoint
/vcpcloud/api/padApi/listInstalledApp

### Parameters
#### Request Body
- **padCodes** (String[]) - Required - Instance identifier list
- **appName** (String) - Optional - Application name

### Request Example
```json
{
    "padCodes": ["AC32010780841"],
    "appName": null
}
```

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **msg** (String) - Response message
- **ts** (Long) - Timestamp
- **data** (Object[])
  - **padCode** (String) - Instance ID
  - **apps** (Object[]) - Application list
    - **appName** (String) - Application name
    - **packageName** (String) - Application package name
    - **versionName** (String) - Application version name
    - **versionCode** (String) - Application version code
    - **appState** (Integer) - 0 Completed, 1 Installing, 2 Downloading

#### Response Example
```json
{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "padCode": "AC32010780841",
            "apps": [
                {
                    "appName": "TapTap",
                    "packageName": "com.taptap.global",
                    "versionName": "3.49.0-full.100000",
                    "versionCode": "349001000",
                    "appState": 0
                }
            ]
        }
    ], 
    "ts": 1740020993436
}
```
```

--------------------------------

### Query Installed Applications

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Retrieves a list of applications installed on the specified instances.

```json
{
 "padCodes": ["AC32010250001"],
 "appName": ""
}
```

```json
{
    "code": 200,
    "msg": "success",
    "ts": 1756313784076,
    "data": [
        {
            "padCode": "ACP250417KYBOAXK",
            "apps": [
                {
                    "appName": "WeChat",
                    "packageName": "com.tencent.mm",
                    "versionCode": "2900",
                    "versionName": "8.0.62",
                    "appState": 0
                }
            ]
        }
    ],
    "traceId": "ewab8qh6vwg1"
}
```

--------------------------------

### POST /vcpcloud/api/padApi/installApp

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Installs one or more applications on one or more instances asynchronously.

```APIDOC
## POST /vcpcloud/api/padApi/installApp

### Description
Install one or more apps on one or more instances at once. This API is asynchronous and supports allowlist/blocklist logic.

### Method
POST

### Endpoint
/vcpcloud/api/padApi/installApp

### Parameters
#### Request Body
- **apps** (Object[]) - Required - Application list

### Request Example
{
	"apps":[
		{
			"appId":124,
			"appName":"AppName",
			"pkgName":"com.huluxia.gametools",
			"isGrantAllPerm":false,
			"padCodes":["AC22010020062"]
		}
	]
}

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **msg** (String) - Response message
- **ts** (Long) - Timestamp
- **data** (Object[]) - Task results

#### Response Example
{
	"code": 200,
	"msg": "success",
	"ts": 1717570991004,
	"data": [
		{
			"taskId": 37,
			"padCode": "AC22030010001",
			"vmStatus": 1,
			"taskStatus": 1
		}
	],
	"traceId": "ewab8qjqbaio"
}
```

--------------------------------

### Application Management - Instance Installed App List Query

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Query the list of installed applications for an instance.

```APIDOC
## GET /vcpcloud/api/padApi/listInstalledApp

### Description
Query the list of installed applications for an instance.

### Method
GET

### Endpoint
/vcpcloud/api/padApi/listInstalledApp

### Query Parameters
- **instanceId** (string) - Required - The ID of the instance

### Response
#### Success Response (200)
- **code** (integer) - Response code
- **msg** (string) - Response message
- **data** (array) - List of installed applications
```

--------------------------------

### POST /vcpcloud/api/padApi/startApp

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Starts an application on an instance based on the instance ID and package name.

```APIDOC
## POST /vcpcloud/api/padApi/startApp

### Description
Start an app on an instance based on the instance ID and app package name.

### Method
POST

### Endpoint
/vcpcloud/api/padApi/startApp

### Parameters
#### Request Body
- **pkgName** (String) - Required - Package Name
- **padCodes** (String[]) - Required - Instance Codes

### Request Example
{
	"padCodes": ["AC22010020062"],
	"pkgName": "xxx.test.com"
}

### Response
#### Success Response (200)
- **code** (Integer) - Status Code
- **msg** (String) - Response Message
- **ts** (Long) - Timestamp
- **data** (Object[]) - Task results

#### Response Example
{
	"code": 200,
	"msg": "success",
	"ts": 1717570663080,
	"data": [
		{
			"taskId": 24,
			"padCode": "AC22010020062",
			"vmStatus": 1
		}
	]
}
```

--------------------------------

### Get Installed Apps Request

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Use this snippet to request a list of all installed applications on specified cloud instances. Ensure the 'padCodeList' contains valid instance codes.

```json
{
    "padCodeList": ["AC32010601132"]
}

```

--------------------------------

### Get All Installed Apps in Specified Cloud Instance List

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Retrieves a list of all installed applications on specified cloud instances.

```APIDOC
## POST /vcpcloud/api/padApi/getListInstalledApp

### Description
Retrieves a list of all installed applications on specified cloud instances.

### Method
POST

### Endpoint
/vcpcloud/api/padApi/getListInstalledApp

### Parameters
#### Request Body
- **padCodeList** (String[]) - Required - List of instance codes.
  - **padCode** (String) - Required - Instance code.

### Request Example
```json
{
    "padCodeList": ["AC32010601132"]
}
```

### Response
#### Success Response (200)
- **code** (Integer) - Status code.
- **msg** (String) - Response message.
- **ts** (Long) - Timestamp.
- **data** (Object[]) - List of installed apps.
  - **appName** (String) - App name.
  - **packageName** (String) - Package name.

#### Response Example
```json
{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "appName": "VMOSCloud",
            "packageName": "com.geniuscloud.overseas"
        },
        {
            "appName": "快手极速版",
            "packageName": "com.kuaishou.nebula"
        }
    ],
    "ts": 1746694111364
}
```
```

--------------------------------

### Instance Details Response Example

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

This is an example of a successful response when querying instance details. It includes status codes, messages, and paginated data for instances.

```json
{
    "code": 200,
    "msg": "success",
    "ts": 1756360093771,
    "data": {
        "page": 1,
        "rows": 10,
        "size": 10,
        "total": 13398,
        "totalPage": 1340,
        "pageData": [
            {
                "padId": 552,
                "padCode": "ACP250331GLMP7YX",
                "customerId": null,

```

--------------------------------

### Query Installed Application List Request and Response

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

JSON payloads for retrieving the list of applications installed on specific instances.

```json
{
    "padCodes": ["AC32010780841"],
    "appName": null
}
```

```json
{
    "msg": "success",
        "code": 200,
        "data": [
            {
                "padCode": "AC32010780841",
                "apps": [
                    {
                        "appName": "TapTap",
                        "packageName": "com.taptap.global",
                        "versionName": "3.49.0-full.100000",
                        "versionCode": "349001000",
                        "appState": 0
                    }
                ]
            }
        ], 
        "ts": 1740020993436
}
```

--------------------------------

### Create Dynamic Proxy

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Request and response examples for creating a new dynamic proxy instance.

```json
{
    "proxyHost": "xxxxx:7778",
    "countryCode": "CN",
    "state": "Sichuan",
    "city": "Sichuan",
    "time": 5,
    "proxyType": "socks5",
    "proxyUseType": "vpn"
}
```

```json
{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "id": 82750,
            "proxyHost": "E44S5YaWP660_custom_zone_HK_st_Kowloon_city_sid_27165697_time_10"
        }
    ],
    "ts": 1760068573317
}
```

--------------------------------

### Retrieve SKU Package List Response Example

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example JSON response structure for the SKU package list API.

```json
{
    "msg": "success",
        "code": 200,
        "data": {
        "configs": [
            {
                "configName": "Samsung Galaxy A53",
                "sellOutFlag": false,
                "defaultSelection": false,
                "custom": 1,
                "match": false,
                "reorder": 0,
                "configModel": "Samsung",
                "countryList": [
                    { "armCountryCode": "HK",
                        "sellOutFlag": false,
                        "soutienTime": true,
                        "timingSellOutFlag": true,
                        "armCountryMsg": "Hong Kong"
                    }],
                "timingSellOutFlag": true,
                "androidVersion": "13",
                "configBlurb": "Top technology, comparable to the ultimate experience of a real machine!",
                "configId": 13,
                "defaultTimeSelection": false,
                "goodTimes": [
                    {
                        "oldGoodPrice": 105,
                        "supportSigning": true,
                        "defaultSelection": false,
                        "iosGoodsId": "",
                        "showContent": "1 day",
                        "whetherFirstPurchase": false,
                        "chargeType": 1,
                        "currentPrice": 100,
                        "reorder": 1,
                        "goodPrice": 100,
                        "equipmentNumber": 1,
                        "goodTime": 1440,
                        "autoRenew": true,
                        "recommendContent": "5% Off",
                        "id": 74
                    }],
                "serviceProviderType": 4
            }],
            "goodId": 1
    }
```

--------------------------------

### App Start Callback

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Callback interface for receiving notifications about the status of app startup.

```APIDOC
## POST /callback/app_start

### Description
This endpoint serves as a callback interface to notify customers about the status of app startup on an instance.

### Method
POST

### Endpoint
/callback/app_start

### Parameters
#### Request Body
- **taskBusinessType** (Integer) - Required - Task business type. Example: 1007.
- **taskId** (Integer) - Required - Task ID. Example: 1.
- **taskStatus** (Integer) - Required - Task status. Possible values: -1 (Total failure), -3 (Cancel), -4 (Timeout), 1 (Pending), 2 (Executing), 3 (Completed).
- **padCode** (String) - Required - Instance identifier. Example: AC22030022001.
- **pkgName** (String) - Required - Package Name of the app. Example: xxx.test.com.

### Request Example
```json
{
    "taskBusinessType": 1007,
    "packageName": "com.quark.browser",
    "padCode": "AC22030022001",
    "taskId": 10618,
    "taskStatus": 3
}
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the success of the callback reception. Example: "OK".

#### Response Example
```json
{
    "status": "OK"
}
```
```

--------------------------------

### Query Dynamic Proxy Product List Response

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example response showing available dynamic proxy products and their specifications.

```json
{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "goodName": "2GB",
            "goodId": 1,
            "goodPrice": 1000,
            "protocolDescription": "HTTP(S)/SOCKS5",
            "totalTraffic": 2048
        }
    ],
    "ts": 1740643153803
}
```

--------------------------------

### Real-Time Query Installed Apps List API

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

This API retrieves a list of installed applications on specified instances.

```APIDOC
## POST /vcpcloud/api/padApi/listInstalledApp

### Description
Queries the list of installed applications on one or more instances.

### Method
POST

### Endpoint
/vcpcloud/api/padApi/listInstalledApp

### Parameters
#### Request Body Parameters
- **padCodes** (String[]) - Yes - List of instance codes to query.
- **appName** (String) - No - Filter by application name.

### Request Example
```json
{
 "padCodes": ["AC32010250001"],
 "appName": ""
}
```

### Response
#### Success Response (200)
- **code** (Integer) - Status code.
- **msg** (String) - Response message.
- **ts** (Long) - Timestamp.
- **traceId** (String) - Trace ID.
- **data** (Object[]) - List of instances with their installed apps.
  - **padCode** (String) - Instance code.
  - **apps** (Object[]) - List of installed applications.
    - **appName** (String) - App name.
    - **packageName** (String) - Package name.
    - **versionCode** (String) - Version code.
    - **versionName** (String) - Version name.
    - **appState** (Integer) - App state (0: installed, 1: installing, 2: downloading).

#### Response Example
```json
{
    "code": 200,
    "msg": "success",
    "ts": 1756313784076,
    "data": [
        {
            "padCode": "ACP250417KYBOAXK",
            "apps": [
                {
                    "appName": "WeChat",
                    "packageName": "com.tencent.mm",
                    "versionCode": "8.0.62",
                    "versionName": "8.0.62",
                    "appState": 0
                }
            ]
        }
    ],
    "traceId": "ewab8qh6vwg1"
}
```
```

--------------------------------

### App Start Callback JSON

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Represents the callback payload received after an application startup task completes.

```json
{
    "taskBusinessType": 1007,
    "packageName": "com.quark.browser",
    "padCode": "AC22030022001",
    "taskId": 10618,
    "taskStatus": 3
}
```

--------------------------------

### GET /vcpcloud/api/padApi/getDynamicGoodService

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Retrieves the list of available dynamic proxy products.

```APIDOC
## GET /vcpcloud/api/padApi/getDynamicGoodService

### Description
Retrieves the list of available dynamic proxy products.

### Method
GET

### Endpoint
/vcpcloud/api/padApi/getDynamicGoodService

### Response
#### Success Response (200)
- **msg** (String) - Response message
- **code** (Integer) - Status code
- **ts** (Integer) - Timestamp
- **data** (Object[]) - List of dynamic proxy products

#### Response Example
{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "goodName": "2GB",
            "goodId": 1,
            "goodPrice": 1000,
            "protocolDescription": "HTTP(S)/SOCKS5",
            "totalTraffic": 2048
        }
    ],
    "ts": 1740643153803
}
```

--------------------------------

### Handle One-Key New Device Responses

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Examples of successful and error responses for the device reset operation.

```json
{
  "code": 200,
  "msg": "success",
  "ts": 1732270378320,
  "data": {
    "taskId": 8405,
    "padCode": "AC32010250031",
    "vmStatus": 2,
    "taskStatus": 1
  },
  "traceId": "ewab8qjqbaio"
}
```

```json
{
   "code": 500,
   "msg": "Currently not supporting country code: xx",
   "ts": 1753521350163,
   "data": null,
    "traceId": "ewab8qjqbaio"
}
```

--------------------------------

### Query Instance Operation Task Details

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Request and response examples for retrieving the status and details of instance operation tasks.

```json
{
 "taskIds":[1,2]
}
```

```json
{
    "code": 200,
    "msg": "success",
    "ts": 1756313781081,
    "data": [
        {
            "taskId": 22323794,
            "padCode": "ACN250828DYJE95Z",
            "taskStatus": 2,
            "endTime": null,
            "taskContent": null,
            "taskResult": null,
            "errorMsg": null
        }
    ],
    "traceId": "ewab8kpxb7k0"
}
```

--------------------------------

### File Task Response

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example response containing the execution status and details for file tasks.

```json
{
	"code": 200,
	"msg": "success",
	"ts": 1716283460673,
	"data": [
		{
			"taskId": 1,
			"appId": 134,
			"fileUniqueId": "e2c07491309858c5cade4bfc44c03724",
			"fileName": "xx.apk",
			"taskStatus": 2,
			"endTime": 1713429401000
		},
		{
			"taskId": 2,
			"appId": 135,
			"fileUniqueId": "e2c07491309858c5cade4bfc43c03725",
			"fileName": "xx.apk",
			"taskStatus": 2,
			"endTime": 1713429401001
		}
	]
}
```

--------------------------------

### GET /vcpcloud/api/padApi/proxyGoodList

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Retrieves the list of available static residential proxy products.

```APIDOC
## GET /vcpcloud/api/padApi/proxyGoodList

### Description
Retrieves the list of available static residential proxy products.

### Method
GET

### Endpoint
/vcpcloud/api/padApi/proxyGoodList

### Response
#### Success Response (200)
- **msg** (String) - Response message
- **code** (Integer) - Status code
- **data** (Object[]) - List of proxy products

#### Response Example
{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "proxyGoodName": "5 days",
            "proxyGoodId": 4,
            "proxyGoodTime": 7200,
            "proxyGoodType": 2,
            "proxyGoodPrice": 200
        }
    ],
    "ts": 1747734076860
}
```

--------------------------------

### Instance Operation Task Response

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example response containing the execution status and details for instance operation tasks.

```json
{
	"code": 200,
	"msg": "success",
	"ts": 1716283460673,
	"data": [
		{
			"taskId": 1,
			"padCode": "AC22030022441",
			"taskStatus": 2,
			"endTime": 1713429401000,
			"taskContent": null,
			"taskResult": null
		},
		{
			"taskId": 2,
			"padCode": "AC22030022442",
			"taskStatus": 2,
			"endTime": 1713429401001,
			"taskContent": null,
			"taskResult": null
		}
	]
}
```

--------------------------------

### Get Instance List Information

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Retrieves a paginated list of instances based on provided query filters.

```json
{
"page": 1,
"rows": 10,
"padCodes": [
"AC21020010391"
]
}
```

```json
{
"code": 200,
"msg": "success",
"ts":1713773577581,
"data": {
"page": 1,
"rows": 1,
"size": 1,
"total": 1,
"totalPage": 1,
"pageData": [
{
{
"padCode": "AC21020010391",
"padGrade": "q2-4",
"padStatus": 10,
"idcCode": "8e61ad284bc105b877611e6fef7bdd17",
"deviceIp": "172.31.2.34",
"padIp": "10.255.1.19",
"apps": [
"armcloud001"
]
}
]
}
}
```

--------------------------------

### GET /vcpcloud/api/padApi/getCloudGoodList

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Retrieves the list of available cloud SKU packages, including device configurations and pricing options.

```APIDOC
## GET /vcpcloud/api/padApi/getCloudGoodList

### Description
Retrieves the list of available cloud SKU packages, including device configurations and pricing options.

### Method
GET

### Endpoint
/vcpcloud/api/padApi/getCloudGoodList

### Parameters
#### Query Parameters
- **androidVersion** (Integer) - Optional - androidVersion(optional, default: Android 13)

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **msg** (String) - Response message
- **ts** (Long) - Timestamp (milliseconds)
- **data** (Object) - Response body

#### Response Example
{
    "msg": "success",
    "code": 200,
    "data": {
        "configs": [
            {
                "configName": "Samsung Galaxy A53",
                "sellOutFlag": false,
                "defaultSelection": false,
                "custom": 1,
                "match": false,
                "reorder": 0,
                "configModel": "Samsung",
                "countryList": [
                    {
                        "armCountryCode": "HK",
                        "sellOutFlag": false,
                        "soutienTime": true,
                        "timingSellOutFlag": true,
                        "armCountryMsg": "Hong Kong"
                    }
                ],
                "timingSellOutFlag": true,
                "androidVersion": "13",
                "configBlurb": "Top technology, comparable to the ultimate experience of a real machine!",
                "configId": 13,
                "defaultTimeSelection": false,
                "goodTimes": [
                    {
                        "oldGoodPrice": 105,
                        "supportSigning": true,
                        "defaultSelection": false,
                        "iosGoodsId": "",
                        "showContent": "1 day",
                        "whetherFirstPurchase": false,
                        "chargeType": 1,
                        "currentPrice": 100,
                        "reorder": 1,
                        "goodPrice": 100,
                        "equipmentNumber": 1,
                        "goodTime": 1440,
                        "autoRenew": true,
                        "recommendContent": "5% Off",
                        "id": 74
                    }
                ],
                "serviceProviderType": 4
            }
        ],
        "goodId": 1
    }
}
```

--------------------------------

### Query Purchased Email List Request

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example GET request to retrieve a list of purchased emails with pagination and filtering parameters.

```http
/vcpcloud/api/vcEmailService/getEmailOrder?page=1&size=10&serviceId=2&email=yzxovmq&status=0
```

--------------------------------

### Get Instance Script Execution Result

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Request and response examples for checking the outcome of a script execution task using its ID.

```json
{
 "taskIds": [1]
}
```

```json
{
    "code": 200,
    "msg": "success",
    "ts": 1752214432301,
    "data": [
        {
            "taskId": 49884,
            "padCode": "ATP250707FNSVRMC",
            "taskStatus": 3,
            "endTime": 1752214271000,
            "taskContent": null,
            "taskResult": null,
            "errorMsg": "调用Adb命令成功"
        }
    ],
    "traceId": "erl0i57h6v40"
}
```

--------------------------------

### Refresh Email Verification Code Request

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example GET request to refresh the verification code for a specific order using the external order ID.

```http
/vcpcloud/api/vcEmailService/getEmailCode?orderId=1917193290790019073
```

--------------------------------

### Create Local Instance Backup Response

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

This is a successful response example for creating a local instance backup. It includes task details and status information.

```json
{
  "code": 200,
  "msg": "success",
  "ts": 1758271736814,
  "data": {
    "taskId": 59,
    "padCode": "ACP25091XXXXXX15",
    "vmStatus": 0,
    "taskStatus": 1,
    "errMsg": null,
    "backupName": "backnameinfo",
    "backupId": "bkp-ACP25091XXXXXX15-1758271735910"
  },
  "traceId": "eyj68nk6dnuo"
}

```

--------------------------------

### Paginated Get Real Device Templates Response

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

This is an example of a successful response when retrieving real device templates. It includes pagination details and a list of device records.

```json
{
    "msg": "success",
        "code": 200,
        "data": {
        "records": [
            {
                "goodFingerprintId": 36,
                "goodConfigId": null,
                "goodFingerprintName": "Google Pixel 7 Pro",
                "goodFingerprintModel": null,
                "goodFingerprintBrand": null,
                "goodAndroidVersion": "13",
                "goodStatus": null
            } ],
            "total": 638,
            "size": 10,
            "current": 1,
            "orders": [],
            "optimizeCountSql": true,
            "searchCount": true,
            "maxLimit": null,
            "countId": null,
            "pages": 64
    }
    "ts": 1770257529924
}
```

--------------------------------

### One-Click New Device Callback Example

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Callback triggered after a One-Click New Device task is completed. Provides details on the task, instance, and outcome.

```json
{
    "taskBusinessType": 1124,
    "padCode": "212254",
    "taskStatus": 3,
    "taskId": 1,
    "taskContent": "-",
    "endTime": 1756021166163,
    "taskResult": "Success"
}
```

--------------------------------

### Query Instance Properties Response

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example JSON response containing the instance properties including modem, system, setting, and OAID lists.

```json
{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": {
  "padCode": "AC21020010001",
  "modemPropertiesList": [
   {
    "propertiesName": "IMEI",
    "propertiesValue": "412327621057784"
   }
  ],
  "systemPropertiesList": [
   {
    "propertiesName": "ro.build.id",
    "propertiesValue": "QQ3A.200805.001"
   }
  ],
  "settingPropertiesList": [
   {
    "propertiesName": "ro.build.tags",
    "propertiesValue": "release-keys"
   }
  ],
  "oaidPropertiesList": [
   {
    "propertiesName": "oaid",
    "propertiesValue": "001"
   }
  ]
 }
}
```

--------------------------------

### Response Example for Modify SIM Card Information (Error)

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example of an error response when the country code is not supported.

```json
{
   "code": 500,
   "msg": "Currently not supporting country code: XX",
   "ts": 1753521350163,
   "data": null
}

```

--------------------------------

### Response Example for Modify Instance Android Properties

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example of a successful response after modifying Android properties. Includes task ID and status.

```json
{
    "code": 200,
    "msg": "success",
    "ts": 1756313781338,
    "data": {
        "taskId": 760459884,
        "padCode": "AC32010160134",
        "vmStatus": 0,
        "taskStatus": 1
    },
    "traceId": "ewab8l4lqu4g"
}

```

--------------------------------

### Response Example for Modify SIM Card Information (Success)

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Example of a successful response when modifying SIM card information. Indicates the task was added successfully.

```json
{
    "code": 200,
    "msg": "success",
    "ts": 1756360113813,
    "data": {
        "taskId": 10002486,
        "padCode": "ACN342712020172800",
        "vmStatus": 0,
        "taskStatus": 1
    },
    "traceId": "ewc84g8si0oy"
}

```

--------------------------------

### Local Instance Backup Query Response

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

This is an example of a successful response when querying for local instance backups. It returns pagination information and a list of backup details, including backup ID, name, and path.

```json
{
  "code": 200,
  "msg": "success",
  "ts": 1764819200220,
  "data": {
    "page": 1,
    "rows": 10,
    "size": 1,
    "total": 1,
    "totalPage": 1,
    "pageData": [
      {
        "padCode": "ACP5C24S9G6xxxxx",
        "backupId": "bkp-xxxxxS4QBMGEW1ZX-1764728535556",
        "backupName": "android13-xxxx-虚拟机-img-25112665572-王者荣耀+抖音",
        "backupPath": "backup/data/",
        "endpoint": "oss-cn-xxxxxx.xxxxxxx.com",
        "bucket": "armcloud-xx",
        "protocol": "https",
        "region": "cn-hongkong"
      }
    ]
  },
  "traceId": "f61kq5vu5ts0"
}
```

--------------------------------

### POST /vcpcloud/api/padApi/addUserRom

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Uploads a new user ROM image to the cloud system.

```APIDOC
## POST /vcpcloud/api/padApi/addUserRom

### Description
Uploads a user ROM image with metadata including version, Android version, and download URL.

### Method
POST

### Endpoint
/vcpcloud/api/padApi/addUserRom

### Parameters
#### Request Body
- **name** (String) - Required - ROM name
- **updateLog** (String) - Required - Update log
- **androidVersion** (String) - Required - Android version
- **version** (String) - Required - Version
- **downloadUrl** (String) - Required - Download URL
- **packageSize** (String) - Required - Size (bytes)

### Request Example
{
    "name": "CloudROM-13-11",
    "updateLog": "更新日志",
    "androidVersion": "13",
    "version": "v1.0.0",
    "downloadUrl": "https://file.vmoscloud.com/userFile/userRom/d281d848eff49adee2dda2475235b80b2.tar",
    "packageSize": 236978175
}

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **msg** (String) - Response message
- **ts** (Long) - Timestamp
- **data** (String) - Image ID

#### Response Example
{
    "msg": "success",
    "code": 200,
    "data": "img-2505287582886572",
    "ts": 1748425758327
}
```

--------------------------------

### Get Instance Real-Time Preview Image Request

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Request to get a real-time preview image for specified instances. Supports batch requests and image format/size customization.

```json
{
    "padCodes": [
        "AC11010000031",
        "AC11010000032"
    ],
    "format": "png"
}
```

--------------------------------

### Batch Get ADB Connection Information

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Use this endpoint to batch get or disable ADB connection information for instances. It supports a maximum of 10 instances per call. If enabling ADB is successful but connection info is incomplete, re-enable the instance first.

```json
{
    "padCodes": [
        "AC32010250032",
        "AC32010250033"
    ],
    "enable": true
}
```

```json
{
    "code": 200,
    "msg": "success",
    "traceId": "ewbssur1jbwg",
    "ts": 1736922808949,
    "data": {
        "successList": [
            {
                "padCode": "AC32010250032",
                "command": "ssh -oHostKeyAlgorithms=+ssh-rsa 10.255.3.2_001_1736922765389@156.59.80.166 -p 1824 -L 8572:adb-proxy:53728 -Nf",
                "expireTime": "2025-01-16 14:32:00",
                "enable": true,
                "key": "3CXr3FJZ6gbnGuJctDOpP9M6X6Rl786xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==",
                "adb": "adb connect localhost:8577"
            }
        ],
        "failedList": [
            {
                "padCode": "AC32010250034",
                "errorMsg": "实例未运行",
                "errorCode": "PAD_NOT_RUNNING"
            }
        ]
    }
}
```

--------------------------------

### POST /vcpcloud/api/padApi/localPodBackup

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Creates a backup for a local instance. This endpoint requires S3-compatible OSS configuration for storage.

```APIDOC
## POST /vcpcloud/api/padApi/localPodBackup

### Description
Create a backup for a local instance. This endpoint is currently pending launch.

### Method
POST

### Endpoint
/vcpcloud/api/padApi/localPodBackup

### Parameters
#### Request Body
- **padCode** (String) - Required - Instance code (max 64 chars)
- **backupName** (String) - Optional - Backup name (max 128 chars)
- **backupPath** (String) - Optional - Path (no leading /; default root /{backupID}/ ; max 256 chars)
- **ossConfig** (Object) - Required - S3-compatible OSS config
  - **endpoint** (String) - Required - OSS endpoint (max 128 chars)
  - **bucket** (String) - Required - Bucket name (max 128 chars)
  - **accessKey** (String) - Required - Access key (max 128 chars)
  - **secretKey** (String) - Required - Secret key (max 128 chars)
  - **protocol** (String) - Required - Protocol: http or https (max 16 chars)
  - **region** (String) - Required - Region (max 32 chars)
  - **securityToken** (String) - Required if credentialType=2 - Temporary token
  - **expiration** (String) - Required if credentialType=2 - Expiration
- **credentialType** (Integer) - Optional - Credential type: 1-permanent, 2-temporary

### Request Example
{
  "padCode": "ACP25091XXXXXX15",
  "backupName": "backnameinfo",
  "backupPath": "backup/data/",
  "credentialType": 1,
  "ossConfig": {
    "endpoint": "oss-cn-xxxxx.xxxxx.com",
    "bucket": "armcloud-cn",
    "accessKey": "LTAI5txxxxxxxYC",
    "secretKey": "kjgvYxxxxxxxxxxx8URWU",
    "protocol": "httpxxxx",
    "region": "cn-xxxxx"
  }
}

### Response
#### Success Response (200)
- **code** (Integer) - Status code (200 success)
- **msg** (String) - Request status
- **ts** (Long) - Timestamp
- **data** (Object) - Task info
  - **taskId** (Long) - Task ID
  - **padCode** (String) - Instance code
  - **vmStatus** (Integer) - Online status: 0-offline, 1-online
  - **taskStatus** (Integer) - Task status: -1 exists, 1 added
  - **errMsg** (String) - Error message
  - **backupName** (String) - Backup name
  - **backupId** (String) - Backup ID
- **traceId** (String) - Trace ID

#### Response Example
{
  "code": 200,
  "msg": "success",
  "ts": 1758271736814,
  "data": {
    "taskId": 59,
    "padCode": "ACP25091XXXXXX15",
    "vmStatus": 0,
    "taskStatus": 1,
    "errMsg": null,
    "backupName": "backnameinfo",
    "backupId": "bkp-ACP25091XXXXXX15-1758271735910"
  },
  "traceId": "eyj68nk6dnuo"
}
```

--------------------------------

### GET /vcpcloud/api/padApi/getEmailServiceList

Source: https://cloud.vmoscloud.com/vmoscloud/doc/en/server/OpenAPI.html

Retrieves the list of available email services.

```APIDOC
## GET /vcpcloud/api/padApi/getEmailServiceList

### Description
Fetches the list of available email services and their sub-services.

### Method
GET

### Endpoint
/vcpcloud/api/padApi/getEmailServiceList

### Response
#### Success Response (200)
- **msg** (String) - Response message
- **code** (Integer) - Status code
- **ts** (Integer) - Timestamp
- **data** (Object[]) - List of services

#### Response Example
{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "price": 0.01,
            "stockNum": 300,
            "serviceId": 1,
            "serviceName": "Github",
            "items": [
                {
                    "serviceItemId": 1,
                    "serviceItemName": "Github Register"
                }
            ]
        }
    ],
    "ts": 1745825162018
}
```