summaryrefslogtreecommitdiff
path: root/data/zh_cn/eds-aic/2023-09-30/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/eds-aic/2023-09-30/api-docs.php')
-rw-r--r--data/zh_cn/eds-aic/2023-09-30/api-docs.php18266
1 files changed, 7428 insertions, 10838 deletions
diff --git a/data/zh_cn/eds-aic/2023-09-30/api-docs.php b/data/zh_cn/eds-aic/2023-09-30/api-docs.php
index 96d5f68..249b80f 100644
--- a/data/zh_cn/eds-aic/2023-09-30/api-docs.php
+++ b/data/zh_cn/eds-aic/2023-09-30/api-docs.php
@@ -1,47 +1,26 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'eds-aic',
- 'version' => '2023-09-30',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'eds-aic', 'version' => '2023-09-30'],
'directories' => [
[
- 'id' => 365432,
- 'title' => '云手机矩阵',
+ 'children' => ['CreateCreditPackage', 'DescribeCreditPackage', 'CreateMobileAgentPackage', 'DeleteMobileAgentPackage', 'DescribeMobileAgentPackage', 'RenewMobileAgentPackage', 'ModifyJVSInstance', 'DescribeJVSInstance', 'RunAgentTask', 'DescribeAgentTask', 'CancelAgentTask', 'PauseAgentTask', 'ResumeAgentTask', 'DescribeCreditDetail'],
'type' => 'directory',
- 'children' => [
- 'CreateCloudPhoneNode',
- 'DescribeCloudPhoneNodes',
- 'ModifyCloudPhoneNode',
- 'RenewCloudPhoneNodes',
- 'ChangeCloudPhoneNode',
- 'ExpandDataVolume',
- 'DeleteCloudPhoneNodes',
- ],
+ 'title' => 'JVS Mobile',
+ 'id' => 439887,
],
[
- 'id' => 365440,
- 'title' => '实例组',
+ 'children' => ['CreateCloudPhoneNode', 'DescribeCloudPhoneNodes', 'ModifyCloudPhoneNode', 'RenewCloudPhoneNodes', 'ChangeCloudPhoneNode', 'ExpandDataVolume', 'DeleteCloudPhoneNodes'],
'type' => 'directory',
- 'children' => [
- 'DescribeRegions',
- 'DescribeSpec',
- 'CheckResourceStock',
- 'CreateAndroidInstanceGroup',
- 'DescribeAndroidInstanceGroups',
- 'ModifyAndroidInstanceGroup',
- 'UpgradeAndroidInstanceGroup',
- 'DowngradeAndroidInstanceGroup',
- 'RenewAndroidInstanceGroups',
- 'UpdateInstanceGroupImage',
- 'DeleteAndroidInstanceGroup',
- ],
+ 'title' => '云手机矩阵',
+ 'id' => 432663,
],
[
- 'id' => 365452,
- 'title' => '实例',
+ 'children' => ['DescribeSpec', 'CheckResourceStock', 'CreateAndroidInstanceGroup', 'DescribeAndroidInstanceGroups', 'ModifyAndroidInstanceGroup', 'UpgradeAndroidInstanceGroup', 'DowngradeAndroidInstanceGroup', 'RenewAndroidInstanceGroups', 'UpdateInstanceGroupImage', 'DeleteAndroidInstanceGroup'],
'type' => 'directory',
+ 'title' => '实例组',
+ 'id' => 432671,
+ ],
+ [
'children' => [
'DescribeAndroidInstances',
'ModifyAndroidInstance',
@@ -50,7 +29,6 @@
'StopAndroidInstance',
'RebootAndroidInstancesInGroup',
'ResetAndroidInstancesInGroup',
- 'ModifyInstanceChargeType',
'UpdateInstanceImage',
'ExpandPhoneDataVolume',
'InstanceHealer',
@@ -58,1194 +36,299 @@
'StopInstanceAdb',
'ListInstanceAdbAttributes',
[
- 'id' => 365467,
- 'title' => '连接&断连',
+ 'children' => ['BatchGetAcpConnectionTicket', 'DisconnectAndroidInstance'],
'type' => 'directory',
- 'children' => [
- 'BatchGetAcpConnectionTicket',
- 'DisconnectAndroidInstance',
- ],
+ 'title' => '连接&断连',
+ 'id' => 432698,
],
[
- 'id' => 365470,
- 'title' => '远程命令',
+ 'children' => ['RunCommand', 'DescribeInvocations', 'RunSyncCommand'],
'type' => 'directory',
- 'children' => [
- 'RunCommand',
- 'DescribeInvocations',
- ],
+ 'title' => '远程命令',
+ 'id' => 432701,
],
[
- 'id' => 365473,
- 'title' => '文件上传下载',
+ 'children' => ['SendFile', 'FetchFile'],
'type' => 'directory',
- 'children' => [
- 'SendFile',
- 'FetchFile',
- ],
+ 'title' => '文件上传下载',
+ 'id' => 432705,
],
[
- 'id' => 365476,
- 'title' => '截屏',
+ 'children' => ['CreateScreenshot'],
'type' => 'directory',
- 'children' => [
- 'CreateScreenshot',
- ],
+ 'title' => '截屏',
+ 'id' => 432708,
],
[
- 'id' => 365478,
- 'title' => '流协同',
+ 'children' => ['GenerateCoordinationCode', 'EndCoordination'],
'type' => 'directory',
- 'children' => [
- 'GenerateCoordinationCode',
- 'EndCoordination',
- ],
+ 'title' => '流协同',
+ 'id' => 432710,
],
],
- ],
- [
- 'id' => 365481,
- 'title' => '镜像',
'type' => 'directory',
- 'children' => [
- 'CreateCustomImage',
- 'DescribeImageList',
- 'UpdateCustomImageName',
- 'DistributeImage',
- 'DeleteImages',
- ],
+ 'title' => '实例',
+ 'id' => 432683,
],
[
- 'id' => 365487,
- 'title' => '应用',
+ 'children' => ['ImportImage', 'DescribeImageList', 'CreateCustomImage', 'UpdateCustomImageName', 'DistributeImage', 'DeleteImages'],
'type' => 'directory',
- 'children' => [
- 'CreateApp',
- 'DescribeApps',
- 'ModifyApp',
- 'DeleteApps',
- 'InstallApp',
- 'UninstallApp',
- 'OperateApp',
- ],
+ 'title' => '镜像',
+ 'id' => 432713,
],
[
- 'id' => 365495,
- 'title' => '密钥',
+ 'children' => ['CreateApp', 'DescribeApps', 'ModifyApp', 'DeleteApps', 'InstallApp', 'UninstallApp', 'OperateApp'],
'type' => 'directory',
- 'children' => [
- 'CreateKeyPair',
- 'ImportKeyPair',
- 'DescribeKeyPairs',
- 'ModifyKeyPairName',
- 'DeleteKeyPairs',
- 'AttachKeyPair',
- 'DetachKeyPair',
- ],
+ 'title' => '应用',
+ 'id' => 432719,
],
[
- 'id' => 365503,
- 'title' => '备份',
+ 'children' => ['CreateKeyPair', 'DescribeKeyPairs', 'ImportKeyPair', 'ModifyKeyPairName', 'DeleteKeyPairs', 'AttachKeyPair', 'DetachKeyPair', 'SetAdbSecure'],
'type' => 'directory',
- 'children' => [
- 'BackupAndroidInstance',
- 'BackupApp',
- 'RecoverAndroidInstance',
- 'RecoverApp',
- 'BackupFile',
- 'RecoveryFile',
- 'DescribeBackupFiles',
- 'DeleteBackupFile',
- ],
+ 'title' => '密钥',
+ 'id' => 432727,
],
[
- 'id' => 365512,
- 'title' => '策略',
+ 'children' => ['DescribeBackupFiles', 'DescribeBuckets', 'BackupAndroidInstance', 'BackupApp', 'RecoverAndroidInstance', 'RecoverApp', 'BackupFile', 'RecoveryFile', 'DeleteBackupFile'],
'type' => 'directory',
- 'children' => [
- 'CreatePolicyGroup',
- 'ListPolicyGroups',
- 'ModifyPolicyGroup',
- 'DeletePolicyGroup',
- ],
+ 'title' => '备份',
+ 'id' => 432735,
],
[
- 'id' => 365517,
- 'title' => '系统属性模板',
+ 'children' => ['CreatePolicyGroup', 'ListPolicyGroups', 'ModifyPolicyGroup', 'DeletePolicyGroup'],
'type' => 'directory',
- 'children' => [
- 'CreateSystemPropertyTemplate',
- 'SendSystemPropertyTemplate',
- 'DescribeSystemPropertyTemplates',
- 'GetInstanceProperties',
- 'ModifySystemPropertyTemplate',
- 'DeleteSystemPropertyTemplates',
- ],
+ 'title' => '策略',
+ 'id' => 432744,
],
[
- 'id' => 365524,
- 'title' => '任务',
+ 'children' => ['CreateSystemPropertyTemplate', 'SendSystemPropertyTemplate', 'DescribeSystemPropertyTemplates', 'GetInstanceProperties', 'ModifySystemPropertyTemplate', 'DeleteSystemPropertyTemplates'],
'type' => 'directory',
- 'children' => [
- 'DescribeTasks',
- ],
+ 'title' => '系统属性模板',
+ 'id' => 432749,
],
[
- 'id' => 365526,
- 'title' => '监控',
+ 'children' => ['InstallMonitorAgent', 'UninstallMonitorAgent', 'DescribeMetricLast', 'DescribeMetricList', 'DescribeMetricTop'],
'type' => 'directory',
- 'children' => [
- 'InstallMonitorAgent',
- 'UninstallMonitorAgent',
- 'DescribeMetricLast',
- 'DescribeMetricList',
- 'DescribeMetricTop',
- ],
+ 'title' => '监控',
+ 'id' => 432758,
],
[
- 'id' => 365532,
- 'title' => '标签',
+ 'children' => ['ModifyDisplayConfig', 'DescribeDisplayConfig', 'GetNetworkBlacklist', 'SetNetworkBlacklist', 'DescribeRegions', 'DescribeTasks', 'ListTagResources', 'ModifyInstanceChargeType', 'TagResources', 'UntagResources', 'ActivateEdgeMobileAgent', 'CreateEdgeMobileAgentPackage', 'DescribeEdgeMobileAgentPackages', 'RefreshAuthTokens'],
'type' => 'directory',
- 'children' => [
- 'TagResources',
- 'UntagResources',
- 'ListTagResources',
- ],
- ],
- [
- 'id' => 365536,
'title' => '其他',
- 'type' => 'directory',
- 'children' => [
- 'DescribeBuckets',
- 'SetAdbSecure',
- 'ModifyDisplayConfig',
- 'DescribeDisplayConfig',
- 'ImportImage',
- ],
- ],
- [
- 'id' => 0,
- 'title' => '其它',
- 'type' => 'directory',
- 'children' => [
- 'GetNetworkBlacklist',
- 'SetNetworkBlacklist',
- ],
+ 'id' => 432768,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateCloudPhoneNode' => [
- 'summary' => '创建云手机矩阵。'."\n"
- ."\n"
- .'在无影云手机系统中,矩阵(Cloud Phone Server)是一个逻辑上的资源管理单元,代表一个物理服务器实例。该物理服务器可以被划分为多个独立运行的云手机实例,这些实例共享矩阵底层的计算、存储和网络资源。创建一个矩阵,即相当于获得一台物理服务器,您可以在其上创建相应的云手机实例(配置不同对应的云手机数量不同)。',
+ 'ActivateEdgeMobileAgent' => [
+ 'summary' => '激活边缘智能体设备。',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
+ 'operationType' => 'readAndWrite',
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneTVG3Y7',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneLI0KSA'],
],
'parameters' => [
[
- 'name' => 'BizRegionId',
+ 'name' => 'LicenseKey',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'cn-shanghai' => '华东2(上海)',
- 'ap-southeast-1' => '新加坡',
- 'eu-central-1' => '德国(法兰克福)',
- 'cn-hangzhou' => '华东1(杭州)',
- ],
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => '牌照密钥。', 'description' => '许可证Key。', 'type' => 'string', 'required' => true, 'example' => 'lic-ez197xvdf0j5eo0*****'],
],
[
- 'name' => 'NodeName',
+ 'name' => 'DeviceClass',
'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'node_name',
- ],
+ 'schema' => ['title' => '设备形态: BOX/PHONE/PAD/OTHER。不传时自动从牌照配置获取。', 'description' => '设备形态: BOX/PHONE/PAD/OTHER。', 'type' => 'string', 'required' => false, 'example' => 'BOX'],
],
[
- 'name' => 'ServerType',
+ 'name' => 'DeviceId',
'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵规格。',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'cpm.gx7.10xlarge' => 'cpm.gx7.10xlarge',
- 'cpm.gx8.16xlarge' => 'cpm.gx8.16xlarge',
- ],
- 'example' => 'cpm.gx7.10xlarge',
- ],
+ 'schema' => ['title' => '设备唯一标识。', 'description' => '设备唯一标识。', 'type' => 'string', 'required' => true, 'example' => 'sn-0001eevqa6jeapl*****'],
],
[
- 'name' => 'InstanceType',
+ 'name' => 'DeviceMeta',
'in' => 'query',
- 'schema' => [
- 'description' => '实例规格。'."\n"
- .'> 如需购买更多规格,您可以[联系售前咨询](https://smartservice.console.aliyun.com/service/pre-sales-chat?spm=5176.6d6ecb63.0.0.729adda2VqVQx7)。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ac.max' => '该规格下默认实例开数为25开,可通过设置PhoneCount参数调整开数设置(最小4开,最大40开)',
- 'ac.plus' => '该规格下默认实例开数为40开,可通过设置PhoneCount参数调整开数设置(最小4开,最大40开)',
- ],
- 'example' => 'ac.max',
- ],
+ 'schema' => ['title' => '设备扩展元数据,JSON格式字符串,包含fingerprint、deviceModel、firmwareVersion等信息。', 'description' => '设备扩展元数据,JSON格式字符串,包含fingerprint、deviceModel、firmwareVersion等信息。', 'type' => 'string', 'required' => false, 'example' => '{"frmwareVersion": "1.0.0"}'],
],
- [
- 'name' => 'ChargeType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '付费类型。当前仅支持包年包月类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'PrePaid' => '包年包月',
- ],
- 'example' => 'PrePaid',
- ],
- ],
- [
- 'name' => 'PeriodUnit',
- 'in' => 'query',
- 'schema' => [
- 'description' => '购买资源的时长单位。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Month' => '月 [默认值]',
- 'Year' => '年',
- ],
- 'example' => 'Month',
- ],
- ],
- [
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => '购买资源的时长,单位由`PeriodUnit`指定。'."\n"
- ."\n"
- .'- 当`PeriodUnit`为**year**时,取值只能为1。'."\n"
- .'- 当`PeriodUnit`为**month**时,取值范围为1、2、3、6。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'AutoPay',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否自动付费。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'flase' => '需要前往阿里云费用与成本中心手动支付 [默认值]',
- 'true' => '自动支付',
- ],
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'AutoRenew',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否开启自动续费。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '启用自动续费,实例到期后由系统自动续费',
- 'false' => '不自动续费,实例到期后手动续费 [默认值]',
- ],
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'ImageId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'imgc-075cllfeuazh0****',
- ],
- ],
- [
- 'name' => 'Count',
- 'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵的购买数量。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'NetworkId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '办公网络ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou+dir-5mwr9azebliva****',
- ],
- ],
- [
- 'name' => 'VSwitchId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '交换机ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-2zeekryyc1q3sm72l****',
- ],
- ],
- [
- 'name' => 'Tag',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '资源的标签。',
- 'type' => 'array',
- 'items' => [
- 'description' => '资源的标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'keyname',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'valuename',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 20,
- ],
- ],
- [
- 'name' => 'PhoneDataVolume',
- 'in' => 'query',
- 'schema' => [
- 'description' => '独立机身存储的大小。单位:GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'ServerShareDataVolume',
- 'in' => 'query',
- 'schema' => [
- 'description' => '共享机身存储的大小。单位:GiB。'."\n"
- ."\n"
- .'> 共享机身存储最小值需大于矩阵下的实例开数乘以10GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '4000',
- 'minimum' => '100',
- 'example' => '200',
- ],
- ],
- [
- 'name' => 'ResolutionHeight',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分辨率的高度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1280',
- ],
- ],
- [
- 'name' => 'ResolutionWidth',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分辨率的宽度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '720',
- ],
- ],
- [
- 'name' => 'PhoneCount',
- 'in' => 'query',
- 'schema' => [
- 'description' => '单个矩阵中创建云手机实例数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '25',
- ],
- ],
- [
- 'name' => 'DisplayConfig',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '显示设置。',
- 'type' => 'object',
- 'properties' => [
- 'Dpi' => [
- 'description' => 'DPI。取值范围72~600。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '240',
- ],
- 'Fps' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => 'null',
- ],
- 'LockResolution' => [
- 'description' => '是否锁定分辨率。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
- 'enum' => [
- 'off',
- 'on',
- ],
- ],
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'StreamMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵下实例的串流模式,该参数不传默认为抢占模式。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '抢占模式',
- '协同模式',
- ],
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'NetworkType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '实例的网络类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'network_pro_ecd' => '云电脑高级办公网络',
- ],
- 'example' => 'network_pro_ecd',
- ],
- ],
- [
- 'name' => 'NetworkInfo',
- 'in' => 'query',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例网络映射信息。'."\n"
- ."\n",
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'BandwidthPackageName' => [
- 'description' => '带宽包名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'inst-bandwidth-pkg-1',
- ],
- 'CidrBlock' => [
- 'description' => '私网网段',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.10.13.0/24',
- ],
- 'LimitedBandwidth' => [
- 'description' => '带宽包限速峰值,单位Mbps。使用该带宽包的所有实例(求和)受该带宽上限限制。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '200',
- ],
- 'InternetChargeType' => [
- 'description' => '带宽包的计费方式。取值:'."\n"
- ."\n"
- .'<props="china">'."\n"
- ."\n"
- .'- **PayByBandwidth**(默认值):按带宽计费。'."\n"
- .'- **PayBy95**:表示按传统95计费。IPv6公网带宽默认不支持按传统95计费,如需使用,请联系客户经理申请。'."\n"
- ."\n"
- .'</props>'."\n"
- .'<props="intl">'."\n"
- ."\n"
- .'- **PayByBandwidth**(默认值):按带宽计费。'."\n"
- ."\n"
- .'</props>',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'PayBy95' => '按传统95计费',
- 'PayByBandwidth' => '按带宽计费',
- ],
- 'example' => 'PayByBandwidth',
- ],
- 'IpRatio' => [
- 'description' => 'IP与实例比。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 128 => '128个云手机实例对应一个EIP(公网出口IP)',
- ],
- 'example' => '128',
- ],
- 'Isp' => [
- 'description' => '线路类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ChinaUnicom' => '中国联通',
- 'ChinaTelecom' => '中国电信',
- 'ChinaMobile' => '中国移动',
- 'BGP' => 'BGP(多线)线路',
- ],
- 'example' => 'ChinaTelecom',
- ],
- 'PayType' => [
- 'description' => '付费类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'PostPaid' => '按量付费',
- 'PrePaid' => '包年包月',
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****'],
+ 'Data' => [
+ 'title' => '返回数据对象。',
+ 'description' => '返回数据对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DeviceId' => ['title' => '设备ID。', 'description' => '设备ID。', 'type' => 'string', 'example' => 'sn-0001eevqa6jeapl*****'],
+ 'InstanceId' => ['title' => 'EdgeMobile实例ID。', 'description' => 'EdgeMobile实例ID。', 'type' => 'string', 'example' => 'em-uto81vfd8t8z****'],
+ 'AuthToken' => ['title' => '分配的API密钥,仅首次激活返回明文。', 'description' => '分配的API密钥,仅首次激活返回明文。', 'type' => 'string', 'example' => 'cpk-81vfd8t8zdfxdf*****'],
+ 'Idempotent' => ['title' => '是否为幂等重复请求。', 'description' => '是否为幂等重复请求。', 'type' => 'boolean', 'example' => 'false'],
],
- 'example' => 'PostPaid',
- ],
- 'VisibleType' => [
- 'description' => '可见范围',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CPS',
],
],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'BandwidthPackageType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '带宽类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cbwp_ecd' => '精品带宽包',
- ],
- 'example' => 'cbwp_ecd',
- ],
- ],
- [
- 'name' => 'BandwidthPackageId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '共享带宽实例的ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cbwp-uf6g3hgg*******8s3lxiob3',
- ],
- ],
- [
- 'name' => 'UpBandwidthLimit',
- 'in' => 'query',
- 'schema' => [
- 'description' => '上行带宽限速,单位Mbps',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
- ],
- [
- 'name' => 'DownBandwidthLimit',
- 'in' => 'query',
- 'schema' => [
- 'description' => '下行带宽限速,单位Mbps',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
- ],
- [
- 'name' => 'UseTemplate',
- 'in' => 'query',
- 'schema' => [
- 'description' => '创建时是否使用模板。如果使用模版列表的随机模板,则取值为`Random`,如果传入模板ID,则使用该模板ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Random',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '激活边缘智能体设备',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"Data\\": {\\n \\"DeviceId\\": \\"sn-0001eevqa6jeapl*****\\",\\n \\"InstanceId\\": \\"em-uto81vfd8t8z****\\",\\n \\"AuthToken\\": \\"cpk-81vfd8t8zdfxdf*****\\",\\n \\"Idempotent\\": false\\n }\\n}","type":"json"}]',
+ ],
+ 'AttachKeyPair' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'PromotionId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphone377ZZK'],
+ ],
+ 'parameters' => [
[
- 'name' => 'SwapSize',
+ 'name' => 'KeyPairId',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'ADB密钥对的ID。', 'type' => 'string', 'required' => true, 'example' => 'kp-6v2q33ae4tw3a****'],
],
[
- 'name' => 'IsSingleImgDisk',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'type' => 'boolean',
+ 'description' => '云手机实例ID列表,最多支持50个实例。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh4a31emkt6u****'],
'required' => false,
+ 'maxItems' => 200,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '请求信息。',
+ 'title' => 'PlainResult<AttachKeyPairResult>',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****',
- ],
- 'OrderId' => [
- 'description' => '订单ID。',
- 'type' => 'string',
- 'example' => '223684716098****',
- ],
- 'NodeInfos' => [
- 'description' => '云手机矩阵信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '云手机矩阵信息。',
- 'type' => 'object',
- 'properties' => [
- 'NodeId' => [
- 'description' => '云手机矩阵ID。',
- 'type' => 'string',
- 'example' => 'cpn-e5kxgjyt8s1mb****',
- ],
- 'InstanceIds' => [
- 'description' => '云手机实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '云手机实例ID。',
- 'type' => 'string',
- 'example' => 'cpn-e5kxgjyt8s1mb****',
- ],
- ],
- ],
- ],
- ],
- 'NetworkPackageOrderModel' => [
- 'description' => '带宽包订单信息',
+ 'Data' => [
+ 'description' => '返回结果对象。',
'type' => 'object',
'properties' => [
- 'BandwidthPackageOrderId' => [
- 'description' => '带宽包订单ID',
- 'type' => 'string',
- 'example' => '25954415983*****',
- ],
- 'BandwidthPackageId' => [
- 'description' => ' 共享带宽的ID。 ',
- 'type' => 'string',
- 'example' => 'cbwp-uf63gsv8j0ir53*****',
+ 'KeyPairId' => ['description' => 'ADB密钥对的ID。', 'type' => 'string', 'example' => 'kp-6v2q33ae4tw3a****'],
+ 'TotalCount' => ['description' => '尝试绑定的总实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'FailCount' => ['description' => '绑定失败的实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'AttachedInstanceIds' => [
+ 'description' => '绑定成功的云手机实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-5hh431emkt6ua****'],
],
],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\",\\n \\"OrderId\\": \\"223684716098****\\",\\n \\"NodeInfos\\": [\\n {\\n \\"NodeId\\": \\"cpn-e5kxgjyt8s1mb****\\",\\n \\"InstanceIds\\": [\\n \\"cpn-e5kxgjyt8s1mb****\\"\\n ]\\n }\\n ],\\n \\"NetworkPackageOrderModel\\": {\\n \\"BandwidthPackageOrderId\\": \\"25954415983*****\\",\\n \\"BandwidthPackageId\\": \\"cbwp-uf63gsv8j0ir53*****\\"\\n }\\n}","type":"json"}]',
- 'title' => '创建云手机矩阵',
- ],
- 'DescribeCloudPhoneNodes' => [
- 'summary' => '查询云手机矩阵的详细信息。'."\n"
- ."\n"
- .'在无影云手机系统中,矩阵(Cloud Phone Server)是一个逻辑上的资源管理单元,代表一个物理服务器实例。该物理服务器可以被划分为多个独立运行的云手机实例,这些实例共享矩阵底层的计算、存储和网络资源。创建一个矩阵,即相当于获得一台物理服务器,您可以在其上创建相应的云手机实例(配置不同对应可创建的云手机数量不同)。',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '绑定ADB密钥对',
+ 'summary' => '调用AttachKeyPair绑定一个ADB密钥对到一台或多台云手机实例。',
+ 'description' => '- 只有实例处于运行中(Running)状态,绑定ADB密钥对才能生效。'."\n"
+ .'- 绑定密钥对以后,请注意要将密钥对的私钥拷贝到您本地的密钥对所在目录下(macOS或者Linux操作系统,目录为~/.android;Windows操作系统,目录为C:\\Users\\用户名\\.android。),并调用adb kill-server重启ADB进程,才能正常连接ADB,否则ADB连接可能会鉴权失败。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-31T07:55:40.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"KeyPairId\\": \\"kp-6v2q33ae4tw3a****\\",\\n \\"TotalCount\\": 100,\\n \\"FailCount\\": 0,\\n \\"AttachedInstanceIds\\": [\\n \\"acp-5hh431emkt6ua****\\"\\n ]\\n },\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
+ ],
+ 'AuthorizeAndroidInstance' => [
+ 'summary' => '为云手机实例分配用户或者取消已分配用户。目前一台云手机实例仅支持分配一个用户。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneTVG3Y7',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'BizRegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cn-shanghai' => '华东2(上海)',
- 'ap-southeast-1' => '新加坡',
- 'eu-central-1' => '德国(法兰克福)',
- 'cn-hangzhou' => '华东1(杭州)',
- ],
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的最大条目数。最大值为100。默认值为20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '下一次查询的令牌(Token)。如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****',
- ],
- ],
- [
- 'name' => 'NodeIds',
+ 'name' => 'AndroidInstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机矩阵ID列表。',
+ 'description' => '实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机矩阵ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-192c32356ft1ov1m****',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-8v5bjld0r7pl****'],
'required' => false,
'maxItems' => 100,
+ 'minItems' => 1,
],
],
[
- 'name' => 'NodeName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'node_name',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵状态。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'FAILED' => '创建失败',
- 'RUNNING' => '可用',
- 'DELETING' => '删除中',
- 'NODE_READY' => '节点就绪,实例创建中',
- 'DELETED' => '已删除',
- 'CREATING' => '创建中',
- ],
- 'example' => 'CREATING',
- ],
- ],
- [
- 'name' => 'ServerType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵规格。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cpm.gx7.10xlarge' => 'cpm.gx7.10xlarge',
- 'cpm.gx8.16xlarge' => 'cpm.gx8.16xlarge',
- ],
- 'example' => 'cpm.gx7.10xlarge',
- ],
- ],
- [
- 'name' => 'ChargeType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '付费类型。当前只支持包年包月类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'PrePaid' => '包年包月',
- ],
- 'example' => 'PrePaid',
- ],
- ],
- [
- 'name' => 'BandwidthPackageId',
+ 'name' => 'AuthorizeUserId',
'in' => 'query',
- 'schema' => [
- 'description' => '带宽包实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cbwp-bp17psa7fhxqmm*****',
- ],
+ 'schema' => ['description' => '需要分配的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'NodeNameList',
+ 'name' => 'UnAuthorizeUserId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '需要取消分配的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '请求信息。',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F07A1DA1-E1EB-5CCA-8EED-12F85D32****',
- ],
- 'NodeModel' => [
- 'description' => '云手机矩阵信息详情。',
- 'type' => 'array',
- 'items' => [
- 'description' => '云手机矩阵信息详情。',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '云手机矩阵状态。',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'ServerType' => [
- 'description' => '云手机矩阵规格。',
- 'type' => 'string',
- 'example' => 'cpm.gx7.10xlarge',
- ],
- 'ResolutionWidth' => [
- 'description' => '分辨率的宽度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '720',
- ],
- 'NodeName' => [
- 'description' => '云手机矩阵名称。',
- 'type' => 'string',
- 'example' => 'node_name',
- ],
- 'Memory' => [
- 'description' => '内存大小。单位:GB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- ],
- 'VSwitchId' => [
- 'description' => '交换机ID。',
- 'type' => 'string',
- 'example' => 'vsw-2zeekryyc1q3sm72l****',
- ],
- 'GmtModified' => [
- 'description' => '最近一次修改时间。',
- 'type' => 'string',
- 'example' => '2025-02-13 02:03:14',
- ],
- 'Cpu' => [
- 'description' => 'CPU核数。',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'ResolutionHeight' => [
- 'description' => '分辨率的高度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1280',
- ],
- 'NetworkId' => [
- 'description' => '网络ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou+dir-5mwr9azebliva****',
- ],
- 'GmtExpired' => [
- 'description' => '包年包月矩阵的过期时间。',
- 'type' => 'string',
- 'example' => '2025-03-09 02:00:34',
- ],
- 'PhoneCount' => [
- 'description' => '云手机矩阵下的实例开数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '25',
- ],
- 'GmtCreate' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-11-13 02:03:14',
- ],
- 'ChargeType' => [
- 'description' => '付费类型。',
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'NodeId' => [
- 'description' => '云手机矩阵ID。',
- 'type' => 'string',
- 'example' => 'cpn-ehs0yoedq8ntm****',
- ],
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'InstanceType' => [
- 'description' => '实例规格。',
- 'type' => 'string',
- 'example' => 'ac.max',
- ],
- 'ShareDataVolume' => [
- 'description' => '共享机身存储的大小。单位:GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PhoneDataInfo' => [
- 'description' => '独立机身存储信息。',
- 'type' => 'object',
- 'properties' => [
- 'PhoneDataId' => [
- 'description' => '独立机身存储ID。',
- 'type' => 'string',
- 'example' => 'pd-dhusabisshj****',
- ],
- 'PhoneDataVolume' => [
- 'description' => '独立机身存储容量大小。单位:GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- ],
- ],
- 'NetworkInfos' => [
- 'description' => '网络相关信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '网络相关信息。',
- 'type' => 'object',
- 'properties' => [
- 'VSwitchId' => [
- 'description' => '专有网络中的交换机ID。',
- 'type' => 'string',
- 'example' => 'vsw-j6cjgev6fv3ftw4f0****',
- ],
- 'NetworkId' => [
- 'description' => '网络ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou+dir-avcuocx9805oq****',
- ],
- 'NetworkType' => [
- 'description' => '实例的网络类型。',
- 'type' => 'string',
- 'example' => 'network_pro_ecd',
- ],
- 'BandwidthPackageType' => [
- 'description' => '带宽类型。',
- 'type' => 'string',
- 'example' => 'cbwp_ecd',
- ],
- 'BandwidthPackageId' => [
- 'description' => '带宽包实例ID。',
- 'type' => 'string',
- 'example' => 'cbwp-hn3tj409amvamz8mf****',
- ],
- ],
- ],
- ],
- 'NetworkType' => [
- 'description' => '实例的网络类型。',
- 'type' => 'string',
- 'example' => 'network_pro_ecd',
- ],
- 'BandwidthPackageType' => [
- 'description' => '带宽类型。',
- 'type' => 'string',
- 'example' => 'cbwp_ecd',
- ],
- 'BandwidthPackageId' => [
- 'description' => '带宽包ID。',
- 'type' => 'string',
- 'example' => 'cbwp-7xvrl7axet2qg6yia******',
- ],
- 'BizTags' => [
- 'description' => '标签信息数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签对象',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'keyname',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'valuename',
- ],
- ],
- ],
- ],
- 'BandwidthPackageStatus' => [
- 'description' => '带宽包状态:0-初始化,1-正常,2-删除',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'SwapSize' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '31',
- ],
- 'NextToken' => [
- 'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
- .'- 如果**NextToken**为空表示没有下一次查询。'."\n"
- .'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****',
- ],
- 'MaxResults' => [
- 'description' => '分页查询时每页的最大条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\"\\n}","type":"json"}]',
+ 'title' => '实例分配用户&取消分配',
+ 'description' => '支持分配用户的实例状态:可用、关机中、已关机、开机中、备份中、恢复中、备份失败、恢复失败。'."\n"
+ ."\n"
+ .'支持取消分配的实例状态:可用、关机中、已关机、开机中、备份中、恢复中、备份失败、恢复失败、已过期、已欠费、已删除。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F07A1DA1-E1EB-5CCA-8EED-12F85D32****\\",\\n \\"NodeModel\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ServerType\\": \\"cpm.gx7.10xlarge\\",\\n \\"ResolutionWidth\\": 720,\\n \\"NodeName\\": \\"node_name\\",\\n \\"Memory\\": 32,\\n \\"VSwitchId\\": \\"vsw-2zeekryyc1q3sm72l****\\",\\n \\"GmtModified\\": \\"2025-02-13 02:03:14\\",\\n \\"Cpu\\": \\"2\\",\\n \\"ResolutionHeight\\": 1280,\\n \\"NetworkId\\": \\"cn-hangzhou+dir-5mwr9azebliva****\\",\\n \\"GmtExpired\\": \\"2025-03-09 02:00:34\\",\\n \\"PhoneCount\\": 25,\\n \\"GmtCreate\\": \\"2024-11-13 02:03:14\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"NodeId\\": \\"cpn-ehs0yoedq8ntm****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceType\\": \\"ac.max\\",\\n \\"ShareDataVolume\\": 100,\\n \\"PhoneDataInfo\\": {\\n \\"PhoneDataId\\": \\"pd-dhusabisshj****\\",\\n \\"PhoneDataVolume\\": 20\\n },\\n \\"NetworkInfos\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-j6cjgev6fv3ftw4f0****\\",\\n \\"NetworkId\\": \\"cn-hangzhou+dir-avcuocx9805oq****\\",\\n \\"NetworkType\\": \\"network_pro_ecd\\",\\n \\"BandwidthPackageType\\": \\"cbwp_ecd\\",\\n \\"BandwidthPackageId\\": \\"cbwp-hn3tj409amvamz8mf****\\"\\n }\\n ],\\n \\"NetworkType\\": \\"network_pro_ecd\\",\\n \\"BandwidthPackageType\\": \\"cbwp_ecd\\",\\n \\"BandwidthPackageId\\": \\"cbwp-7xvrl7axet2qg6yia******\\",\\n \\"BizTags\\": [\\n {\\n \\"Key\\": \\"keyname\\",\\n \\"Value\\": \\"valuename\\"\\n }\\n ],\\n \\"BandwidthPackageStatus\\": \\"1\\",\\n \\"SwapSize\\": 0\\n }\\n ],\\n \\"TotalCount\\": 31,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
- 'title' => '查询云手机矩阵信息',
],
- 'ModifyCloudPhoneNode' => [
- 'summary' => '修改云手机矩阵信息。'."\n"
- ."\n"
- .'在无影云手机系统中,矩阵(Cloud Phone Server)是一个逻辑上的资源管理单元,代表一个物理服务器实例。该物理服务器可以被划分为多个独立运行的云手机实例,这些实例共享矩阵底层的计算、存储和网络资源。创建一个矩阵,相当于获得一台物理服务器,您可以在其上创建相应的云手机实例(配置不同对应的云手机数量不同)。',
+ 'BackupAndroidInstance' => [
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1254,84 +337,91 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneE7UBTJ',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneE62QJ7'],
],
'parameters' => [
[
- 'name' => 'NodeId',
+ 'name' => 'AndroidInstanceIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '云手机矩阵ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-0ugbptfu473fy****',
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'aic-ig2bdpk374l12****'],
+ 'deprecated' => false,
+ 'required' => true,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'NewNodeName',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵的新名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'node_name_new',
- ],
+ 'schema' => ['title' => 'App文件名称', 'description' => '整机备份描述。', 'type' => 'string', 'required' => false, 'example' => 'this is a backup android instance'],
],
[
- 'name' => 'StreamMode',
+ 'name' => 'UploadEndpoint',
'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵下实例的串流模式,该参数不传默认为抢占模式。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '抢占模式',
- '协同模式',
- ],
- 'example' => '1',
- ],
+ 'schema' => ['description' => '备份地域。', 'type' => 'string', 'required' => true, 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'],
+ ],
+ [
+ 'name' => 'BackupFilePath',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份文件的上传地址。', 'type' => 'string', 'required' => true, 'example' => 'oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab'],
+ ],
+ [
+ 'name' => 'BackupFileName',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份文件名称。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '请求信息。',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => 'PlainResult<Integer>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7B9EFA4F-4305-5968-BAEE-BD8B8DE5****',
+ 'Data' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'BackupFileId' => ['description' => '备份文件ID。', 'type' => 'string', 'example' => 'bf-b0qbg3pbpjkn7****'],
+ 'BackupFileName' => ['description' => '备份文件名称。', 'type' => 'string', 'example' => 'a-58ftsoo90p0qa****.ab'],
+ 'AndroidInstanceId' => ['description' => '云手机实例ID。', 'type' => 'string', 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-bp67acfmxazb4p****'],
+ ],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '440D7342-5FC2-5E7C-B2DB-D0B4EAC2BDF1'],
+ 'Count' => ['description' => '备份的实例个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-14xwibw7pyrjd****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '整机备份',
+ 'summary' => '对云手机实例进行整机备份,包括已安装的应用、属性等。',
+ 'description' => '1. 为保证您的操作成功率,请您尽量在关机后操作数据备份,备份时操作云手机可能导致备份操作失败。'."\n"
+ .'2. 请确保您的备份文件可以正常恢复,恢复完成后,请检查和验证您的数据是否全部完整、功能是否正常使用,再考虑删除原始备份文件和重置源实例,否则您的数据可能丢失。'."\n"
+ .'3. 不同镜像版本不支持互相备份恢复,自定义镜像和公共镜像不支持互相备份恢复,跨架构(cpm.gx7.10xlarge和cpm.gx8.16xlarge)不支持互相备份恢复。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B9EFA4F-4305-5968-BAEE-BD8B8DE5****\\"\\n}","type":"json"}]',
- 'title' => '修改云手机矩阵信息',
- 'description' => '修改云手机矩阵串流模式是异步接口,请勿频繁修改。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"BackupFileId\\": \\"bf-b0qbg3pbpjkn7****\\",\\n \\"BackupFileName\\": \\"a-58ftsoo90p0qa****.ab\\",\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-bp67acfmxazb4p****\\"\\n }\\n ],\\n \\"RequestId\\": \\"440D7342-5FC2-5E7C-B2DB-D0B4EAC2BDF1\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-14xwibw7pyrjd****\\"\\n}","type":"json"}]',
],
- 'RenewCloudPhoneNodes' => [
- 'summary' => '续费云手机矩阵。',
+ 'BackupApp' => [
+ 'summary' => '对云手机实例的部分应用进行应用备份,包括应用、应用缓存等。',
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1340,348 +430,251 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone3XZF7I',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneE62QJ7'],
],
'parameters' => [
[
- 'name' => 'NodeIds',
- 'in' => 'formData',
+ 'name' => 'AndroidInstanceIdList',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机矩阵ID列表。',
+ 'description' => '实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机矩阵ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-csbdhjcbvfd****',
- ],
- 'required' => false,
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-34pqe4r0kd9kn****'."\n"],
+ 'deprecated' => false,
+ 'required' => true,
'maxItems' => 100,
- 'minItems' => 1,
],
],
[
- 'name' => 'PeriodUnit',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '购买资源的时长单位。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Month' => '月 [默认值]',
- 'Year' => '年',
- ],
- 'example' => 'Month',
- ],
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['title' => 'App文件名称', 'description' => '备份应用描述。', 'type' => 'string', 'required' => false, 'example' => 'this is a backup app'],
],
[
- 'name' => 'Period',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '购买资源的时长,单位由`PeriodUnit`指定。'."\n"
- ."\n"
- .'- 当`PeriodUnit`为**year**时,取值只能为1。'."\n"
- .'- 当`PeriodUnit`为**month**时,取值范围为1、2、3、6。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'UploadEndpoint',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份地域。', 'type' => 'string', 'required' => true, 'example' => 'oss-cn-shanghai-internal.aliyuncs.com'],
],
[
- 'name' => 'AutoRenew',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '是否开启自动续费。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '启用自动续费,实例到期后由系统自动续费',
- 'false' => '不自动续费,实例到期后手动续费 [默认值]',
- ],
- 'example' => 'true',
- ],
+ 'name' => 'BackupFilePath',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份文件地址。', 'type' => 'string', 'required' => true, 'example' => 'oss://cloudphone-saved-bucket-****/backupDir/'],
],
[
- 'name' => 'AutoPay',
+ 'name' => 'BackupFileName',
'in' => 'query',
- 'schema' => [
- 'description' => '是否自动支付。默认为false。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '自动支付,调用API后自动完成支付',
- 'false' => '需要前往阿里云费用与成本中心手动支付 [默认值]',
- ],
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '备份文件名称。', 'type' => 'string', 'required' => false, 'example' => 'MyBackup'],
],
[
- 'name' => 'PromotionId',
+ 'name' => 'SourceAppList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'type' => 'string',
- 'required' => false,
+ 'description' => '备份的应用包名列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '备份的应用包名。', 'type' => 'string', 'required' => false, 'example' => 'com.example.xhs'],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '请求信息。',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => 'PlainResult<Integer>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC****',
- ],
- 'OrderId' => [
- 'description' => '订单ID。',
- 'type' => 'string',
- 'example' => '22365781890****',
+ 'Data' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'BackupFileId' => ['description' => '备份文件ID。', 'type' => 'string', 'example' => 'bf-b0qbg3pbpjkn7****'],
+ 'BackupFileName' => ['description' => '备份文件名称。', 'type' => 'string', 'example' => 'MyBackup'],
+ 'AndroidInstanceId' => ['description' => '云手机实例ID。', 'type' => 'string', 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-4ks224ujixw****'],
+ ],
+ ],
],
+ 'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'Count' => ['description' => '备份的实例个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TaskId' => ['description' => '批量任务ID。', 'type' => 'string', 'example' => 't-14xwibw7pyrjd****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '应用备份',
+ 'description' => '1. 为保证您的操作成功率,请您尽量在关机后操作数据备份,备份时操作云手机可能导致备份操作失败。'."\n"
+ .'2. 请确保您的备份文件可以正常恢复,恢复完成后,请检查和验证您的数据是否全部完整、功能是否正常使用,再考虑删除原始备份文件和重置源实例,否则您的数据可能丢失。'."\n"
+ .'3. 不同镜像版本不支持互相备份恢复,自定义镜像和公共镜像不支持互相备份恢复,跨架构(cpm.gx7.10xlarge和cpm.gx8.16xlarge)不支持互相备份恢复。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC****\\",\\n \\"OrderId\\": \\"22365781890****\\"\\n}","type":"json"}]',
- 'title' => '续费云手机矩阵',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"BackupFileId\\": \\"bf-b0qbg3pbpjkn7****\\",\\n \\"BackupFileName\\": \\"MyBackup\\",\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-4ks224ujixw****\\"\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-14xwibw7pyrjd****\\"\\n}","type":"json"}]',
],
- 'ChangeCloudPhoneNode' => [
- 'summary' => '变更云手机矩阵的配置,目前仅支持变更实例规格和云手机实例开数(实例开数即云手机矩阵的实例数量)。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'BackupFile' => [
+ 'summary' => '生成备份文件并上传到远端存储。 使用场景:可以基于数据安全的角度进行定期备份,也可以备份一机文件,恢复到多机,实现类似复制迁移的效果。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneUQT9QO',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneE62QJ7'],
],
'parameters' => [
[
- 'name' => 'NodeId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-0ugbptfu473fy****',
- ],
- ],
- [
- 'name' => 'InstanceType',
+ 'name' => 'AndroidInstanceIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '实例规格。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ac2.plus' => '瀚博VG1000 4vCPU 6GiB',
- 'ac2.max' => '瀚博VG1000 8vCPU 12GiB',
- 'ac.max' => 'NvidiaT4 8vCPU 12GiB',
- 'ac.plus' => 'NvidiaT4 4vCPU 6GiB',
- ],
- 'example' => 'ac.max',
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'aic-ig2bdpk374l12****'],
+ 'deprecated' => false,
+ 'required' => true,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'PhoneCount',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '云手机实例开数。可查询[DescribeSpec](~~2807299~~)接口查询最大最小开数限制',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['title' => 'App文件名称', 'description' => '备份文件描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a backup/data request.'],
],
[
- 'name' => 'UpBandwidthLimit',
+ 'name' => 'SourceFilePathList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '上行带宽限速,单位Mbps',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '备份的文件路径列表。',
+ 'type' => 'array',
+ 'items' => ['description' => 'Android 系统的源文件目录绝对路径。', 'type' => 'string', 'required' => false, 'example' => '/data'],
'required' => false,
- 'example' => '50',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'DownBandwidthLimit',
+ 'name' => 'SourceAppList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '下行带宽限速,单位Mbps',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '备份的应用包名列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '备份的应用包名。', 'type' => 'string', 'required' => false, 'example' => 'com.example.xhs'],
'required' => false,
- 'example' => '50',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'PhoneDataVolume',
+ 'name' => 'UploadType',
'in' => 'query',
'schema' => [
- 'description' => '机身存储大小设置,大小范围10GiB-4000GiB,为空则维持原来大小。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '备份类型。',
+ 'type' => 'string',
'required' => false,
- 'example' => '10',
+ 'enumValueTitles' => ['OSS' => '备份文件上传到OSS Bucket'],
+ 'example' => 'OSS',
],
],
[
- 'name' => 'AutoPay',
+ 'name' => 'UploadEndpoint',
'in' => 'query',
- 'schema' => [
- 'description' => '是否自动付费。默认为false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '备份地址的域名。'."\n"
+ ."\n"
+ .'> 如果上传到OSS Bucket,调用describeBuckets接口获取Bucket,如果云手机和Bucket是同地域,获取intranetEndpoint字段;如果是不同地域获取extranetEndpoint字段。', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-shanghai-internal.aliyuncs.com'],
],
[
- 'name' => 'PromotionId',
+ 'name' => 'BackupFilePath',
'in' => 'query',
- 'schema' => [
- 'description' => '优惠活动ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '50003308011****',
- ],
+ 'schema' => ['description' => '备份文件的上传地址。'."\n"
+ .'> 如果上传到OSS Bucket,调用describeBuckets接口获取bucketName,选择ossObjectList获取key,key是OSS Bucket的文件夹路径,拼接成`oss://${bucketName}/${key}`。', 'type' => 'string', 'required' => true, 'example' => 'oss://cloudphone-saved-bucket-****/backupDir/'],
],
[
- 'name' => 'DisplayConfig',
+ 'name' => 'BackupFileName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '备份文件名称。', 'type' => 'string', 'required' => false, 'example' => 'MyBackup'],
],
[
- 'name' => 'SwapSize',
+ 'name' => 'BackupAll',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'schema' => ['description' => '是否整机备份。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'ShareDataVolume',
+ 'name' => 'ExcludeSourceFilePathList',
'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'style' => 'repeatList',
'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ 'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '4610632D-D661-5982-B3D7-5D3FD183F****',
- ],
- 'NodeInfos' => [
- 'description' => '云手机矩阵信息。',
+ 'Data' => [
+ 'description' => '返回结果对象。',
'type' => 'array',
'items' => [
- 'description' => '云手机矩阵信息。',
'type' => 'object',
'properties' => [
- 'NodeId' => [
- 'description' => '云手机矩阵ID。',
- 'type' => 'string',
- 'example' => 'cpn-e5kxgjyt8s1mb****',
- ],
- 'InstanceInfos' => [
- 'description' => '云手机实例信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '云手机实例信息。',
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'cpn-jewjt8xryuitu****',
- ],
- 'PhoneDataVolume' => [
- 'description' => '独立机身存储容量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
- ],
- 'ShareDataVolume' => [
- 'description' => '当矩阵使用独立机身存储时,默认会分配64GiB共享存储空间(不可修改),用于存放镜像等矩阵全局的文件。当矩阵使用共享机身存储时(购买时设置大小),该存储空间为所有实例共用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'BackupFileId' => ['description' => '备份文件ID。', 'type' => 'string', 'example' => 'bf-b0qbg3pbpjkn7****'],
+ 'BackupFileName' => ['description' => '备份文件名称。', 'type' => 'string', 'example' => 'MyBackup'],
+ 'AndroidInstanceId' => ['description' => '云手机实例ID。', 'type' => 'string', 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-22ex666a653gq****'],
],
+ 'description' => '',
],
+ 'example' => '6C8439B9-7DBF-57F4-92AE-55A9B9D3****'."\n",
],
- 'OrderId' => [
- 'description' => '生成的订单ID。',
- 'type' => 'string',
- 'example' => '223684716098****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6C8439B9-7DBF-57F4-92AE-55A9B9D3****'],
+ 'Count' => ['description' => '备份的实例个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TaskId' => ['description' => '批量任务ID。', 'type' => 'string', 'example' => 't-14xwibw7pyrjd****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4610632D-D661-5982-B3D7-5D3FD183F****\\",\\n \\"NodeInfos\\": [\\n {\\n \\"NodeId\\": \\"cpn-e5kxgjyt8s1mb****\\",\\n \\"InstanceInfos\\": [\\n {\\n \\"InstanceId\\": \\"cpn-jewjt8xryuitu****\\",\\n \\"PhoneDataVolume\\": 200\\n }\\n ],\\n \\"ShareDataVolume\\": 100\\n }\\n ],\\n \\"OrderId\\": \\"223684716098****\\"\\n}","type":"json"}]',
- 'title' => '变更云手机矩阵配置',
- ],
- 'ExpandDataVolume' => [
- 'summary' => '扩容云手机矩阵存储。可以对共享机身存储(用于存储镜像等矩阵级文件)、独立机身存储进行扩容。存储空间扩容后将产生新的费用,接口调用的响应参数中包含了新费用的订单ID。',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"BackupFileId\\": \\"bf-b0qbg3pbpjkn7****\\",\\n \\"BackupFileName\\": \\"MyBackup\\",\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-22ex666a653gq****\\"\\n }\\n ],\\n \\"RequestId\\": \\"6C8439B9-7DBF-57F4-92AE-55A9B9D3****\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-14xwibw7pyrjd****\\"\\n}","type":"json"}]',
+ 'title' => '创建备份文件',
+ 'description' => '目前仅支持云手机生成的备份文件保存在OSS对象存储服务。',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-03T11:17:53.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-17T05:04:23.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-12-06T02:39:25.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-14T10:59:55.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-10-16T09:05:59.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'BatchGetAcpConnectionTicket' => [
+ 'summary' => '批量获取连接凭证。本接口会异步进行 Ticket 的生成,绝大多数可第一次直接从Response中直接拿到Ticket,部分情况需要根据Response中的TaskId再调用本接口进行轮询是否生成。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1690,85 +683,75 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneUQT9QO',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMEHI4H'],
],
'parameters' => [
[
- 'name' => 'BizRegionId',
+ 'name' => 'InstanceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-25nt4kk9whjh****'],
],
[
- 'name' => 'NodeIds',
+ 'name' => 'InstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机矩阵ID列表。',
+ 'description' => '云手机实例ID列表,可设置 1~100 个。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机矩阵ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-csbdhjcbvfd****',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-bj9t2gmys****'],
'required' => false,
'maxItems' => 100,
],
],
[
- 'name' => 'ShareDataVolume',
+ 'name' => 'EndUserId',
'in' => 'query',
- 'schema' => [
- 'description' => '矩阵共享存储大小。单位:GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['description' => '已分配的用户ID,如果不传,则会使用后台分配的系统用户获取Ticket。'."\n"
+ ."\n"
+ .'<props="china">'."\n"
+ .'本参数的使用方法因云手机产品版本和实例串流模式而异:'."\n"
+ ."\n"
+ .'- 云手机实例版或云手机矩阵版(抢占模式):只能通过同一个`EnduserId`获取`Ticket`。'."\n"
+ .'- 云手机矩阵版(协同模式):可通过传入不同的`EnduserId`来为不同的用户(至多5个)同时获取`Ticket`并串流。每次只能传入1个`EnduserId`。'."\n"
+ ."\n"
+ .'> 实例串流模式可通过`ModifyCloudPhoneNode`接口的`StreamMode`参数来定义。</props>', 'type' => 'string', 'required' => false, 'example' => 'user'],
],
[
- 'name' => 'PhoneDataVolume',
+ 'name' => 'ConnectionMode',
'in' => 'query',
- 'schema' => [
- 'description' => '实例机身存储大小。单位:GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['description' => '建连模式。', 'type' => 'string', 'required' => false, 'example' => 'custom'],
],
[
- 'name' => 'AutoPay',
+ 'name' => 'InstanceTasks',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '是否自动支付。默认为false。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
+ 'description' => '实例连接任务。用于查询Ticket获取任务是否完成。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '实例连接任务。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-fkuit0cmyfvzz****'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****'],
+ ],
+ 'required' => false,
],
- 'example' => 'true',
+ 'required' => false,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'PromotionId',
+ 'name' => 'Ports',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '优惠活动ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '50003308011****',
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ 'maxItems' => 10,
],
],
],
@@ -1779,38 +762,55 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****',
- ],
- 'OrderId' => [
- 'description' => '订单ID。',
- 'type' => 'string',
- 'example' => '22326560487****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7B9EFA4F-4305-5968-BAEE-BD8B8DE5****'],
+ 'InstanceConnectionModels' => [
+ 'description' => '实例连接任务结果。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '实例连接任务结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppInstanceGroupId' => ['description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-1uzb6heg797z3****'],
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-ajxvwo1u0hqvd****'],
+ 'TaskStatus' => ['description' => '任务状态。状态为FINISHED代表可以从Ticket字段获取到Ticket,否则仍需要使用TaskId调用本接口查询Ticket生成结果。', 'type' => 'string', 'example' => 'FINISHED'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 'cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****'],
+ 'Ticket' => ['description' => '用于连接用户实例的Ticket。', 'type' => 'string', 'example' => 'piVE58_AdmVSVW7SEW3*AE5*p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV*0*Cm58slMT1tJw3****'],
+ 'ErrorCode' => ['description' => '错误原因。', 'type' => 'string', 'example' => 'InvalidResourceId.NotFound'],
+ 'PersistentAppInstanceId' => ['description' => '持久会话ID。', 'type' => 'string', 'example' => 'p-abdywvcksdb****'],
+ 'AppInstanceId' => ['description' => '物理实例ID。', 'type' => 'string', 'example' => 'ai-0caoetkqi8kj****'],
+ 'Port' => ['description' => '建连端口', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"OrderId\\": \\"22326560487****\\"\\n}","type":"json"}]',
- 'title' => '扩容云手机矩阵存储',
- 'description' => '本接口仅适用于中国站。',
- ],
- 'DeleteCloudPhoneNodes' => [
- 'summary' => '删除云手机矩阵。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '批量获取实例连接凭证',
+ 'description' => '<props="china">'."\n"
+ .'本接口的作用因云手机产品版本和实例串流模式而异:'."\n"
+ ."\n"
+ .'- 云手机实例版或云手机矩阵版(抢占模式):只能通过同一个`EnduserId`获取`Ticket`。'."\n"
+ .'- 云手机矩阵版(协同模式):可通过传入不同的`EnduserId`来为不同的用户(至多5个)同时获取`Ticket`并串流。每次只能传入1个`EnduserId`。'."\n"
+ ."\n"
+ .'> 实例串流模式可通过[ModifyCloudPhoneNode](~~2878539~~)接口的`StreamMode`参数来定义。</props>',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-31T08:16:30.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B9EFA4F-4305-5968-BAEE-BD8B8DE5****\\",\\n \\"InstanceConnectionModels\\": [\\n {\\n \\"AppInstanceGroupId\\": \\"aig-1uzb6heg797z3****\\",\\n \\"InstanceId\\": \\"acp-ajxvwo1u0hqvd****\\",\\n \\"TaskStatus\\": \\"FINISHED\\",\\n \\"TaskId\\": \\"cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****\\",\\n \\"Ticket\\": \\"piVE58_AdmVSVW7SEW3*AE5*p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV*0*Cm58slMT1tJw3****\\",\\n \\"ErrorCode\\": \\"InvalidResourceId.NotFound\\",\\n \\"PersistentAppInstanceId\\": \\"p-abdywvcksdb****\\",\\n \\"AppInstanceId\\": \\"ai-0caoetkqi8kj****\\",\\n \\"Port\\": 10000\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'CancelAgentTask' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1820,30 +820,21 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneZCSVZQ',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
],
'parameters' => [
[
- 'name' => 'NodeIds',
- 'in' => 'formData',
+ 'name' => 'TaskIds',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机矩阵ID列表。',
+ 'description' => '任务 ID 列表。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机矩阵ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-05e4d1cec2urdh1j****',
- ],
- 'required' => false,
+ 'items' => ['description' => '任务 ID。', 'type' => 'string', 'required' => true, 'example' => 't-bp67acfmxazb4p****'],
+ 'required' => true,
'maxItems' => 100,
- 'minItems' => 1,
],
],
],
@@ -1851,35 +842,54 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '请求信息。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => '4B886792-2051-5DB4-8AE6-C8E45D3B4****'],
+ 'Code' => ['description' => '接口状态码。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '接口返回信息。', 'type' => 'string', 'example' => 'Success.'],
+ 'Tasks' => [
+ 'description' => '任务 list。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务 ID,全局唯一。', 'type' => 'string', 'example' => 't-imr0fufqd7cle****'],
+ 'InstanceId' => ['description' => 'Mobile节点 ID。', 'type' => 'string', 'example' => 'acp-ek65k51zoxia3x8xz'],
+ 'PreviousStatus' => ['description' => '任务取消前状态,参考下方状态枚举,取值如下:'."\n"
+ ."\n"
+ .'PENDING 任务创建中。'."\n"
+ ."\n"
+ .'RUNNING 任务运行中。', 'type' => 'string', 'example' => 'RUNNING'],
+ 'CurrentStatus' => ['description' => '任务当前状态,参考下方状态枚举,取值如下:'."\n"
+ ."\n"
+ .'CANCELLING 取消中。'."\n"
+ ."\n"
+ .'CANCELED 已取消。', 'type' => 'string', 'example' => 'COMPLETED'],
+ 'CancelAt' => ['description' => '任务取消时间,ISO 8601 格式。', 'type' => 'string', 'example' => '2026-04-13T17:42:19Z'."\n"],
+ 'FailedReason' => ['description' => '取消任务失败原因。', 'type' => 'string', 'example' => 'Task status [COMPLETED] does not support cancellation, only PENDING/RUNNING/CANCELLING tasks can be canceled.'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '取消 Agent 任务。',
+ 'summary' => '取消 Mobile 节点上正在运行的 Agent 任务。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC****\\"\\n}","type":"json"}]',
- 'title' => '删除云手机矩阵',
- 'description' => '仅状态为已过期的云手机矩阵可以删除,其他状态下不支持删除。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4B886792-2051-5DB4-8AE6-C8E45D3B4****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Tasks\\": [\\n {\\n \\"TaskId\\": \\"t-imr0fufqd7cle****\\",\\n \\"InstanceId\\": \\"acp-ek65k51zoxia3x8xz\\",\\n \\"PreviousStatus\\": \\"RUNNING\\",\\n \\"CurrentStatus\\": \\"COMPLETED\\",\\n \\"CancelAt\\": \\"2026-04-13T17:42:19Z\\\\n\\",\\n \\"FailedReason\\": \\"Task status [COMPLETED] does not support cancellation, only PENDING/RUNNING/CANCELLING tasks can be canceled.\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DescribeRegions' => [
- 'summary' => '查询地域。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ChangeCloudPhoneNode' => [
+ 'summary' => '变更云手机矩阵的配置,目前仅支持变更实例规格和云手机实例开数(实例开数即云手机矩阵的实例数量)。',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1888,352 +898,128 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneTVG3Y7',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneUQT9QO'],
],
'parameters' => [
[
- 'name' => 'AcceptLanguage',
+ 'name' => 'NodeId',
'in' => 'query',
- 'schema' => [
- 'description' => '控制台显示语言。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'en' => '英文',
- 'cn' => '简体中文',
- ],
- 'example' => 'cn',
- ],
+ 'schema' => ['description' => '云手机矩阵ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-0ugbptfu473fy****'],
],
[
- 'name' => 'SaleMode',
+ 'name' => 'InstanceType',
'in' => 'query',
'schema' => [
- 'description' => '云手机的购买模式。',
+ 'description' => '实例规格。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'Instance' => '实例组模式 [默认值]',
- 'Node' => '云手机矩阵模式 [白名单功能]',
- ],
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Node',
- ],
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A87B3769-0D05-5383-B236-5798B455****',
- ],
- 'RegionModels' => [
- 'description' => '可用地域。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'RegionName' => [
- 'description' => '地域名称。',
- 'type' => 'string',
- 'example' => '华东1(杭州)',
- ],
- ],
- ],
- ],
- ],
+ 'enumValueTitles' => ['ac2.plus' => '瀚博VG1000 4vCPU 6GiB', 'ac2.max' => '瀚博VG1000 8vCPU 12GiB', 'ac.max' => 'NvidiaT4 8vCPU 12GiB', 'ac.plus' => 'NvidiaT4 4vCPU 6GiB'],
+ 'example' => 'ac.max',
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A87B3769-0D05-5383-B236-5798B455****\\",\\n \\"RegionModels\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionName\\": \\"华东1(杭州)\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询可用地域',
- ],
- 'DescribeSpec' => [
- 'summary' => '查询云手机可用规格。 实例的创建需要指定规格参数,可通过该接口获取所有规格信息。对于矩阵创建的情况,可以通过该接口获取矩阵的最大和最小开数限制(单个矩阵创建实例数的限制)。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneQ1CSHT',
- 'FEATUREcloudphoneM9M7K0',
- 'FEATUREcloudphone3VSOTB',
- 'FEATUREcloudphone32DVRA',
- 'FEATUREcloudphoneVYV97B',
+ 'name' => 'PhoneCount',
+ 'in' => 'query',
+ 'schema' => ['description' => '云手机实例开数。可查询[DescribeSpec](~~2807299~~)接口查询最大最小开数限制', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
- ],
- 'parameters' => [
[
- 'name' => 'BizRegionId',
+ 'name' => 'UpBandwidthLimit',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '上行带宽限速,单位Mbps', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
],
[
- 'name' => 'SpecIds',
+ 'name' => 'DownBandwidthLimit',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '规格ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '规格ID。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'acp.perf.large' => '性能型',
- 'acp.basic.small' => '轻量型',
- 'acp.std.small' => '通用型',
- 'acp.std.large' => '标准型',
- 'acp.perf.small' => '增强型',
- ],
- 'example' => 'acp.basic.small',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '下行带宽限速,单位Mbps', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
],
[
- 'name' => 'SpecType',
+ 'name' => 'PhoneDataVolume',
'in' => 'query',
- 'schema' => [
- 'description' => '规格类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'CPU' => 'CPU规格',
- 'GPU' => 'GPU规格',
- ],
- 'example' => 'CPU',
- ],
+ 'schema' => ['description' => '机身存储大小设置,大小范围10GiB-4000GiB,为空则维持原来大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'SpecStatus',
+ 'name' => 'AutoPay',
'in' => 'query',
- 'schema' => [
- 'description' => '规格状态。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Unsupported' => '不支持',
- 'Available' => '可用',
- ],
- 'example' => 'Available',
- ],
+ 'schema' => ['description' => '是否自动付费。默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'SaleMode',
+ 'name' => 'PromotionId',
'in' => 'query',
- 'schema' => [
- 'description' => '云手机的购买模式。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Instance' => '实例组模式 [默认值]',
- 'Node' => '云手机矩阵模式 [白名单功能]',
- ],
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Node',
- ],
- ],
+ 'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'example' => '50003308011****'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'DisplayConfig',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '20',
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'SwapSize',
'in' => 'query',
- 'schema' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32'],
],
[
- 'name' => 'MatrixSpec',
+ 'name' => 'ShareDataVolume',
'in' => 'query',
- 'schema' => [
- 'description' => '云手机矩阵规格。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cpm.gx7.10xlarge' => 'cpm.gx7.10xlarge',
- 'cpm.gx8.16xlarge' => 'cpm.gx8.16xlarge',
- ],
- 'example' => 'cpm.gx7.10xlarge',
- 'enum' => [
- 'cpm.gn6.gx2',
- 'cpm.gn6.gx1',
- 'cpm.8yx.gx1',
- 'cpm.gx8.16xlarge',
- 'cpm.gx7.10xlarge',
- ],
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9888DAD-331E-5FBC-B5A0-F2445115****',
- ],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'NextToken' => [
- 'description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****',
- ],
- 'SpecInfoModel' => [
- 'description' => '规格信息。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4610632D-D661-5982-B3D7-5D3FD183F****'],
+ 'NodeInfos' => [
+ 'description' => '云手机矩阵信息。',
'type' => 'array',
'items' => [
+ 'description' => '云手机矩阵信息。',
'type' => 'object',
'properties' => [
- 'SpecId' => [
- 'description' => '规格ID。',
- 'type' => 'string',
- 'example' => 'acp.basic.small',
- ],
- 'Core' => [
- 'description' => 'CPU核数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'Memory' => [
- 'description' => '内存大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '16',
- ],
- 'SystemDiskSize' => [
- 'description' => '系统盘大小,单位:GB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- ],
- 'SpecType' => [
- 'description' => '规格类型。',
- 'type' => 'string',
- 'example' => 'ARM',
- ],
- 'SpecStatus' => [
- 'description' => '规格状态。',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'PhoneCount' => [
- 'description' => '云手机实例开数。',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'Resolution' => [
- 'description' => '云手机实例的分辨率。',
- 'type' => 'string',
- 'example' => '1920*1080',
- ],
- 'MaxPhoneCount' => [
- 'description' => '最大实例开数。',
- 'type' => 'string',
- 'example' => '40',
- ],
- 'MinPhoneCount' => [
- 'description' => '最小实例开数。',
- 'type' => 'string',
- 'example' => '4',
+ 'NodeId' => ['description' => '云手机矩阵ID。', 'type' => 'string', 'example' => 'cpn-e5kxgjyt8s1mb****'],
+ 'InstanceInfos' => [
+ 'description' => '云手机实例信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '云手机实例信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'cpn-jewjt8xryuitu****'],
+ 'PhoneDataVolume' => ['description' => '独立机身存储容量。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
+ ],
],
+ 'ShareDataVolume' => ['description' => '当矩阵使用独立机身存储时,默认会分配64GiB共享存储空间(不可修改),用于存放镜像等矩阵全局的文件。当矩阵使用共享机身存储时(购买时设置大小),该存储空间为所有实例共用。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
+ 'OrderId' => ['description' => '生成的订单ID。', 'type' => 'string', 'example' => '223684716098****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '变更云手机矩阵配置',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-12T10:37:06.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-09-05T06:13:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-08T10:57:57.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-08-08T09:54:32.000Z', 'description' => '请求参数发生变更'],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9888DAD-331E-5FBC-B5A0-F2445115****\\",\\n \\"TotalCount\\": 4,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****\\",\\n \\"SpecInfoModel\\": [\\n {\\n \\"SpecId\\": \\"acp.basic.small\\",\\n \\"Core\\": 8,\\n \\"Memory\\": 16,\\n \\"SystemDiskSize\\": 32,\\n \\"SpecType\\": \\"ARM\\",\\n \\"SpecStatus\\": \\"Available\\",\\n \\"PhoneCount\\": \\"2\\",\\n \\"Resolution\\": \\"1920*1080\\",\\n \\"MaxPhoneCount\\": \\"40\\",\\n \\"MinPhoneCount\\": \\"4\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询可用规格',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4610632D-D661-5982-B3D7-5D3FD183F****\\",\\n \\"NodeInfos\\": [\\n {\\n \\"NodeId\\": \\"cpn-e5kxgjyt8s1mb****\\",\\n \\"InstanceInfos\\": [\\n {\\n \\"InstanceId\\": \\"cpn-jewjt8xryuitu****\\",\\n \\"PhoneDataVolume\\": 200\\n }\\n ],\\n \\"ShareDataVolume\\": 100\\n }\\n ],\\n \\"OrderId\\": \\"223684716098****\\"\\n}","type":"json"}]',
],
'CheckResourceStock' => [
'summary' => '检查云手机资源库存状态。在实例创建前,可先通过该接口检测目标region库存是否足够,确认足够后再进行创建。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2245,31 +1031,19 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneQ1CSHT',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneQ1CSHT'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'BizRegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '资源所属的可用区。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-i',
- ],
+ 'schema' => ['description' => '资源所属的可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'],
],
[
'name' => 'AcpSpecId',
@@ -2278,47 +1052,11 @@
'description' => '规格ID。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'acp.perf.large' => '增强型',
- 'acp.basic.small' => '轻量型 ',
- 'acp.std.small' => '通用型',
- 'acp.std.large' => '标准型',
- 'acp.perf.small' => '增强型',
- ],
+ 'enumValueTitles' => ['acp.perf.large' => '增强型', 'acp.basic.small' => '轻量型 ', 'acp.std.small' => '通用型', 'acp.std.large' => '标准型', 'acp.perf.small' => '增强型'],
'example' => 'acp.basic.small',
'enum' => [
- 'acp.basic.small',
- 'acp.std.small',
- 'acp.std.large',
- 'acp.perf.small',
- 'acp.perf.large',
- 'acp.basic-v3.small',
- 'acp.basic-g1.small',
- 'acp.basic-g2.small',
- 'acp.std-g3.large',
- 'acp.perf-g4.large',
- 'acp.pro.large',
- 'acp.pro-g6.large',
- 'cps.std',
- 'cps.std.gn6ia',
- 'cps.std.r8ys',
- 'cpm.gn6.gx1',
- 'cpm.gn6.gx2',
- 'ac.se',
- 'ac.plus',
- 'ac.pro',
- 'ac.max',
- 'ac1.plus',
- 'acp.std.medium',
- 'acp.basic-g2r.small',
- 'acp.std-g3.medium',
- 'acp.std-g3s.large',
- 'acp.std-g3r.large',
- 'cpm.8yx.gx1',
- 'cps.std.64c256g',
- 'cps.perf.gn6ia',
- 'cpm.gx7.10xlarge',
- 'cpm.gx8.16xlarge',
+ 'acp.basic.small', 'acp.std.small', 'acp.std.large', 'acp.perf.small', 'acp.perf.large', 'acp.basic-v3.small', 'acp.basic-g1.small', 'acp.basic-g2.small', 'acp.std-g3.large', 'acp.perf-g4.large', 'acp.pro.large', 'acp.pro-g6.large', 'cps.std', 'cps.std.gn6ia', 'cps.std.r8ys', 'cpm.gn6.gx1', 'cpm.gn6.gx2', 'ac.se', 'ac.plus', 'ac.pro',
+ 'ac.max', 'ac1.plus', 'acp.std.medium', 'acp.basic-g2r.small', 'acp.std-g3.medium', 'acp.std-g3s.large', 'acp.std-g3r.large', 'cpm.8yx.gx1', 'cps.std.64c256g', 'cps.perf.gn6ia', 'cpm.gx7.10xlarge', 'cpm.gx8.16xlarge',
],
],
],
@@ -2329,23 +1067,14 @@
'description' => '是否开启GPU加速。',
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '开启',
- 'false' => '不开启 [默认值]',
- ],
+ 'enumValueTitles' => ['true' => '开启', 'false' => '不开启 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'Amount',
'in' => 'query',
- 'schema' => [
- 'description' => '云手机实例数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['description' => '云手机实例数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
],
'responses' => [
@@ -2355,35 +1084,19 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '805D8FB6-512A-531C-9E4D-2A807D3C****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '805D8FB6-512A-531C-9E4D-2A807D3C****'],
'ResourceStockModels' => [
'description' => '资源库存详情。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- 'ZoneId' => [
- 'description' => '可用区ID。',
- 'type' => 'string',
- 'example' => 'cn-shanghai-b',
- ],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-shanghai'],
+ 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-shanghai-b'],
'StockStatus' => [
'description' => '实例组库存状态。',
'type' => 'string',
- 'enumValueTitles' => [
- 'SoldOut' => '资源已售罄',
- 'Available' => '库存充足',
- ],
+ 'enumValueTitles' => ['SoldOut' => '资源已售罄', 'Available' => '库存充足'],
'example' => 'Available',
],
],
@@ -2393,22 +1106,26 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"805D8FB6-512A-531C-9E4D-2A807D3C****\\",\\n \\"ResourceStockModels\\": [\\n {\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"ZoneId\\": \\"cn-shanghai-b\\",\\n \\"StockStatus\\": \\"Available\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '检查资源库存状态',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-22T07:09:20.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-04T07:07:34.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-01-22T12:26:48.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-01-13T12:18:27.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-18T16:14:29.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-05T14:17:06.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-07-29T15:02:41.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'CreateAndroidInstanceGroup' => [
'summary' => '创建按量付费或包年包月的云手机实例组。一个实例组可以管理多个实例。可以将具有相同功能定位的实例编入同一个实例组,以便于统一管理。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2420,9 +1137,7 @@
'operationType' => 'none',
'riskType' => 'high',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneYWRDCM',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneYWRDCM'],
],
'parameters' => [
[
@@ -2432,41 +1147,21 @@
'description' => '地域ID。可以通过调用[DescribeRegions](~~DescribeRegions~~)查询云手机支持购买的地域列表。',
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'cn-shenzhen' => '深圳',
- 'cn-beijing' => '北京',
- 'cn-shanghai' => '上海',
- 'cn-hongkong' => '中国香港',
- 'ap-southeast-1' => '新加坡',
- 'cn-hangzhou' => '杭州',
- ],
+ 'enumValueTitles' => ['cn-shenzhen' => '深圳', 'cn-beijing' => '北京', 'cn-shanghai' => '上海', 'cn-hongkong' => '中国香港', 'ap-southeast-1' => '新加坡', 'cn-hangzhou' => '杭州'],
'example' => 'cn-hangzhou',
],
],
[
'name' => 'InstanceGroupName',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组名称。'."\n"
- ."\n"
- .'> 实例组名称长度不超过30个字符;请以大/小写字母或中文开头,不能以`http://`和`https://`开头,仅支持中文、英文、数字、半角冒号(:)、下划线(_)、点号(.)或者连字符(-)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '云手机A',
- ],
+ 'schema' => ['description' => '实例组名称。'."\n"
+ ."\n"
+ .'> 实例组名称长度不超过30个字符;请以大/小写字母或中文开头,不能以`http://`和`https://`开头,仅支持中文、英文、数字、半角冒号(:)、下划线(_)、点号(.)或者连字符(-)。', 'type' => 'string', 'required' => false, 'example' => 'Cloud phoneA'],
],
[
'name' => 'NumberOfInstances',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组中的实例数量。最大值为100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '实例组中的实例数量。最大值为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'ChargeType',
@@ -2475,23 +1170,14 @@
'description' => '计费类型。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'PostPaid' => '后付费',
- 'PrePaid' => '预付费',
- ],
+ 'enumValueTitles' => ['PostPaid' => '后付费', 'PrePaid' => '预付费'],
'example' => 'PostPaid',
],
],
[
'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '购买资源的时长,单位由PeriodUnit指定。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '购买资源的时长,单位由PeriodUnit指定。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PeriodUnit',
@@ -2500,11 +1186,7 @@
'description' => '购买资源的时长单位。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'Month' => '月',
- 'Year' => '年',
- 'Hour' => '小时,只能用于按量付费方式',
- ],
+ 'enumValueTitles' => ['Month' => '月', 'Year' => '年', 'Hour' => '小时,只能用于按量付费方式'],
'example' => 'Month',
],
],
@@ -2515,11 +1197,7 @@
'description' => '实例组规格。可以通过调用[DescribeSpec](~~DescribeSpec~~)查询云手机支持购买的规格。',
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'acp.perf.large' => '性能型(8vCPU、16GiB内存、32GiB存储)',
- 'acp.basic.small' => '轻量型(2vCPU、4GiB内存、32GiB存储)',
- 'acp.std.large' => '标准型(4vCPU、8GiB内存、32GiB存储)',
- ],
+ 'enumValueTitles' => ['acp.perf.large' => '性能型(8vCPU、16GiB内存、32GiB存储)', 'acp.basic.small' => '轻量型(2vCPU、4GiB内存、32GiB存储)', 'acp.std.large' => '标准型(4vCPU、8GiB内存、32GiB存储)'],
'example' => 'acp.basic.small',
],
],
@@ -2530,10 +1208,7 @@
'description' => '是否自动付费。默认为false。',
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '自动付费,请确保账号有足够的余额',
- 'false' => '手动付费',
- ],
+ 'enumValueTitles' => ['true' => '自动付费,请确保账号有足够的余额', 'false' => '手动付费'],
'example' => 'false',
],
],
@@ -2544,73 +1219,42 @@
'description' => '是否开启自动续费。默认为false。',
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '预付费资源到期后自动续费',
- 'false' => '预付费资源到期后需要手动续费',
- ],
+ 'enumValueTitles' => ['true' => '预付费资源到期后自动续费', 'false' => '预付费资源到期后需要手动续费'],
'example' => 'false',
],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
- 'schema' => [
- 'description' => '网络ID。'."\n"
- ."\n"
- .'- 创建共享网络实例:网络ID选填。填写[云手机控制台>网络](https://wya.wuying.aliyun.com/network)页面中类型为**共享网络**的网络ID。如果控制台没有共享网络,可以不用填写,将会在创建实例组时自动创建一个共享网络。'."\n"
- ."\n"
- .'- 创建VPC网络实例:网络ID必填。填写[云手机控制台>网络](https://wya.wuying.aliyun.com/network)页面中类型为**VPC网络**的网络ID,如果控制台没有VPC网络,则需要先创建网络。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou+dir-745976****',
- ],
+ 'schema' => ['description' => '网络ID。'."\n"
+ ."\n"
+ .'- 创建共享网络实例:网络ID选填。填写[云手机控制台>网络](https://wya.wuying.aliyun.com/network)页面中类型为**共享网络**的网络ID。如果控制台没有共享网络,可以不用填写,将会在创建实例组时自动创建一个共享网络。'."\n"
+ ."\n"
+ .'- 创建VPC网络实例:网络ID必填。填写[云手机控制台>网络](https://wya.wuying.aliyun.com/network)页面中类型为**VPC网络**的网络ID,如果控制台没有VPC网络,则需要先创建网络。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-745976****'],
],
[
'name' => 'VSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '交换机 ID。可以通过调用[DescribeVSwitches](~~448774~~)查询交换机列表。'."\n"
- ."\n"
- .'- 创建共享网络实例:不填写。'."\n"
- ."\n"
- .'- 创建VPC网络实例:交换机 ID 必填。选用此交换机来创建实例。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-uf61uvzhz8ejaw776****',
- ],
+ 'schema' => ['description' => '交换机 ID。可以通过调用[DescribeVSwitches](~~448774~~)查询交换机列表。'."\n"
+ ."\n"
+ .'- 创建共享网络实例:不填写。'."\n"
+ ."\n"
+ .'- 创建VPC网络实例:交换机 ID 必填。选用此交换机来创建实例。', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf61uvzhz8ejaw776****'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '策略ID。可以通过调用[ListPolicyGroups](~~ListPolicyGroups~~)查询策略列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pg-b7bxrrwxkijjh****',
- ],
+ 'schema' => ['description' => '策略ID。可以通过调用[ListPolicyGroups](~~ListPolicyGroups~~)查询策略列表。', 'type' => 'string', 'required' => false, 'example' => 'pg-b7bxrrwxkijjh****'],
],
[
'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => '镜像ID。可以通过调用[DescribeImageList](~~DescribeImageList~~)查询云手机的镜像列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'imgc-06zyt9m93zwax****',
- ],
+ 'schema' => ['description' => '镜像ID。可以通过调用[DescribeImageList](~~DescribeImageList~~)查询云手机的镜像列表。', 'type' => 'string', 'required' => true, 'example' => 'imgc-06zyt9m93zwax****'],
],
[
'name' => 'Amount',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组数量,默认值为1,最大值为100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '8',
- ],
+ 'schema' => ['description' => '实例组数量,默认值为1,最大值为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '8'],
],
[
'name' => 'GpuAcceleration',
@@ -2619,55 +1263,31 @@
'description' => '是否开启GPU加速。',
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '开启',
- 'false' => '不开启 [默认值]',
- ],
+ 'enumValueTitles' => ['true' => '开启', 'false' => '不开启 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'KeyPairId',
'in' => 'query',
- 'schema' => [
- 'description' => '密钥对ID。创建实例组的时候,如果指定了合法的密钥对ID,会在这次创建成功的实例上,都绑定该密钥对,不用再重新调用绑定接口。'."\n"
- ."\n"
- .'> 目前还不支持扩容的时候绑定密钥对。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'kp-7o9xywwfutc1l****',
- ],
+ 'schema' => ['description' => '密钥对ID。创建实例组的时候,如果指定了合法的密钥对ID,会在这次创建成功的实例上,都绑定该密钥对,不用再重新调用绑定接口。'."\n"
+ ."\n"
+ .'> 目前还不支持扩容的时候绑定密钥对。', 'type' => 'string', 'required' => false, 'example' => 'kp-7o9xywwfutc1l****'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '用于保证请求的幂等性,防止重复提交请求。不超过100个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'asadbuvwiabdbvchj****',
- ],
+ 'schema' => ['description' => '用于保证请求的幂等性,防止重复提交请求。不超过100个字符。', 'type' => 'string', 'required' => false, 'example' => 'asadbuvwiabdbvchj****'],
],
[
'name' => 'EnableIpv6',
'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'boolean', 'required' => false, 'example' => 'null'],
],
[
'name' => 'Ipv6Bandwidth',
'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'],
],
[
'name' => 'Tag',
@@ -2680,18 +1300,8 @@
'description' => '资源的标签。',
'type' => 'object',
'properties' => [
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'value',
- ],
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'key',
- ],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'value'],
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'key'],
],
'required' => false,
],
@@ -2706,101 +1316,64 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'BandwidthPackageName' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'CidrBlock' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'LimitedBandwidth' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- 'InternetChargeType' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'IpRatio' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- 'Isp' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'PayType' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'Period' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- 'PeriodUnit' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'AutoPay' => [
- 'type' => 'boolean',
- 'required' => false,
- ],
- 'AutoRenew' => [
- 'type' => 'boolean',
- 'required' => false,
- ],
- 'VisibleType' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'BandwidthPackageName' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'CidrBlock' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'LimitedBandwidth' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
+ 'InternetChargeType' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'IpRatio' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
+ 'Isp' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'PayType' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'Period' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
+ 'PeriodUnit' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'AutoPay' => ['type' => 'boolean', 'required' => false, 'description' => ''],
+ 'AutoRenew' => ['type' => 'boolean', 'required' => false, 'description' => ''],
+ 'VisibleType' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'PromotionId' => ['type' => 'string'],
+ 'PaidCallbackUrl' => ['type' => 'string'],
],
'required' => false,
+ 'description' => '',
],
],
[
'name' => 'BandwidthPackageType',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'BandwidthPackageId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'NetworkType',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'PromotionId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'StreamMode',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32'],
+ ],
+ [
+ 'name' => 'PaidCallBackUrl',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'example' => 'wya.wuying.aliyun.com/instanceGroup'],
+ ],
+ [
+ 'name' => 'SaleMode',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'InstanceVersion',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -2810,67 +1383,42 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****'],
'InstanceGroupInfos' => [
'description' => '实例组信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'InstanceGroupId' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'example' => 'ag-cuv4scs4obxch****',
- ],
+ 'InstanceGroupId' => ['description' => '实例组ID。', 'type' => 'string', 'example' => 'ag-cuv4scs4obxch****'],
'InstanceIds' => [
'description' => '实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-g40b9at5nhjo9****',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-g40b9at5nhjo9****'],
],
],
+ 'description' => '',
],
],
- 'OrderId' => [
- 'description' => '订单ID。',
- 'type' => 'string',
- 'example' => '22365781890****',
- ],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '22365781890****'],
'InstanceGroupIds' => [
'description' => '实例组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'example' => 'ag-cuv4scs4obxch****',
- ],
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'example' => 'ag-cuv4scs4obxch****'],
],
'NetworkPackageOrderModel' => [
'type' => 'object',
'properties' => [
- 'BandwidthPackageOrderId' => [
- 'type' => 'string',
- ],
- 'BandwidthPackageId' => [
- 'type' => 'string',
- ],
+ 'BandwidthPackageOrderId' => ['type' => 'string', 'description' => ''],
+ 'BandwidthPackageId' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
@@ -2884,186 +1432,302 @@
.' - 若实例组的计费方式为包年包月(PrePaid),默认AutoPay(自动支付)的值为false,调用接口后需要前往<props="china">[阿里云费用与成本](https://usercenter2.aliyun.com/order/list)</props><props="intl">[阿里云费用与成本](https://usercenter2-intl.aliyun.com/order/list)</props>手动支付订单。'."\n"
."\n"
.' - 如果需要自动支付则设置AutoPay的值为true。',
- ],
- 'DescribeAndroidInstanceGroups' => [
- 'summary' => '查询云手机实例组的详细信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-05T06:13:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-22T08:01:59.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-02-21T14:24:32.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-17T09:52:46.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-01-08T08:06:11.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-10-24T13:02:09.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-08-19T09:49:56.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-24T09:34:56.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-07-02T02:05:34.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'CreateApp' => [
+ 'summary' => '创建 Android 应用。在进行应用安装前,必须先使用本接口进行应用创建。应用创建时不会进行应用下载,安装时才会进行下载操作,须确保云手机与下载URL的网络可达性。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneQNMLJ7',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneRPX4AN'],
],
'parameters' => [
[
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['title' => 'App名称', 'description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'Application name 1'],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'query',
+ 'schema' => ['title' => 'App文件名称', 'description' => '应用文件在OSS中的存储名称。该参数与`FilePath`共同确定唯一的OSS地址。'."\n"
+ ."\n"
+ .'> * 若选择传入无影应用中心的应用,则必须传入`FileName`+`FilePath`或`OssAppUrl`,前者优先级更高。'."\n"
+ .'> * 请登录[无影云电脑企业版控制台](https://eds.console.aliyun.com/osshelp),并根据该页面提示将您的应用文件上传至无影应用中心,以便获得此参数。', 'type' => 'string', 'required' => false, 'example' => 'testApp.apk'],
+ ],
+ [
+ 'name' => 'FilePath',
+ 'in' => 'query',
+ 'schema' => ['title' => 'App文件地址', 'description' => '应用文件的OSS Bucket存储地址。该参数与`FileName`共同确定唯一的OSS地址。'."\n"
+ ."\n"
+ .'> * 若选择传入无影应用中心的应用,则必须传入`FileName`+`FilePath`或`OssAppUrl`,前者优先级更高。'."\n"
+ .'> * 请登录[无影云电脑企业版控制台](https://eds.console.aliyun.com/osshelp),并根据该页面提示将您的应用文件上传至无影应用中心,以便获得此参数。', 'type' => 'string', 'required' => false, 'example' => 'tenant/1642150****/'],
+ ],
+ [
+ 'name' => 'IconUrl',
+ 'in' => 'query',
+ 'schema' => ['title' => 'App icon地址', 'description' => '应用图标地址。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/icon.png'],
+ ],
+ [
+ 'name' => 'OssAppUrl',
+ 'in' => 'query',
+ 'schema' => ['title' => 'App oss地址', 'description' => '应用的OSS地址。'."\n"
+ ."\n"
+ .'> * 若选择传入无影应用中心的应用,则必须传入`FileName`+`FilePath`或`OssAppUrl`,前者优先级更高。'."\n"
+ .'> * 请登录[无影云电脑企业版控制台](https://eds.console.aliyun.com/osshelp),并根据该页面提示将您的应用文件上传至无影应用中心,以便获得此参数。', 'type' => 'string', 'required' => false, 'example' => 'http://testApp.apk'],
+ ],
+ [
'name' => 'BizRegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'InstanceGroupIds',
+ 'name' => 'InstallParam',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['description' => '安装参数。安装应用时默认自带`-r`安装参数。', 'type' => 'string', 'required' => false, 'example' => '-d'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用描述。', 'type' => 'string', 'required' => false, 'example' => 'Application description'],
+ ],
+ [
+ 'name' => 'CustomAppInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '实例组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-25nt4kk9whhdh****',
+ 'description' => '自定义应用信息。'."\n"
+ ."\n"
+ .'> * 若选择传入自定义应用,请传入`CustomAppInfo`参数,且该object参数包含的6个字段均为必填,必须全部传入。'."\n"
+ .'> * 自定义应用的优先级高于无影应用中心的应用,若传入`CustomAppInfo`参数,则`FileName`+`FilePath`或`OssAppUrl`都将失效。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DownloadUrl' => ['description' => '应用下载地址。', 'type' => 'string', 'required' => false, 'example' => 'http://testApp.apk', 'maxLength' => 1024],
+ 'Version' => ['description' => '应用版本。', 'type' => 'string', 'required' => false, 'example' => '1.0.0', 'maxLength' => 64],
+ 'VersionCode' => ['description' => '应用版本代码。', 'type' => 'string', 'required' => false, 'example' => '10000', 'maxLength' => 64],
+ 'PackageName' => ['description' => '应用包名。', 'type' => 'string', 'required' => false, 'example' => 'com.example.demo', 'maxLength' => 128],
+ 'ApkSize' => ['description' => '.apk文件的大小。单位:MB。', 'type' => 'string', 'required' => false, 'example' => '10', 'maxLength' => 128],
+ 'Md5' => ['description' => '.apk包的MD5值。', 'type' => 'string', 'required' => false, 'example' => 'df3f46ce5844ddb278f14c5a9cd2****', 'maxLength' => 128],
],
'required' => false,
- 'maxItems' => 100,
- 'minItems' => 1,
],
],
[
- 'name' => 'InstanceGroupName',
+ 'name' => 'SignApk',
'in' => 'query',
'schema' => [
- 'description' => '实例组名称。支持模糊查询。',
+ 'description' => '是否需要进行系统签名',
'type' => 'string',
'required' => false,
- 'example' => '云手机',
+ 'enumValueTitles' => ['false' => '不需要签名', 'true' => '需要签名'],
+ 'example' => 'false',
],
],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'PlainResult<Integer>',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['description' => '应用ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1234'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E5138F7E-46B5-526A-8C99-82DEAE6B****'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": 1234,\\n \\"RequestId\\": \\"E5138F7E-46B5-526A-8C99-82DEAE6B****\\"\\n}","type":"json"}]',
+ 'title' => '创建应用',
+ 'description' => '创建应用时,您可以选择以下两种方式中的一种来传入应用信息:'."\n"
+ ."\n"
+ .'- 方式1:传入无影应用中心的应用。'."\n"
+ .' - 支持的传入方法:'."\n"
+ .' - 方法1:传入`FileName`+`FilePath`(两个参数需同时传入)。'."\n"
+ .' - 方法2:传入`OssAppUrl`。'."\n"
+ .' - 规则:若传入无影应用中心的应用,则方法1和方法2之中必须至少使用1种;若同时使用两种方法,则以方法1为准。'."\n"
+ .' - 前置条件:请登录[无影云电脑企业版控制台](https://eds.console.aliyun.com/osshelp),并根据该页面提示将您的应用文件上传至无影应用中心,以便获得本接口所需的必填请求参数(`FileName`+`FilePath`或`OssAppUrl`)。'."\n"
+ .'- 方式2:传入自定义应用。'."\n"
+ .' - 支持的传入方法:传入`CustomAppInfo`。'."\n"
+ .' - 规则:若选择传入`CustomAppInfo`,则该object参数包含的6个字段均为必填,必须全部传入。'."\n"
+ ."\n"
+ .'> 若同时使用方式1和方式2,则以方式2传入的信息为准。',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-11T01:45:19.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-21T14:24:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-15T02:07:18.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-06-26T12:41:04.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'CreateCloudPhoneNode' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneTVG3Y7'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'Status',
+ 'name' => 'BizRegionId',
'in' => 'query',
'schema' => [
- 'description' => '实例组状态。',
+ 'description' => '地域ID。',
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'UPDATING_FAILED' => '镜像变更失败',
- 'FAILED' => '创建失败',
- 'RUNNING' => '可用',
- 'EXPIRED' => '已过期',
- 'DELETING' => '删除中',
- 'DELETED' => '已删除',
- 'UPDATING' => '镜像变更中',
- 'CREATING' => '创建中',
- ],
- 'example' => 'CREATING',
+ 'required' => true,
+ 'enumValueTitles' => ['cn-shanghai' => '华东2(上海)', 'ap-southeast-1' => '新加坡', 'eu-central-1' => '德国(法兰克福)', 'cn-hangzhou' => '华东1(杭州)'],
+ 'example' => 'cn-hangzhou',
],
],
[
- 'name' => 'SaleMode',
+ 'name' => 'NodeName',
+ 'in' => 'query',
+ 'schema' => ['description' => '云手机矩阵名称。', 'type' => 'string', 'required' => false, 'example' => 'node_name'],
+ ],
+ [
+ 'name' => 'ServerType',
'in' => 'query',
'schema' => [
- 'description' => '云手机的购买模式。',
+ 'description' => '云手机矩阵规格。',
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'STANDARD' => '标准模式[默认值]',
- ],
- 'example' => 'standard',
+ 'required' => true,
+ 'enumValueTitles' => ['cpm.gx7.10xlarge' => 'cpm.gx7.10xlarge', 'cpm.gx8.16xlarge' => 'cpm.gx8.16xlarge'],
+ 'example' => 'cpm.gx7.10xlarge',
],
],
[
- 'name' => 'ChargeType',
+ 'name' => 'InstanceType',
'in' => 'query',
'schema' => [
- 'description' => '付费类型。',
+ 'description' => '实例规格。'."\n"
+ .'> 如需购买更多规格,您可以[联系售前咨询](https://smartservice.console.aliyun.com/service/pre-sales-chat?spm=5176.6d6ecb63.0.0.729adda2VqVQx7)。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- ' PrePaid' => '包年包月',
- 'PostPaid' => '按量付费',
- ],
- 'example' => 'PostPaid',
+ 'enumValueTitles' => ['ac.max' => '该规格下默认实例开数为25开,可通过设置PhoneCount参数调整开数设置(最小4开,最大40开)', 'ac.plus' => '该规格下默认实例开数为40开,可通过设置PhoneCount参数调整开数设置(最小4开,最大40开)'],
+ 'example' => 'ac.max',
],
],
[
- 'name' => 'PolicyGroupId',
+ 'name' => 'ChargeType',
'in' => 'query',
'schema' => [
- 'description' => '策略ID。',
+ 'description' => '付费类型。当前仅支持包年包月类型。',
'type' => 'string',
'required' => false,
- 'example' => 'pg-1b77w6xrqfubi****',
+ 'enumValueTitles' => ['PrePaid' => '包年包月'],
+ 'example' => 'PrePaid',
],
],
[
- 'name' => 'KeyPairId',
+ 'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
- 'description' => '密钥对的ID。',
+ 'description' => '购买资源的时长单位。',
'type' => 'string',
'required' => false,
- 'example' => 'kp-5htf0ymsrnb7q****',
+ 'enumValueTitles' => ['Month' => '月 [默认值]', 'Year' => '年'],
+ 'example' => 'Month',
],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => '购买资源的时长,单位由`PeriodUnit`指定。'."\n"
+ ."\n"
+ .'- 当`PeriodUnit`为**year**时,取值只能为1。'."\n"
+ .'- 当`PeriodUnit`为**month**时,取值范围为1、2、3、6。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'AutoPay',
'in' => 'query',
'schema' => [
- 'description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为100。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '是否自动付费。',
+ 'type' => 'boolean',
'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
+ 'enumValueTitles' => ['flase' => '需要前往阿里云费用与成本中心手动支付 [默认值]', 'true' => '自动支付'],
+ 'example' => 'true',
],
],
[
- 'name' => 'NextToken',
+ 'name' => 'AutoRenew',
'in' => 'query',
'schema' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
+ 'description' => '是否开启自动续费。',
+ 'type' => 'boolean',
'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****',
+ 'enumValueTitles' => ['true' => '启用自动续费,实例到期后由系统自动续费', 'false' => '不自动续费,实例到期后手动续费 [默认值]'],
+ 'example' => 'true',
],
],
[
- 'name' => 'Tags',
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'imgc-075cllfeuazh0****'],
+ ],
+ [
+ 'name' => 'Count',
+ 'in' => 'query',
+ 'schema' => ['description' => '云手机矩阵的购买数量。', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'NetworkId',
+ 'in' => 'query',
+ 'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-5mwr9azebliva****'],
+ ],
+ [
+ 'name' => 'VSwitchId',
+ 'in' => 'query',
+ 'schema' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-2zeekryyc1q3sm72l****'],
+ ],
+ [
+ 'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例组的标签。每个实例最多可绑定20个标签。',
+ 'description' => '资源的标签。',
'type' => 'array',
'items' => [
- 'description' => '标签信息。',
+ 'description' => '资源的标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '标签键。可包含 1~20 个。'."\n"
- .'><notice>标签键最多支持128个字符,不能以aliyun或acs:开头,也不能包含http://或https://。></notice>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'phone',
- ],
- 'Value' => [
- 'description' => '标签值。'."\n"
- .'><notice>标签值最多支持128个字符,不能以`aliyun`或`acs:`开头,不能包含`http://`或`https://`。></notice>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025',
- ],
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'keyname'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'valuename'],
],
'required' => false,
],
@@ -3071,430 +1735,250 @@
'maxItems' => 20,
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'PhoneDataVolume',
+ 'in' => 'query',
+ 'schema' => ['description' => '独立机身存储的大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'ServerShareDataVolume',
+ 'in' => 'query',
+ 'schema' => ['description' => '共享机身存储的大小。单位:GiB。'."\n"
+ ."\n"
+ .'> 共享机身存储最小值需大于矩阵下的实例开数乘以10GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '4000', 'minimum' => '100', 'example' => '200'],
+ ],
+ [
+ 'name' => 'ResolutionHeight',
+ 'in' => 'query',
+ 'schema' => ['description' => '分辨率的高度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1280'],
+ ],
+ [
+ 'name' => 'ResolutionWidth',
+ 'in' => 'query',
+ 'schema' => ['description' => '分辨率的宽度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720'],
+ ],
+ [
+ 'name' => 'PhoneCount',
+ 'in' => 'query',
+ 'schema' => ['description' => '单个矩阵中创建云手机实例数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '25'],
+ ],
+ [
+ 'name' => 'DisplayConfig',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => '显示设置。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F07A1DA1-E1EB-5CCA-8EED-12F85D32****',
- ],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。',
+ 'Dpi' => ['description' => 'DPI。取值范围72~600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '240'],
+ 'Fps' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'],
+ 'LockResolution' => [
+ 'description' => '是否锁定分辨率。',
'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****',
- ],
- 'InstanceGroupModel' => [
- 'description' => '实例组的详细信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组的详细信息。',
- 'type' => 'object',
- 'properties' => [
- 'InstanceGroupId' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'example' => 'ag-h67a2cs0zprfdh****'."\n",
- ],
- 'InstanceGroupName' => [
- 'description' => '实例组名称。',
- 'type' => 'string',
- 'example' => '云手机A',
- ],
- 'InstanceGroupStatus' => [
- 'description' => '实例组状态。',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'InstanceGroupSpec' => [
- 'description' => '实例组规格。',
- 'type' => 'string',
- 'example' => 'acp.basic.small',
- ],
- 'InstanceGroupSpecDescribe' => [
- 'description' => '实例组规格描述。',
- 'type' => 'string',
- 'example' => 'ARM-2vCPU4GiB 32GiB',
- ],
- 'OfficeSiteId' => [
- 'description' => '网络ID。',
- 'type' => 'string',
- 'example' => 'cn-shanghai+dir-030598****',
- ],
- 'ImageId' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'example' => 'imgc-06zyt9m93zwax****',
- ],
- 'NumberOfInstances' => [
- 'description' => '实例组中的实例数量。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'ChargeType' => [
- 'description' => '付费方式。',
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'GmtCreate' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-02-01 10:56:36',
- ],
- 'GmtModified' => [
- 'description' => '更新时间。',
- 'type' => 'string',
- 'example' => '2024-02-01 10:56:36',
- ],
- 'SaleMode' => [
- 'description' => '售卖模式。',
- 'type' => 'string',
- 'example' => 'standard',
- ],
- 'InstalledAppList' => [
- 'description' => '已安装的应用列表。',
- 'type' => 'string',
- 'example' => '"抖音","淘宝"',
- ],
- 'GmtExpired' => [
- 'description' => '包年包月实例组的过期时间。',
- 'type' => 'string',
- 'example' => '2027-06-29 07:25:31',
- ],
- 'AppInstanceGroupId' => [
- 'description' => '交付组ID。',
- 'type' => 'string',
- 'example' => 'aig-48xr63m4dybjk****',
- ],
- 'PolicyGroupId' => [
- 'description' => '策略ID。',
- 'type' => 'string',
- 'example' => 'pg-c6n38xucps8kl****',
- ],
- 'VSwitchId' => [
- 'description' => '专有网络中的交换机ID。',
- 'type' => 'string',
- 'example' => 'vsw-t4n0yqs009ho024wt****',
- ],
- 'ResolutionHeight' => [
- 'description' => '分辨率的高。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1280',
- ],
- 'ResolutionWidth' => [
- 'description' => '分辨率的宽。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '720',
- ],
- 'SystemVersion' => [
- 'description' => '系统版本。',
- 'type' => 'string',
- 'example' => 'Android 12',
- ],
- 'ArchitectureType' => [
- 'description' => '架构类型。',
- 'type' => 'string',
- 'example' => 'ARM',
- ],
- 'Memory' => [
- 'description' => '内存大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'Cpu' => [
- 'description' => 'CPU核数。',
- 'type' => 'string',
- 'example' => '8',
- ],
- 'Disks' => [
- 'description' => '磁盘信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '磁盘信息。',
- 'type' => 'object',
- 'properties' => [
- 'DiskType' => [
- 'description' => '磁盘类型。',
- 'type' => 'string',
- 'example' => 'SYSTEM',
- ],
- 'DiskSize' => [
- 'description' => '磁盘大小(单位GB)。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- ],
- ],
- ],
- ],
- 'ErrorCode' => [
- 'description' => '创建失败的原因。',
- 'type' => 'string',
- 'example' => 'InternalError',
- ],
- 'RenderingType' => [
- 'description' => '实例组的渲染方式。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'GPURemote' => 'GPU远程渲染',
- 'CPU' => 'CPU渲染',
- 'GPULocal' => 'GPU本地渲染',
- ],
- 'example' => 'CPU',
- ],
- 'AvailableInstanceAmount' => [
- 'description' => '可用的实例数量。'."\n"
- ."\n"
- .'> 可用是指实例状态不为“删除中”或“已删除”。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'EnableIpv6' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Ipv6Bandwidth' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'BandwidthPackageId' => [
- 'description' => '带宽包的ID。',
- 'type' => 'string',
- 'example' => 'np-0q6ixs7vpxciz****',
- ],
- 'BandwidthPackageType' => [
- 'description' => '带宽包的类型。',
- 'type' => 'string',
- 'example' => 'cbwp_ecd',
- ],
- 'BandwidthPackageStatus' => [
- 'description' => '带宽包的状态。'."\n"
- .'枚举值:'."\n"
- .'- Creating,创建中'."\n"
- .'- Releasing,释放中'."\n"
- .'- InUse,使用中'."\n"
- .'- Failed,失败'."\n"
- .'- Expired,已过期'."\n"
- .'- Available未绑定,扣费中',
- 'type' => 'string',
- 'example' => 'Creating',
- ],
- 'NetworkType' => [
- 'description' => '实例的网络类型。'."\n"
- ."\n"
- .'> 目前只有标准网络的实例组才会返回该字段。',
- 'type' => 'string',
- 'example' => 'network_pro_ecd',
- ],
- 'ImageVersion' => [
- 'description' => '镜像版本。',
- 'type' => 'string',
- 'example' => '25.09.2',
- ],
- 'BindQosRules' => [
- 'description' => '实例组下的公网限速规则信息。',
- 'type' => 'object',
- 'properties' => [
- 'totalCount' => [
- 'description' => '实例组下的公网限速规则总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'InstanceQosRule' => [
- 'description' => '实例绑定的公网限速规则信息。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-h3m8b5dusopp5****',
- ],
- 'QosRuleId' => [
- 'description' => '公网限速规则ID(仅作用于精品带宽)',
- 'type' => 'string',
- 'example' => 'qos-3kh93uu0vdbka****',
- ],
- ],
- ],
- ],
- ],
- ],
- 'ZoneId' => [
- 'description' => '可用区ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-j',
- ],
- 'Tags' => [
- 'description' => '标签信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签信息。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'phone',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => '2025',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'required' => false,
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
+ 'enum' => ['off', 'on'],
],
],
+ 'required' => false,
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F07A1DA1-E1EB-5CCA-8EED-12F85D32****\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****\\",\\n \\"InstanceGroupModel\\": [\\n {\\n \\"InstanceGroupId\\": \\"ag-h67a2cs0zprfdh****\\\\n\\",\\n \\"InstanceGroupName\\": \\"云手机A\\",\\n \\"InstanceGroupStatus\\": \\"RUNNING\\",\\n \\"InstanceGroupSpec\\": \\"acp.basic.small\\",\\n \\"InstanceGroupSpecDescribe\\": \\"ARM-2vCPU4GiB 32GiB\\",\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-030598****\\",\\n \\"ImageId\\": \\"imgc-06zyt9m93zwax****\\",\\n \\"NumberOfInstances\\": \\"10\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2024-02-01 10:56:36\\",\\n \\"GmtModified\\": \\"2024-02-01 10:56:36\\",\\n \\"SaleMode\\": \\"standard\\",\\n \\"InstalledAppList\\": \\"\\\\\\"抖音\\\\\\",\\\\\\"淘宝\\\\\\"\\",\\n \\"GmtExpired\\": \\"2027-06-29 07:25:31\\",\\n \\"AppInstanceGroupId\\": \\"aig-48xr63m4dybjk****\\",\\n \\"PolicyGroupId\\": \\"pg-c6n38xucps8kl****\\",\\n \\"VSwitchId\\": \\"vsw-t4n0yqs009ho024wt****\\",\\n \\"ResolutionHeight\\": 1280,\\n \\"ResolutionWidth\\": 720,\\n \\"SystemVersion\\": \\"Android 12\\",\\n \\"ArchitectureType\\": \\"ARM\\",\\n \\"Memory\\": 8,\\n \\"Cpu\\": \\"8\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskSize\\": 32\\n }\\n ],\\n \\"ErrorCode\\": \\"InternalError\\",\\n \\"RenderingType\\": \\"CPU\\",\\n \\"AvailableInstanceAmount\\": 2,\\n \\"EnableIpv6\\": true,\\n \\"Ipv6Bandwidth\\": 50,\\n \\"BandwidthPackageId\\": \\"np-0q6ixs7vpxciz****\\",\\n \\"BandwidthPackageType\\": \\"cbwp_ecd\\",\\n \\"BandwidthPackageStatus\\": \\"Creating\\",\\n \\"NetworkType\\": \\"network_pro_ecd\\",\\n \\"ImageVersion\\": \\"25.09.2\\",\\n \\"BindQosRules\\": {\\n \\"totalCount\\": 2,\\n \\"InstanceQosRule\\": [\\n {\\n \\"InstanceId\\": \\"acp-h3m8b5dusopp5****\\",\\n \\"QosRuleId\\": \\"qos-3kh93uu0vdbka****\\"\\n }\\n ]\\n },\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"phone\\",\\n \\"Value\\": \\"2025\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询实例组详细信息',
- ],
- 'ModifyAndroidInstanceGroup' => [
- 'summary' => '修改云手机实例组的信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVGR0HK',
- ],
- ],
- 'parameters' => [
[
- 'name' => 'InstanceGroupId',
+ 'name' => 'StreamMode',
'in' => 'query',
'schema' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
+ 'description' => '云手机矩阵下实例的串流模式,该参数不传默认为抢占模式。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => 'ag-cuv4scs4obxhs****'."\n",
+ 'enumValueTitles' => [1 => '抢占模式', '协同模式'],
+ 'example' => '1',
],
],
[
- 'name' => 'NewInstanceGroupName',
+ 'name' => 'NetworkType',
'in' => 'query',
'schema' => [
- 'description' => '实例组的新名称。'."\n"
- ."\n"
- .'> '."\n"
- .'> - 实例组名称长度不超过30个字符;请以大/小写字母或中文开头,不能以http://和https://开头,仅支持中文、英文、数字、半角冒号(:)、下划线(_)、点号(.)或者连字符(-)',
+ 'description' => '实例的网络类型。',
'type' => 'string',
'required' => false,
- 'example' => 'newName',
+ 'enumValueTitles' => ['network_pro_ecd' => '云电脑高级办公网络'],
+ 'example' => 'network_pro_ecd',
],
],
[
- 'name' => 'PolicyGroupId',
+ 'name' => 'NetworkInfo',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '策略ID。',
- 'type' => 'string',
+ 'description' => '实例网络映射信息。'."\n"
+ ."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'BandwidthPackageName' => ['description' => '带宽包名称', 'type' => 'string', 'required' => false, 'example' => 'inst-bandwidth-pkg-1'],
+ 'CidrBlock' => ['description' => '私网网段', 'type' => 'string', 'required' => false, 'example' => '10.10.13.0/24'],
+ 'LimitedBandwidth' => ['description' => '带宽包限速峰值,单位Mbps。使用该带宽包的所有实例(求和)受该带宽上限限制。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'],
+ 'InternetChargeType' => [
+ 'description' => '带宽包的计费方式。取值:'."\n"
+ ."\n"
+ .'<props="china">'."\n"
+ ."\n"
+ .'- **PayByBandwidth**(默认值):按带宽计费。'."\n"
+ .'- **PayBy95**:表示按传统95计费。IPv6公网带宽默认不支持按传统95计费,如需使用,请联系客户经理申请。'."\n"
+ ."\n"
+ .'</props>'."\n"
+ .'<props="intl">'."\n"
+ ."\n"
+ .'- **PayByBandwidth**(默认值):按带宽计费。'."\n"
+ ."\n"
+ .'</props>',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['PayBy95' => '按传统95计费', 'PayByBandwidth' => '按带宽计费'],
+ 'example' => 'PayByBandwidth',
+ ],
+ 'IpRatio' => [
+ 'description' => 'IP与实例比。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'enumValueTitles' => [128 => '128个云手机实例对应一个EIP(公网出口IP)'],
+ 'example' => '128',
+ ],
+ 'Isp' => [
+ 'description' => '线路类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['ChinaUnicom' => '中国联通', 'ChinaTelecom' => '中国电信', 'ChinaMobile' => '中国移动', 'BGP' => 'BGP(多线)线路'],
+ 'example' => 'ChinaTelecom',
+ ],
+ 'PayType' => [
+ 'description' => '付费类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '包年包月'],
+ 'example' => 'PostPaid',
+ ],
+ 'VisibleType' => ['description' => '可见范围', 'type' => 'string', 'required' => false, 'example' => 'CPS'],
+ 'PaidCallbackUrl' => ['type' => 'string'],
+ ],
'required' => false,
- 'example' => 'pg-2w97kp89gnsif****',
],
],
[
- 'name' => 'StreamMode',
+ 'name' => 'BandwidthPackageType',
'in' => 'query',
'schema' => [
- 'description' => '实例组下实例的串流模式,该参数不传默认为抢占模式。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '带宽类型。',
+ 'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 1 => '抢占模式 [默认值]',
- '协同模式',
- ],
- 'example' => '1',
+ 'enumValueTitles' => ['cbwp_ecd' => '精品带宽包'],
+ 'example' => 'cbwp_ecd',
],
],
+ [
+ 'name' => 'BandwidthPackageId',
+ 'in' => 'query',
+ 'schema' => ['description' => '共享带宽实例的ID。', 'type' => 'string', 'required' => false, 'example' => 'cbwp-uf6g3hgg*******8s3lxiob3'],
+ ],
+ [
+ 'name' => 'UpBandwidthLimit',
+ 'in' => 'query',
+ 'schema' => ['description' => '上行带宽限速,单位Mbps', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ ],
+ [
+ 'name' => 'DownBandwidthLimit',
+ 'in' => 'query',
+ 'schema' => ['description' => '下行带宽限速,单位Mbps', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ ],
+ [
+ 'name' => 'UseTemplate',
+ 'in' => 'query',
+ 'schema' => ['description' => '创建时是否使用模板。如果使用模版列表的随机模板,则取值为`Random`,如果传入模板ID,则使用该模板ID。', 'type' => 'string', 'required' => false, 'example' => 'Random'],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'PaidCallBackUrl',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'SwapSize',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'IsSingleImgDisk',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => '请求信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '6C83EBE3-F267-5F11-ABF8-4E7B90B****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****'],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '223684716098****'],
+ 'NodeInfos' => [
+ 'description' => '云手机矩阵信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '云手机矩阵信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeId' => ['description' => '云手机矩阵ID。', 'type' => 'string', 'example' => 'cpn-e5kxgjyt8s1mb****'],
+ 'InstanceIds' => [
+ 'description' => '云手机实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '云手机实例ID。', 'type' => 'string', 'example' => 'cpn-e5kxgjyt8s1mb****'],
+ ],
+ ],
+ ],
+ ],
+ 'NetworkPackageOrderModel' => [
+ 'description' => '带宽包订单信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'BandwidthPackageOrderId' => ['description' => '带宽包订单ID', 'type' => 'string', 'example' => '25954415983*****'],
+ 'BandwidthPackageId' => ['description' => ' 共享带宽的ID。 ', 'type' => 'string', 'example' => 'cbwp-uf63gsv8j0ir53*****'],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建云手机矩阵',
+ 'summary' => '创建云手机矩阵。'."\n"
+ ."\n"
+ .'在无影云手机系统中,矩阵(Cloud Phone Server)是一个逻辑上的资源管理单元,代表一个物理服务器实例。该物理服务器可以被划分为多个独立运行的云手机实例,这些实例共享矩阵底层的计算、存储和网络资源。创建一个矩阵,即相当于获得一台物理服务器,您可以在其上创建相应的云手机实例(配置不同对应的云手机数量不同)。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-05T06:13:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-22T08:01:59.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-15T10:57:06.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-28T04:34:39.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-15T07:46:27.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-07-07T02:42:05.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-28T12:53:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-03T10:00:32.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C83EBE3-F267-5F11-ABF8-4E7B90B****\\"\\n}","type":"json"}]',
- 'title' => '修改实例组信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\",\\n \\"OrderId\\": \\"223684716098****\\",\\n \\"NodeInfos\\": [\\n {\\n \\"NodeId\\": \\"cpn-e5kxgjyt8s1mb****\\",\\n \\"InstanceIds\\": [\\n \\"cpn-e5kxgjyt8s1mb****\\"\\n ]\\n }\\n ],\\n \\"NetworkPackageOrderModel\\": {\\n \\"BandwidthPackageOrderId\\": \\"25954415983*****\\",\\n \\"BandwidthPackageId\\": \\"cbwp-uf63gsv8j0ir53*****\\"\\n }\\n}","type":"json"}]',
],
- 'UpgradeAndroidInstanceGroup' => [
- 'summary' => '升级实例组。目前仅支持增加实例组中的实例数量,即实例组扩容。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateCreditPackage' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3506,96 +1990,81 @@
'operationType' => 'none',
'riskType' => 'high',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMGJBSL',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneWY4NGN'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceGroupId',
+ 'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-asguicdjh****',
- ],
+ 'schema' => ['description' => '购买资源的时长,单位由PeriodUnit指定。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6'],
],
[
- 'name' => 'IncreaseNumberOfInstance',
+ 'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
- 'description' => '实例组中需要增加的实例数量。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '购买资源的时长单位。'."\n"
+ .'取值范围:'."\n"
+ .'- **Month**:月。'."\n"
+ .'- **Year**:年。',
+ 'type' => 'string',
'required' => false,
- 'example' => '2',
+ 'enumValueTitles' => ['Month' => '月', 'Year' => '年'],
+ 'example' => 'Month',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
- 'schema' => [
- 'description' => '是否自动支付。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '自动付费,请确保账号有足够的余额',
- 'false' => '手动付费',
- ],
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否自动支付。取值范围:'."\n"
+ ."\n"
+ .'- **true**:自动支付。您需要确保账户余额充足。'."\n"
+ .'- **false**(默认):只生成订单不扣费。'."\n"
+ ."\n\n"
+ ."\n\n"
+ .'> 如果您的支付方式余额不足,可以将此参数设置为false,此时会生成未支付订单,您可以登录无影云手机管理控制台自行支付。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'CreditAmount',
+ 'in' => 'query',
+ 'schema' => ['description' => '积分数量。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
[
'name' => 'PromotionId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'example' => '50003308011****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '310A783E-CC46-5452-A8A3-71AE5DB59****',
- ],
- 'OrderId' => [
- 'description' => '订单ID。',
- 'type' => 'string',
- 'example' => '223684716098****',
- ],
- 'InstanceIds' => [
- 'description' => '扩容产生的实例ID。',
- 'type' => 'string',
- 'example' => '[\'acp-2iowaqjyw9nrd****\', \'acp-2iowaqjyw9nrd****\']',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F07A1DA1-E1EB-5CCA-8EED-12F85D32****'],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '223684716098****'],
+ 'CreditPackageId' => ['description' => '积分加油包ID。', 'type' => 'string', 'example' => 'crp-bt7e2t4anbq50****'],
+ 'EffectiveTime' => ['description' => '积分加油包的生效时间。', 'type' => 'string', 'example' => '2026-04-30 00:00:00'],
+ 'ExpiredTime' => ['description' => '积分加油包的到期时间。', 'type' => 'string', 'example' => '2026-10-30 00:00:00'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '下单购买积分加油包',
+ 'summary' => '下单购买积分加油包。',
+ 'description' => '该接口涉及计费,请确保在使用接口前,已充分了解无影云手机产品的[收费方式和价格](https://help.aliyun.com/zh/ecp/jvs-mobile-billing-instructions?spm=a2c4g.11186623.help-menu-254658.d_0_1_1.78bc5732j49PWP)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"310A783E-CC46-5452-A8A3-71AE5DB59****\\",\\n \\"OrderId\\": \\"223684716098****\\",\\n \\"InstanceIds\\": \\"[\'acp-2iowaqjyw9nrd****\', \'acp-2iowaqjyw9nrd****\']\\"\\n}","type":"json"}]',
- 'title' => '升级实例组',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F07A1DA1-E1EB-5CCA-8EED-12F85D32****\\",\\n \\"OrderId\\": \\"223684716098****\\",\\n \\"CreditPackageId\\": \\"crp-bt7e2t4anbq50****\\",\\n \\"EffectiveTime\\": \\"2026-04-30 00:00:00\\",\\n \\"ExpiredTime\\": \\"2026-10-30 00:00:00\\"\\n}","type":"json"}]',
],
- 'DowngradeAndroidInstanceGroup' => [
- 'summary' => '降级实例组。目前仅支持释放实例组中的指定实例。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateCustomImage' => [
+ 'summary' => '根据云手机实例创建自定义镜像。可以进一步通过自定义镜像创建更多相同配置的云手机。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3604,1334 +2073,805 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMGJBSL',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneCPBVX1'],
],
'parameters' => [
[
- 'name' => 'InstanceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ag-cuv4scs4obxhs****',
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '镜像id搜素', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'acp-2zecay9ponatdc4m****'],
],
[
- 'name' => 'AndroidInstanceIds',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '待释放的实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-hangzhouarmw****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'name' => 'ImageName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '镜像类型', 'description' => '镜像名称。', 'type' => 'string', 'required' => true, 'example' => 'custom image name'],
],
[
- 'name' => 'AutoPay',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否自动付费。默认为false。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '自动付费,请确保账号有足够的余额',
- 'false' => '手动付费',
- ],
- 'example' => 'true',
- ],
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['title' => '镜像名称搜素', 'description' => '镜像描述。', 'type' => 'string', 'required' => false, 'example' => 'create for cc5g group auth rules test'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '幂等参数。默认为空,长度不超过100个字符。相同的ClientToken的多次调用,只会执行一次创建操作。', 'type' => 'string', 'required' => false, 'example' => '20393E53-8FF1-524C-B494-B478A5369733', 'maxLength' => 100],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => 'PageListResult<ImageDTO>',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '3AF82CE1-2801-52CE-BF64-B491DD7C****',
- ],
- 'OrderId' => [
- 'description' => '订单ID。',
- 'type' => 'string',
- 'example' => '22326560487****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20393E53-8FF1-524C-B494-B478A5369733'],
+ 'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'imgc-075cllfeuazh0****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AF82CE1-2801-52CE-BF64-B491DD7C****\\",\\n \\"OrderId\\": \\"22326560487****\\"\\n}","type":"json"}]',
- 'title' => '降级实例组',
- 'description' => '目前仅支持释放实例组中的部分实例,即实例组缩容。',
- ],
- 'RenewAndroidInstanceGroups' => [
- 'summary' => '续费云手机实例组。预付费(包年包月)已到期 15天系统将自动删除实例组及其实例,且不可恢复,请及时进行续费操作。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20393E53-8FF1-524C-B494-B478A5369733\\",\\n \\"ImageId\\": \\"imgc-075cllfeuazh0****\\"\\n}","type":"json"}]',
+ 'title' => '创建自定义镜像',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-19T09:36:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'CreateEdgeMobileAgentPackage' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'high',
+ 'operationType' => 'create',
+ 'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMR1L7E',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneLI0KSA'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceGroupIds',
+ 'name' => 'BizRegionId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-aobj3xwnvexhs****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- 'minItems' => 1,
- ],
+ 'schema' => ['title' => '业务大区。', 'description' => 'Agent所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'Quantity',
+ 'in' => 'query',
+ 'schema' => ['title' => '套餐数量, 1~1000。', 'description' => '套餐包数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '指定续费时长。单位由PeriodUnit指定。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '6',
- ],
+ 'schema' => ['title' => '时长。', 'description' => '购买资源的时长,单位由`PeriodUnit`指定。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '续费时长的时间单位,即参数Period的单位。默认值:Month。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Month' => '月',
- 'Year' => '年',
- ],
- 'example' => 'Month',
- ],
+ 'schema' => ['title' => '时长单位: Month/Year。', 'description' => '购买资源的时长单位。'."\n"
+ .'取值范围:'."\n"
+ .'- **Month**:月。'."\n"
+ .'- **Year**:年。', 'type' => 'string', 'required' => true, 'example' => 'Month'],
],
[
- 'name' => 'AutoPay',
+ 'name' => 'AutoRenew',
'in' => 'query',
- 'schema' => [
- 'description' => '是否自动支付。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '自动付费,请确保账号有足够的余额',
- 'false' => '手动付费',
- ],
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '自动续期, 默认false。', 'description' => '实例是否自动续费,取值:'."\n"
+ ."\n"
+ .'* **true**:是'."\n"
+ .'* **false**(默认):否', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'PromotionId',
+ 'name' => 'AutoPay',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '4B886792-2051-5DB4-8AE6-C8E45D3B4****',
- ],
- 'OrderId' => [
- 'description' => '订单ID。',
- 'type' => 'string',
- 'example' => '22326560487****',
- ],
- ],
- ],
+ 'schema' => ['title' => '自动支付, 默认false。', 'description' => '是否自动支付。取值范围:'."\n"
+ ."\n"
+ .'- **true**:自动支付。您需要确保账户余额充足。'."\n"
+ .'- **false**(默认):只生成订单不扣费。'."\n"
+ ."\n\n"
+ ."\n\n"
+ .'> 如果您的支付方式余额不足,可以将此参数设置为false,此时会生成未支付订单,您可以登录无影云手机管理控制台自行支付。'."\n"
+ .'>', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4B886792-2051-5DB4-8AE6-C8E45D3B4****\\",\\n \\"OrderId\\": \\"22326560487****\\"\\n}","type":"json"}]',
- 'title' => '续费实例组',
- ],
- 'UpdateInstanceGroupImage' => [
- 'summary' => '变更实例组镜像。会作用于该实例组下的所有实例。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneE7UBTJ',
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['title' => '幂等键。', 'description' => '幂等键。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'],
],
- ],
- 'parameters' => [
[
- 'name' => 'InstanceGroupIds',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-3kzpiqqsjwpy9****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- 'minItems' => 1,
- ],
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '优惠码。', 'description' => '优惠活动 ID。', 'type' => 'string', 'required' => false, 'example' => '50003308011****'],
],
[
- 'name' => 'ImageId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'imgc-075cllfeuazh****',
- ],
+ 'name' => 'DeviceClass',
+ 'in' => 'query',
+ 'schema' => ['description' => '设备形态。', 'type' => 'string', 'required' => false, 'example' => 'BOX'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => '返回参数。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '55726272-E40B-530D-914F-5126B19C79B3',
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC******'],
+ 'OrderId' => ['title' => '订单ID。', 'description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '22326560487****'],
+ 'PackageIds' => [
+ 'description' => '套餐包 ID 列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '套餐包 ID。', 'type' => 'string', 'example' => 'cmag-0c1g77wjljl9hc****'],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '下单购买边缘智能体套餐包',
+ 'summary' => '下单购买边缘智能体套餐包。',
+ 'description' => '该接口涉及计费,请确保在使用接口前,已充分了解无影云手机产品的[收费方式和价格](https://help.aliyun.com/zh/ecp/jvs-mobile-billing-instructions?spm=a2c4g.11174283.help-menu-254658.d_0_1_1.23695732Cpmwbs)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"55726272-E40B-530D-914F-5126B19C79B3\\"\\n}","type":"json"}]',
- 'title' => '变更实例组镜像',
- 'description' => '镜像的状态为可用且可用地域中包含实例组的地域,实例组状态为可用。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC******\\",\\n \\"OrderId\\": 0,\\n \\"PackageIds\\": [\\n \\"cmag-0c1g77wjljl9hc****\\"\\n ]\\n}","type":"json"}]',
],
- 'DeleteAndroidInstanceGroup' => [
- 'summary' => '删除云手机实例组。 将同步删除实例组下的所有实例,删除后不可恢复,请谨慎操作。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateKeyPair' => [
+ 'summary' => '用户可以通过ADB连接云手机,对云手机进行设备管理、应用管理、文件传输等操作。由于其操作权限较大且云手机没有物理接口,无法通过 USB 触发设备端的授权对话框。因此adb通过网络连接云手机,必须预先配置密钥对,让设备信任客户端,确保操作的安全。调用本接口CreateKeyPair可创建一对ADB密钥对。系统会为您保管密钥的公钥部分,并返回符合ADB连接规范的PEM编码的PKCS#8格式私钥。您需要自行妥善保管私钥部分。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneDADB6I'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceGroupIds',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-h67a2cs0zpruy****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => '密钥对名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以http://或https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。', 'type' => 'string', 'required' => true, 'example' => 'testKeyPairName', 'maxLength' => 128, 'minLength' => 2],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => 'PlainResult<KeyPairModel>',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'CB95E410-FD1D-53C5-9F7D-93CC44D7****',
+ 'Data' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'KeyPairId' => ['description' => 'ADB密钥对ID。', 'type' => 'string', 'example' => 'kp-6v2q33ae4tw3*****'],
+ 'KeyPairName' => ['description' => '密钥对名称。', 'type' => 'string', 'example' => 'testKeyPairName'],
+ 'PrivateKeyBody' => ['description' => '密钥对的私钥。符合ADB密钥对规范的PEM 编码的 PKCS#8 格式的私钥部分。', 'type' => 'string', 'example' => 'MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****'],
+ 'GmtCreated' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2024-06-30 08:45:09.0'],
+ ],
],
+ 'RequestId' => ['description' => '接口请求ID。', 'type' => 'string', 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB95E410-FD1D-53C5-9F7D-93CC44D7****\\"\\n}","type":"json"}]',
- 'title' => '删除实例组',
- 'description' => '按量付费实例组支持直接删除;'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"KeyPairId\\": \\"kp-6v2q33ae4tw3*****\\",\\n \\"KeyPairName\\": \\"testKeyPairName\\",\\n \\"PrivateKeyBody\\": \\"MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****\\",\\n \\"GmtCreated\\": \\"2024-06-30 08:45:09.0\\"\\n },\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
+ 'title' => '创建ADB密钥对',
+ 'description' => '除了调用 CreateKeyPair 创建密钥对之外,您还可以使用ADB工具创建密钥对,然后上传( [ImportKeyPair](~~2807340~~) )到无影云手机控制台,其使用方法和系统为您创建的密钥对是一致的。'."\n"
."\n"
- .'包年包月实例组过期后才能删除,即“已过期”状态的包年包月实例组支持删除。',
- ],
- 'DescribeAndroidInstances' => [
- 'summary' => '查询云手机实例的详情信息。',
- 'methods' => [
- 'post',
- 'get',
+ .'每个租户的密钥对数最高为 500 对。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-04T08:01:33.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'CreateMobileAgentPackage' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneTVG3Y7',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneWY4NGN'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceGroupId',
+ 'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-25nt4kk9whjh****',
- ],
+ 'schema' => ['description' => '购买资源的时长,单位由`PeriodUnit`指定。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'KeyPairId',
+ 'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
- 'description' => '已绑定的密钥对ID。',
+ 'description' => '购买资源的时长单位。'."\n"
+ .'取值范围:'."\n"
+ .'- **Month**:月。'."\n"
+ .'- **Year**:年。',
'type' => 'string',
'required' => false,
- 'example' => 'kp-5hh431emkpuoi****',
+ 'enumValueTitles' => ['Month' => '月', 'Year' => '年'],
+ 'example' => 'Month',
],
],
[
- 'name' => 'AndroidInstanceIds',
+ 'name' => 'AutoPay',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-25nt4kk9whhok****',
- ],
- 'required' => false,
- 'maxItems' => 1000,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => '是否自动支付。取值范围:'."\n"
+ ."\n"
+ .'- **true**:自动支付。您需要确保账户余额充足。'."\n"
+ .'- **false**(默认):只生成订单不扣费。'."\n"
+ ."\n\n"
+ ."\n\n"
+ .'> 如果您的支付方式余额不足,可以将此参数设置为false,此时会生成未支付订单,您可以登录无影云手机管理控制台自行支付。'."\n"
+ .'>', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'AndroidInstanceName',
+ 'name' => 'CreditAmount',
'in' => 'query',
- 'schema' => [
- 'description' => '实例名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'name',
- ],
+ 'schema' => ['description' => '积分额度。', 'type' => 'string', 'required' => false, 'example' => '10000.0'],
],
[
- 'name' => 'Status',
+ 'name' => 'PromotionId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例状态。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'BACKUPING' => '文件备份中',
- 'STARTING' => '开机中',
- 'RUNNING' => '可用',
- 'DELETING' => '删除中',
- 'BACKUP_FAILED' => '文件备份失败',
- 'DELETED' => '已删除',
- 'FAILED' => '创建失败',
- 'STOPPED' => '已关机',
- 'RECOVERING' => '文件恢复中',
- 'UNAVAILABLE' => '异常',
- 'REBOOTING' => '重启中',
- 'RESETTING' => '重置中',
- 'STOPPING' => '关机中',
- 'RECOVER_FAILED' => '文件恢复失败',
- 'CREATING' => '创建中',
- ],
- 'example' => 'RUNNING',
- ],
+ 'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'example' => '50003308011****'],
],
[
- 'name' => 'SaleMode',
+ 'name' => 'MobileAgentPackageSpec',
'in' => 'query',
'schema' => [
- 'description' => '售卖模式。',
+ 'description' => '套餐包规格。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'Instance' => '云手机实例模式',
- 'Node' => '云手机矩阵模式',
- ],
- 'example' => 'Instance',
+ 'enumValueTitles' => ['advanced' => '高级版', 'ultimate' => '旗舰版'],
+ 'example' => 'advanced',
],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'InstanceName',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => '节点实例名称。', 'type' => 'string', 'required' => false, 'example' => 'CloudPhone'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'CreditConfig',
'in' => 'query',
- 'schema' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****',
- ],
+ 'schema' => ['description' => 'Credit限额配置。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'InstanceGroupIds',
+ 'name' => 'Amount',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-25nt4kk9whhdh****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '套餐包数量。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'InstanceGroupName',
+ 'name' => 'PaidCallbackUrl',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '支付成功页跳转链接。', 'type' => 'string', 'required' => false, 'example' => 'https://aim.wuying.aliyun.com/nodes'],
],
[
- 'name' => 'ChargeType',
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例是否自动续费,取值:'."\n"
+ ."\n"
+ .'* **true**:是'."\n"
+ .'* **false**(默认):否', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'BizRegionId',
'in' => 'query',
'schema' => [
- 'description' => '付费类型。',
+ 'description' => '实例所在地域。当前仅支持cn-hangzhou。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'PostPaid' => '后付费',
- 'PrePaid' => '预付费',
- ],
- 'example' => 'PostPaid',
+ 'enumValueTitles' => ['cn-hangzhou' => '华东1(杭州)'],
+ 'example' => 'cn-hangzhou',
],
],
[
- 'name' => 'Tag',
+ 'name' => 'ImageId',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'PackageSpecId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '资源的标签。',
- 'type' => 'array',
- 'items' => [
- 'description' => '资源的标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'key',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'value',
- ],
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****'],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '22326560487****'],
+ 'MobileAgentPackageIds' => [
+ 'description' => '套餐包ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '套餐包ID。', 'type' => 'string', 'example' => 'cmag-sbbhdajsds**** '],
],
- 'required' => false,
],
- 'required' => false,
- 'maxItems' => 20,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '下单购买套餐包',
+ 'summary' => '下单购买套餐包。',
+ 'description' => '该接口涉及计费,请确保在使用接口前,已充分了解无影云手机产品的[收费方式和价格](https://help.aliyun.com/zh/ecp/jvs-mobile-billing-instructions?spm=a2c4g.11174283.help-menu-254658.d_0_1_1.23695732Cpmwbs)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\",\\n \\"OrderId\\": \\"22326560487****\\",\\n \\"MobileAgentPackageIds\\": [\\n \\"cmag-sbbhdajsds**** \\"\\n ]\\n}","type":"json"}]',
+ ],
+ 'CreatePolicyGroup' => [
+ 'summary' => '创建策略。策略用于对云手机进行统一的设置,例如网络重定向策略、水印、分辨率、剪贴板等功能设置。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'BizRegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '<props="china">地域ID。可以通过调用[DescribeRegions](~~2807298~~)查询云手机不同版本(实例版/矩阵版)支持购买的地域列表。</props>'."\n"
- ."\n"
- .'<props="intl">地域ID。可以通过调用[DescribeRegions](~~2807298~~)查询云手机支持购买的地域列表。</props>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneS5VM56'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'NodeId',
- 'in' => 'query',
+ 'name' => 'Html5FileTransfer',
+ 'in' => 'formData',
'schema' => [
- 'description' => '<props="china">矩阵ID。</props>'."\n"
- .'<props="intl">本参数暂不对外开放使用。</props>',
+ 'description' => '无影Web客户端文件传输策略。',
'type' => 'string',
'required' => false,
- 'example' => 'node_id',
+ 'enumValueTitles' => ['all' => '允许上传下载', 'download' => '允许下载', 'upload' => '允许上传', 'off' => '关闭'],
+ 'example' => 'off',
],
],
[
- 'name' => 'NodeName',
- 'in' => 'query',
+ 'name' => 'LocalDrive',
+ 'in' => 'formData',
'schema' => [
- 'description' => '<props="china">矩阵的名称。</props>'."\n"
- .'<props="intl">本参数暂不对外开放使用。</props>',
+ 'description' => '本地磁盘映射权限。',
'type' => 'string',
'required' => false,
- 'example' => 'node_name',
+ 'enumValueTitles' => ['read' => '只读', 'readwrite' => '读写', 'off' => '关闭'],
+ 'example' => 'off',
],
],
[
- 'name' => 'OfficeSiteIds',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '云手机网络ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '云手机网络ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou+dir-744962****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'name' => 'PolicyGroupName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '策略名称。', 'type' => 'string', 'required' => false, 'example' => 'Default policy'],
],
[
- 'name' => 'AuthorizedUserId',
- 'in' => 'query',
+ 'name' => 'CameraRedirect',
+ 'in' => 'formData',
'schema' => [
- 'description' => '实例分配的用户ID,即无影便捷账号ID。',
+ 'description' => '是否开启本地摄像头重定向。',
'type' => 'string',
'required' => false,
- 'example' => 'user',
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
],
],
[
- 'name' => 'QosRuleIds',
- 'in' => 'query',
- 'style' => 'repeatList',
+ 'name' => 'Clipboard',
+ 'in' => 'formData',
'schema' => [
- 'description' => '公网限速规则组ID。基础共享网络中的实例限速规则。',
- 'type' => 'array',
- 'items' => [
- 'description' => '公网限速规则组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qos-g6no280ed8byi****',
- ],
+ 'description' => '剪贴板权限。',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 100,
+ 'enumValueTitles' => ['read' => '单向允许', 'readwrite' => '双向允许', 'off' => '双向禁止'],
+ 'example' => 'readwrite',
],
],
[
- 'name' => 'AppManagePolicyId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用管控规则ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'amp-shigvudbyeuib****',
- ],
+ 'name' => 'ResolutionHeight',
+ 'in' => 'formData',
+ 'schema' => ['description' => '分辨率的高度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1280'],
],
[
- 'name' => 'PrivateIpAddress',
- 'in' => 'query',
+ 'name' => 'ResolutionWidth',
+ 'in' => 'formData',
+ 'schema' => ['description' => '分辨率的宽度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720'],
+ ],
+ [
+ 'name' => 'LockResolution',
+ 'in' => 'formData',
'schema' => [
- 'description' => '实例的私网IP地址。',
+ 'description' => '是否锁定分辨率。',
'type' => 'string',
'required' => false,
- 'example' => '10.0.162.136',
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'NetRedirectPolicy',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回信息。',
+ 'description' => '网络重定向。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
+ 'NetRedirect' => [
+ 'description' => '是否开启网络重定向。',
'type' => 'string',
- 'example' => 'F07A1DA1-E1EB-5CCA-8EED-12F85D32****',
+ 'required' => false,
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
+ 'CustomProxy' => [
+ 'description' => '是否手动配置透明代理。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
],
- 'NextToken' => [
- 'description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。',
+ 'ProxyType' => [
+ 'description' => '代理协议类型。',
'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kmma/xxE9WtwL/ADvZ****',
+ 'required' => false,
+ 'enumValueTitles' => ['socks5' => 'socks5'],
+ 'example' => 'socks5',
],
- 'InstanceModel' => [
- 'description' => '实例信息。',
+ 'HostAddr' => ['description' => '透明代理IP。格式为IPv4地址。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX'],
+ 'Port' => ['description' => '透明代理端口。端口取值范围为1\\~65535。', 'type' => 'string', 'required' => false, 'example' => '1145'],
+ 'ProxyUserName' => ['description' => '代理用户名。长度范围为1\\~256,不允许包含中文字符和空白字符。', 'type' => 'string', 'required' => false, 'example' => 'username'],
+ 'ProxyPassword' => ['description' => '代理密码。长度范围为1\\~256,不允许包含中文字符和空白字符。', 'type' => 'string', 'required' => false, 'example' => 'password'],
+ 'Rules' => [
+ 'description' => '代理规则列表(最多100条)',
'type' => 'array',
'items' => [
- 'description' => '实例信息。',
+ 'description' => '代理规则',
'type' => 'object',
'properties' => [
- 'AndroidInstanceGroupId' => [
- 'description' => '实例所属实例组的ID。',
- 'type' => 'string',
- 'example' => 'ag-ayyhomlal7po****',
- ],
- 'AndroidInstanceGroupName' => [
- 'description' => '实例组名称。',
- 'type' => 'string',
- 'example' => 'AndroidInstanceGroupName',
- ],
- 'AndroidInstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-8at8h6ejkadjh****',
- ],
- 'AndroidInstanceName' => [
- 'description' => '实例名称。',
- 'type' => 'string',
- 'example' => 'name',
- ],
- 'AndroidInstanceStatus' => [
- 'description' => '实例状态。',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'NetworkInterfaceIp' => [
- 'description' => '网卡IP。',
- 'type' => 'string',
- 'example' => '192.168.22.48',
- ],
- 'AuthorizedUserId' => [
- 'description' => '已分配的用户。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'BindUserId' => [
- 'description' => '已绑定的用户。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'PersistentAppInstanceId' => [
- 'description' => '持久会话ID。',
- 'type' => 'string',
- 'example' => 'p-0btrd5zj8epo****',
- ],
- 'AppInstanceId' => [
- 'description' => '物理实例ID。',
- 'type' => 'string',
- 'example' => 'ai-9ey6io0q58rcd****',
- ],
- 'KeyPairId' => [
- 'description' => '密钥对ID。',
- 'type' => 'string',
- 'example' => 'kp-5hh431emkpucs****',
- ],
- 'GmtCreate' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2023-05-06 10:42:10',
- ],
- 'GmtModified' => [
- 'description' => '修改时间。',
- 'type' => 'string',
- 'example' => '2023-05-06 10:42:10',
- ],
- 'AppInstanceGroupId' => [
- 'description' => '交付组ID。',
- 'type' => 'string',
- 'example' => 'aig-i7yv6tkn7kh8dv****',
- ],
- 'RegionId' => [
- 'description' => '地域 ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'Rate' => [
- 'description' => '实例数据备份中和恢复中的进度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'ErrorCode' => [
- 'description' => '实例数据备份失败和恢复失败的错误原因。',
- 'type' => 'string',
- 'example' => 'FilePathNotFound',
- ],
- 'RenderingType' => [
- 'description' => '渲染类型。',
- 'type' => 'string',
- 'example' => 'local',
- ],
- 'InstanceType' => [
- 'description' => '实例类型。',
- 'type' => 'string',
- 'example' => 'acp.basic.small',
- ],
- 'ChargeType' => [
- 'description' => '实例的计费类型。',
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'GmtExpired' => [
- 'description' => '包年包月实例组的过期时间。',
- 'type' => 'string',
- 'example' => '2024-07-15T02:03:33Z',
- ],
- 'PolicyGroupId' => [
- 'description' => '策略组ID。',
- 'type' => 'string',
- 'example' => 'pg-0bszojpu0seql****',
- ],
- 'OfficeSiteId' => [
- 'description' => '网络ID。对应控制台上创建时所选择的网络(基础共享网络,高级共享网络)',
- 'type' => 'string',
- 'example' => 'cn-shenzhen+dir-211620****',
- ],
- 'VSwitchId' => [
- 'description' => '专有网络中的交换机ID。',
- 'type' => 'string',
- 'example' => 'vsw-2zepmau2hsbhos42****',
- ],
- 'Memory' => [
- 'description' => '内存大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1024',
- ],
- 'Cpu' => [
- 'description' => 'CPU核数。',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'Disks' => [
- 'description' => '磁盘信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '磁盘信息。',
- 'type' => 'object',
- 'properties' => [
- 'DiskType' => [
- 'description' => '磁盘类型。',
- 'type' => 'string',
- 'example' => 'SYSTEM',
- ],
- 'DiskSize' => [
- 'description' => '磁盘大小。单位:GB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- ],
- ],
- ],
- ],
- 'Tags' => [
- 'description' => '标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签信息。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'key',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'value',
- ],
- ],
- ],
- ],
- 'ImageVersion' => [
- 'description' => '镜像版本。',
- 'type' => 'string',
- 'example' => '3.5.3.867',
- ],
- 'PublicIpAddress' => [
- 'description' => '公网IP。',
- 'type' => 'string',
- 'example' => '10.32.1.41',
- ],
- 'SessionStatus' => [
- 'description' => '会话连接状态。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'disConnect' => '未连接',
- 'connect' => '连接',
- ],
- 'example' => 'connect',
- ],
- 'NetworkInterfaceIpv6Address' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'PublicIpv6Address' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'ImageId' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'example' => 'imgc-075cllfeuazh0****',
- ],
- 'DisplayConfig' => [
- 'description' => '显示设置。',
- 'type' => 'object',
- 'properties' => [
- 'ResolutionHeight' => [
- 'description' => '分辨率的高。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1280',
- ],
- 'ResolutionWidth' => [
- 'description' => '分辨率的宽。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '720',
- ],
- 'Dpi' => [
- 'description' => 'DPI。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '240',
- ],
- 'Fps' => [
- 'description' => '帧率。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'LockResolution' => [
- 'description' => '锁定分辨率。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
- ],
- ],
- ],
- 'QosRuleId' => [
- 'description' => '公网限速规则ID(仅作用于精品带宽)',
- 'type' => 'string',
- 'example' => 'qos-5605u0gelk200****',
- ],
- 'AppManagePolicy' => [
- 'description' => '应用管控规则信息。对应管制台的应用管控规则的黑白名单管理。',
- 'type' => 'object',
- 'properties' => [
- 'AppManagePolicyId' => [
- 'description' => '应用管控规则ID。',
- 'type' => 'string',
- 'example' => 'amp-dgiavcvibfdds****',
- ],
- 'AppManagePolicyName' => [
- 'description' => '应用管控规则名称。',
- 'type' => 'string',
- 'example' => '应用组1',
- ],
- ],
- ],
- 'ZoneId' => [
- 'description' => '实例所属的可用区ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h',
- ],
- 'PhoneDataInfo' => [
- 'description' => '<props="china">云手机矩阵版实例的独立机身存储信息。</props>'."\n"
- .'<props="intl">本参数暂不对外开放使用。</props>',
- 'type' => 'object',
- 'properties' => [
- 'PhoneDataId' => [
- 'description' => '独立机身存储ID。',
- 'type' => 'string',
- 'example' => 'pd-sbcudgidbhb****',
- ],
- 'PhoneDataVolume' => [
- 'description' => '独立机身存储的容量大小。单位:GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- ],
- ],
- 'StreamMode' => [
- 'description' => '<props="china">云手机矩阵下实例的串流模式。</props>'."\n"
- .'<props="intl">本参数暂不对外开放使用。</props>',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NetworkType' => [
- 'description' => '实例的网络类型。',
- 'type' => 'string',
- 'example' => 'network_pro_ecd',
- ],
- 'BandwidthPackageType' => [
- 'description' => '带宽类型。',
- 'type' => 'string',
- 'example' => 'cbwp_ecd',
- ],
- 'BandwidthPackageId' => [
- 'description' => '带宽包的ID。',
- 'type' => 'string',
- 'example' => 'np-0q6ixs7vpxcizp***',
- ],
- 'UpBandwidthLimit' => [
- 'description' => '上行带宽限速,单位Mbps',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'DownBandwidthLimit' => [
- 'description' => '下行带宽限速,单位Mbps',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'ServerType' => [
- 'description' => '<props="china">云手机矩阵规格。</props>'."\n"
- .'<props="intl">本参数暂不对外开放使用。</props>',
- 'type' => 'string',
- 'example' => 'cpm.gx7.10xlarge',
- ],
- 'BizTags' => [
- 'description' => '标签数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签对象',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'releaseFlag',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'on',
- ],
- ],
- ],
- ],
- 'ServerStatus' => [
- 'description' => '<props="china">矩阵状态。</props>'."\n"
- .'<props="intl">本参数暂不对外开放使用。</props>',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'FAILED' => '创建失败',
- 'RUNNING' => '可用',
- 'EXPIRED' => '过期',
- 'DELETING' => '删除中',
- 'NODE_READY' => '矩阵ready,实例创建中',
- 'CHANGING' => '矩阵变配中',
- 'CEASED' => '欠费',
- 'UPDATING' => '变更镜像中',
- 'CREATING' => '创建中',
- 'DATA_EXPANDING' => '存储扩容中',
- ],
- 'example' => 'RUNNING',
- ],
- 'SystemVersion' => [
- 'description' => 'android系统版本。',
- 'type' => 'string',
- 'example' => 'Android 11',
- ],
- 'InternetStatus' => [
- 'type' => 'string',
- ],
- 'BizImageType' => [
+ 'Target' => ['description' => '应用包名或域名', 'type' => 'string', 'required' => false, 'example' => '*.baidu.com'],
+ 'RuleType' => [
+ 'description' => '规则类型',
'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['prc' => '应用包名', 'domain' => '域名'],
+ 'example' => 'domain',
],
],
+ 'required' => false,
],
+ 'required' => false,
],
],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PolicyType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '策略类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Node'],
+ ],
+ ],
+ [
+ 'name' => 'Watermark',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '屏幕水印。',
+ 'type' => 'object',
+ 'properties' => [
+ 'WatermarkSwitch' => [
+ 'description' => '屏幕水印开关。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
+ ],
+ 'WatermarkTypes' => [
+ 'description' => '屏幕水印内容。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '屏幕水印内容。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['Username' => '用户名', 'CustomText' => '自定义文字', 'ClientIpAddress' => '客户端IP地址', 'IpAddress' => 'IP地址', 'ClientTime' => '当前时间'],
+ 'example' => 'Username',
+ ],
+ 'required' => false,
+ ],
+ 'WatermarkCustomText' => ['description' => '水印自定义内容。长度不超过10个字符,且不支持Emoji表情符号。', 'type' => 'string', 'required' => false, 'example' => 'custom text'],
+ 'WatermarkFontSize' => ['description' => '水印字体大小。 取值范围:10\\~20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12'],
+ 'WatermarkColor' => ['description' => '水印字体颜色。 取值范围: 0\\~16777215。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'WatermarkTransparencyValue' => ['description' => '水印不透明度,值越大,透明度越小。 取值范围: 10\\~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '25'],
+ ],
+ 'required' => false,
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC******'],
+ 'PolicyGroupId' => ['description' => '策略ID。', 'type' => 'string', 'example' => 'pg-exbuu6yrpvb******'],
+ ],
+ ],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F07A1DA1-E1EB-5CCA-8EED-12F85D32****\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kmma/xxE9WtwL/ADvZ****\\",\\n \\"InstanceModel\\": [\\n {\\n \\"AndroidInstanceGroupId\\": \\"ag-ayyhomlal7po****\\",\\n \\"AndroidInstanceGroupName\\": \\"AndroidInstanceGroupName\\",\\n \\"AndroidInstanceId\\": \\"acp-8at8h6ejkadjh****\\",\\n \\"AndroidInstanceName\\": \\"name\\",\\n \\"AndroidInstanceStatus\\": \\"RUNNING\\",\\n \\"NetworkInterfaceIp\\": \\"192.168.22.48\\",\\n \\"AuthorizedUserId\\": \\"test\\",\\n \\"BindUserId\\": \\"test\\",\\n \\"PersistentAppInstanceId\\": \\"p-0btrd5zj8epo****\\",\\n \\"AppInstanceId\\": \\"ai-9ey6io0q58rcd****\\",\\n \\"KeyPairId\\": \\"kp-5hh431emkpucs****\\",\\n \\"GmtCreate\\": \\"2023-05-06 10:42:10\\",\\n \\"GmtModified\\": \\"2023-05-06 10:42:10\\",\\n \\"AppInstanceGroupId\\": \\"aig-i7yv6tkn7kh8dv****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Rate\\": 100,\\n \\"ErrorCode\\": \\"FilePathNotFound\\",\\n \\"RenderingType\\": \\"local\\",\\n \\"InstanceType\\": \\"acp.basic.small\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"GmtExpired\\": \\"2024-07-15T02:03:33Z\\",\\n \\"PolicyGroupId\\": \\"pg-0bszojpu0seql****\\",\\n \\"OfficeSiteId\\": \\"cn-shenzhen+dir-211620****\\",\\n \\"VSwitchId\\": \\"vsw-2zepmau2hsbhos42****\\",\\n \\"Memory\\": 1024,\\n \\"Cpu\\": \\"4\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskSize\\": 32\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"ImageVersion\\": \\"3.5.3.867\\",\\n \\"PublicIpAddress\\": \\"10.32.1.41\\",\\n \\"SessionStatus\\": \\"connect\\",\\n \\"NetworkInterfaceIpv6Address\\": \\"null\\",\\n \\"PublicIpv6Address\\": \\"null\\",\\n \\"ImageId\\": \\"imgc-075cllfeuazh0****\\",\\n \\"DisplayConfig\\": {\\n \\"ResolutionHeight\\": 1280,\\n \\"ResolutionWidth\\": 720,\\n \\"Dpi\\": 240,\\n \\"Fps\\": 30,\\n \\"LockResolution\\": \\"off\\"\\n },\\n \\"QosRuleId\\": \\"qos-5605u0gelk200****\\",\\n \\"AppManagePolicy\\": {\\n \\"AppManagePolicyId\\": \\"amp-dgiavcvibfdds****\\",\\n \\"AppManagePolicyName\\": \\"应用组1\\"\\n },\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"PhoneDataInfo\\": {\\n \\"PhoneDataId\\": \\"pd-sbcudgidbhb****\\",\\n \\"PhoneDataVolume\\": 20\\n },\\n \\"StreamMode\\": 1,\\n \\"NetworkType\\": \\"network_pro_ecd\\",\\n \\"BandwidthPackageType\\": \\"cbwp_ecd\\",\\n \\"BandwidthPackageId\\": \\"np-0q6ixs7vpxcizp***\\",\\n \\"UpBandwidthLimit\\": 5,\\n \\"DownBandwidthLimit\\": 30,\\n \\"ServerType\\": \\"cpm.gx7.10xlarge\\",\\n \\"BizTags\\": [\\n {\\n \\"Key\\": \\"releaseFlag\\",\\n \\"Value\\": \\"on\\"\\n }\\n ],\\n \\"ServerStatus\\": \\"RUNNING\\",\\n \\"SystemVersion\\": \\"Android 11\\",\\n \\"InternetStatus\\": \\"\\",\\n \\"BizImageType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询实例详细信息',
- ],
- 'ModifyAndroidInstance' => [
- 'summary' => '修改云手机实例信息,目前仅支持修改实例名称、上下行带宽限制。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC******\\",\\n \\"PolicyGroupId\\": \\"pg-exbuu6yrpvb******\\"\\n}","type":"json"}]',
+ 'title' => '创建策略',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-25T11:27:20.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-03T10:00:32.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-01-09T15:07:06.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-15T01:35:07.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-26T11:32:59.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-08-20T03:54:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-08-19T09:42:45.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'CreateScreenshot' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVGR0HK',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneQNMLJ7'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AndroidInstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '单个实例ID,当该字段有值时会忽略InstanceIds(多个实例ID)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-8v5bjld0r7tkl****'."\n",
- ],
- ],
- [
- 'name' => 'NewAndroidInstanceName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '实例的新名称。'."\n"
- ."\n"
- .'> '."\n"
- .'> - 实例名称长度不超过30个字符;请以大/小写字母或中文开头,不能以http://和https://开头,仅支持中文、英文、数字、半角冒号(:)、下划线(_)、点号(.)或者连字符(-)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'new_name',
- ],
- ],
- [
- 'name' => 'InstanceIds',
+ 'name' => 'AndroidInstanceIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机实例ID列表,可设置 1~100 个。',
+ 'description' => '实例ID列表,支持批量截图。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机实例ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-5hh4a31emkt6u****',
- ],
- 'required' => false,
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'acp-ig2bdpk374l12****'],
+ 'deprecated' => false,
+ 'required' => true,
'maxItems' => 100,
],
],
[
- 'name' => 'UpBandwidthLimit',
+ 'name' => 'OssBucketName',
'in' => 'query',
- 'schema' => [
- 'description' => '上行带宽限速,单位Mbps',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
+ 'schema' => ['description' => '自定义OSS桶,桶名必须“cloudphone-saved-bucket-”为前缀,云手机实例和OSS桶地域需要保持一致。空默认创建桶“cloudphone-saved-bucket-{云手机所在地域}-{AliUid}”。', 'type' => 'string', 'required' => false, 'example' => 'cloudphone-saved-bucket-cn-shanghai-default'],
],
[
- 'name' => 'DownBandwidthLimit',
+ 'name' => 'SkipCheckPolicyConfig',
'in' => 'query',
- 'schema' => [
- 'description' => '下行带宽限速,单位Mbps',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
+ 'schema' => ['description' => '是否跳过截图策略控制,默认false。', 'type' => 'string', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ScreenshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => '截屏ID。生成的截屏图片命名为“ ScreenshotId_AndroidInstanceId.png”。'."\n"
+ ."\n"
+ .'><notice>ScreenshotId 长度为 2~128 个字符,以英文字母或中文开头,不能以http://和https://开头,可包含数字、下划线(_)和短划线(-)。></notice>', 'type' => 'string', 'required' => false, 'example' => 'image'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => 'PlainResult<Integer>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E5138F7E-46B5-526A-8C99-82DEAE6B****',
+ 'RequestId' => ['description' => '请求唯一ID,如果遇到问题请提供这个请求ID,由工作人员为您排查。', 'type' => 'string', 'example' => '3AF82CE1-2801-52CE-BF64-B491DD7C****'],
+ 'Tasks' => [
+ 'description' => '任务列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AndroidInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-bwhtebzah2fse****'],
+ 'TaskId' => ['description' => '任务ID。通过TaskId可以调用DescribeTasks接口查询当前实例的截图任务,当任务完成可以拿到截图的下载链接。', 'type' => 'string', 'example' => 't-imr0fufqd7cle****'],
+ 'ScreenshotId' => ['description' => '截屏ID。生成的截屏图片命名为“ ScreenshotId_AndroidInstanceId.png”。', 'type' => 'string', 'example' => 'image'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '生成一张云手机的截屏图片',
+ 'summary' => '生成一张云手机的截屏图片,异步接口。',
+ 'description' => '创建一张云手机的截屏图片并上传到默认的OSS桶,接口返回TaskId,可以通过DescribeTasks接口查询截图的下载链接。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5138F7E-46B5-526A-8C99-82DEAE6B****\\"\\n}","type":"json"}]',
- 'title' => '修改实例信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AF82CE1-2801-52CE-BF64-B491DD7C****\\",\\n \\"Tasks\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-bwhtebzah2fse****\\",\\n \\"TaskId\\": \\"t-imr0fufqd7cle****\\",\\n \\"ScreenshotId\\": \\"image\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'AuthorizeAndroidInstance' => [
- 'summary' => '为云手机实例分配用户或者取消已分配用户。目前一台云手机实例仅支持分配一个用户。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateSystemPropertyTemplate' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphone3OZQF8'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIds',
+ 'name' => 'TemplateName',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['description' => '模板的名称。必须符合以下要求:'."\n"
+ ."\n"
+ .'- 长度2~32个英文或中文字符。'."\n"
+ .'- 必须以大小写字母或中文开头,不能以`http://`或`https://`开头。'."\n"
+ .'- 可以包含字母、数字、汉字、半角冒号(:)、下划线(_)或短划线(-),不支持点号(.)。', 'type' => 'string', 'required' => false, 'example' => 'Template1'],
+ ],
+ [
+ 'name' => 'SystemPropertyInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-8v5bjld0r7pl****',
+ 'description' => '系统属性模板信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoBuildFingerprint' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoProductModel' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoProductManufacturer' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoProductBrand' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildUser' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildId' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBootloader' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildTags' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoProductBoard' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoProductDevice' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildProduct' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildType' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildHost' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildDisplayId' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RwRoSerialNo' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'CustomPropertyInfos' => [
+ 'description' => '自定义属性信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '自定义属性信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PropertyName' => ['description' => '自定义属性Key。', 'type' => 'string', 'required' => false, 'example' => 'propKey'],
+ 'PropertyValue' => ['description' => '自定义属性Value。', 'type' => 'string', 'required' => false, 'example' => 'propValue'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
],
'required' => false,
- 'maxItems' => 100,
- 'minItems' => 1,
],
],
[
- 'name' => 'AuthorizeUserId',
+ 'name' => 'FilePath',
'in' => 'query',
- 'schema' => [
- 'description' => '需要分配的用户ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '属性模板的文件URL路径。接口会同步解析文件内容,如果文件内容格式有问题,则会报错解析失败。'."\n"
+ .'> 文件模板格式:`{ "propties":{"key1":"value1"}}`。', 'type' => 'string', 'required' => false, 'example' => 'https://filepath****.com'."\n", 'maxLength' => 512],
],
[
- 'name' => 'UnAuthorizeUserId',
+ 'name' => 'EnableAuto',
'in' => 'query',
- 'schema' => [
- 'description' => '需要取消分配的用户ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '是否支持部分预置系统属性自动生成。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'TemplateId' => ['description' => '属性模板ID。', 'type' => 'string', 'example' => 'ap-g6gyv4a4xlf****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建系统属性模板',
+ 'summary' => '创建系统属性模板。属性模板中定义的属性键值对,将下发到云手机并通过setprop命令设置到云手机android系统中,APK或相关程序可读取这些属性值。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\"\\n}","type":"json"}]',
- 'title' => '实例分配用户&取消分配',
- 'description' => '支持分配用户的实例状态:可用、关机中、已关机、开机中、备份中、恢复中、备份失败、恢复失败。'."\n"
- ."\n"
- .'支持取消分配的实例状态:可用、关机中、已关机、开机中、备份中、恢复中、备份失败、恢复失败、已过期、已欠费、已删除。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"TemplateId\\": \\"ap-g6gyv4a4xlf****\\"\\n}","type":"json"}]',
],
- 'StartAndroidInstance' => [
- 'summary' => '启动(开机)云手机实例。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteAndroidInstanceGroup' => [
+ 'summary' => '删除云手机实例组。 将同步删除实例组下的所有实例,删除后不可恢复,请谨慎操作。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone5C0MVL',
- ],
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'AndroidInstanceIds',
+ 'name' => 'InstanceGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例列表。',
+ 'description' => '实例组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-hk34lbnw0qhi7****',
- ],
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-h67a2cs0zpruy****'],
'required' => false,
- 'maxItems' => 1000,
- ],
- ],
- [
- 'name' => 'SaleMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '售卖模式。该参数已废弃!',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Instance' => '云手机实例模式',
- 'Node' => '云手机矩阵模式',
- ],
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Node',
- ],
+ 'maxItems' => 100,
+ 'minItems' => 1,
],
],
],
@@ -4942,92 +2882,44 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '17C731AB-AAEE-5844-A352-D8D0352D****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'CB95E410-FD1D-53C5-9F7D-93CC44D7****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除实例组',
+ 'description' => '按量付费实例组支持直接删除;'."\n"
+ ."\n"
+ .'包年包月实例组过期后才能删除,即“已过期”状态的包年包月实例组支持删除。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17C731AB-AAEE-5844-A352-D8D0352D****\\"\\n}","type":"json"}]',
- 'title' => '启动实例',
- 'description' => '只有实例处于 **已关机、备份失败、恢复失败** 状态时才支持启动。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB95E410-FD1D-53C5-9F7D-93CC44D7****\\"\\n}","type":"json"}]',
],
- 'StopAndroidInstance' => [
- 'summary' => '停止(关机)云手机实例。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteApps' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneRXVHCU',
- ],
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'AndroidInstanceIds',
+ 'name' => 'AppIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID列表。',
+ 'description' => '应用ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-3kzpiqqsjwtw7****',
- ],
- 'required' => false,
- 'maxItems' => 1000,
- ],
- ],
- [
- 'name' => 'ForceStop',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否强制关机。当云手机遇到系统、网络等异常原因导致无法关机时,可选择强制关机(可能会丢失未保存数据)。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'SaleMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '售卖模式。该参数已废弃!',
- 'type' => 'string',
+ 'items' => ['description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => '1234'],
'required' => false,
- 'enumValueTitles' => [
- 'Instance' => '云手机实例模式',
- 'Node' => '云手机矩阵模式',
- ],
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Node',
- ],
+ 'maxItems' => 100,
+ 'minItems' => 1,
],
],
],
@@ -5038,503 +2930,246 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E38B41A8-8E00-5AE4-A957-6636ACB8****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '310A783E-CC46-5452-A8A3-71AE5DB5****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除应用',
+ 'summary' => '删除应用。'."\n"
+ .'删除时需保证该应用未安装在任何实例组。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E38B41A8-8E00-5AE4-A957-6636ACB8****\\"\\n}","type":"json"}]',
- 'title' => '停止实例',
- 'description' => '只有实例处于**可用、备份失败、恢复失败**状态时才支持停止。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"310A783E-CC46-5452-A8A3-71AE5DB5****\\"\\n}","type":"json"}]',
],
- 'RebootAndroidInstancesInGroup' => [
- 'summary' => '重启(先关机再开机)云手机实例。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteBackupFile' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneO96MC6',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMPR6T6'],
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIds',
+ 'name' => 'BackupFileIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID列表。',
+ 'description' => '备份文件ID列表',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-sgicbcdadjs****',
- ],
- 'required' => false,
+ 'items' => ['description' => '备份文件ID', 'type' => 'string', 'required' => false, 'example' => 'bf-islptramvb730****'],
+ 'required' => true,
'maxItems' => 100,
- 'minItems' => 1,
- ],
- ],
- [
- 'name' => 'ForceStop',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否强制重启。当云手机遇到系统、网络等异常原因导致无法关机时,可选择强制重启(可能会丢失未保存数据)。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
- ],
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'SaleMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '售卖模式。该参数已废弃!',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Instance' => '云手机实例模式',
- 'Node' => '云手机矩阵模式',
- ],
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Node',
- ],
- ],
- ],
- [
- 'name' => 'IgnoreParamValidation',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'boolean',
- 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => 'PlainResult<Integer>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '227CBB4C-F5DC-589D-A667-C5CA3D52****',
- ],
+ 'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除备份文件',
+ 'summary' => '批量删除备份文件。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"227CBB4C-F5DC-589D-A667-C5CA3D52****\\"\\n}","type":"json"}]',
- 'title' => '重启实例',
- 'description' => '只有实例处于**可用、异常、备份失败、恢复失败**状态时才支持重启。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\"\\n}","type":"json"}]',
],
- 'ResetAndroidInstancesInGroup' => [
- 'summary' => '重置云手机实例。 重置是使用该云手机的镜像进行重装系统的过程,例如云手机创建时使用的镜像被删除将重置失败。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteCloudPhoneNodes' => [
+ 'summary' => '删除云手机矩阵。',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneEDCJTJ',
- ],
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneZCSVZQ'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIds',
- 'in' => 'query',
+ 'name' => 'NodeIds',
+ 'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID列表。',
+ 'description' => '云手机矩阵ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-scaucydkl****',
- ],
+ 'items' => ['description' => '云手机矩阵ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-05e4d1cec2urdh1j****'],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
],
],
- [
- 'name' => 'SaleMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '售卖模式。该参数已废弃!',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Instance' => '云手机实例模式',
- 'Node' => '云手机矩阵模式',
- ],
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Node',
- ],
- ],
- ],
- [
- 'name' => 'SettingResetType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '<props="china">重置是否保留属性设置,不传则默认不保留属性配置,该参数仅针对云手机矩阵实例生效。可执行wya dump config命令查看保留的属性详情。</props>'."\n"
- .'<props="intl">国际站不支持此参数</props>',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '不保留属性设置',
- '保留属性设置',
- ],
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'IgnoreParamValidation',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'boolean',
- 'required' => false,
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => '请求信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除云手机矩阵',
+ 'description' => '仅状态为已过期的云手机矩阵可以删除,其他状态下不支持删除。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
- 'title' => '重置实例(初始化系统)',
- 'description' => '只有实例处于**可用、已关机、异常、备份失败、恢复失败**状态时才支持重置(初始化系统)。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC****\\"\\n}","type":"json"}]',
],
- 'ModifyInstanceChargeType' => [
- 'summary' => '修改实例的付费方式。目前只支持按量付费转为包年包月。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteImages' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneTVG3Y7',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneXWUML7'],
],
'parameters' => [
[
- 'name' => 'InstanceGroupIds',
- 'in' => 'query',
- 'style' => 'repeatList',
+ 'name' => 'ImageIds',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '实例组ID列表。',
+ 'description' => '镜像ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-25nt4kk9whhdh****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'ChargeType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '实例付费类型。'."\n"
- .'> 目前只支持**按量付费转为包年包月**。',
- 'type' => 'string',
+ 'items' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'imgc-kjsdfkjsk****'],
'required' => true,
- 'enumValueTitles' => [
- 'PrePaid' => '包年包月',
- ],
- 'example' => 'PrePaid',
- ],
- ],
- [
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => '购买资源的时长,单位由PeriodUnit指定。'."\n"
- .'取值范围:1个月、2个月、3个月、6个月、1年。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PeriodUnit',
- 'in' => 'query',
- 'schema' => [
- 'description' => '购买资源的时长单位。'."\n"
- .'取值范围:'."\n"
- .'- **Month**:月。'."\n"
- .'- **Year**:年。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Month',
- ],
- ],
- [
- 'name' => 'AutoPay',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否自动支付。默认为false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'AutoRenew',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否开启自动续费。默认为false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'PromotionId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => 'PlainResult<DeleteImagesResp>',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****',
- ],
- 'InstanceGroupIds' => [
- 'description' => '实例组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'example' => 'ag-cuv4scs4obxch****',
+ 'Data' => [
+ 'description' => '删除结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SuccessDeleteImageIds' => [
+ 'title' => '成功删除的镜像id',
+ 'description' => '删除成功的镜像ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '删除成功的镜像ID。', 'type' => 'string', 'example' => 'imgc-jkafjsjk****'],
+ ],
+ 'FailDeleteImageIds' => [
+ 'title' => '失败删除的镜像id',
+ 'description' => '删除失败的镜像ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '删除失败的镜像ID。', 'type' => 'string', 'example' => 'imgc-sjkdfs8****'],
+ ],
],
],
- 'OrderId' => [
- 'description' => '生成的订单ID。',
- 'type' => 'string',
- 'example' => '22326560487****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4610632D-D661-5982-B3D7-5D3FD183F595'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '删除自定义镜像',
+ 'summary' => '删除自定义镜像。',
+ 'description' => '实例组正在使用中的镜像不可被删除。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\",\\n \\"InstanceGroupIds\\": [\\n \\"ag-cuv4scs4obxch****\\"\\n ],\\n \\"OrderId\\": \\"22326560487****\\"\\n}","type":"json"}]',
- 'title' => '修改实例的付费方式',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SuccessDeleteImageIds\\": [\\n \\"imgc-jkafjsjk****\\"\\n ],\\n \\"FailDeleteImageIds\\": [\\n \\"imgc-sjkdfs8****\\"\\n ]\\n },\\n \\"RequestId\\": \\"4610632D-D661-5982-B3D7-5D3FD183F595\\"\\n}","type":"json"}]',
],
- 'UpdateInstanceImage' => [
- 'summary' => '变更云手机矩阵实例镜像。仅支持对运行中、关机、镜像变更失败这三种状态的实例进行镜像变更。目标镜像的GPU厂商必须与当前实例所在的服务器GPU厂商匹配。如果是跨版本变更镜像,例如从Android 10升级到Android 12,则系统将强制清空所有数据(等同于变更镜像+重置)。',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteKeyPairs' => [
+ 'summary' => '调用本接口删除云手机密钥对。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone3OZQF8',
- ],
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'InstanceIdList',
+ 'name' => 'KeyPairIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例列表。',
+ 'description' => '密钥对ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-dvbhknfasf123****',
- ],
+ 'items' => ['description' => '密钥对ID。', 'type' => 'string', 'required' => false, 'example' => 'kp-6v2q33ae4tw3a****'],
'required' => false,
'maxItems' => 100,
],
],
- [
- 'name' => 'ImageId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '镜像ID。可以通过调用[DescribeImageList](~~2807324~~)查询云手机的镜像列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'imgc-075cllfeuazh0****',
- ],
- ],
- [
- 'name' => 'Reset',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否重置。重置将清除该实例上的所有用户数据。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'IgnoreParamValidation',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'boolean',
- 'required' => false,
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'BaseResult',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-1ljew7on6ay0j****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '删除ADB密钥对',
+ 'description' => '- 如果已经有云手机实例绑定了该ADB 密钥对,则该密钥对不支持被删除。'."\n"
+ .'- 删除ADB密钥对后,无法通过DescribeKeyPairs 查询到该ADB 密钥对。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\",\\n \\"TaskId\\": \\"t-1ljew7on6ay0j****\\"\\n}","type":"json"}]',
- 'title' => '变更实例镜像',
- 'description' => '<props="china">目前只可变更云手机矩阵实例镜像,其他类型实例暂不支持。</props>'."\n"
- .'<props="intl">暂不支持国际站。</props>',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\"\\n}","type":"json"}]',
],
- 'ExpandPhoneDataVolume' => [
- 'summary' => '该接口用于扩容矩阵实例的独立机身存储。',
+ 'DeleteMobileAgentPackage' => [
+ 'summary' => '删除节点套餐包。',
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5544,69 +3179,21 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneUQT9QO',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
],
'parameters' => [
[
- 'name' => 'BizRegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'InstanceIds',
+ 'name' => 'PackageIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机矩阵版本实例ID列表,可设置 1~100 个。',
+ 'description' => '套餐包列表。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机矩阵版本实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-aw14zoevk6809****',
- ],
+ 'items' => ['description' => '套餐包ID。', 'type' => 'string', 'required' => false, 'example' => 'cmag-0c1g77wjljl9h****'],
'required' => false,
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'PhoneDataVolume',
- 'in' => 'query',
- 'schema' => [
- 'description' => '扩容后期望的独立机身存储的大小。单位:GiB。><notice>新值必须大于实例原来的独立机身存储大小。></notice>',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'AutoPay',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否自动支付。默认为false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'PromotionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '优惠ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '50003308011****',
+ 'maxItems' => 1000,
],
],
],
@@ -5614,141 +3201,74 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '请求返回参数。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'DB070C80-45AC-52CA-8101-937C25DA****',
- ],
- 'OrderId' => [
- 'description' => '订单ID。',
- 'type' => 'string',
- 'example' => '223684716098****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F07A1DA1-E1EB-5CCA-8EED-12F85D32****'],
+ 'Code' => ['description' => '状态码。返回 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '接口返回信息。', 'type' => 'string', 'example' => 'Success.'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除套餐包',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB070C80-45AC-52CA-8101-937C25DA****\\",\\n \\"OrderId\\": \\"223684716098****\\"\\n}","type":"json"}]',
- 'title' => '扩容独立机身存储',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F07A1DA1-E1EB-5CCA-8EED-12F85D32****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\"\\n}","type":"json"}]',
],
- 'InstanceHealer' => [
- 'summary' => '云手机矩阵实例诊断恢复,目前仅可以清理实例的系统日志文件,避免磁盘打满之后实例异常无法恢复。',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeletePolicyGroup' => [
+ 'summary' => '删除策略。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneYYGTDB',
- ],
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'InstanceIdList',
+ 'name' => 'PolicyGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例列表。',
+ 'description' => '策略ID列表。如存在任意一个策略绑定了未删除的实例组,则整体删除失败。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-42do7k******-001',
- ],
+ 'items' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-gx4ger9hynfov****'],
'required' => true,
'maxItems' => 100,
],
],
- [
- 'name' => 'Timeout',
- 'in' => 'query',
- 'schema' => [
- 'description' => '超时时间。不传默认30秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '30',
- ],
- ],
- [
- 'name' => 'Strategy',
- 'in' => 'query',
- 'schema' => [
- 'description' => '策略类型,目前仅支持清理系统日志文件。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Clean' => '清理系统日志',
- ],
- 'example' => 'Clean',
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回值。',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7B9EFA4F-4305-5968-BAEE-BD8B8DE5****',
- ],
- 'InstanceHealerModel' => [
- 'description' => '诊断结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'Result' => [
- 'description' => '任务执行结果。',
- 'type' => 'string',
- 'example' => 'True',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '17C731AB-AAEE-5844-A352-D8D0352D3F0B'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17C731AB-AAEE-5844-A352-D8D0352D3F0B\\"\\n}","type":"json"}]',
+ 'title' => '删除策略',
+ 'description' => '如绑定了未删除的实例组,则不允许删除',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B9EFA4F-4305-5968-BAEE-BD8B8DE5****\\",\\n \\"InstanceHealerModel\\": {\\n \\"Result\\": \\"True\\"\\n }\\n}","type":"json"}]',
- 'title' => '实例诊断恢复',
],
- 'StartInstanceAdb' => [
- 'summary' => '开启实例ADB连接功能,为实例创建ADB端口公网映射规则(仅限标准网络)。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteSystemPropertyTemplates' => [
+ 'summary' => '删除系统属性模板。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5757,29 +3277,21 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneLYX9LP',
- ],
- 'autoTest' => true,
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVQDPK9'],
],
'parameters' => [
[
- 'name' => 'InstanceIds',
+ 'name' => 'TemplateIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机实例ID列表,可设置 1~100 个。',
+ 'description' => '属性模板ID。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-5hh431emkt6u*****',
- ],
- 'required' => true,
+ 'items' => ['description' => '属性模板ID。', 'type' => 'string', 'required' => false, 'example' => 'ap-6f1z5z9d85qq7****'],
+ 'required' => false,
'maxItems' => 100,
],
],
@@ -5787,67 +3299,56 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => '接口返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****'],
+ 'Code' => ['description' => '错误码。'."\n"
+ ."\n"
+ .'> 仅当接口调用出错时会出现该参数。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Success.'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除系统属性模板',
+ 'description' => '删除属性模板不会对已经调用[SendSystemPropertyTemplate](~~2950220~~)的实例产生任何影响。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
- 'title' => '开启实例ADB连接功能',
- 'description' => '只有实例处于 **非异常**(**UNAVAILABLE**)状态,且成功分配**私网IP**时才支持启动。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\"\\n}","type":"json"}]',
],
- 'StopInstanceAdb' => [
- 'summary' => '关闭实例ADB连接功能,删除实例ADB端口转发规则(仅限标准网络)。',
+ 'DescribeAgentTask' => [
+ 'summary' => '查询Agent Task的相关信息。',
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneLYX9LP',
- ],
- 'autoTest' => true,
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
],
'parameters' => [
[
- 'name' => 'InstanceIds',
+ 'name' => 'TaskIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机实例ID列表,可设置 1~100 个。',
+ 'description' => '任务ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-5hh4a31emkt6u****',
- ],
- 'required' => true,
+ 'items' => ['description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => 't-bp67acfmxazb4p****'],
+ 'required' => false,
'maxItems' => 100,
],
],
@@ -5855,35 +3356,60 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => '接口返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC******',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n"
+ ."\n", 'type' => 'string', 'example' => '310A783E-CC46-5452-A8A3-71AE5DB5****'],
+ 'Code' => ['description' => '接口状态码。', 'type' => 'string', 'example' => 'For example, "200" indicates success.'],
+ 'Message' => ['description' => '接口返回信息。', 'type' => 'string', 'example' => 'Success.'],
+ 'Count' => ['description' => '任务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Tasks' => [
+ 'description' => '任务 list。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务 ID,全局唯一。', 'type' => 'string', 'example' => 't-imr0fufqd7cle****'],
+ 'InstanceId' => ['description' => 'Mobile节点 ID。', 'type' => 'string', 'example' => 'acp-anzzuho371azi44xr'],
+ 'UserPrompt' => ['description' => '用户指令(自然语言),Agent 据此完成操作。', 'type' => 'string', 'example' => 'Download DingTalk from App Store'],
+ 'CurrentStatus' => ['description' => '任务当前状态,参考下方状态枚举,取值如下:'."\n"
+ ."\n"
+ .'PENDING 任务创建中。'."\n"
+ ."\n"
+ .'RUNNING 任务运行中。'."\n"
+ ."\n"
+ .'COMPLETED 任务已完成。'."\n"
+ ."\n"
+ .'FAILED 任务失败。'."\n"
+ ."\n"
+ .'TIMEOUT 任务执行超时。', 'type' => 'string', 'example' => 'COMPLETED'],
+ 'RunningAt' => ['description' => '任务创建时间,ISO 8601 格式。'."\n"
+ ."\n", 'type' => 'string', 'example' => '2026-04-13T17:42:19Z'],
+ 'Steps' => ['description' => '执行的步骤数。', 'type' => 'string', 'example' => '30'],
+ 'TaskResult' => ['description' => '任务结果(终态),只有 CurrentStatus=COMPLETED/FAILED 时有该字段。', 'type' => 'string', 'example' => 'Download DingTalk succeeded.'],
+ 'TaskDuration' => ['description' => '任务耗时,CurrentStatus=FAILED/COMPLETED时有该字段。', 'type' => 'string', 'example' => '50'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询 Agent 任务详细信息。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC******\\"\\n}","type":"json"}]',
- 'title' => '关闭实例ADB连接',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"310A783E-CC46-5452-A8A3-71AE5DB5****\\",\\n \\"Code\\": \\"For example, \\\\\\"200\\\\\\" indicates success.\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Count\\": 1,\\n \\"Tasks\\": [\\n {\\n \\"TaskId\\": \\"t-imr0fufqd7cle****\\",\\n \\"InstanceId\\": \\"acp-anzzuho371azi44xr\\",\\n \\"UserPrompt\\": \\"Download DingTalk from App Store\\",\\n \\"CurrentStatus\\": \\"COMPLETED\\",\\n \\"RunningAt\\": \\"2026-04-13T17:42:19Z\\",\\n \\"Steps\\": \\"30\\",\\n \\"TaskResult\\": \\"Download DingTalk succeeded.\\",\\n \\"TaskDuration\\": \\"50\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'ListInstanceAdbAttributes' => [
- 'summary' => '查询实例ADB连接信息(仅限标准网络)。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeAndroidInstanceGroups' => [
+ 'summary' => '查询云手机实例组的详细信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5895,191 +3421,251 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone89PVC7',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneQNMLJ7'],
],
'parameters' => [
[
- 'name' => 'InstanceIds',
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'InstanceGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机实例ID列表,可设置 1~100 个。',
+ 'description' => '实例组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-5hh431emkt6u*****',
- ],
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-25nt4kk9whhdh****'],
'required' => false,
'maxItems' => 100,
+ 'minItems' => 1,
],
],
[
- 'name' => 'ExternalIp',
+ 'name' => 'InstanceGroupName',
'in' => 'query',
- 'schema' => [
- 'description' => '公网IP地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '106.38.188.223',
- ],
+ 'schema' => ['description' => '实例组名称。支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'Cloud phone'],
],
[
- 'name' => 'InternalIp',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => '内网IP地址。',
+ 'description' => '实例组状态。',
'type' => 'string',
'required' => false,
- 'example' => '10.0.3.23',
+ 'enumValueTitles' => ['UPDATING_FAILED' => '镜像变更失败', 'FAILED' => '创建失败', 'RUNNING' => '可用', 'EXPIRED' => '已过期', 'DELETING' => '删除中', 'DELETED' => '已删除', 'UPDATING' => '镜像变更中', 'CREATING' => '创建中'],
+ 'example' => 'CREATING',
],
],
[
- 'name' => 'InternalPort',
+ 'name' => 'SaleMode',
'in' => 'query',
'schema' => [
- 'description' => 'ADB端口号。',
+ 'description' => '云手机的购买模式。',
'type' => 'string',
'required' => false,
- 'example' => '5555',
+ 'enumValueTitles' => ['STANDARD' => '标准模式[默认值]'],
+ 'example' => 'standard',
],
],
[
- 'name' => 'IpProtocol',
+ 'name' => 'ChargeType',
'in' => 'query',
'schema' => [
- 'description' => '网络协议类型。',
+ 'description' => '付费类型。',
'type' => 'string',
'required' => false,
- 'example' => 'TCP',
+ 'enumValueTitles' => [' PrePaid' => '包年包月', 'PostPaid' => '按量付费'],
+ 'example' => 'PostPaid',
],
],
[
+ 'name' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-1b77w6xrqfubi****'],
+ ],
+ [
+ 'name' => 'KeyPairId',
+ 'in' => 'query',
+ 'schema' => ['description' => '密钥对的ID。', 'type' => 'string', 'required' => false, 'example' => 'kp-5htf0ymsrnb7q****'],
+ ],
+ [
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '20',
- 'default' => '20',
- ],
+ 'schema' => ['description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
+ 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****'],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
+ 'description' => '实例组的标签。每个实例最多可绑定20个标签。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。可包含 1~20 个。'."\n"
+ .'><notice>标签键最多支持128个字符,不能以aliyun或acs:开头,也不能包含http://或https://。></notice>', 'type' => 'string', 'required' => false, 'example' => 'phone'],
+ 'Value' => ['description' => '标签值。'."\n"
+ .'><notice>标签值最多支持128个字符,不能以`aliyun`或`acs:`开头,不能包含`http://`或`https://`。></notice>', 'type' => 'string', 'required' => false, 'example' => '2025'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****',
+ 'maxItems' => 20,
],
],
+ [
+ 'name' => 'InstanceVersion',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => '接口返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '实例ADB连接信息列表',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F07A1DA1-E1EB-5CCA-8EED-12F85D32****'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****'],
+ 'InstanceGroupModel' => [
+ 'description' => '实例组的详细信息。',
'type' => 'array',
'items' => [
- 'description' => '实例ADB连接信息。',
+ 'description' => '实例组的详细信息。',
'type' => 'object',
'properties' => [
- 'GmtCreated' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-05-15 17:33:59',
- ],
- 'GmtModified' => [
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '2024-05-15 17:33:59',
- ],
- 'InstanceId' => [
- 'description' => '云手机实例ID。',
- 'type' => 'string',
- 'example' => 'acp-uto81vfd8t8z****',
- ],
- 'ExternalIp' => [
- 'description' => '公网IP地址。',
- 'type' => 'string',
- 'example' => '183.201.219.157',
- ],
- 'ExternalPort' => [
- 'description' => '公网端口号。',
- 'type' => 'string',
- 'example' => '14840/14849',
+ 'InstanceGroupId' => ['description' => '实例组ID。', 'type' => 'string', 'example' => 'ag-h67a2cs0zprfdh****'."\n"],
+ 'InstanceGroupName' => ['description' => '实例组名称。', 'type' => 'string', 'example' => 'Cloud phoneA'],
+ 'InstanceGroupStatus' => ['description' => '实例组状态。', 'type' => 'string', 'example' => 'RUNNING'],
+ 'InstanceGroupSpec' => ['description' => '实例组规格。', 'type' => 'string', 'example' => 'acp.basic.small'],
+ 'InstanceGroupSpecDescribe' => ['description' => '实例组规格描述。', 'type' => 'string', 'example' => 'ARM-2vCPU4GiB 32GiB'],
+ 'OfficeSiteId' => ['description' => '网络ID。', 'type' => 'string', 'example' => 'cn-shanghai+dir-030598****'],
+ 'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'imgc-06zyt9m93zwax****'],
+ 'NumberOfInstances' => ['description' => '实例组中的实例数量。', 'type' => 'string', 'example' => '10'],
+ 'ChargeType' => ['description' => '付费方式。', 'type' => 'string', 'example' => 'PrePaid'],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-02-01 10:56:36'],
+ 'GmtModified' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2024-02-01 10:56:36'],
+ 'SaleMode' => ['description' => '售卖模式。', 'type' => 'string', 'example' => 'standard'],
+ 'InstalledAppList' => ['description' => '已安装的应用列表。', 'type' => 'string', 'example' => '"抖音","淘宝"'],
+ 'GmtExpired' => ['description' => '包年包月实例组的过期时间。', 'type' => 'string', 'example' => '2027-06-29 07:25:31'],
+ 'AppInstanceGroupId' => ['description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-48xr63m4dybjk****'],
+ 'PolicyGroupId' => ['description' => '策略ID。', 'type' => 'string', 'example' => 'pg-c6n38xucps8kl****'],
+ 'VSwitchId' => ['description' => '专有网络中的交换机ID。', 'type' => 'string', 'example' => 'vsw-t4n0yqs009ho024wt****'],
+ 'ResolutionHeight' => ['description' => '分辨率的高。', 'type' => 'integer', 'format' => 'int32', 'example' => '1280'],
+ 'ResolutionWidth' => ['description' => '分辨率的宽。', 'type' => 'integer', 'format' => 'int32', 'example' => '720'],
+ 'SystemVersion' => ['description' => '系统版本。', 'type' => 'string', 'example' => 'Android 12'],
+ 'ArchitectureType' => ['description' => '架构类型。', 'type' => 'string', 'example' => 'ARM'],
+ 'Memory' => ['description' => '内存大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'Cpu' => ['description' => 'CPU核数。', 'type' => 'string', 'example' => '8'],
+ 'Disks' => [
+ 'description' => '磁盘信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '磁盘信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DiskType' => ['description' => '磁盘类型。', 'type' => 'string', 'example' => 'SYSTEM'],
+ 'DiskSize' => ['description' => '磁盘大小(单位GB)。', 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
+ ],
+ ],
],
- 'InternalIp' => [
- 'description' => '内网IP地址。',
+ 'ErrorCode' => ['description' => '创建失败的原因。', 'type' => 'string', 'example' => 'InternalError'],
+ 'RenderingType' => [
+ 'description' => '实例组的渲染方式。',
'type' => 'string',
- 'example' => '10.0.0.239',
+ 'enumValueTitles' => ['GPURemote' => 'GPU远程渲染', 'CPU' => 'CPU渲染', 'GPULocal' => 'GPU本地渲染'],
+ 'example' => 'CPU',
],
- 'InternalPort' => [
- 'description' => '私网端口号。',
- 'type' => 'string',
- 'example' => '5555/5555',
+ 'AvailableInstanceAmount' => ['description' => '可用的实例数量。'."\n"
+ ."\n"
+ .'> 可用是指实例状态不为“删除中”或“已删除”。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'EnableIpv6' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'boolean', 'example' => 'true'],
+ 'Ipv6Bandwidth' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'BandwidthPackageId' => ['description' => '带宽包的ID。', 'type' => 'string', 'example' => 'np-0q6ixs7vpxciz****'],
+ 'BandwidthPackageType' => ['description' => '带宽包的类型。', 'type' => 'string', 'example' => 'cbwp_ecd'],
+ 'BandwidthPackageStatus' => ['description' => '带宽包的状态。'."\n"
+ .'枚举值:'."\n"
+ .'- Creating,创建中'."\n"
+ .'- Releasing,释放中'."\n"
+ .'- InUse,使用中'."\n"
+ .'- Failed,失败'."\n"
+ .'- Expired,已过期'."\n"
+ .'- Available未绑定,扣费中', 'type' => 'string', 'example' => 'Creating'],
+ 'NetworkType' => ['description' => '实例的网络类型。'."\n"
+ ."\n"
+ .'> 目前只有标准网络的实例组才会返回该字段。', 'type' => 'string', 'example' => 'network_pro_ecd'],
+ 'ImageVersion' => ['description' => '镜像版本。', 'type' => 'string', 'example' => '25.09.2'],
+ 'BindQosRules' => [
+ 'description' => '实例组下的公网限速规则信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'totalCount' => ['description' => '实例组下的公网限速规则总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'InstanceQosRule' => [
+ 'description' => '实例绑定的公网限速规则信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-h3m8b5dusopp5****'],
+ 'QosRuleId' => ['description' => '公网限速规则ID(仅作用于精品带宽)', 'type' => 'string', 'example' => 'qos-3kh93uu0vdbka****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
- 'IpProtocol' => [
- 'description' => '网络协议类型。',
- 'type' => 'string',
- 'example' => 'TCP',
+ 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-j'],
+ 'Tags' => [
+ 'description' => '标签信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'phone'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => '2025'],
+ ],
+ ],
],
+ 'Channel' => ['type' => 'string'],
+ 'PackageId' => ['type' => 'string'],
],
],
],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'CB95E410-FD1D-53C5-9F7D-93CC44D7****',
- ],
- 'NextToken' => [
- 'description' => '下一次查询的令牌(Token)。如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****',
- ],
- 'MaxResults' => [
- 'description' => '本次读取的最大数据量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreated\\": \\"2024-05-15 17:33:59\\",\\n \\"GmtModified\\": \\"2024-05-15 17:33:59\\",\\n \\"InstanceId\\": \\"acp-uto81vfd8t8z****\\",\\n \\"ExternalIp\\": \\"183.201.219.157\\",\\n \\"ExternalPort\\": \\"14840/14849\\",\\n \\"InternalIp\\": \\"10.0.0.239\\",\\n \\"InternalPort\\": \\"5555/5555\\",\\n \\"IpProtocol\\": \\"TCP\\"\\n }\\n ],\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"CB95E410-FD1D-53C5-9F7D-93CC44D7****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MaxResults\\": 100\\n}","type":"json"}]',
- 'title' => '查询实例ADB连接信息',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询实例组详细信息',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-29T09:53:37.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-08-22T08:01:59.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-03-14T11:00:47.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-12-05T14:41:29.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-07-24T09:34:56.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-07-02T02:05:34.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F07A1DA1-E1EB-5CCA-8EED-12F85D32****\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****\\",\\n \\"InstanceGroupModel\\": [\\n {\\n \\"InstanceGroupId\\": \\"ag-h67a2cs0zprfdh****\\\\n\\",\\n \\"InstanceGroupName\\": \\"Cloud phoneA\\",\\n \\"InstanceGroupStatus\\": \\"RUNNING\\",\\n \\"InstanceGroupSpec\\": \\"acp.basic.small\\",\\n \\"InstanceGroupSpecDescribe\\": \\"ARM-2vCPU4GiB 32GiB\\",\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-030598****\\",\\n \\"ImageId\\": \\"imgc-06zyt9m93zwax****\\",\\n \\"NumberOfInstances\\": \\"10\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2024-02-01 10:56:36\\",\\n \\"GmtModified\\": \\"2024-02-01 10:56:36\\",\\n \\"SaleMode\\": \\"standard\\",\\n \\"InstalledAppList\\": \\"\\\\\\"抖音\\\\\\",\\\\\\"淘宝\\\\\\"\\",\\n \\"GmtExpired\\": \\"2027-06-29 07:25:31\\",\\n \\"AppInstanceGroupId\\": \\"aig-48xr63m4dybjk****\\",\\n \\"PolicyGroupId\\": \\"pg-c6n38xucps8kl****\\",\\n \\"VSwitchId\\": \\"vsw-t4n0yqs009ho024wt****\\",\\n \\"ResolutionHeight\\": 1280,\\n \\"ResolutionWidth\\": 720,\\n \\"SystemVersion\\": \\"Android 12\\",\\n \\"ArchitectureType\\": \\"ARM\\",\\n \\"Memory\\": 8,\\n \\"Cpu\\": \\"8\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskSize\\": 32\\n }\\n ],\\n \\"ErrorCode\\": \\"InternalError\\",\\n \\"RenderingType\\": \\"CPU\\",\\n \\"AvailableInstanceAmount\\": 2,\\n \\"EnableIpv6\\": true,\\n \\"Ipv6Bandwidth\\": 50,\\n \\"BandwidthPackageId\\": \\"np-0q6ixs7vpxciz****\\",\\n \\"BandwidthPackageType\\": \\"cbwp_ecd\\",\\n \\"BandwidthPackageStatus\\": \\"Creating\\",\\n \\"NetworkType\\": \\"network_pro_ecd\\",\\n \\"ImageVersion\\": \\"25.09.2\\",\\n \\"BindQosRules\\": {\\n \\"totalCount\\": 2,\\n \\"InstanceQosRule\\": [\\n {\\n \\"InstanceId\\": \\"acp-h3m8b5dusopp5****\\",\\n \\"QosRuleId\\": \\"qos-3kh93uu0vdbka****\\"\\n }\\n ]\\n },\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"phone\\",\\n \\"Value\\": \\"2025\\"\\n }\\n ],\\n \\"Channel\\": \\"\\",\\n \\"PackageId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'BatchGetAcpConnectionTicket' => [
- 'summary' => '批量获取连接凭证。本接口会异步进行 Ticket 的生成,绝大多数可第一次直接从Response中直接拿到Ticket,部分情况需要根据Response中的TaskId再调用本接口进行轮询是否生成。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeAndroidInstances' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6088,397 +3674,349 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMEHI4H',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneTVG3Y7'],
],
'parameters' => [
[
'name' => 'InstanceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-25nt4kk9whjh****',
- ],
+ 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-25nt4kk9whjh****'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'KeyPairId',
+ 'in' => 'query',
+ 'schema' => ['description' => '已绑定的密钥对ID。', 'type' => 'string', 'required' => false, 'example' => 'kp-5hh431emkpuoi****'],
+ ],
+ [
+ 'name' => 'AndroidInstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机实例ID列表,可设置 1~100 个。',
+ 'description' => '实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-bj9t2gmys****',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-25nt4kk9whhok****'],
'required' => false,
- 'maxItems' => 100,
+ 'maxItems' => 1000,
+ 'minItems' => 1,
],
],
[
- 'name' => 'EndUserId',
+ 'name' => 'AndroidInstanceName',
'in' => 'query',
- 'schema' => [
- 'description' => '已分配的用户ID,如果不传,则会使用后台分配的系统用户获取Ticket。'."\n"
- ."\n"
- .'<props="china">'."\n"
- .'本参数的使用方法因云手机产品版本和实例串流模式而异:'."\n"
- ."\n"
- .'- 云手机实例版或云手机矩阵版(抢占模式):只能通过同一个`EnduserId`获取`Ticket`。'."\n"
- .'- 云手机矩阵版(协同模式):可通过传入不同的`EnduserId`来为不同的用户(至多5个)同时获取`Ticket`并串流。每次只能传入1个`EnduserId`。'."\n"
- ."\n"
- .'> 实例串流模式可通过`ModifyCloudPhoneNode`接口的`StreamMode`参数来定义。</props>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user',
- ],
+ 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'name'],
],
[
- 'name' => 'ConnectionMode',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => '建连模式。',
+ 'description' => '实例状态。',
'type' => 'string',
'required' => false,
- 'example' => 'custom',
+ 'enumValueTitles' => [
+ 'BACKUPING' => '文件备份中', 'STARTING' => '开机中', 'RUNNING' => '可用', 'DELETING' => '删除中', 'BACKUP_FAILED' => '文件备份失败', 'DELETED' => '已删除', 'FAILED' => '创建失败', 'STOPPED' => '已关机', 'RECOVERING' => '文件恢复中', 'UNAVAILABLE' => '异常',
+ 'REBOOTING' => '重启中', 'RESETTING' => '重置中', 'STOPPING' => '关机中', 'RECOVER_FAILED' => '文件恢复失败', 'CREATING' => '创建中',
+ ],
+ 'example' => 'RUNNING',
],
],
[
- 'name' => 'InstanceTasks',
+ 'name' => 'SaleMode',
'in' => 'query',
- 'style' => 'repeatList',
'schema' => [
- 'description' => '实例连接任务。用于查询Ticket获取任务是否完成。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例连接任务。',
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-fkuit0cmyfvzz****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****',
- ],
- ],
- 'required' => false,
- ],
+ 'description' => '售卖模式。',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 100,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7B9EFA4F-4305-5968-BAEE-BD8B8DE5****',
- ],
- 'InstanceConnectionModels' => [
- 'description' => '实例连接任务结果。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例连接任务结果。',
- 'type' => 'object',
- 'properties' => [
- 'AppInstanceGroupId' => [
- 'description' => '交付组ID。',
- 'type' => 'string',
- 'example' => 'aig-1uzb6heg797z3****',
- ],
- 'InstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-ajxvwo1u0hqvd****',
- ],
- 'TaskStatus' => [
- 'description' => '任务状态。状态为FINISHED代表可以从Ticket字段获取到Ticket,否则仍需要使用TaskId调用本接口查询Ticket生成结果。',
- 'type' => 'string',
- 'example' => 'FINISHED',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****',
- ],
- 'Ticket' => [
- 'description' => '用于连接用户实例的Ticket。',
- 'type' => 'string',
- 'example' => 'piVE58_AdmVSVW7SEW3*AE5*p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV*0*Cm58slMT1tJw3****',
- ],
- 'ErrorCode' => [
- 'description' => '错误原因。',
- 'type' => 'string',
- 'example' => 'InvalidResourceId.NotFound',
- ],
- 'PersistentAppInstanceId' => [
- 'description' => '持久会话ID。',
- 'type' => 'string',
- 'example' => 'p-abdywvcksdb****',
- ],
- 'AppInstanceId' => [
- 'description' => '物理实例ID。',
- 'type' => 'string',
- 'example' => 'ai-0caoetkqi8kj****',
- ],
- 'Port' => [
- 'description' => '建连端口',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10000',
- ],
- ],
- ],
- ],
- ],
+ 'enumValueTitles' => ['Instance' => '云手机实例模式', 'Node' => '云手机矩阵模式'],
+ 'example' => 'Instance',
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B9EFA4F-4305-5968-BAEE-BD8B8DE5****\\",\\n \\"InstanceConnectionModels\\": [\\n {\\n \\"AppInstanceGroupId\\": \\"aig-1uzb6heg797z3****\\",\\n \\"InstanceId\\": \\"acp-ajxvwo1u0hqvd****\\",\\n \\"TaskStatus\\": \\"FINISHED\\",\\n \\"TaskId\\": \\"cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****\\",\\n \\"Ticket\\": \\"piVE58_AdmVSVW7SEW3*AE5*p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV*0*Cm58slMT1tJw3****\\",\\n \\"ErrorCode\\": \\"InvalidResourceId.NotFound\\",\\n \\"PersistentAppInstanceId\\": \\"p-abdywvcksdb****\\",\\n \\"AppInstanceId\\": \\"ai-0caoetkqi8kj****\\",\\n \\"Port\\": 10000\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '批量获取实例连接凭证',
- 'description' => '<props="china">'."\n"
- .'本接口的作用因云手机产品版本和实例串流模式而异:'."\n"
- ."\n"
- .'- 云手机实例版或云手机矩阵版(抢占模式):只能通过同一个`EnduserId`获取`Ticket`。'."\n"
- .'- 云手机矩阵版(协同模式):可通过传入不同的`EnduserId`来为不同的用户(至多5个)同时获取`Ticket`并串流。每次只能传入1个`EnduserId`。'."\n"
- ."\n"
- .'> 实例串流模式可通过[ModifyCloudPhoneNode](~~2878539~~)接口的`StreamMode`参数来定义。</props>',
- ],
- 'DisconnectAndroidInstance' => [
- 'summary' => '将处于连接中的实例断开连接,或将被其他用户绑定的实例进行解绑。',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMEHI4H',
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****'],
],
- ],
- 'parameters' => [
[
- 'name' => 'InstanceIds',
+ 'name' => 'InstanceGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机实例ID列表,可设置 1~100 个。',
+ 'description' => '实例组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机实例ID列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-5hh4a31emkt6u****',
- 'pattern' => '^[^\';<>=|\\(\\)]+$',
- ],
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-25nt4kk9whhdh****'],
'required' => false,
'maxItems' => 100,
],
],
[
- 'name' => 'EndUserId',
+ 'name' => 'InstanceGroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'ChargeType',
'in' => 'query',
'schema' => [
- 'description' => '<props="china">如果使用的是云手机矩阵版,并且实例串流模式为协同模式,则可以通过指定`EndUserId`的方式断开指定用户的连接,并且令相应的Ticket失效。</props>'."\n"
- ."\n"
- .'<props="intl">本参数暂不对外开放使用。</props>',
+ 'description' => '付费类型。',
'type' => 'string',
'required' => false,
- 'example' => 'user1',
+ 'enumValueTitles' => ['PostPaid' => '后付费', 'PrePaid' => '预付费'],
+ 'example' => 'PostPaid',
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E5138F7E-46B5-526A-8C99-82DEAE6B****',
+ 'description' => '资源的标签。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '资源的标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'key'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
+ 'required' => false,
],
+ 'required' => false,
+ 'maxItems' => 20,
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5138F7E-46B5-526A-8C99-82DEAE6B****\\"\\n}","type":"json"}]',
- 'title' => '断开实例的连接',
- 'description' => '实例的连接通过[web sdk](~~2858136~~)完成。通过`session.stop()`断开连接后,系统仍会保持5分钟的用户与云机的连接绑定关系,这5分钟内其他用户不可连接,此时可通过`DisconnectAndroidInstance`接口进行立即解绑。'."\n"
- .'<props="china">如果使用的是云手机矩阵版,并且实例串流模式为协同模式,则可以通过指定`EndUserId`的方式断开指定用户的连接,并且令相应的Ticket失效。</props>',
- ],
- 'RunCommand' => [
- 'summary' => '在云手机实例中执行命令。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '<props="china">地域ID。可以通过调用[DescribeRegions](~~2807298~~)查询云手机不同版本(实例版/矩阵版)支持购买的地域列表。</props>'."\n"
+ ."\n"
+ .'<props="intl">地域ID。可以通过调用[DescribeRegions](~~2807298~~)查询云手机支持购买的地域列表。</props>', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneYYGTDB',
+ [
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => ['description' => '<props="china">矩阵ID。</props>'."\n"
+ .'<props="intl">本参数暂不对外开放使用。</props>', 'type' => 'string', 'required' => false, 'example' => 'node_id'],
],
- ],
- 'parameters' => [
[
- 'name' => 'InstanceIds',
+ 'name' => 'NodeName',
+ 'in' => 'query',
+ 'schema' => ['description' => '<props="china">矩阵的名称。</props>'."\n"
+ .'<props="intl">本参数暂不对外开放使用。</props>', 'type' => 'string', 'required' => false, 'example' => 'node_name'],
+ ],
+ [
+ 'name' => 'OfficeSiteIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID列表。一次请求最多支持50个实例。',
+ 'description' => '云手机网络ID。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-7b15ex96****',
- ],
+ 'items' => ['description' => '云手机网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-744962****'],
'required' => false,
- 'maxItems' => 1000,
- 'minItems' => 1,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'CommandContent',
+ 'name' => 'AuthorizedUserId',
'in' => 'query',
- 'schema' => [
- 'description' => '命令内容。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ls',
- ],
+ 'schema' => ['description' => '实例分配的用户ID,即无影便捷账号ID。', 'type' => 'string', 'required' => false, 'example' => 'user'],
],
[
- 'name' => 'Timeout',
+ 'name' => 'QosRuleIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '超时时间。单位秒,如果超过该时间命令仍然没有执行完成,则命令执行状态为超时,如果不填则默认为60秒。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '公网限速规则组ID。基础共享网络中的实例限速规则。',
+ 'type' => 'array',
+ 'items' => ['description' => '公网限速规则组ID。', 'type' => 'string', 'required' => false, 'example' => 'qos-g6no280ed8byi****'],
'required' => false,
- 'example' => '60',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'AgentType',
+ 'name' => 'AppManagePolicyId',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用管控规则ID。', 'type' => 'string', 'required' => false, 'example' => 'amp-shigvudbyeuib****'],
+ ],
+ [
+ 'name' => 'PrivateIpAddress',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例的私网IP地址。', 'type' => 'string', 'required' => false, 'example' => '10.0.162.136'],
+ ],
+ [
+ 'name' => 'SortKey',
'in' => 'query',
'schema' => [
- 'description' => '执行命令的通道类型。',
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'EdsAgent' => 'EdsAgent通道',
- 'CloudAssistant' => '云助手',
- ],
- 'example' => 'EdsAgent',
+ 'enum' => ['CreationTime', 'ExpiredTime'],
],
],
[
- 'name' => 'ContentEncoding',
+ 'name' => 'SortType',
'in' => 'query',
'schema' => [
- 'description' => '命令内容(`CommandContent`)的编码方式。不区分大小写。'."\n"
- ."\n"
- .'> 若传入的值不在枚举值范围内,则一律视为`PlainText`处理。',
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Base64' => 'Base64编码',
- 'PlainText' => '不编码,采用明文传输 [默认值]',
- ],
- 'example' => 'PlainText',
+ 'enum' => ['ASC', 'DESC'],
],
],
+ [
+ 'name' => 'InstanceVersion',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回参数',
+ 'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '440D7342-5E7C-B2DB-D0B4EAC2BDF1****',
- ],
- 'InvokeId' => [
- 'description' => '命令执行ID,可以通过这个ID查询命令执行结果。',
- 'type' => 'string',
- 'example' => 't-gov2ujrk32v4****',
- ],
- 'RunCommandInfos' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F07A1DA1-E1EB-5CCA-8EED-12F85D32****'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kmma/xxE9WtwL/ADvZ****'],
+ 'InstanceModel' => [
+ 'description' => '实例信息。',
'type' => 'array',
'items' => [
+ 'description' => '实例信息。',
'type' => 'object',
'properties' => [
- 'InvokeId' => [
+ 'AndroidInstanceGroupId' => ['description' => '实例所属实例组的ID。', 'type' => 'string', 'example' => 'ag-ayyhomlal7po****'],
+ 'AndroidInstanceGroupName' => ['description' => '实例组名称。', 'type' => 'string', 'example' => 'AndroidInstanceGroupName'],
+ 'AndroidInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-8at8h6ejkadjh****'],
+ 'AndroidInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'name'],
+ 'AndroidInstanceStatus' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'RUNNING'],
+ 'NetworkInterfaceIp' => ['description' => '网卡IP。', 'type' => 'string', 'example' => '192.168.22.48'],
+ 'AuthorizedUserId' => ['description' => '已分配的用户。', 'type' => 'string', 'example' => 'test'],
+ 'BindUserId' => ['description' => '已绑定的用户。', 'type' => 'string', 'example' => 'test'],
+ 'PersistentAppInstanceId' => ['description' => '持久会话ID。', 'type' => 'string', 'example' => 'p-0btrd5zj8epo****'],
+ 'AppInstanceId' => ['description' => '物理实例ID。', 'type' => 'string', 'example' => 'ai-9ey6io0q58rcd****'],
+ 'KeyPairId' => ['description' => '密钥对ID。', 'type' => 'string', 'example' => 'kp-5hh431emkpucs****'],
+ 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2023-05-06 10:42:10'],
+ 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2023-05-06 10:42:10'],
+ 'AppInstanceGroupId' => ['description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-i7yv6tkn7kh8dv****'],
+ 'RegionId' => ['description' => '地域 ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'Rate' => ['description' => '实例数据备份中和恢复中的进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'ErrorCode' => ['description' => '实例数据备份失败和恢复失败的错误原因。', 'type' => 'string', 'example' => 'FilePathNotFound'],
+ 'RenderingType' => ['description' => '渲染类型。', 'type' => 'string', 'example' => 'local'],
+ 'InstanceType' => ['description' => '实例类型。', 'type' => 'string', 'example' => 'acp.basic.small'],
+ 'ChargeType' => ['description' => '实例的计费类型。', 'type' => 'string', 'example' => 'PrePaid'],
+ 'GmtExpired' => ['description' => '包年包月实例组的过期时间。', 'type' => 'string', 'example' => '2024-07-15T02:03:33Z'],
+ 'PolicyGroupId' => ['description' => '策略组ID。', 'type' => 'string', 'example' => 'pg-0bszojpu0seql****'],
+ 'OfficeSiteId' => ['description' => '网络ID。对应控制台上创建时所选择的网络(基础共享网络,高级共享网络)', 'type' => 'string', 'example' => 'cn-shenzhen+dir-211620****'],
+ 'VSwitchId' => ['description' => '专有网络中的交换机ID。', 'type' => 'string', 'example' => 'vsw-2zepmau2hsbhos42****'],
+ 'Memory' => ['description' => '内存大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '1024'],
+ 'Cpu' => ['description' => 'CPU核数。', 'type' => 'string', 'example' => '4'],
+ 'Disks' => [
+ 'description' => '磁盘信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '磁盘信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DiskType' => ['description' => '磁盘类型。', 'type' => 'string', 'example' => 'SYSTEM'],
+ 'DiskSize' => ['description' => '磁盘大小。单位:GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
+ ],
+ ],
+ ],
+ 'Tags' => [
+ 'description' => '标签列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value'],
+ ],
+ ],
+ ],
+ 'ImageVersion' => ['description' => '镜像版本。', 'type' => 'string', 'example' => '3.5.3.867'],
+ 'PublicIpAddress' => ['description' => '公网IP。', 'type' => 'string', 'example' => '10.32.1.41'],
+ 'SessionStatus' => [
+ 'description' => '会话连接状态。',
'type' => 'string',
+ 'enumValueTitles' => ['disConnect' => '未连接', 'connect' => '连接'],
+ 'example' => 'connect',
],
- 'InstanceId' => [
+ 'NetworkInterfaceIpv6Address' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'example' => 'null'],
+ 'PublicIpv6Address' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'example' => 'null'],
+ 'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'imgc-075cllfeuazh0****'],
+ 'DisplayConfig' => [
+ 'description' => '显示设置。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResolutionHeight' => ['description' => '分辨率的高。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'example' => '1280'],
+ 'ResolutionWidth' => ['description' => '分辨率的宽。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'example' => '720'],
+ 'Dpi' => ['description' => 'DPI。', 'type' => 'integer', 'format' => 'int32', 'example' => '240'],
+ 'Fps' => ['description' => '帧率。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'LockResolution' => [
+ 'description' => '锁定分辨率。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
+ ],
+ ],
+ ],
+ 'QosRuleId' => ['description' => '公网限速规则ID(仅作用于精品带宽)', 'type' => 'string', 'example' => 'qos-5605u0gelk200****'],
+ 'AppManagePolicy' => [
+ 'description' => '应用管控规则信息。对应管制台的应用管控规则的黑白名单管理。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppManagePolicyId' => ['description' => '应用管控规则ID。', 'type' => 'string', 'example' => 'amp-dgiavcvibfdds****'],
+ 'AppManagePolicyName' => ['description' => '应用管控规则名称。', 'type' => 'string', 'example' => 'Application group 1'],
+ ],
+ ],
+ 'ZoneId' => ['description' => '实例所属的可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h'],
+ 'PhoneDataInfo' => [
+ 'description' => '<props="china">云手机矩阵版实例的独立机身存储信息。</props>'."\n"
+ .'<props="intl">本参数暂不对外开放使用。</props>',
+ 'type' => 'object',
+ 'properties' => [
+ 'PhoneDataId' => ['description' => '独立机身存储ID。', 'type' => 'string', 'example' => 'pd-sbcudgidbhb****'],
+ 'PhoneDataVolume' => ['description' => '独立机身存储的容量大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ ],
+ ],
+ 'StreamMode' => ['description' => '<props="china">云手机矩阵下实例的串流模式。</props>'."\n"
+ .'<props="intl">本参数暂不对外开放使用。</props>', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'NetworkType' => ['description' => '实例的网络类型。', 'type' => 'string', 'example' => 'network_pro_ecd'],
+ 'BandwidthPackageType' => ['description' => '带宽类型。', 'type' => 'string', 'example' => 'cbwp_ecd'],
+ 'BandwidthPackageId' => ['description' => '带宽包的ID。', 'type' => 'string', 'example' => 'np-0q6ixs7vpxcizp***'],
+ 'UpBandwidthLimit' => ['description' => '上行带宽限速,单位Mbps', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'DownBandwidthLimit' => ['description' => '下行带宽限速,单位Mbps', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'ServerType' => ['description' => '<props="china">云手机矩阵规格。</props>'."\n"
+ .'<props="intl">本参数暂不对外开放使用。</props>', 'type' => 'string', 'example' => 'cpm.gx7.10xlarge'],
+ 'BizTags' => [
+ 'description' => '标签数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'releaseFlag'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'on'],
+ ],
+ ],
+ ],
+ 'ServerStatus' => [
+ 'description' => '<props="china">矩阵状态。</props>'."\n"
+ .'<props="intl">本参数暂不对外开放使用。</props>',
'type' => 'string',
+ 'enumValueTitles' => ['FAILED' => '创建失败', 'RUNNING' => '可用', 'EXPIRED' => '过期', 'DELETING' => '删除中', 'NODE_READY' => '矩阵ready,实例创建中', 'CHANGING' => '矩阵变配中', 'CEASED' => '欠费', 'UPDATING' => '变更镜像中', 'CREATING' => '创建中', 'DATA_EXPANDING' => '存储扩容中'],
+ 'example' => 'RUNNING',
],
+ 'SystemVersion' => ['description' => 'android系统版本。', 'type' => 'string', 'example' => 'Android 11'],
+ 'InternetStatus' => ['type' => 'string', 'description' => ''],
+ 'BizImageType' => ['type' => 'string'],
+ 'Channel' => ['type' => 'string'],
+ 'PackageId' => ['type' => 'string'],
],
],
],
@@ -6486,64 +4024,127 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"440D7342-5E7C-B2DB-D0B4EAC2BDF1****\\",\\n \\"InvokeId\\": \\"t-gov2ujrk32v4****\\",\\n \\"RunCommandInfos\\": [\\n {\\n \\"InvokeId\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '执行命令',
+ 'title' => '查询实例详细信息',
+ 'summary' => '查询云手机实例的详情信息。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-12T08:38:03.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-08-22T08:01:59.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-08-01T11:31:58.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-25T15:04:47.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-15T07:46:27.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-15T05:15:08.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-28T12:53:31.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-06-27T10:23:27.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-05-31T09:41:39.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-05-23T10:38:25.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-05-14T13:01:38.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-04-17T12:56:36.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-10T13:59:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-03T10:00:32.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-03-14T09:57:38.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-02-17T09:52:46.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-01-22T12:26:49.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-01-16T07:59:35.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-01-03T10:01:01.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-12-20T03:04:10.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-20T02:37:07.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-09-26T12:10:00.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-08-19T09:49:56.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-07-24T09:34:56.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F07A1DA1-E1EB-5CCA-8EED-12F85D32****\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kmma/xxE9WtwL/ADvZ****\\",\\n \\"InstanceModel\\": [\\n {\\n \\"AndroidInstanceGroupId\\": \\"ag-ayyhomlal7po****\\",\\n \\"AndroidInstanceGroupName\\": \\"AndroidInstanceGroupName\\",\\n \\"AndroidInstanceId\\": \\"acp-8at8h6ejkadjh****\\",\\n \\"AndroidInstanceName\\": \\"name\\",\\n \\"AndroidInstanceStatus\\": \\"RUNNING\\",\\n \\"NetworkInterfaceIp\\": \\"192.168.22.48\\",\\n \\"AuthorizedUserId\\": \\"test\\",\\n \\"BindUserId\\": \\"test\\",\\n \\"PersistentAppInstanceId\\": \\"p-0btrd5zj8epo****\\",\\n \\"AppInstanceId\\": \\"ai-9ey6io0q58rcd****\\",\\n \\"KeyPairId\\": \\"kp-5hh431emkpucs****\\",\\n \\"GmtCreate\\": \\"2023-05-06 10:42:10\\",\\n \\"GmtModified\\": \\"2023-05-06 10:42:10\\",\\n \\"AppInstanceGroupId\\": \\"aig-i7yv6tkn7kh8dv****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Rate\\": 100,\\n \\"ErrorCode\\": \\"FilePathNotFound\\",\\n \\"RenderingType\\": \\"local\\",\\n \\"InstanceType\\": \\"acp.basic.small\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"GmtExpired\\": \\"2024-07-15T02:03:33Z\\",\\n \\"PolicyGroupId\\": \\"pg-0bszojpu0seql****\\",\\n \\"OfficeSiteId\\": \\"cn-shenzhen+dir-211620****\\",\\n \\"VSwitchId\\": \\"vsw-2zepmau2hsbhos42****\\",\\n \\"Memory\\": 1024,\\n \\"Cpu\\": \\"4\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskSize\\": 32\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"ImageVersion\\": \\"3.5.3.867\\",\\n \\"PublicIpAddress\\": \\"10.32.1.41\\",\\n \\"SessionStatus\\": \\"connect\\",\\n \\"NetworkInterfaceIpv6Address\\": \\"null\\",\\n \\"PublicIpv6Address\\": \\"null\\",\\n \\"ImageId\\": \\"imgc-075cllfeuazh0****\\",\\n \\"DisplayConfig\\": {\\n \\"ResolutionHeight\\": 1280,\\n \\"ResolutionWidth\\": 720,\\n \\"Dpi\\": 240,\\n \\"Fps\\": 30,\\n \\"LockResolution\\": \\"off\\"\\n },\\n \\"QosRuleId\\": \\"qos-5605u0gelk200****\\",\\n \\"AppManagePolicy\\": {\\n \\"AppManagePolicyId\\": \\"amp-dgiavcvibfdds****\\",\\n \\"AppManagePolicyName\\": \\"Application group 1\\"\\n },\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"PhoneDataInfo\\": {\\n \\"PhoneDataId\\": \\"pd-sbcudgidbhb****\\",\\n \\"PhoneDataVolume\\": 20\\n },\\n \\"StreamMode\\": 1,\\n \\"NetworkType\\": \\"network_pro_ecd\\",\\n \\"BandwidthPackageType\\": \\"cbwp_ecd\\",\\n \\"BandwidthPackageId\\": \\"np-0q6ixs7vpxcizp***\\",\\n \\"UpBandwidthLimit\\": 5,\\n \\"DownBandwidthLimit\\": 30,\\n \\"ServerType\\": \\"cpm.gx7.10xlarge\\",\\n \\"BizTags\\": [\\n {\\n \\"Key\\": \\"releaseFlag\\",\\n \\"Value\\": \\"on\\"\\n }\\n ],\\n \\"ServerStatus\\": \\"RUNNING\\",\\n \\"SystemVersion\\": \\"Android 11\\",\\n \\"InternetStatus\\": \\"\\",\\n \\"BizImageType\\": \\"\\",\\n \\"Channel\\": \\"\\",\\n \\"PackageId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DescribeInvocations' => [
- 'summary' => '查询RunCommand接口命令执行结果。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeApps' => [
+ 'summary' => '查询已创建的应用信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphone4KHDE1'],
],
'parameters' => [
[
- 'name' => 'InstanceIds',
+ 'name' => 'AppIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机实例ID列表,一次请求最多查询50个实例的执行结果。',
+ 'description' => '应用ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-bj9t2gmys****',
- ],
- 'required' => true,
+ 'items' => ['description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => '1234'],
+ 'required' => false,
'maxItems' => 100,
'minItems' => 1,
],
],
[
- 'name' => 'InvocationId',
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'Application name'],
+ ],
+ [
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => '命令执行ID,根据该ID和云手机实例ID可查询一次命令执行的结果。',
+ 'description' => '应用创建状态。',
'type' => 'string',
- 'required' => true,
- 'example' => 't-4e98eeb5****',
+ 'required' => false,
+ 'enumValueTitles' => ['FAILED' => '创建失败', 'NORMAL' => '正常', 'CREATING' => '创建中'],
+ 'example' => 'NORMAL',
],
],
+ [
+ 'name' => 'InstallationStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '应用的安装/卸载状态。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['INSTALLFAILED' => '安装失败', 'UNINSTALLING' => '卸载中', 'INSTALLING' => '安装中', 'UNINSTALLED' => '卸载完成', 'INSTALLED' => '安装完成', 'UNINSTALLFAILED' => '卸载失败'],
+ 'example' => 'INSTALLING',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
+ ],
+ [
+ 'name' => 'MD5',
+ 'in' => 'query',
+ 'schema' => ['description' => '.apk文件的MD5值。', 'type' => 'string', 'required' => false, 'example' => '009ee07fe13a29fa0c180ed0b6bc****'],
+ ],
+ [
+ 'name' => 'AppType',
+ 'in' => 'query',
+ 'schema' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => '-'],
+ ],
],
'responses' => [
200 => [
@@ -6552,60 +4153,49 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '440D7342-5E7C-B2DB-D0B4EAC2BDF1****',
- ],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'string',
- 'example' => '10',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'CB95E410-FD1D-53C5-9F7D-93CC44D7****'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'string', 'example' => '10'],
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****'],
'Data' => [
- 'description' => '返回结果列表。',
+ 'description' => '返回结果对象。',
'type' => 'array',
'items' => [
- 'description' => '返回结果数据。',
+ 'description' => '返回结果对象。',
'type' => 'object',
'properties' => [
- 'InvocationId' => [
- 'description' => '命令执行ID。',
- 'type' => 'string',
- 'example' => 't-15775dc8****',
- ],
- 'StartTime' => [
- 'description' => '命令开始执行时间。',
- 'type' => 'string',
- 'example' => '2022-08-11 17:45:03',
- ],
- 'FinishTime' => [
- 'description' => '命令结束执行时间。',
- 'type' => 'string',
- 'example' => '2022-08-11 17:45:03',
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'testapp'],
+ 'AppId' => ['description' => '应用ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '10404'],
+ 'AndroidAppVersion' => ['description' => '应用版本。', 'type' => 'string', 'example' => '1.0.0'],
+ 'IconUrl' => ['description' => '应用图标地址。', 'type' => 'string', 'example' => 'https://test.png'],
+ 'InstanceGroupList' => [
+ 'description' => '应用已经安装的实例组列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '应用安装的实例组ID。', 'type' => 'string', 'example' => 'ag-fasf****'],
],
- 'Output' => [
- 'description' => '命令执行输出的结果。',
+ 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-08-11 17:45:03'],
+ 'GmtModified' => ['description' => '最近一次修改时间。', 'type' => 'string', 'example' => '2022-08-11 17:45:03'],
+ 'Description' => ['description' => '应用描述。', 'type' => 'string', 'example' => 'CustomApp'],
+ 'Status' => [
+ 'description' => '应用状态。',
'type' => 'string',
- 'example' => 'success',
+ 'enumValueTitles' => ['FAILED' => '创建失败', 'NORMAL' => '正常', 'CREATING' => '创建中'],
+ 'example' => 'NORMAL',
],
- 'InstanceId' => [
- 'description' => '执行当前命令的实例ID。',
+ 'InstallationStatus' => [
+ 'description' => '应用的安装/卸载状态。',
'type' => 'string',
- 'example' => 'acp-uto81vfd8t8z****',
+ 'enumValueTitles' => ['INSTALLFAILED' => '安装失败', 'UNINSTALLING' => '卸载中', 'INSTALLING' => '安装中', 'UNINSTALLED' => '卸载完成', 'INSTALLED' => '安装完成', 'UNINSTALLFAILED' => '卸载失败'],
+ 'example' => 'INSTALLING',
],
- 'InvocationStatus' => [
- 'description' => '命令执行进度状态。',
+ 'BizRegionId' => ['description' => '应用的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'PackageName' => ['description' => '应用包名。', 'type' => 'string', 'example' => 'com.example.chinalife'],
+ 'ApkSize' => ['description' => '.apk文件的大小。单位:MB。', 'type' => 'string', 'example' => '2.7'],
+ 'MD5' => ['description' => '.apk文件的MD5值。', 'type' => 'string', 'example' => '009ee07fe13a29fa0c180ed0b6bc****'],
+ 'AppType' => [
+ 'description' => '应用类型',
'type' => 'string',
- 'enumValueTitles' => [
- 'Failed' => '执行失败',
- 'Timeout' => '执行超时',
- 'Running' => '执行中',
- 'Success' => '执行成功',
- 'Pending' => '等待执行',
- ],
- 'example' => 'Running',
+ 'enumValueTitles' => ['Normal' => '普通应用', 'System_Signature' => '系统签名应用'],
+ 'example' => 'Normal',
],
],
],
@@ -6614,22 +4204,27 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"440D7342-5E7C-B2DB-D0B4EAC2BDF1****\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"Data\\": [\\n {\\n \\"InvocationId\\": \\"t-15775dc8****\\",\\n \\"StartTime\\": \\"2022-08-11 17:45:03\\",\\n \\"FinishTime\\": \\"2022-08-11 17:45:03\\",\\n \\"Output\\": \\"success\\",\\n \\"InstanceId\\": \\"acp-uto81vfd8t8z****\\",\\n \\"InvocationStatus\\": \\"Running\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询命令执行结果',
- 'description' => '此接口即将下线,推荐使用[DescribeTasks](~~2833926~~)接口查询命令执行进度和结果。',
- ],
- 'SendFile' => [
- 'summary' => '将OSS文件或者公网下载链接的文件推送到云手机。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB95E410-FD1D-53C5-9F7D-93CC44D7****\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****\\",\\n \\"Data\\": [\\n {\\n \\"AppName\\": \\"testapp\\",\\n \\"AppId\\": 10404,\\n \\"AndroidAppVersion\\": \\"1.0.0\\",\\n \\"IconUrl\\": \\"https://test.png\\",\\n \\"InstanceGroupList\\": [\\n \\"ag-fasf****\\"\\n ],\\n \\"GmtCreate\\": \\"2022-08-11 17:45:03\\",\\n \\"GmtModified\\": \\"2022-08-11 17:45:03\\",\\n \\"Description\\": \\"CustomApp\\",\\n \\"Status\\": \\"NORMAL\\",\\n \\"InstallationStatus\\": \\"INSTALLING\\",\\n \\"BizRegionId\\": \\"cn-hangzhou\\",\\n \\"PackageName\\": \\"com.example.chinalife\\",\\n \\"ApkSize\\": \\"2.7\\",\\n \\"MD5\\": \\"009ee07fe13a29fa0c180ed0b6bc****\\",\\n \\"AppType\\": \\"Normal\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询应用信息',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-11T01:45:19.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-12-17T03:35:22.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-10-16T06:49:24.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-06-26T12:41:04.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeBackupFiles' => [
+ 'summary' => '查询备份文件列表。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6641,110 +4236,97 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone0959GM',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMPR6T6'],
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIdList',
+ 'name' => 'BackupFileId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'App文件地址', 'description' => '备份文件ID。', 'type' => 'string', 'required' => false, 'example' => 'bf-dxrh5jrv0zpb8****'],
+ ],
+ [
+ 'name' => 'BackupFileName',
+ 'in' => 'query',
+ 'schema' => ['title' => 'App文件名称', 'description' => '备份文件名称。支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
+ ],
+ [
+ 'name' => 'InstanceGroupId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'App oss地址', 'description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-fxdx91jsfyiy3****'],
+ ],
+ [
+ 'name' => 'AndroidInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-34pqe4r0kd9kn****'],
+ ],
+ [
+ 'name' => 'AndroidInstanceName',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例名称。支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'acp-34pqe4r0kd9kn****'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '描述。支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'desc'],
+ ],
+ [
+ 'name' => 'StatusList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例列表。',
+ 'description' => '备份文件状态列表。',
'type' => 'array',
'items' => [
- 'description' => '实例ID。',
+ 'description' => '备份文件状态。',
'type' => 'string',
'required' => false,
- 'example' => 'acp-34pqe4r0kd9kn****',
+ 'enumValueTitles' => ['AVAILABLE' => '可用', 'BACKUPING' => '备份中', 'RECOVERING' => '恢复中', 'DELETING' => '删除中', 'BACKUP_FAILED' => '备份失败', 'RECOVERY_FAILED' => '恢复失败', 'PART_BACKUP_FINISHED' => '部分备份成功'],
+ 'example' => 'AVAILABLE',
],
- 'deprecated' => false,
- 'required' => true,
+ 'required' => false,
'maxItems' => 100,
],
],
[
- 'name' => 'SourceFilePath',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '将文件上传到云手机内部的上传路径。'."\n"
- ."\n"
- .'> 当UploadType是OSS或者OSS_BRIDGED,云手机内部的上传路径SourceFilePath必须是目录,例如:/sdcard/Download;当UploadType是DOWNLOAD_URL,云手机内部的上传路径SourceFilePath必须是文件,例如:/sdcard/Download/MyFile.txt。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => '/sdcard/Download',
- ],
+ 'schema' => ['description' => '查询当前时间之后的备份文件。', 'type' => 'string', 'required' => false, 'example' => '2024-05-23 10:00:00'],
],
[
- 'name' => 'UploadType',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '上传文件所在的存储类型。'."\n"
- ."\n"
- .'- OSS'."\n"
- .' 当上传的文件是OSS资源,上传文件所在的存储类型是OSS。'."\n"
- .'- DOWNLOAD_URL'."\n"
- .' 当上传的文件是文件的公网下载链接,上传文件所在的存储类型是DOWNLOAD_URL。'."\n"
- .'- OSS_BRIDGED'."\n"
- .' 通过公网下载链接同步到OSS,再通过OSS内网分发到云手机实例。',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'OSS_BRIDGED' => '公网下载链接同步OSS后分发',
- 'DOWNLOAD_URL' => '文件公网下载链接',
- 'OSS' => 'OSS文件资源',
- ],
- 'example' => 'OSS',
- ],
+ 'schema' => ['description' => '查询当前时间之前的备份文件。', 'type' => 'string', 'required' => false, 'example' => '2024-05-20 10:00:00'],
],
[
- 'name' => 'UploadEndpoint',
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份文件的Owner。', 'type' => 'string', 'required' => false, 'example' => 'test1'],
+ ],
+ [
+ 'name' => 'BackupAll',
'in' => 'query',
'schema' => [
- 'description' => '文件上传到OSS的服务域名,UploadType为OSS和OSS_BRIDGED时,UploadEndpoint必填。'."\n"
- ."\n"
- .'> 当云手机和OSS Bucket处于相同地域,域名可填写内网域名,加快传输速率,不产生公网网络费用,杭州为例: `oss-cn-hangzhou-internal.aliyuncs.com` 。具体的域名列表映射可参考[OSS地域和访问域名](~~31837~~)。',
- 'type' => 'string',
+ 'description' => '是否整机备份。',
+ 'type' => 'boolean',
'required' => false,
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com',
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
+ 'example' => 'false',
],
],
[
- 'name' => 'UploadUrl',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '- 当UploadType是OSS,UploadUrl是文件上传到OSS的云端地址。'."\n"
- .'> 可使用的OSS Bucket名,必须以“cloudphone-saved-bucket-”前缀的Bucket Bucket,例如“cloudphone-saved-bucket-example”,并创建OSS文件夹作为备份目录。UploadUrl的拼写规则是“oss://”+“Bucket名”+“/”+“文件夹名称”+“上传的文件名称”。'."\n"
- .'- 当UploadType是DOWNLOAD或者OSS_BRIDGED,UploadUrl是文件的公网下载地址。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://cloudphone-saved-bucket-example/send/a.txt',
- ],
+ 'schema' => ['description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'default' => '20'],
],
[
- 'name' => 'TargetFileName',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '从OSS上传到云手机的文件名称。'."\n"
- ."\n"
- .'> 当UploadType是OSS或者OSS_BRIDGED,TargetFileName字段选填,如果TargetFileName为空,OSS文件上传到云手机的文件名称保留源文件名称,如果TargetFileName不为空,源文件上传到云手机的SourceFilePath路径下文件名称为TargetFileName的值;当UploadType是DOWNLOAD_URL,TargetFileName字段不生效。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test.txt',
- ],
+ 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****'],
],
[
- 'name' => 'AutoInstall',
+ 'name' => 'SaleMode',
'in' => 'query',
- 'schema' => [
- 'description' => '上传的应用是否自动安装。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -6755,56 +4337,78 @@
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => '返回数据。',
+ 'description' => '返回结果对象列表。',
'type' => 'array',
'items' => [
'description' => '返回结果对象。',
'type' => 'object',
'properties' => [
- 'AndroidInstanceId' => [
- 'description' => '实例ID。',
+ 'GmtCreated' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-05-15 17:33:59'],
+ 'GmtModified' => ['description' => '更新时间', 'type' => 'string', 'example' => '2024-05-15 17:33:59'],
+ 'BackupFileId' => ['description' => '备份文件ID。', 'type' => 'string', 'example' => 'bf-b0qbg3pbpjkn7****'],
+ 'BackupFileName' => ['description' => '备份文件名称。', 'type' => 'string', 'example' => 'a-58ftsoo90p0qa****.ab'],
+ 'InstanceGroupId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ag-58ftsoo90p0qi****'],
+ 'AndroidInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'AndroidInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'Test cloud phone'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-bp67acfmxazb4p****'],
+ 'EndUserId' => ['description' => '备份文件的Owner。', 'type' => 'string', 'example' => 'test'],
+ 'Status' => [
+ 'description' => '备份文件状态。',
'type' => 'string',
- 'example' => 'acp-34pqe4r0kd9kn****',
+ 'enumValueTitles' => ['AVAILABLE' => '可用', 'RECOVERING' => '恢复中'],
+ 'example' => 'AVAILABLE',
+ ],
+ 'SourceFilePathList' => [
+ 'description' => '源备份文件的目录列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '源备份文件的目录。', 'type' => 'string', 'example' => '/data/media'],
],
- 'TaskId' => [
- 'description' => '任务ID',
+ 'SourceAppInfoList' => [
+ 'description' => '备份的应用包名列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '备份的应用包名。', 'type' => 'string', 'example' => 'com.example.xhs'],
+ ],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'FileSize' => ['description' => '源备份文件总大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10227168'],
+ 'UploadType' => [
+ 'description' => '备份类型。',
'type' => 'string',
- 'example' => 't-4ks224ujixw****',
+ 'enumValueTitles' => ['OSS' => '备份文件保存在OSS桶。'],
+ 'example' => 'OSS',
],
+ 'UploadEndpoint' => ['description' => '上传地址的域名。', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com'],
+ 'BackupFilePath' => ['description' => '备份文件保存的目录。', 'type' => 'string', 'example' => 'oss://cloudphone-saved-bucket-cn-shanghai/backup/aic-58ftsoo90p0qa****.ab'],
+ 'Description' => ['description' => '备份文件的描述信息。', 'type' => 'string', 'example' => 'Backup file for /data/media directory.'],
+ 'BackupAll' => ['description' => '是否整机备份。', 'type' => 'boolean', 'example' => 'false'],
+ 'SystemVersion' => ['type' => 'string', 'description' => ''],
+ 'Channel' => ['type' => 'string'],
],
],
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'."\n",
- ],
- 'RequestId' => [
- 'description' => '请求唯一ID,如果遇到问题请提供这个请求ID,由工作人员为您排查。',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
- ],
- 'TaskId' => [
- 'description' => '批量任务ID。',
- 'type' => 'string',
- 'example' => 't-ehs0yoedj0xe9****',
],
+ 'RequestId' => ['description' => '请求唯一ID,如果遇到问题请提供这个请求ID,由工作人员为您排查。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****'],
+ 'MaxResults' => ['description' => '本次读取的最大数据量。', 'type' => 'string', 'example' => '10'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int64', 'example' => '91'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-4ks224ujixw****\\"\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"TaskId\\": \\"t-ehs0yoedj0xe9****\\"\\n}","type":"json"}]',
- 'title' => '文件上传到云手机',
- 'description' => '目前仅支持将OSS对象存储服务的文件或者文件夹发送到云手机。',
- ],
- 'FetchFile' => [
- 'summary' => '从云手机拉取文件到OSS。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询备份文件列表',
+ 'description' => '目前仅支持云手机生成的备份文件保存在OSS对象存储服务。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-12T04:58:32.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-01-03T11:17:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-11-14T10:59:55.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreated\\": \\"2024-05-15 17:33:59\\",\\n \\"GmtModified\\": \\"2024-05-15 17:33:59\\",\\n \\"BackupFileId\\": \\"bf-b0qbg3pbpjkn7****\\",\\n \\"BackupFileName\\": \\"a-58ftsoo90p0qa****.ab\\",\\n \\"InstanceGroupId\\": \\"ag-58ftsoo90p0qi****\\",\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"AndroidInstanceName\\": \\"Test cloud phone\\",\\n \\"TaskId\\": \\"t-bp67acfmxazb4p****\\",\\n \\"EndUserId\\": \\"test\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"SourceFilePathList\\": [\\n \\"/data/media\\"\\n ],\\n \\"SourceAppInfoList\\": [\\n \\"com.example.xhs\\"\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FileSize\\": 10227168,\\n \\"UploadType\\": \\"OSS\\",\\n \\"UploadEndpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"BackupFilePath\\": \\"oss://cloudphone-saved-bucket-cn-shanghai/backup/aic-58ftsoo90p0qa****.ab\\",\\n \\"Description\\": \\"Backup file for /data/media directory.\\",\\n \\"BackupAll\\": false,\\n \\"SystemVersion\\": \\"\\",\\n \\"Channel\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": 91\\n}","type":"json"}]',
+ ],
+ 'DescribeBuckets' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6813,76 +4417,24 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone0959GM',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMPR6T6'],
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIdList',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-34pqe4r0kd9kn****'."\n",
- ],
- 'deprecated' => false,
- 'required' => true,
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'SourceFilePath',
- 'in' => 'query',
- 'schema' => [
- 'description' => '从指定的云手机文件路径拉取文件。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '/data/a.txt',
- ],
- ],
- [
- 'name' => 'UploadType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保存拉取文件的存储类型。'."\n"
- ."\n"
- .'> 目前仅支持的云端存储类型是OSS对象存储。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OSS',
- ],
- ],
- [
- 'name' => 'UploadEndpoint',
- 'in' => 'query',
- 'schema' => [
- 'description' => '从OSS拉取文件的服务域名。'."\n"
- ."\n"
- .'> 当云手机和OSS Bucket处于相同地域,域名可填写内网域名,加快传输速率,不产生公网网络费用,杭州为例: `oss-cn-hangzhou-internal.aliyuncs.com` 。具体的域名列表映射可参考[OSS地域和访问域名](~~31837~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com',
- ],
- ],
- [
- 'name' => 'UploadUrl',
+ 'name' => 'FileType',
'in' => 'query',
'schema' => [
- 'description' => '从OSS拉取文件的云端地址。'."\n"
+ 'description' => 'OSS文件类型。'."\n"
."\n"
- .'> 可使用的OSS桶名,必须以“cloudphone-saved-bucket-”前缀的Bucket桶,例如“cloudphone-saved-bucket-example”,并创建OSS文件夹作为备份目录。UploadUrl的拼写规则是“oss://”+“桶名”+“/”+“文件夹名称”。',
+ .'> 该参数暂未开放',
'type' => 'string',
- 'required' => true,
- 'example' => 'oss://cloudphone-saved-bucket-example/received'."\n",
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'docx',
+ 'enum' => ['FILE', 'DIR'],
],
],
],
@@ -6890,186 +4442,328 @@
200 => [
'schema' => [
'title' => 'PlainResult<Integer>',
- 'description' => '返回参数。',
+ 'description' => 'PlainResult<Integer>',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => '返回数据。',
+ 'description' => '返回结果对象。',
'type' => 'array',
'items' => [
'description' => '返回结果对象。',
'type' => 'object',
'properties' => [
- 'AndroidInstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-34pqe4r0kd9kn****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-bp67acfmxazb4p****',
+ 'GmtCreated' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-05-15 17:33:59'],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'BucketName' => ['description' => '存储空间名称。', 'type' => 'string', 'example' => 'zydctest'],
+ 'ExtranetEndpoint' => ['description' => 'Bucket访问的外网域名。', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com'],
+ 'IntranetEndpoint' => ['description' => '同地域ECS访问Bucket的内网域名。', 'type' => 'string', 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'."\n"
+ ."\n"],
+ 'Location' => ['description' => 'HDFS或OSS等存放路径。', 'type' => 'string', 'example' => 'center'],
+ 'OssObjectList' => [
+ 'description' => '存储空间(Bucket)中的文件(Object)的信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '存储空间(Bucket)中的文件(Object)的信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'BucketName' => ['description' => 'Bucket名称。', 'type' => 'string', 'example' => 'tf-testacceu-central-1ensbucketlifecycle44222'],
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'con'],
+ 'ETag' => ['description' => 'ETag (Entity Tag) 在每个Object生成时创建,用于标识一个Object的内容。'."\n"
+ ."\n"
+ .'- 对于PutObject请求创建的Object,ETag值是其内容的MD5值。'."\n"
+ ."\n"
+ .'- 对于其他方式创建的Object,ETag值是基于一定计算规则生成的唯一值,但不是其内容的MD5值。'."\n"
+ ."\n"
+ .'- ETag值可以用于检查Object内容是否发生变化。不建议使用ETag值作为Object内容的MD5校验数据完整性的依据。', 'type' => 'string', 'example' => '5B3C1A2E053D763E1B002CC607C5A0FE1****'."\n"
+ ."\n"],
+ 'Size' => ['description' => '文件大小,单位:KB。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
+ 'LastModified' => ['description' => 'Object最后被修改的时间。', 'type' => 'string', 'example' => '2012-02-24T08:42:32.000Z'],
+ 'StorageClass' => ['description' => 'Bucket的存储类型。 取值范围如下:'."\n"
+ ."\n"
+ .'- Standard(默认):标准存储'."\n"
+ .'- IA:低频访问'."\n"
+ .'- Archive:归档存储'."\n"
+ .'- ColdArchive:冷归档存储'."\n"
+ .'- DeepColdArchive:深度冷归档存储', 'type' => 'string', 'example' => 'ARCHIVE'],
+ 'Owner' => [
+ 'description' => 'Bucket拥有者信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'DisplayName' => ['description' => 'Bucket拥有者的名称 。', 'type' => 'string', 'example' => '佳钰'],
+ 'Id' => ['description' => 'Bucket拥有者的唯一标识符。', 'type' => 'string', 'example' => '395'],
+ ],
+ ],
+ 'Type' => ['description' => '触发方式类型。', 'type' => 'string', 'example' => 'InstanceGroup'],
+ 'RestoreInfo' => ['description' => '恢复数据库类型为MSSQL时,数据库恢复信息。格式为JSON字符串格式,取值:'."\n"
+ .'- **name**:数据库名称'."\n"
+ .'- **files**:数据库文件路径', 'type' => 'string', 'example' => 'ongoing-request="true"'],
+ ],
+ ],
],
],
],
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'."\n",
- ],
- 'RequestId' => [
- 'description' => '请求唯一ID,如果遇到问题请提供这个请求ID,由工作人员为您排查。',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
- ],
- 'TaskId' => [
- 'description' => '批量任务ID。',
- 'type' => 'string',
- 'example' => 't-ehs0yoedj0xe9****',
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['description' => '错误码。'."\n"
+ ."\n"
+ .'> 仅当接口调用出错时会出现该参数。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Success.'],
+ 'HttpStatusCode' => ['description' => '请求返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询可用于备份的oss Bucket信息',
+ 'summary' => '查询bucket信息,仅查询bucket名称以「cloudphone-saved-bucket-」打头的bucket list',
+ 'description' => '目前仅支持云手机生成的备份文件保存在OSS对象存储服务。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-bp67acfmxazb4p****\\"\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"TaskId\\": \\"t-ehs0yoedj0xe9****\\"\\n}","type":"json"}]',
- 'title' => '从云手机拉取文件',
- 'description' => '目前仅支持将云手机的文件或文件夹拉取到OSS对象存储服务。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreated\\": \\"2024-05-15 17:33:59\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"BucketName\\": \\"zydctest\\",\\n \\"ExtranetEndpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"IntranetEndpoint\\": \\"oss-cn-hangzhou-internal.aliyuncs.com\\\\n\\\\n\\",\\n \\"Location\\": \\"center\\",\\n \\"OssObjectList\\": [\\n {\\n \\"BucketName\\": \\"tf-testacceu-central-1ensbucketlifecycle44222\\",\\n \\"Key\\": \\"con\\",\\n \\"ETag\\": \\"5B3C1A2E053D763E1B002CC607C5A0FE1****\\\\n\\\\n\\",\\n \\"Size\\": 9,\\n \\"LastModified\\": \\"2012-02-24T08:42:32.000Z\\",\\n \\"StorageClass\\": \\"ARCHIVE\\",\\n \\"Owner\\": {\\n \\"DisplayName\\": \\"佳钰\\",\\n \\"Id\\": \\"395\\"\\n },\\n \\"Type\\": \\"InstanceGroup\\",\\n \\"RestoreInfo\\": \\"ongoing-request=\\\\\\"true\\\\\\"\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
- 'CreateScreenshot' => [
- 'summary' => '生成一张云手机的截屏图片,异步接口。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeCloudPhoneNodes' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneQNMLJ7',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneTVG3Y7'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIdList',
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '地域ID。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['cn-shanghai' => '华东2(上海)', 'ap-southeast-1' => '新加坡', 'eu-central-1' => '德国(法兰克福)', 'cn-hangzhou' => '华东1(杭州)'],
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的最大条目数。最大值为100。默认值为20。', 'type' => 'string', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '下一次查询的令牌(Token)。如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****'],
+ ],
+ [
+ 'name' => 'NodeIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID列表,支持批量截图。',
+ 'description' => '云手机矩阵ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'acp-ig2bdpk374l12****',
- ],
- 'deprecated' => false,
- 'required' => true,
+ 'items' => ['description' => '云手机矩阵ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-192c32356ft1ov1m****'],
+ 'required' => false,
'maxItems' => 100,
],
],
[
- 'name' => 'OssBucketName',
+ 'name' => 'NodeName',
+ 'in' => 'query',
+ 'schema' => ['description' => '云手机矩阵名称。', 'type' => 'string', 'required' => false, 'example' => 'node_name'],
+ ],
+ [
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => '自定义OSS桶,桶名必须“cloudphone-saved-bucket-”为前缀,云手机实例和OSS桶地域需要保持一致。空默认创建桶“cloudphone-saved-bucket-{云手机所在地域}-{AliUid}”。',
+ 'description' => '云手机矩阵状态。',
'type' => 'string',
'required' => false,
- 'example' => 'cloudphone-saved-bucket-cn-shanghai-default',
+ 'enumValueTitles' => ['FAILED' => '创建失败', 'RUNNING' => '可用', 'DELETING' => '删除中', 'NODE_READY' => '节点就绪,实例创建中', 'DELETED' => '已删除', 'CREATING' => '创建中'],
+ 'example' => 'CREATING',
],
],
[
- 'name' => 'SkipCheckPolicyConfig',
+ 'name' => 'ServerType',
'in' => 'query',
'schema' => [
- 'description' => '是否跳过截图策略控制,默认false。',
+ 'description' => '云手机矩阵规格。',
'type' => 'string',
'required' => false,
- 'example' => 'false',
+ 'enumValueTitles' => ['cpm.gx7.10xlarge' => 'cpm.gx7.10xlarge', 'cpm.gx8.16xlarge' => 'cpm.gx8.16xlarge'],
+ 'example' => 'cpm.gx7.10xlarge',
],
],
[
- 'name' => 'ScreenshotId',
+ 'name' => 'ChargeType',
'in' => 'query',
'schema' => [
- 'description' => '截屏ID。生成的截屏图片命名为“ ScreenshotId_AndroidInstanceId.png”。'."\n"
- ."\n"
- .'><notice>ScreenshotId 长度为 2~128 个字符,以英文字母或中文开头,不能以http://和https://开头,可包含数字、下划线(_)和短划线(-)。></notice>',
+ 'description' => '付费类型。当前只支持包年包月类型。',
'type' => 'string',
'required' => false,
- 'example' => 'image',
+ 'enumValueTitles' => ['PrePaid' => '包年包月'],
+ 'example' => 'PrePaid',
+ ],
+ ],
+ [
+ 'name' => 'BandwidthPackageId',
+ 'in' => 'query',
+ 'schema' => ['description' => '带宽包实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cbwp-bp17psa7fhxqmm*****'],
+ ],
+ [
+ 'name' => 'NodeNameList',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['type' => 'string'],
+ 'Value' => ['type' => 'string'],
+ ],
+ ],
+ 'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => 'PlainResult<Integer>',
+ 'title' => 'Schema of Response',
+ 'description' => '请求信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求唯一ID,如果遇到问题请提供这个请求ID,由工作人员为您排查。',
- 'type' => 'string',
- 'example' => '3AF82CE1-2801-52CE-BF64-B491DD7C****',
- ],
- 'Tasks' => [
- 'description' => '任务列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F07A1DA1-E1EB-5CCA-8EED-12F85D32****'],
+ 'NodeModel' => [
+ 'description' => '云手机矩阵信息详情。',
'type' => 'array',
'items' => [
- 'description' => '任务。',
+ 'description' => '云手机矩阵信息详情。',
'type' => 'object',
'properties' => [
- 'AndroidInstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-bwhtebzah2fse****',
+ 'Status' => ['description' => '云手机矩阵状态。', 'type' => 'string', 'example' => 'RUNNING'],
+ 'ServerType' => ['description' => '云手机矩阵规格。', 'type' => 'string', 'example' => 'cpm.gx7.10xlarge'],
+ 'ResolutionWidth' => ['description' => '分辨率的宽度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'example' => '720'],
+ 'NodeName' => ['description' => '云手机矩阵名称。', 'type' => 'string', 'example' => 'node_name'],
+ 'Memory' => ['description' => '内存大小。单位:GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
+ 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-2zeekryyc1q3sm72l****'],
+ 'GmtModified' => ['description' => '最近一次修改时间。', 'type' => 'string', 'example' => '2025-02-13 02:03:14'],
+ 'Cpu' => ['description' => 'CPU核数。', 'type' => 'string', 'example' => '2'],
+ 'ResolutionHeight' => ['description' => '分辨率的高度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'example' => '1280'],
+ 'NetworkId' => ['description' => '网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-5mwr9azebliva****'],
+ 'GmtExpired' => ['description' => '包年包月矩阵的过期时间。', 'type' => 'string', 'example' => '2025-03-09 02:00:34'],
+ 'PhoneCount' => ['description' => '云手机矩阵下的实例开数。', 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
+ 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-11-13 02:03:14'],
+ 'ChargeType' => ['description' => '付费类型。', 'type' => 'string', 'example' => 'PrePaid'],
+ 'NodeId' => ['description' => '云手机矩阵ID。', 'type' => 'string', 'example' => 'cpn-ehs0yoedq8ntm****'],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'InstanceType' => ['description' => '实例规格。', 'type' => 'string', 'example' => 'ac.max'],
+ 'ShareDataVolume' => ['description' => '共享机身存储的大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PhoneDataInfo' => [
+ 'description' => '独立机身存储信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PhoneDataId' => ['description' => '独立机身存储ID。', 'type' => 'string', 'example' => 'pd-dhusabisshj****'],
+ 'PhoneDataVolume' => ['description' => '独立机身存储容量大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ ],
],
- 'TaskId' => [
- 'description' => '任务ID。通过TaskId可以调用DescribeTasks接口查询当前实例的截图任务,当任务完成可以拿到截图的下载链接。',
- 'type' => 'string',
- 'example' => 't-imr0fufqd7cle****',
+ 'NetworkInfos' => [
+ 'description' => '网络相关信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '网络相关信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'VSwitchId' => ['description' => '专有网络中的交换机ID。', 'type' => 'string', 'example' => 'vsw-j6cjgev6fv3ftw4f0****'],
+ 'NetworkId' => ['description' => '网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-avcuocx9805oq****'],
+ 'NetworkType' => ['description' => '实例的网络类型。', 'type' => 'string', 'example' => 'network_pro_ecd'],
+ 'BandwidthPackageType' => ['description' => '带宽类型。', 'type' => 'string', 'example' => 'cbwp_ecd'],
+ 'BandwidthPackageId' => ['description' => '带宽包实例ID。', 'type' => 'string', 'example' => 'cbwp-hn3tj409amvamz8mf****'],
+ ],
+ ],
],
- 'ScreenshotId' => [
- 'description' => '截屏ID。生成的截屏图片命名为“ ScreenshotId_AndroidInstanceId.png”。',
- 'type' => 'string',
- 'example' => 'image',
+ 'NetworkType' => ['description' => '实例的网络类型。', 'type' => 'string', 'example' => 'network_pro_ecd'],
+ 'BandwidthPackageType' => ['description' => '带宽类型。', 'type' => 'string', 'example' => 'cbwp_ecd'],
+ 'BandwidthPackageId' => ['description' => '带宽包ID。', 'type' => 'string', 'example' => 'cbwp-7xvrl7axet2qg6yia******'],
+ 'BizTags' => [
+ 'description' => '标签信息数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'keyname'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'valuename'],
+ ],
+ ],
+ ],
+ 'BandwidthPackageStatus' => ['description' => '带宽包状态:0-初始化,1-正常,2-删除', 'type' => 'string', 'example' => '1'],
+ 'SwapSize' => ['type' => 'integer', 'format' => 'int32'],
+ 'Tags' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['type' => 'string'],
+ 'Value' => ['type' => 'string'],
+ ],
+ ],
],
],
],
],
+ 'TotalCount' => ['description' => '总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '31'],
+ 'NextToken' => ['description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
+ .'- 如果**NextToken**为空表示没有下一次查询。'."\n"
+ .'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
+ 'MaxResults' => ['description' => '分页查询时每页的最大条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AF82CE1-2801-52CE-BF64-B491DD7C****\\",\\n \\"Tasks\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-bwhtebzah2fse****\\",\\n \\"TaskId\\": \\"t-imr0fufqd7cle****\\",\\n \\"ScreenshotId\\": \\"image\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '生成一张云手机的截屏图片',
- 'description' => '创建一张云手机的截屏图片并上传到默认的OSS桶,接口返回TaskId,可以通过DescribeTasks接口查询截图的下载链接。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询云手机矩阵信息',
+ 'summary' => '查询云手机矩阵的详细信息。'."\n"
+ ."\n"
+ .'在无影云手机系统中,矩阵(Cloud Phone Server)是一个逻辑上的资源管理单元,代表一个物理服务器实例。该物理服务器可以被划分为多个独立运行的云手机实例,这些实例共享矩阵底层的计算、存储和网络资源。创建一个矩阵,即相当于获得一台物理服务器,您可以在其上创建相应的云手机实例(配置不同对应可创建的云手机数量不同)。',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-08T09:54:31.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-25T15:04:47.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-15T07:46:27.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-06-27T10:23:26.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-05-31T09:41:39.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-04-03T09:48:53.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F07A1DA1-E1EB-5CCA-8EED-12F85D32****\\",\\n \\"NodeModel\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ServerType\\": \\"cpm.gx7.10xlarge\\",\\n \\"ResolutionWidth\\": 720,\\n \\"NodeName\\": \\"node_name\\",\\n \\"Memory\\": 32,\\n \\"VSwitchId\\": \\"vsw-2zeekryyc1q3sm72l****\\",\\n \\"GmtModified\\": \\"2025-02-13 02:03:14\\",\\n \\"Cpu\\": \\"2\\",\\n \\"ResolutionHeight\\": 1280,\\n \\"NetworkId\\": \\"cn-hangzhou+dir-5mwr9azebliva****\\",\\n \\"GmtExpired\\": \\"2025-03-09 02:00:34\\",\\n \\"PhoneCount\\": 25,\\n \\"GmtCreate\\": \\"2024-11-13 02:03:14\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"NodeId\\": \\"cpn-ehs0yoedq8ntm****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceType\\": \\"ac.max\\",\\n \\"ShareDataVolume\\": 100,\\n \\"PhoneDataInfo\\": {\\n \\"PhoneDataId\\": \\"pd-dhusabisshj****\\",\\n \\"PhoneDataVolume\\": 20\\n },\\n \\"NetworkInfos\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-j6cjgev6fv3ftw4f0****\\",\\n \\"NetworkId\\": \\"cn-hangzhou+dir-avcuocx9805oq****\\",\\n \\"NetworkType\\": \\"network_pro_ecd\\",\\n \\"BandwidthPackageType\\": \\"cbwp_ecd\\",\\n \\"BandwidthPackageId\\": \\"cbwp-hn3tj409amvamz8mf****\\"\\n }\\n ],\\n \\"NetworkType\\": \\"network_pro_ecd\\",\\n \\"BandwidthPackageType\\": \\"cbwp_ecd\\",\\n \\"BandwidthPackageId\\": \\"cbwp-7xvrl7axet2qg6yia******\\",\\n \\"BizTags\\": [\\n {\\n \\"Key\\": \\"keyname\\",\\n \\"Value\\": \\"valuename\\"\\n }\\n ],\\n \\"BandwidthPackageStatus\\": \\"1\\",\\n \\"SwapSize\\": 0,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 31,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
- 'GenerateCoordinationCode' => [
- 'summary' => '云手机默认情况只能通过BatchGetAcpConnectionTicket接口获取连接Ticket,一个云手机只支持一个用户连接。如果需要多个用户连接同一个云手机。可为当前无影便捷账号连接中的云手机生成一个协同码,通过将协同码分享给其他便捷账号,则可实现其他账号连接到当前云手机的场景。',
+ 'DescribeCreditDetail' => [
+ 'summary' => '查询积分的所有变动记录',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7081,29 +4775,52 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMEHI4H',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'OwnerUserId',
+ 'name' => 'PageNum',
'in' => 'query',
+ 'schema' => ['description' => '分页的页码,默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页大小。', 'type' => 'string', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1782819840000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1782906240000'],
+ ],
+ [
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '当前实例分配的用户ID。',
- 'type' => 'string',
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh4a31emkt6u****'],
'required' => false,
- 'example' => 'xiaoming',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'PackageIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID。',
- 'type' => 'string',
+ 'description' => '套餐包/积分加油包列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '套餐包/积分加油包ID。', 'type' => 'string', 'required' => false, 'example' => 'cmag-0c1g77wjljl9h****'],
'required' => false,
- 'example' => 'acp-2zecay9ponatdc4m****',
+ 'maxItems' => 100,
],
],
],
@@ -7114,40 +4831,50 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****',
- ],
- 'CoordinatorCode' => [
- 'description' => '协同码。',
- 'type' => 'string',
- 'example' => 'CSHGDK',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC****'],
+ 'Data' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => '总明细数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageSize' => ['description' => '每页显示的条数,默认为10条,最大为100条。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNum' => ['description' => '分页的页码,默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalCreditChange' => ['description' => '总积分变动。', 'type' => 'string', 'example' => '100'],
+ 'Details' => [
+ 'description' => '积分变动详情。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '积分变动详情Item。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ChangeTime' => ['description' => '发生时间。', 'type' => 'string', 'example' => '2026-06-30T08:14:02Z'],
+ 'Description' => ['description' => '任务描述。', 'type' => 'string', 'example' => '打开小红书'],
+ 'TaskId' => ['description' => '任务 ID,全局唯一。', 'type' => 'string', 'example' => 't-1fr0k51pozyr5****'],
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-12oe0l75vl7o5****'],
+ 'CreditChange' => ['description' => '积分变化。', 'type' => 'string', 'example' => '0.7637'],
+ 'PackageId' => ['description' => '积分或套餐包ID。', 'type' => 'string', 'example' => 'cmag-0c1g77wjljl9h****'],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询积分明细。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\",\\n \\"CoordinatorCode\\": \\"CSHGDK\\"\\n}","type":"json"}]',
- 'title' => '生成协同码',
- 'description' => '<props="china">为当前无影便捷账号连接中的云手机生成一个协同码,其他便捷账号可以在云手机客户端(包括桌面端、移动端和Web端)使用该协同码连接到当前云手机,也可以通过[ApplyCoordinationWithCode](~~2863194~~)接口发起协同连接,获取协同连接凭证。</props>'."\n"
- ."\n"
- .'<props="intl">为当前无影便捷账号连接中的云手机生成一个协同码,其他便捷账号可以在云手机客户端(包括桌面端、移动端和Web端)使用该协同码连接到当前云手机。</props>',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC****\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNum\\": 1,\\n \\"TotalCreditChange\\": \\"100\\",\\n \\"Details\\": [\\n {\\n \\"ChangeTime\\": \\"2026-06-30T08:14:02Z\\",\\n \\"Description\\": \\"打开小红书\\",\\n \\"TaskId\\": \\"t-1fr0k51pozyr5****\\",\\n \\"InstanceId\\": \\"acp-12oe0l75vl7o5****\\",\\n \\"CreditChange\\": \\"0.7637\\",\\n \\"PackageId\\": \\"cmag-0c1g77wjljl9h****\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'EndCoordination' => [
- 'summary' => '云手机所有者主动结束当前云手机实例的所有协同任务,协同码将同步失效。',
+ 'DescribeCreditPackage' => [
+ 'summary' => '查询积分加油包。',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7159,39 +4886,23 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMEHI4H',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
],
'parameters' => [
[
- 'name' => 'OwnerUserId',
+ 'name' => 'CreditPackageId',
'in' => 'query',
- 'schema' => [
- 'description' => '协同发起方的用户ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xiaoming',
- ],
+ 'schema' => ['description' => '积分加油包ID。', 'type' => 'string', 'required' => false, 'example' => 'crp-xagydbhfkah****'],
],
[
- 'name' => 'CoordinatorUserId',
+ 'name' => 'CreditPackageStatus',
'in' => 'query',
'schema' => [
- 'description' => '协同参与方的用户ID。',
+ 'description' => '积分加油包状态。',
'type' => 'string',
'required' => false,
- 'example' => 'lina',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当前正在协同的实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-2zecay9ponatdc4m****',
+ 'enumValueTitles' => ['EXHAUSTED' => '积分已耗尽', 'ACTIVE' => '生效中', 'EXPIRED' => '已过期'],
+ 'example' => 'ACTIVE',
],
],
],
@@ -7202,31 +4913,45 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC****'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'IsFirstPurchase' => ['description' => '是否第一次购买。', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalAvailableCredits' => ['description' => '总的可用积分数。', 'type' => 'string', 'example' => '1000'],
+ 'TotalExhaustedCredit' => ['description' => '总的已消耗积分数。', 'type' => 'string', 'example' => '30'],
+ 'CreditsPackageInfos' => [
+ 'description' => '积分加油包信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CreditPackageId' => ['description' => '积分加油包ID。', 'type' => 'string', 'example' => 'crp-xagydbhfkah****'],
+ 'CreditPackageStatus' => ['description' => '积分加油包状态。', 'type' => 'string', 'example' => 'ACTIVE'],
+ 'EffectiveTime' => ['description' => '积分加油包的生效时间。', 'type' => 'string', 'example' => '2026-04-30 00:00:00'],
+ 'ExpiredTime' => ['description' => '积分加油包的到期时间。', 'type' => 'string', 'example' => '2026-10-30 00:00:00'],
+ 'TotalCredits' => ['description' => '当前积分加油包总积分数。', 'type' => 'string', 'example' => '100'],
+ 'ExhaustedCredits' => ['description' => '当前积分加油包已消耗积分数。', 'type' => 'string', 'example' => '30'],
+ 'AvailableCredits' => ['description' => '当前积分加油包可用积分数。', 'type' => 'string', 'example' => '70'],
+ ],
+ 'description' => '',
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询积分加油包',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\"\\n}","type":"json"}]',
- 'title' => '结束协同',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC****\\",\\n \\"TotalCount\\": 10,\\n \\"IsFirstPurchase\\": true,\\n \\"TotalAvailableCredits\\": \\"1000\\",\\n \\"TotalExhaustedCredit\\": \\"30\\",\\n \\"CreditsPackageInfos\\": [\\n {\\n \\"CreditPackageId\\": \\"crp-xagydbhfkah****\\",\\n \\"CreditPackageStatus\\": \\"ACTIVE\\",\\n \\"EffectiveTime\\": \\"2026-04-30 00:00:00\\",\\n \\"ExpiredTime\\": \\"2026-10-30 00:00:00\\",\\n \\"TotalCredits\\": \\"100\\",\\n \\"ExhaustedCredits\\": \\"30\\",\\n \\"AvailableCredits\\": \\"70\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'CreateCustomImage' => [
- 'summary' => '根据云手机实例创建自定义镜像。可以进一步通过自定义镜像创建更多相同配置的云手机。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeDisplayConfig' => [
+ 'summary' => '查询显示设置。',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7235,95 +4960,164 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneCPBVX1',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVB2A7J'],
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'AndroidInstanceIds',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '镜像id搜素',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'acp-2zecay9ponatdc4m****',
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-jewjt8xryuituz4qn-****'],
+ 'required' => false,
+ 'maxItems' => 100,
],
],
- [
- 'name' => 'ImageName',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '镜像类型',
- 'description' => '镜像名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'custom image name',
+ 'title' => 'Schema of Response',
+ 'description' => '请求信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FFEF7EFE-1E36-56D1-B5BF-5BACE43B****'],
+ 'DisplayConfigModel' => [
+ 'description' => '显示设置列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '显示设置。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AndroidInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'cpn-jewjt8xryuituz4qn-****'],
+ 'ResolutionHeight' => ['description' => '分辨率的高度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'example' => '1280'],
+ 'ResolutionWidth' => ['description' => '分辨率的宽度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'example' => '720'],
+ 'Dpi' => ['description' => 'DPI。取值范围:72~600。', 'type' => 'integer', 'format' => 'int32', 'example' => '240'],
+ 'Fps' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'],
+ 'LockResolution' => [
+ 'description' => '是否锁定分辨率。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询显示设置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FFEF7EFE-1E36-56D1-B5BF-5BACE43B****\\",\\n \\"DisplayConfigModel\\": [\\n {\\n \\"AndroidInstanceId\\": \\"cpn-jewjt8xryuituz4qn-****\\",\\n \\"ResolutionHeight\\": 1280,\\n \\"ResolutionWidth\\": 720,\\n \\"Dpi\\": 240,\\n \\"Fps\\": 0,\\n \\"LockResolution\\": \\"off\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeEdgeMobileAgentPackages' => [
+ 'summary' => '查询边缘智能体套餐包详细信息。',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '镜像名称搜素',
- 'description' => '镜像描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'create for cc5g group auth rules test',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneLI0KSA'],
+ ],
+ 'parameters' => [
[
- 'name' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '幂等参数。默认为空,长度不超过100个字符。相同的ClientToken的多次调用,只会执行一次创建操作。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20393E53-8FF1-524C-B494-B478A5369733',
- 'maxLength' => 100,
- ],
+ 'name' => 'PackageIds',
+ 'in' => 'query',
+ 'schema' => ['title' => '套餐ID列表,精确过滤,多个用逗号分隔。', 'description' => '套餐ID列表,多个ID用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'cmag-0c1g77wjljl9hc****'],
+ ],
+ [
+ 'name' => 'LicenseKeys',
+ 'in' => 'query',
+ 'schema' => ['title' => '牌照密钥列表,精确过滤,多个用逗号分隔。', 'description' => '许可证 Key列表,多个ID用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'lic-ez197xvdf0j5eo0*****'],
+ ],
+ [
+ 'name' => 'DeviceClass',
+ 'in' => 'query',
+ 'schema' => ['title' => '设备形态过滤: BOX/PHONE/PAD/OTHER。', 'description' => '设备形态过滤: BOX/PHONE/PAD/OTHER。', 'type' => 'string', 'required' => false, 'example' => 'BOX'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['title' => '套餐状态过滤。', 'description' => '套餐状态过滤。', 'type' => 'string', 'required' => false, 'example' => 'ACTIVE'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['title' => '翻页令牌,首次查询不填,后续从上次响应中获取。', 'description' => '翻页令牌,首次查询不填,后续从上次响应中获取。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU****'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页最大返回数,取值范围1~100,默认20。', 'description' => '每页最大返回数,取值范围1~100,默认20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PageListResult<ImageDTO>',
- 'description' => '返回参数。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20393E53-8FF1-524C-B494-B478A5369733',
- ],
- 'ImageId' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'example' => 'imgc-075cllfeuazh0****',
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****'],
+ 'NextToken' => ['title' => '下一页翻页令牌,为空表示无更多数据。', 'description' => '下一页翻页令牌,为空表示无更多数据。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
+ 'MaxResults' => ['title' => '本页实际返回条数。', 'description' => '本页实际返回条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalCount' => ['title' => '总记录数。', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'Packages' => [
+ 'title' => '套餐列表。',
+ 'description' => '套餐列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '存储包信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PackageId' => ['title' => '套餐ID。', 'description' => '套餐ID。', 'type' => 'string', 'example' => 'cmag-0c1g77wjljl9hc****'],
+ 'Status' => ['title' => '套餐状态。', 'description' => '套餐状态。', 'type' => 'string', 'example' => 'ACTIVE'],
+ 'DeviceClass' => ['title' => '设备形态。', 'description' => '设备形态。', 'type' => 'string', 'example' => 'BOX'],
+ 'PackageSpec' => ['title' => '套餐规格,当前仅支持hardware。', 'description' => '套餐规格,当前仅支持hardware。', 'type' => 'string', 'example' => 'hardware'],
+ 'ExpireDate' => ['title' => '过期时间。', 'description' => '过期时间。', 'type' => 'string', 'example' => '2026-01-05 10:04:07'],
+ 'LicenseKeys' => [
+ 'title' => '关联的牌照密钥列表。',
+ 'description' => '许可证 Key列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '许可证Key。', 'type' => 'string', 'example' => 'lic-ez197xvdf0j5eo0*****'],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询边缘智能体套餐包详细信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20393E53-8FF1-524C-B494-B478A5369733\\",\\n \\"ImageId\\": \\"imgc-075cllfeuazh0****\\"\\n}","type":"json"}]',
- 'title' => '创建自定义镜像',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 30,\\n \\"Packages\\": [\\n {\\n \\"PackageId\\": \\"cmag-0c1g77wjljl9hc****\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"DeviceClass\\": \\"BOX\\",\\n \\"PackageSpec\\": \\"hardware\\",\\n \\"ExpireDate\\": \\"2026-01-05 10:04:07\\",\\n \\"LicenseKeys\\": [\\n \\"lic-ez197xvdf0j5eo0*****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeImageList' => [
'summary' => '查询镜像列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7335,21 +5129,13 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone3OZQF8',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphone3OZQF8'],
],
'parameters' => [
[
'name' => 'ImageId',
'in' => 'formData',
- 'schema' => [
- 'title' => '镜像id搜素',
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'imgc-075cllfeuazh0****',
- ],
+ 'schema' => ['title' => '镜像id搜素', 'description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'imgc-075cllfeuazh0****'],
],
[
'name' => 'ImageType',
@@ -7359,23 +5145,14 @@
'description' => '镜像类型。',
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'User' => '自定义镜像',
- 'System' => '系统镜像',
- ],
+ 'enumValueTitles' => ['User' => '自定义镜像', 'System' => '系统镜像'],
'example' => 'System',
],
],
[
'name' => 'ImageName',
'in' => 'formData',
- 'schema' => [
- 'title' => '镜像名称搜素',
- 'description' => '镜像名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '安卓12系统镜像',
- ],
+ 'schema' => ['title' => '镜像名称搜素', 'description' => '镜像名称。', 'type' => 'string', 'required' => false, 'example' => 'Android 12 system image'],
],
[
'name' => 'Status',
@@ -7384,59 +5161,29 @@
'description' => '镜像的状态。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'AVAILABLE' => '可用',
- 'DELETE' => '已删除',
- 'INIT' => '初始化中',
- 'CREATE_FAILED' => '创建失败',
- 'CREATING' => '创建中',
- ],
+ 'enumValueTitles' => ['AVAILABLE' => '可用', 'DELETE' => '已删除', 'INIT' => '初始化中', 'CREATE_FAILED' => '创建失败', 'CREATING' => '创建中'],
'example' => 'AVAILABLE',
],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****',
- ],
+ 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
- ],
+ 'schema' => ['description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
],
[
'name' => 'ImagePackageType',
'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '实例规格。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpm.gx7.10xlarge',
- ],
+ 'schema' => ['description' => '实例规格。', 'type' => 'string', 'required' => false, 'example' => 'cpm.gx7.10xlarge'],
],
[
'name' => 'ImageBizTags',
@@ -7449,18 +5196,8 @@
'description' => '标签对象',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'key1',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'value1',
- ],
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'key1'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'value1'],
],
'required' => false,
],
@@ -7471,10 +5208,7 @@
[
'name' => 'SystemType',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -7484,11 +5218,7 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****',
- ],
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****'],
'Data' => [
'description' => '返回数据。',
'type' => 'array',
@@ -7496,78 +5226,31 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AliUid' => [
- 'description' => '阿里云账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '117819727354****',
- ],
- 'Description' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'example' => 'description',
- ],
- 'GmtCreate' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-02-01 10:56:36'."\n",
- ],
- 'GmtModified' => [
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '2024-02-01 10:56:36'."\n",
- ],
- 'ImageId' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'example' => 'imgc-075cllfeuazh****',
- ],
+ 'AliUid' => ['description' => '阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '117819727354****'],
+ 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'description'],
+ 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-02-01 10:56:36'."\n"],
+ 'GmtModified' => ['description' => '修改时间', 'type' => 'string', 'example' => '2024-02-01 10:56:36'."\n"],
+ 'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'imgc-075cllfeuazh****'],
'ImageType' => [
'description' => '镜像类型。',
'type' => 'string',
- 'enumValueTitles' => [
- 'User' => '自定义镜像',
- 'System' => '系统镜像',
- ],
+ 'enumValueTitles' => ['User' => '自定义镜像', 'System' => '系统镜像'],
'example' => 'System',
],
- 'Language' => [
- 'description' => '语言。',
- 'type' => 'string',
- 'example' => 'zh',
- ],
- 'ImageName' => [
- 'description' => '镜像名称。',
- 'type' => 'string',
- 'example' => 'IMAGE',
- ],
+ 'Language' => ['description' => '语言。', 'type' => 'string', 'example' => 'zh'],
+ 'ImageName' => ['description' => '镜像名称。', 'type' => 'string', 'example' => 'IMAGE'],
'ImageRegionList' => [
'description' => '可用地域列表。',
'type' => 'array',
- 'items' => [
- 'description' => '地域。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
+ 'items' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
'Status' => [
'description' => '镜像状态。',
'type' => 'string',
- 'enumValueTitles' => [
- 'AVAILABLE' => '可用',
- 'DELETE' => '已删除',
- 'INIT' => '初始化中',
- 'CREATE_FAILED' => '创建失败',
- 'CREATING' => '创建中',
- ],
+ 'enumValueTitles' => ['AVAILABLE' => '可用', 'DELETE' => '已删除', 'INIT' => '初始化中', 'CREATE_FAILED' => '创建失败', 'CREATING' => '创建中'],
'example' => 'AVAILABLE',
],
- 'SystemType' => [
- 'title' => '操作系统类型,android 9, android 12',
- 'description' => '操作系统类型。',
- 'type' => 'string',
- 'example' => 'Android 12',
- ],
+ 'SystemType' => ['title' => '操作系统类型,android 9, android 12', 'description' => '操作系统类型。', 'type' => 'string', 'example' => 'Android 12'],
'ImageRegionDistributeMap' => [
'title' => '镜像分发地域Map',
'description' => '镜像分发地域信息,key为地域,value为分发信息。',
@@ -7580,49 +5263,22 @@
'description' => '分发状态。',
'type' => 'string',
'example' => 'AVAILABLE',
- 'enumValueTitles' => [
- 'AVAILABLE' => '可用',
- 'DELETE' => '已删除',
- 'INIT' => '初始化中',
- 'CREATE_FAILED' => '创建失败',
- 'CREATING' => '创建中',
- ],
- ],
- 'Progress' => [
- 'title' => '进度',
- 'description' => '分发进度。',
- 'type' => 'string',
- 'example' => '100%',
+ 'enumValueTitles' => ['AVAILABLE' => '可用', 'DELETE' => '已删除', 'INIT' => '初始化中', 'CREATE_FAILED' => '创建失败', 'CREATING' => '创建中'],
],
+ 'Progress' => ['title' => '进度', 'description' => '分发进度。', 'type' => 'string', 'example' => '100%'],
],
'description' => '分发的信息。',
],
],
- 'ReleaseTime' => [
- 'description' => '发布时间。',
- 'type' => 'string',
- 'example' => '2024-07-25 10:06:45',
- ],
+ 'ReleaseTime' => ['description' => '发布时间。', 'type' => 'string', 'example' => '2024-07-25 10:06:45'],
'RenderingType' => [
'description' => '渲染类型。',
'type' => 'string',
- 'enumValueTitles' => [
- 'GPURemote' => 'GPURemote',
- 'CPU' => 'CPU',
- 'GPULocal' => 'GPULocal',
- ],
+ 'enumValueTitles' => ['GPURemote' => 'GPURemote', 'CPU' => 'CPU', 'GPULocal' => 'GPULocal'],
'example' => 'CPU',
- 'enum' => [
- 'CPU',
- 'GPULocal',
- 'GPURemote',
- ],
- ],
- 'ImageVersion' => [
- 'description' => '镜像版本。',
- 'type' => 'string',
- 'example' => '20241204102337',
+ 'enum' => ['CPU', 'GPULocal', 'GPURemote'],
],
+ 'ImageVersion' => ['description' => '镜像版本。', 'type' => 'string', 'example' => '20241204102337'],
'ImageBizTags' => [
'description' => '标签对象数组',
'type' => 'array',
@@ -7630,515 +5286,506 @@
'description' => '标签对象',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'key1',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'value1',
- ],
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key1'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value1'],
],
],
],
],
],
],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '620740FF-492F-5956-B1BA-361E966C0269',
- ],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '620740FF-492F-5956-B1BA-361E966C0269'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****\\",\\n \\"Data\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"Description\\": \\"description\\",\\n \\"GmtCreate\\": \\"2024-02-01 10:56:36\\\\n\\",\\n \\"GmtModified\\": \\"2024-02-01 10:56:36\\\\n\\",\\n \\"ImageId\\": \\"imgc-075cllfeuazh****\\",\\n \\"ImageType\\": \\"System\\",\\n \\"Language\\": \\"zh\\",\\n \\"ImageName\\": \\"IMAGE\\",\\n \\"ImageRegionList\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"SystemType\\": \\"Android 12\\",\\n \\"ImageRegionDistributeMap\\": {\\n \\"key\\": {\\n \\"DistributeStatus\\": \\"AVAILABLE\\",\\n \\"Progress\\": \\"100%\\"\\n }\\n },\\n \\"ReleaseTime\\": \\"2024-07-25 10:06:45\\",\\n \\"RenderingType\\": \\"CPU\\",\\n \\"ImageVersion\\": \\"20241204102337\\",\\n \\"ImageBizTags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 30,\\n \\"RequestId\\": \\"620740FF-492F-5956-B1BA-361E966C0269\\"\\n}","type":"json"}]',
'title' => '查询镜像列表',
- ],
- 'UpdateCustomImageName' => [
- 'summary' => '更新自定义镜像名称。',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-25T15:04:47.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-03-14T09:57:38.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-01-22T12:26:49.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-07-24T09:35:49.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeInvocations' => [
+ 'summary' => '查询RunCommand接口命令执行结果。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneCPBVX1',
- ],
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'ImageId',
- 'in' => 'formData',
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'imgc-075cllfeuazh0****',
+ 'description' => '云手机实例ID列表,一次请求最多查询50个实例的执行结果。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-bj9t2gmys****'],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'minItems' => 1,
],
],
[
- 'name' => 'ImageName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '镜像名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'imagename',
- 'maxLength' => 30,
- ],
+ 'name' => 'InvocationId',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令执行ID,根据该ID和云手机实例ID可查询一次命令执行的结果。', 'type' => 'string', 'required' => true, 'example' => 't-4e98eeb5****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
+ 'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '552B7EED-D434-511F-B838-29EA4E906034',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '440D7342-5E7C-B2DB-D0B4EAC2BDF1****'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'string', 'example' => '10'],
+ 'Data' => [
+ 'description' => '返回结果列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InvocationId' => ['description' => '命令执行ID。', 'type' => 'string', 'example' => 't-15775dc8****'],
+ 'StartTime' => ['description' => '命令开始执行时间。', 'type' => 'string', 'example' => '2022-08-11 17:45:03'],
+ 'FinishTime' => ['description' => '命令结束执行时间。', 'type' => 'string', 'example' => '2022-08-11 17:45:03'],
+ 'Output' => ['description' => '命令执行输出的结果。', 'type' => 'string', 'example' => 'success'],
+ 'InstanceId' => ['description' => '执行当前命令的实例ID。', 'type' => 'string', 'example' => 'acp-uto81vfd8t8z****'],
+ 'InvocationStatus' => [
+ 'description' => '命令执行进度状态。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['Failed' => '执行失败', 'Timeout' => '执行超时', 'Running' => '执行中', 'Success' => '执行成功', 'Pending' => '等待执行'],
+ 'example' => 'Running',
+ ],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询命令执行结果',
+ 'description' => '此接口即将下线,推荐使用[DescribeTasks](~~2833926~~)接口查询命令执行进度和结果。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"552B7EED-D434-511F-B838-29EA4E906034\\"\\n}","type":"json"}]',
- 'title' => '更新自定义镜像名称',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"440D7342-5E7C-B2DB-D0B4EAC2BDF1****\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"Data\\": [\\n {\\n \\"InvocationId\\": \\"t-15775dc8****\\",\\n \\"StartTime\\": \\"2022-08-11 17:45:03\\",\\n \\"FinishTime\\": \\"2022-08-11 17:45:03\\",\\n \\"Output\\": \\"success\\",\\n \\"InstanceId\\": \\"acp-uto81vfd8t8z****\\",\\n \\"InvocationStatus\\": \\"Running\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DistributeImage' => [
- 'summary' => '分发镜像。如需要在更多的地域使用此镜像,可使用分发镜像功能,将镜像文件传输到各个地域,支撑各地域根据该镜像创建云手机的需求。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeJVSInstance' => [
+ 'path' => '/anonymous/jvs/instance/describe',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone3OZQF8',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
],
'parameters' => [
[
- 'name' => 'DistributeRegionList',
- 'in' => 'formData',
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '分发地域列表。',
+ 'title' => '实例ID列表',
+ 'description' => '实例ID列表',
'type' => 'array',
- 'items' => [
- 'description' => '分发地域。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
- 'required' => true,
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh431emkt6u*****'],
+ 'required' => false,
'maxItems' => 100,
- 'minItems' => 1,
],
],
[
- 'name' => 'ImageId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'imgc-075cllfeuazh0****',
- ],
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页游标', 'description' => '分页游标', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => '返回参数。',
+ 'title' => 'ListResult<JVSInstanceModel>',
+ 'description' => 'ListResult<JVSInstanceModel>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '440D7342-5FC2-5E7C-B2DB-D0B4EAC2BDF1',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'MaxResults' => ['description' => '本次读取的最大数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'NextToken' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'Data' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-uto81vfd8t8z****'],
+ 'CreditConfig' => [
+ 'description' => 'Credit限额配置。多次下发后续配额配置会覆盖之前配置。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Credit 限额配置对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreditLimit' => [
+ 'description' => '限额大小。',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'enumValueTitles' => ['不可使用', '>0' => '按照数字配置限额', -1 => '不限额'],
+ 'example' => '-1',
+ ],
+ 'LimitPeriod' => [
+ 'description' => '限额周期。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['total' => '使用总上限', 'month' => '月,按照资源开通时间为一个周期清空', 'day' => '天,0点清空'],
+ 'example' => 'day',
+ ],
+ ],
+ ],
+ ],
+ 'UsedCredit' => [
+ 'description' => '已经使用的Credit。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Credit' => ['description' => 'Credit数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'LimitPeriod' => [
+ 'description' => '当前Credit所在的维度。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['total' => '使用总上限', 'month' => '月,按照资源开通时间为一个周期清空', 'day' => '天,0点清空'],
+ 'example' => 'day',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'JvsPackageId' => ['description' => '暂不支持该参数。', 'type' => 'string', 'example' => 'null'],
+ 'Status' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'RUNNNING'],
+ 'CreateTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2026-04-10T01:31:32Z'],
+ 'ModifyTime' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2026-04-10T01:31:32Z'],
+ 'ExpireTime' => ['description' => '过期时间。', 'type' => 'string', 'example' => '2026-04-10T01:31:32Z'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询JVS实例信息',
+ 'summary' => '查询JVS实例信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"440D7342-5FC2-5E7C-B2DB-D0B4EAC2BDF1\\"\\n}","type":"json"}]',
- 'title' => '分发镜像',
- 'description' => '已分发地域不支持取消。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"TotalCount\\": 30,\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"acp-uto81vfd8t8z****\\",\\n \\"CreditConfig\\": [\\n {\\n \\"CreditLimit\\": -1,\\n \\"LimitPeriod\\": \\"day\\"\\n }\\n ],\\n \\"UsedCredit\\": [\\n {\\n \\"Credit\\": 5,\\n \\"LimitPeriod\\": \\"day\\"\\n }\\n ],\\n \\"JvsPackageId\\": \\"null\\",\\n \\"Status\\": \\"RUNNNING\\",\\n \\"CreateTime\\": \\"2026-04-10T01:31:32Z\\",\\n \\"ModifyTime\\": \\"2026-04-10T01:31:32Z\\",\\n \\"ExpireTime\\": \\"2026-04-10T01:31:32Z\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DeleteImages' => [
- 'summary' => '删除自定义镜像。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeKeyPairs' => [
+ 'summary' => '查询一个或多个密钥对。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneXWUML7',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneDADB6I'],
],
'parameters' => [
[
- 'name' => 'ImageIds',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'KeyPairIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '镜像ID列表。',
+ 'description' => '密钥对ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'imgc-kjsdfkjsk****',
- ],
- 'required' => true,
+ 'items' => ['description' => 'ADB密钥对ID。', 'type' => 'string', 'required' => false, 'example' => 'kp-6v2q33ae4tw3*****'],
+ 'required' => false,
+ 'maxItems' => 100,
],
],
+ [
+ 'name' => 'KeyPairName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'ADB密钥对名称。', 'type' => 'string', 'required' => false, 'example' => 'testKeyPairName'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAYRHtOLVQzCYj17y+OP7LZQBUVVbi0GTu8g5****'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<DeleteImagesResp>',
+ 'title' => 'PlainResult<NextTokenListResult<KeyPairModel>>',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。', 'type' => 'string', 'example' => 'FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0****'],
'Data' => [
- 'description' => '删除结果。',
- 'type' => 'object',
- 'properties' => [
- 'SuccessDeleteImageIds' => [
- 'title' => '成功删除的镜像id',
- 'description' => '删除成功的镜像ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '删除成功的镜像ID。',
- 'type' => 'string',
- 'example' => 'imgc-jkafjsjk****',
- ],
- ],
- 'FailDeleteImageIds' => [
- 'title' => '失败删除的镜像id',
- 'description' => '删除失败的镜像ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '删除失败的镜像ID。',
- 'type' => 'string',
- 'example' => 'imgc-sjkdfs8****',
- ],
+ 'description' => '返回结果对象列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'KeyPairId' => ['description' => 'ADB密钥对的ID。', 'type' => 'string', 'example' => 'kp-6v2q33ae4tw3a****'],
+ 'KeyPairName' => ['description' => 'ADB密钥对名称。', 'type' => 'string', 'example' => 'testKeyPairName'],
+ 'GmtCreated' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2022-10-11T08:53:32Z'],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '4610632D-D661-5982-B3D7-5D3FD183F595',
- ],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '565FB06A-AE04-5AD0-8A32-5BA92CA5****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SuccessDeleteImageIds\\": [\\n \\"imgc-jkafjsjk****\\"\\n ],\\n \\"FailDeleteImageIds\\": [\\n \\"imgc-sjkdfs8****\\"\\n ]\\n },\\n \\"RequestId\\": \\"4610632D-D661-5982-B3D7-5D3FD183F595\\"\\n}","type":"json"}]',
- 'title' => '删除自定义镜像',
- 'description' => '实例组正在使用中的镜像不可被删除。',
- ],
- 'CreateApp' => [
- 'summary' => '创建 Android 应用。在进行应用安装前,必须先使用本接口进行应用创建。应用创建时不会进行应用下载,安装时才会进行下载操作,须确保云手机与下载URL的网络可达性。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => '查询ADB密钥对',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0****\\",\\n \\"Data\\": [\\n {\\n \\"KeyPairId\\": \\"kp-6v2q33ae4tw3a****\\",\\n \\"KeyPairName\\": \\"testKeyPairName\\",\\n \\"GmtCreated\\": \\"2022-10-11T08:53:32Z\\"\\n }\\n ],\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"565FB06A-AE04-5AD0-8A32-5BA92CA5****\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeMetricLast' => [
+ 'summary' => '查询实例或矩阵的最新监控数据。支持 CPU、内存、磁盘、网络等监控数据的查询。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneRPX4AN',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVQDPK9'],
],
'parameters' => [
[
- 'name' => 'AppName',
- 'in' => 'query',
+ 'name' => 'MetricNames',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'App名称',
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '应用名称1',
+ 'description' => '监控指标列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '监控项名称。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'cpu_utilization' => 'CPU使用率', 'diskusage_utilization' => '存储使用率', 'bandwidth_package_usage_out' => '带宽包流出带宽(仅限标准网络)', 'memory_used_utilization' => '内存使用率', 'intranet_out_rate' => '连接流出带宽', 'gpu_memory_used_utilization' => 'GPU显存使用率(仅限矩阵)', 'bandwidth_package_usage_in' => '带宽包流入带宽(仅限标准网络)', 'process_memory' => '进程内存使用率', 'intranet_in_rate' => '连接流入带宽', 'process_cpu' => '进程cpu使用率',
+ 'gpu_used_utilization' => 'GPU使用率(仅限矩阵)',
+ ],
+ 'example' => 'cpu_utilization',
+ ],
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'maxItems' => 100,
],
],
[
- 'name' => 'FileName',
- 'in' => 'query',
+ 'name' => 'AndroidInstanceIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'App文件名称',
- 'description' => '应用文件在OSS中的存储名称。该参数与`FilePath`共同确定唯一的OSS地址。'."\n"
+ 'description' => '实例级别的监控,传入云手机实例ID列表。'."\n"
."\n"
- .'> * 若选择传入无影应用中心的应用,则必须传入`FileName`+`FilePath`或`OssAppUrl`,前者优先级更高。'."\n"
- .'> * 请登录[无影云电脑企业版控制台](https://eds.console.aliyun.com/osshelp),并根据该页面提示将您的应用文件上传至无影应用中心,以便获得此参数。',
- 'type' => 'string',
+ .'<props="china">矩阵级别的监控,传入矩阵ID列表。</props>',
+ 'type' => 'array',
+ 'items' => ['description' => '实例级别的监控,传入云手机实例ID。 '."\n"
+ .'<props="china">矩阵级别的监控,传入矩阵ID。</props>', 'type' => 'string', 'required' => false, 'example' => 'acp-6nongia0tuev7****'],
'required' => false,
- 'example' => 'testApp.apk',
+ 'maxItems' => 50,
],
],
[
- 'name' => 'FilePath',
- 'in' => 'query',
+ 'name' => 'Period',
+ 'in' => 'formData',
'schema' => [
- 'title' => 'App文件地址',
- 'description' => '应用文件的OSS Bucket存储地址。该参数与`FileName`共同确定唯一的OSS地址。'."\n"
+ 'description' => '监控数据的统计周期。'."\n"
."\n"
- .'> * 若选择传入无影应用中心的应用,则必须传入`FileName`+`FilePath`或`OssAppUrl`,前者优先级更高。'."\n"
- .'> * 请登录[无影云电脑企业版控制台](https://eds.console.aliyun.com/osshelp),并根据该页面提示将您的应用文件上传至无影应用中心,以便获得此参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tenant/1642150****/',
- ],
- ],
- [
- 'name' => 'IconUrl',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'App icon地址',
- 'description' => '应用图标地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://www.example.com/icon.png',
- ],
- ],
- [
- 'name' => 'OssAppUrl',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'App oss地址',
- 'description' => '应用的OSS地址。'."\n"
+ .'取值:60、900 和 3600。'."\n"
."\n"
- .'> * 若选择传入无影应用中心的应用,则必须传入`FileName`+`FilePath`或`OssAppUrl`,前者优先级更高。'."\n"
- .'> * 请登录[无影云电脑企业版控制台](https://eds.console.aliyun.com/osshelp),并根据该页面提示将您的应用文件上传至无影应用中心,以便获得此参数。',
- 'type' => 'string',
+ .'单位:秒。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => 'http://testApp.apk',
+ 'enumValueTitles' => [60 => '60', 900 => '900', 3600 => '3600'],
+ 'example' => '60',
],
],
[
- 'name' => 'BizRegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '查询监控项的开始时间。', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:00:00'],
],
[
- 'name' => 'InstallParam',
- 'in' => 'query',
- 'schema' => [
- 'description' => '安装参数。安装应用时默认自带`-r`安装参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-d',
- ],
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '查询监控项的结束时间。', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 11:00:00'],
],
[
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '应用描述',
- ],
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用来标记当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****'],
],
[
- 'name' => 'CustomAppInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '自定义应用信息。'."\n"
- ."\n"
- .'> * 若选择传入自定义应用,请传入`CustomAppInfo`参数,且该object参数包含的6个字段均为必填,必须全部传入。'."\n"
- .'> * 自定义应用的优先级高于无影应用中心的应用,若传入`CustomAppInfo`参数,则`FileName`+`FilePath`或`OssAppUrl`都将失效。',
- 'type' => 'object',
- 'properties' => [
- 'DownloadUrl' => [
- 'description' => '应用下载地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://testApp.apk',
- 'maxLength' => 1024,
- ],
- 'Version' => [
- 'description' => '应用版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.0',
- 'maxLength' => 64,
- ],
- 'VersionCode' => [
- 'description' => '应用版本代码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10000',
- 'maxLength' => 64,
- ],
- 'PackageName' => [
- 'description' => '应用包名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'com.example.demo',
- 'maxLength' => 128,
- ],
- 'ApkSize' => [
- 'description' => '.apk文件的大小。单位:MB。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- 'maxLength' => 128,
- ],
- 'Md5' => [
- 'description' => '.apk包的MD5值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'df3f46ce5844ddb278f14c5a9cd2****',
- 'maxLength' => 128,
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'Length',
+ 'in' => 'formData',
+ 'schema' => ['description' => '返回监控数据的每页大小,用于分页查询。'."\n"
+ ."\n"
+ .'默认值:1000,即每页 1000 条监控数据。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
[
- 'name' => 'SignApk',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '是否需要进行系统签名',
- 'type' => 'string',
+ 'title' => '指定监控资源的维度'."\n",
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['title' => '实例id', 'description' => '实例ID。'."\n"
+ ."\n"
+ .'> 传入带宽包ID,可查询带宽包最新带宽数据', 'type' => 'string', 'required' => false, 'example' => 'np-5hh4a31emkt6u****'."\n"],
'required' => false,
- 'enumValueTitles' => [
- 'false' => '不需要签名',
- 'true' => '需要签名',
- ],
- 'example' => 'false',
+ 'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => '返回参数。',
+ 'title' => 'Schema of Response',
+ 'description' => '接口返回数据。',
'type' => 'object',
'properties' => [
- 'AppId' => [
- 'description' => '应用ID。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1234',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E5138F7E-46B5-526A-8C99-82DEAE6B****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2B9E6946-0E2A-5D2B-B275-361DF81F****'],
+ 'Count' => ['description' => '数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'NextToken' => ['description' => '下一次查询的令牌(Token)。如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
+ 'MetricTotalModel' => [
+ 'description' => '实例监控结果列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '实例监控结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AndroidInstanceId' => ['description' => '实例级别的监控,返回云手机实例ID。 '."\n"
+ .'<props="china">矩阵级别的监控,返回矩阵ID。</props>', 'type' => 'string', 'example' => 'acp-fkuit0cmyru4p****'],
+ 'MetricModelList' => [
+ 'description' => '指标监控结果列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '指标监控结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'MetricName' => ['description' => '监控项名称。', 'type' => 'string', 'example' => 'cpu_utilization'],
+ 'DataPoints' => [
+ 'description' => '监控统计数据点列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '监控统计数据点。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Timestamp' => ['description' => '统计时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1548777660000'],
+ 'Minimum' => ['description' => '最小值。单位:%。'."\n"
+ .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。', 'type' => 'number', 'format' => 'double', 'example' => '93.1'],
+ 'Average' => ['description' => '平均值。单位:%。'."\n"
+ .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。', 'type' => 'number', 'format' => 'double', 'example' => '99.52'],
+ 'Maximum' => ['description' => '最大值。单位:%。'."\n"
+ .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。', 'type' => 'number', 'format' => 'double', 'example' => '100'],
+ 'GpuId' => ['description' => '显卡ID。', 'type' => 'string', 'example' => 'cpn-1t1bxvp9az2pk****-gpu-0'],
+ ],
+ ],
+ ],
+ 'ProcessLastInfos' => [
+ 'description' => '进程监控指标列表。'."\n"
+ ."\n"
+ .'> 监控项为process_cpu和process_memory时返回此项。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '进程监控指标。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Timestamp' => ['description' => '统计时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1548777660000'],
+ 'Name' => ['description' => '进程名。', 'type' => 'string', 'example' => 'com.offerup'],
+ 'ProcessIds' => [
+ 'description' => '进程号列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '进程号。', 'type' => 'integer', 'format' => 'int32', 'example' => '100056'],
+ ],
+ 'MemoryUsage' => ['description' => '存储使用率。单位:%。', 'type' => 'number', 'format' => 'double', 'example' => '50'],
+ 'CpuUsage' => ['description' => 'CPU使用率。单位:%。', 'type' => 'number', 'format' => 'double', 'example' => '50'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": 1234,\\n \\"RequestId\\": \\"E5138F7E-46B5-526A-8C99-82DEAE6B****\\"\\n}","type":"json"}]',
- 'title' => '创建应用',
- 'description' => '创建应用时,您可以选择以下两种方式中的一种来传入应用信息:'."\n"
- ."\n"
- .'- 方式1:传入无影应用中心的应用。'."\n"
- .' - 支持的传入方法:'."\n"
- .' - 方法1:传入`FileName`+`FilePath`(两个参数需同时传入)。'."\n"
- .' - 方法2:传入`OssAppUrl`。'."\n"
- .' - 规则:若传入无影应用中心的应用,则方法1和方法2之中必须至少使用1种;若同时使用两种方法,则以方法1为准。'."\n"
- .' - 前置条件:请登录[无影云电脑企业版控制台](https://eds.console.aliyun.com/osshelp),并根据该页面提示将您的应用文件上传至无影应用中心,以便获得本接口所需的必填请求参数(`FileName`+`FilePath`或`OssAppUrl`)。'."\n"
- .'- 方式2:传入自定义应用。'."\n"
- .' - 支持的传入方法:传入`CustomAppInfo`。'."\n"
- .' - 规则:若选择传入`CustomAppInfo`,则该object参数包含的6个字段均为必填,必须全部传入。'."\n"
- ."\n"
- .'> 若同时使用方式1和方式2,则以方式2传入的信息为准。',
- ],
- 'DescribeApps' => [
- 'summary' => '查询已创建的应用信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B9E6946-0E2A-5D2B-B275-361DF81F****\\",\\n \\"Count\\": 100,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MetricTotalModel\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-fkuit0cmyru4p****\\",\\n \\"MetricModelList\\": [\\n {\\n \\"MetricName\\": \\"cpu_utilization\\",\\n \\"DataPoints\\": [\\n {\\n \\"Timestamp\\": 1548777660000,\\n \\"Minimum\\": 93.1,\\n \\"Average\\": 99.52,\\n \\"Maximum\\": 100,\\n \\"GpuId\\": \\"cpn-1t1bxvp9az2pk****-gpu-0\\"\\n }\\n ],\\n \\"ProcessLastInfos\\": [\\n {\\n \\"Timestamp\\": 1548777660000,\\n \\"Name\\": \\"com.offerup\\",\\n \\"ProcessIds\\": [\\n 100056\\n ],\\n \\"MemoryUsage\\": 50,\\n \\"CpuUsage\\": 50\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询指定云机的最新监控数据',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeMetricList' => [
+ 'summary' => '查询指定监控项的监控数据,支持网络带宽等监控数据的查询。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8150,252 +5797,169 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone4KHDE1',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVQDPK9'],
],
'parameters' => [
[
- 'name' => 'AppIdList',
- 'in' => 'query',
+ 'name' => 'MetricNames',
+ 'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => '应用ID列表。',
+ 'description' => '监控指标列表。',
'type' => 'array',
'items' => [
- 'description' => '应用ID。',
+ 'description' => '监控项名称。',
'type' => 'string',
'required' => false,
- 'example' => '1234',
+ 'enumValueTitles' => [
+ 'cpu_utilization' => 'CPU使用率', 'bandwidth_package_usage_out' => '带宽包流出带宽(仅限标准网络)', 'diskusage_utilization' => '存储使用率', 'memory_used_utilization' => '内存使用率', 'intranet_out_rate' => '连接流出带宽', 'gpu_memory_used_utilization' => 'GPU显存使用率(仅限矩阵)', 'bandwidth_package_usage_in' => '带宽包流入带宽(仅限标准网络)', 'process_memory' => '进程内存使用率', 'intranet_in_rate' => '连接流入带宽', 'process_cpu' => '进程cpu使用率',
+ 'gpu_used_utilization' => 'GPU使用率(仅限矩阵)',
+ ],
+ 'example' => 'bandwidth_package_usage_in',
],
- 'required' => false,
+ 'required' => true,
'maxItems' => 100,
- 'minItems' => 1,
],
],
[
- 'name' => 'AppName',
- 'in' => 'query',
+ 'name' => 'AndroidInstanceIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
+ 'description' => '实例级别的监控,传入云手机实例ID列表。'."\n"
+ ."\n"
+ .'<props="china">矩阵级别的监控,传入矩阵ID列表。</props>',
+ 'type' => 'array',
+ 'items' => ['description' => '实例级别的监控,传入云手机实例ID。 '."\n"
+ .'<props="china">矩阵级别的监控,传入矩阵ID。</props>', 'type' => 'string', 'required' => false, 'example' => 'cpn-25nt4kk9whhok****'],
'required' => false,
- 'example' => '应用名称',
+ 'maxItems' => 50,
],
],
[
- 'name' => 'BizRegionId',
- 'in' => 'query',
+ 'name' => 'InstanceIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '应用的地域ID。',
- 'type' => 'string',
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。'."\n"
+ .'> 传入带宽包ID,可查询带宽包带宽数据', 'type' => 'string', 'required' => false, 'example' => 'np-5hh4a31emkt6u****'],
'required' => false,
- 'example' => 'cn-hangzhou',
+ 'maxItems' => 50,
],
],
[
- 'name' => 'Status',
- 'in' => 'query',
+ 'name' => 'ProcessInfos',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '应用创建状态。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'FAILED' => '创建失败',
- 'NORMAL' => '正常',
- 'CREATING' => '创建中',
+ 'description' => '进程监控指标列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '进程监控指标。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProcessName' => ['description' => '进程名称。', 'type' => 'string', 'required' => false, 'example' => 'php-fpm'],
+ 'ProcessIds' => [
+ 'description' => '进程号列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '进程号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'approval-process-c47080c1f238e889'],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ 'required' => false,
],
- 'example' => 'NORMAL',
+ 'required' => false,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'InstallationStatus',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用的安装/卸载状态。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'INSTALLFAILED' => '安装失败',
- 'UNINSTALLING' => '卸载中',
- 'INSTALLING' => '安装中',
- 'UNINSTALLED' => '卸载完成',
- 'INSTALLED' => '安装完成',
- 'UNINSTALLFAILED' => '卸载失败',
- ],
- 'example' => 'INSTALLING',
- ],
+ 'name' => 'Period',
+ 'in' => 'formData',
+ 'schema' => ['description' => '监控数据的统计周期。'."\n"
+ ."\n"
+ .'取值:60、900 和 3600。'."\n"
+ ."\n"
+ .'单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
],
[
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'example' => '10',
- ],
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '查询监控项的开始时间。', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:00:00'],
],
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****',
- ],
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '查询监控项的结束时间。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => '2019-01-31 11:00:00'],
],
[
- 'name' => 'MD5',
- 'in' => 'query',
- 'schema' => [
- 'description' => '.apk文件的MD5值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '009ee07fe13a29fa0c180ed0b6bc****',
- ],
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用来标记当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****'],
],
[
- 'name' => 'AppType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-',
- ],
+ 'name' => 'Length',
+ 'in' => 'formData',
+ 'schema' => ['description' => '返回监控数据的每页大小,用于分页查询。'."\n"
+ ."\n"
+ .'默认值:1000,即每页 1000 条监控数据。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => '接口返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'CB95E410-FD1D-53C5-9F7D-93CC44D7****',
- ],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****',
- ],
- 'Data' => [
- 'description' => '返回结果对象。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'Count' => ['description' => '数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'NextToken' => ['description' => '下一次查询的令牌(Token)。如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
+ 'MetricTotalModel' => [
+ 'description' => '实例监控结果列表。',
'type' => 'array',
'items' => [
- 'description' => '返回结果对象。',
+ 'description' => '实例监控结果。',
'type' => 'object',
'properties' => [
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'testapp',
- ],
- 'AppId' => [
- 'description' => '应用ID。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10404',
- ],
- 'AndroidAppVersion' => [
- 'description' => '应用版本。',
- 'type' => 'string',
- 'example' => '1.0.0',
- ],
- 'IconUrl' => [
- 'description' => '应用图标地址。',
- 'type' => 'string',
- 'example' => 'https://test.png',
- ],
- 'InstanceGroupList' => [
- 'description' => '应用已经安装的实例组列表。',
+ 'AndroidInstanceId' => ['description' => '实例级别的监控,返回云手机实例ID。 '."\n"
+ .'<props="china">矩阵级别的监控,返回矩阵ID。</props>', 'type' => 'string', 'example' => 'acp-fkuit0cmyru4p****'],
+ 'MetricModelList' => [
+ 'description' => '指标监控结果列表。',
'type' => 'array',
'items' => [
- 'description' => '应用安装的实例组ID。',
- 'type' => 'string',
- 'example' => 'ag-fasf****',
- ],
- ],
- 'GmtCreate' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2022-08-11 17:45:03',
- ],
- 'GmtModified' => [
- 'description' => '最近一次修改时间。',
- 'type' => 'string',
- 'example' => '2022-08-11 17:45:03',
- ],
- 'Description' => [
- 'description' => '应用描述。',
- 'type' => 'string',
- 'example' => 'CustomApp',
- ],
- 'Status' => [
- 'description' => '应用状态。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'FAILED' => '创建失败',
- 'NORMAL' => '正常',
- 'CREATING' => '创建中',
- ],
- 'example' => 'NORMAL',
- ],
- 'InstallationStatus' => [
- 'description' => '应用的安装/卸载状态。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'INSTALLFAILED' => '安装失败',
- 'UNINSTALLING' => '卸载中',
- 'INSTALLING' => '安装中',
- 'UNINSTALLED' => '卸载完成',
- 'INSTALLED' => '安装完成',
- 'UNINSTALLFAILED' => '卸载失败',
- ],
- 'example' => 'INSTALLING',
- ],
- 'BizRegionId' => [
- 'description' => '应用的地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'PackageName' => [
- 'description' => '应用包名。',
- 'type' => 'string',
- 'example' => 'com.example.chinalife',
- ],
- 'ApkSize' => [
- 'description' => '.apk文件的大小。单位:MB。',
- 'type' => 'string',
- 'example' => '2.7',
- ],
- 'MD5' => [
- 'description' => '.apk文件的MD5值。',
- 'type' => 'string',
- 'example' => '009ee07fe13a29fa0c180ed0b6bc****',
- ],
- 'AppType' => [
- 'description' => '应用类型',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Normal' => '普通应用',
- 'System_Signature' => '系统签名应用',
+ 'description' => '指标监控结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'MetricName' => ['description' => '监控项名称。', 'type' => 'string', 'example' => 'cpu_utilization'],
+ 'ProcessName' => ['description' => '进程名称。', 'type' => 'string', 'example' => 'Required'],
+ 'DataPoints' => [
+ 'description' => '监控统计数据点列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '监控统计数据点。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Timestamp' => ['description' => '统计时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1548777660000'],
+ 'Minimum' => ['description' => '最小值。单位:%。'."\n"
+ .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。', 'type' => 'number', 'format' => 'double', 'example' => '93.1'],
+ 'Average' => ['description' => '平均值。单位:%。'."\n"
+ .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。', 'type' => 'number', 'format' => 'double', 'example' => '99.52'],
+ 'Maximum' => ['description' => '最大值。单位:%。'."\n"
+ .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。', 'type' => 'number', 'format' => 'double', 'example' => '100'],
+ 'Value' => ['description' => '数据值。单位:%。'."\n"
+ .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。', 'type' => 'number', 'format' => 'double', 'example' => 'tf-testacc-oos-parameter'],
+ 'GpuId' => ['description' => '显卡ID。', 'type' => 'string', 'example' => 'cpn-1t1bxvp9az2pk****-gpu-0'."\n"],
+ ],
+ ],
+ ],
+ ],
],
- 'example' => 'Normal',
],
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'np-5hh4a31emkt6u****'."\n"],
],
],
],
@@ -8403,136 +5967,106 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询指定监控项的监控数据',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB95E410-FD1D-53C5-9F7D-93CC44D7****\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****\\",\\n \\"Data\\": [\\n {\\n \\"AppName\\": \\"testapp\\",\\n \\"AppId\\": 10404,\\n \\"AndroidAppVersion\\": \\"1.0.0\\",\\n \\"IconUrl\\": \\"https://test.png\\",\\n \\"InstanceGroupList\\": [\\n \\"ag-fasf****\\"\\n ],\\n \\"GmtCreate\\": \\"2022-08-11 17:45:03\\",\\n \\"GmtModified\\": \\"2022-08-11 17:45:03\\",\\n \\"Description\\": \\"CustomApp\\",\\n \\"Status\\": \\"NORMAL\\",\\n \\"InstallationStatus\\": \\"INSTALLING\\",\\n \\"BizRegionId\\": \\"cn-hangzhou\\",\\n \\"PackageName\\": \\"com.example.chinalife\\",\\n \\"ApkSize\\": \\"2.7\\",\\n \\"MD5\\": \\"009ee07fe13a29fa0c180ed0b6bc****\\",\\n \\"AppType\\": \\"Normal\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询应用信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MetricTotalModel\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-fkuit0cmyru4p****\\",\\n \\"MetricModelList\\": [\\n {\\n \\"MetricName\\": \\"cpu_utilization\\",\\n \\"ProcessName\\": \\"Required\\",\\n \\"DataPoints\\": [\\n {\\n \\"Timestamp\\": 1548777660000,\\n \\"Minimum\\": 93.1,\\n \\"Average\\": 99.52,\\n \\"Maximum\\": 100,\\n \\"Value\\": 0,\\n \\"GpuId\\": \\"cpn-1t1bxvp9az2pk****-gpu-0\\\\n\\"\\n }\\n ]\\n }\\n ],\\n \\"InstanceId\\": \\"np-5hh4a31emkt6u****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'ModifyApp' => [
- 'summary' => '修改应用信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeMetricTop' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVQDPK9'],
],
'parameters' => [
[
- 'name' => 'AppId',
- 'in' => 'query',
+ 'name' => 'MetricNames',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '应用ID。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1234',
+ 'description' => '监控指标列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '监控项名称。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['instance_out_traffic' => '流出带宽(仅限标准网络)', 'instance_in_traffic' => '流入带宽(仅限标准网络)'],
+ 'example' => 'instance_in_traffic',
+ ],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'AppName',
- 'in' => 'query',
+ 'name' => 'AndroidInstanceIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
+ 'description' => '实例级别的监控,传入云手机实例ID列表。'."\n"
+ ."\n"
+ .'<props="china">矩阵级别的监控,传入矩阵ID列表。</props>',
+ 'type' => 'array',
+ 'items' => ['description' => '实例级别的监控,传入云手机实例ID。 '."\n"
+ .'<props="china">矩阵级别的监控,传入矩阵ID。</props>', 'type' => 'string', 'required' => false, 'example' => 'acp-sgicbcdadjs****'],
'required' => false,
- 'example' => '应用名称',
+ 'maxItems' => 50,
],
],
[
- 'name' => 'IconUrl',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Icon地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://defaultIcon.png',
- ],
+ 'name' => 'Period',
+ 'in' => 'formData',
+ 'schema' => ['description' => '监控数据的统计周期。'."\n"
+ .'单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
],
[
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '应用描述',
- ],
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '查询监控项的开始时间。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:00:00'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '83418504-5A82-5896-A24C-B2D468F0****',
- ],
- ],
- ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '查询监控项的结束时间。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => '2019-01-31 11:00:00'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"83418504-5A82-5896-A24C-B2D468F0****\\"\\n}","type":"json"}]',
- 'title' => '修改应用信息',
- ],
- 'DeleteApps' => [
- 'summary' => '删除应用。'."\n"
- .'删除时需保证该应用未安装在任何实例组。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用来标记当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****'],
],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
- 'parameters' => [
[
- 'name' => 'AppIdList',
- 'in' => 'query',
+ 'name' => 'Length',
+ 'in' => 'formData',
+ 'schema' => ['description' => '返回监控数据的每页大小,用于分页查询。'."\n"
+ .'> 监控项为instance_in_traffic和instance_out_traffic时,最大值为100。', 'type' => 'string', 'required' => false, 'example' => '100'],
+ ],
+ [
+ 'name' => 'InstanceIds',
+ 'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => '应用ID列表。',
+ 'description' => '实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '应用ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1234',
- ],
+ 'items' => ['description' => '实例ID。'."\n"
+ ."\n"
+ .'> 传入带宽包ID,可查询带宽包下按带宽降序后Top N (N 小于等于100)带宽数据', 'type' => 'string', 'required' => false, 'example' => 'np-5hh4a31emkt6u****'],
'required' => false,
- 'maxItems' => 100,
- 'minItems' => 1,
+ 'maxItems' => 50,
],
],
],
@@ -8540,34 +6074,75 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => '接口返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '310A783E-CC46-5452-A8A3-71AE5DB5****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4610632D-D661-5982-B3D7-5D3FD183F****'],
+ 'Count' => ['description' => '数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'NextToken' => ['description' => '下一次查询的令牌(Token)。如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
+ 'MetricTotalModel' => [
+ 'description' => '实例监控结果列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '实例监控结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AndroidInstanceId' => ['description' => '实例级别的监控,返回云手机实例ID。 '."\n"
+ .'<props="china">矩阵级别的监控,返回矩阵ID。</props>', 'type' => 'string', 'example' => 'acp-fkuit0cmyru4p****'],
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'np-5hh4a31emkt6u****'],
+ 'MetricModelList' => [
+ 'description' => '指标监控结果列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '指标监控结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'MetricName' => ['description' => '监控项名称。', 'type' => 'string', 'example' => 'instance_in_traffic'],
+ 'DataPoints' => [
+ 'description' => '监控统计数据点。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '监控统计数据点。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Timestamp' => ['description' => '统计时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1548777660000'],
+ 'Minimum' => ['description' => '最小值。'."\n"
+ .'> 监控项为instance_in_traffic和instance_out_traffic时单位是bps。', 'type' => 'number', 'format' => 'double', 'example' => '93.1'],
+ 'Average' => ['description' => '平均值。单位:%。'."\n"
+ .'> 监控项为instance_in_traffic和instance_out_traffic时单位是bps。', 'type' => 'number', 'format' => 'double', 'example' => '99.52'],
+ 'Maximum' => ['description' => '最大值。单位:%。'."\n"
+ .'> 监控项为instance_in_traffic和instance_out_traffic时单位是bps。', 'type' => 'number', 'format' => 'double', 'example' => '100'],
+ 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'cloudPhone-****'],
+ 'Id' => ['description' => 'ID信息。', 'type' => 'string', 'example' => 'acp-fkuit0cmyru4p****'."\n"],
+ 'Properties' => ['description' => '属性信息。'."\n"
+ .'> 返回扩展属性信息字符串(Json格式) 。', 'type' => 'string', 'example' => '{"IP":"192.168.*.***"}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询排序后的最新监控数据',
+ 'summary' => '查询排序后的最新监控数据,支持实例网络带宽等监控数据的查询。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"310A783E-CC46-5452-A8A3-71AE5DB5****\\"\\n}","type":"json"}]',
- 'title' => '删除应用',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4610632D-D661-5982-B3D7-5D3FD183F****\\",\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MetricTotalModel\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-fkuit0cmyru4p****\\",\\n \\"InstanceId\\": \\"np-5hh4a31emkt6u****\\",\\n \\"MetricModelList\\": [\\n {\\n \\"MetricName\\": \\"instance_in_traffic\\",\\n \\"DataPoints\\": [\\n {\\n \\"Timestamp\\": 1548777660000,\\n \\"Minimum\\": 93.1,\\n \\"Average\\": 99.52,\\n \\"Maximum\\": 100,\\n \\"Name\\": \\"cloudPhone-****\\",\\n \\"Id\\": \\"acp-fkuit0cmyru4p****\\\\n\\",\\n \\"Properties\\": \\"{\\\\\\"IP\\\\\\":\\\\\\"192.168.*.***\\\\\\"}\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
- 'InstallApp' => [
- 'summary' => '批量在无影云手机实例中安装应用。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeMobileAgentPackage' => [
+ 'summary' => '查询节点套餐详细信息。',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8579,104 +6154,103 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneL912BU',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
],
'parameters' => [
[
- 'name' => 'AppIdList',
+ 'name' => 'PackageIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '应用ID列表。',
+ 'description' => '套餐包列表。',
'type' => 'array',
- 'items' => [
- 'description' => '应用ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12710',
- ],
+ 'items' => ['description' => '套餐包ID。', 'type' => 'string', 'required' => false, 'example' => 'cmag-0c1g77wjljl9hc****'],
'required' => false,
'maxItems' => 100,
- 'minItems' => 1,
],
],
[
- 'name' => 'InstanceGroupIdList',
+ 'name' => 'InstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例组列表。',
+ 'description' => '节点实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-ayyhomlal7mvm****',
- ],
+ 'items' => ['description' => '节点实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-itoxpeisht7if****'],
'required' => false,
- 'maxItems' => 100,
- 'minItems' => 0,
+ 'maxItems' => 1000,
],
],
[
- 'name' => 'InstanceIdList',
+ 'name' => 'PackageSpec',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-dvbhknfasf123****',
- ],
- 'required' => false,
- 'maxItems' => 1000,
- 'minItems' => 0,
- ],
+ 'schema' => ['description' => '套餐包规格。', 'type' => 'string', 'required' => false, 'example' => 'advanced'],
+ ],
+ [
+ 'name' => 'PackageStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => '套餐包状态。', 'type' => 'string', 'required' => false, 'example' => 'ACTIVE'],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页的页码,默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E5138F7E-46B5-526A-8C99-82DEAE6B****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-14xwibw7yp73q****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC****'],
+ 'Code' => ['description' => '状态码。返回 200表示成功。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '接口返回信息。', 'type' => 'string', 'example' => 'Success.'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'string', 'example' => '30'],
+ 'PackageList' => [
+ 'description' => '套餐包信息列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '套餐包信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PackageId' => ['description' => '套餐包ID。', 'type' => 'string', 'example' => 'cmag-bp19i1yxu60r7twy****'],
+ 'PackageStatus' => ['description' => '套餐包状态。', 'type' => 'string', 'example' => 'ACTIVE'],
+ 'InstanceIds' => [
+ 'description' => '节点实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '节点实例ID。', 'type' => 'string', 'example' => 'acp-iuyb1zv1ap6nb****'],
+ ],
+ 'PackageCredit' => ['description' => '套餐包积分额度。', 'type' => 'string', 'example' => '8000'],
+ 'UsedCredit' => ['description' => '已经使用的积分数。', 'type' => 'string', 'example' => '1000'],
+ 'ExpiredAt' => ['description' => '过期时间。', 'type' => 'string', 'example' => '2026-10-30 00:00:00 '],
+ 'PackageSpec' => ['description' => '套餐包规格。', 'type' => 'string', 'example' => 'advanced'],
+ 'PackageSpecName' => ['type' => 'string'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询套餐包',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5138F7E-46B5-526A-8C99-82DEAE6B****\\",\\n \\"TaskId\\": \\"t-14xwibw7yp73q****\\"\\n}","type":"json"}]',
- 'title' => '安装应用',
- 'description' => '须先通过[CreateApp](~~2807330~~)接口进行应用创建,基于已经创建的应用安装至指定云手机中。此接口为异步接口,操作结果可以在任务中心查看。查询任务接口为[DescribeTasks](~~DescribeTasks~~)。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"PackageList\\": [\\n {\\n \\"PackageId\\": \\"cmag-bp19i1yxu60r7twy****\\",\\n \\"PackageStatus\\": \\"ACTIVE\\",\\n \\"InstanceIds\\": [\\n \\"acp-iuyb1zv1ap6nb****\\"\\n ],\\n \\"PackageCredit\\": \\"8000\\",\\n \\"UsedCredit\\": \\"1000\\",\\n \\"ExpiredAt\\": \\"2026-10-30 00:00:00 \\",\\n \\"PackageSpec\\": \\"advanced\\",\\n \\"PackageSpecName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'UninstallApp' => [
- 'summary' => '批量从无影云手机实例中卸载应用。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeRegions' => [
+ 'summary' => '查询地域。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8685,68 +6259,33 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphonePZ72CH',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneTVG3Y7'],
],
'parameters' => [
[
- 'name' => 'AppIdList',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '应用ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '应用ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345',
- ],
- 'required' => false,
- 'maxItems' => 100,
- 'minItems' => 1,
- ],
- ],
- [
- 'name' => 'InstanceGroupIdList',
+ 'name' => 'AcceptLanguage',
'in' => 'query',
- 'style' => 'repeatList',
'schema' => [
- 'description' => '实例组ID列表。'."\n"
- .'该参数与InstanceIdList参数选填一个。如果两者同时有值,则仅InstanceGroupIdList有效。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-ferag1vraw****',
- ],
+ 'description' => '控制台显示语言。',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 100,
- 'minItems' => 0,
+ 'enumValueTitles' => ['en' => '英文', 'cn' => '简体中文'],
+ 'example' => 'cn',
],
],
[
- 'name' => 'InstanceIdList',
+ 'name' => 'SaleMode',
'in' => 'query',
- 'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID列表。'."\n"
- .'该参数与InstanceGroupIdList参数选填一个。如果两者同时有值,则仅InstanceGroupIdList有效。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-3eourrxapshn2****',
- ],
+ 'description' => '云手机的购买模式。',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 1000,
- 'minItems' => 0,
+ 'enumValueTitles' => ['Instance' => '实例组模式 [默认值]', 'Node' => '云手机矩阵模式 [白名单功能]'],
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Node'],
],
],
],
@@ -8757,317 +6296,294 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E5138F7E-46B5-526A-8C99-82DEAE6B****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-1ljew7on6ay0j****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A87B3769-0D05-5383-B236-5798B455****'],
+ 'RegionModels' => [
+ 'description' => '可用地域。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'RegionName' => ['description' => '地域名称。', 'type' => 'string', 'example' => 'China (Hangzhou)'],
+ ],
+ 'description' => '',
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5138F7E-46B5-526A-8C99-82DEAE6B****\\",\\n \\"TaskId\\": \\"t-1ljew7on6ay0j****\\"\\n}","type":"json"}]',
- 'title' => '卸载应用',
- 'description' => '此接口为异步接口,操作结果可以在任务中心查看。查询任务接口为[DescribeTasks](~~DescribeTasks~~)。',
- ],
- 'OperateApp' => [
- 'summary' => '操作云手机内应用,支持打开、关闭、重启应用。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A87B3769-0D05-5383-B236-5798B455****\\",\\n \\"RegionModels\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionName\\": \\"China (Hangzhou)\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询可用地域',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-22T12:26:48.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-07T12:32:00.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeSpec' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneL912BU',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneQ1CSHT', 'FEATUREcloudphoneM9M7K0', 'FEATUREcloudphone3VSOTB', 'FEATUREcloudphone32DVRA', 'FEATUREcloudphoneVYV97B'],
],
'parameters' => [
[
- 'name' => 'InstanceIdList',
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'SpecIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例列表。',
+ 'description' => '规格ID列表。',
'type' => 'array',
'items' => [
- 'description' => '实例列表。',
+ 'description' => '规格ID。',
'type' => 'string',
'required' => false,
- 'example' => 'acp-dvbhknfasf123****',
+ 'enumValueTitles' => ['acp.perf.large' => '性能型', 'acp.basic.small' => '轻量型', 'acp.std.small' => '通用型', 'acp.std.large' => '标准型', 'acp.perf.small' => '增强型'],
+ 'example' => 'acp.basic.small',
],
'required' => false,
- 'maxItems' => 1000,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'AppId',
+ 'name' => 'SpecType',
'in' => 'query',
'schema' => [
- 'description' => '应用ID。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '规格类型。',
+ 'type' => 'string',
'required' => false,
- 'example' => '1234',
+ 'enumValueTitles' => ['CPU' => 'CPU规格', 'GPU' => 'GPU规格'],
+ 'example' => 'CPU',
],
],
[
- 'name' => 'OperateType',
+ 'name' => 'SpecStatus',
'in' => 'query',
'schema' => [
- 'description' => '操作类型。支持开启、关闭和重启操作类型。',
+ 'description' => '规格状态。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'stop' => '关闭应用',
- 'restart' => '重启应用',
- 'start' => '打开应用',
- ],
- 'example' => 'start',
+ 'enumValueTitles' => ['Unsupported' => '不支持', 'Available' => '可用'],
+ 'example' => 'Available',
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'SaleMode',
+ 'in' => 'query',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-imr0fufqgac2z****',
- ],
- ],
+ 'description' => '云手机的购买模式。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['Instance' => '实例组模式 [默认值]', 'Node' => '云手机矩阵模式 [白名单功能]'],
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Node'],
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"TaskId\\": \\"t-imr0fufqgac2z****\\"\\n}","type":"json"}]',
- 'title' => '操作应用',
- 'description' => '此接口为异步接口,操作结果可以在任务中心查看。查询任务接口为[DescribeTasks](~~DescribeTasks~~)。',
- ],
- 'CreateKeyPair' => [
- 'summary' => '用户可以通过ADB连接云手机,对云手机进行设备管理、应用管理、文件传输等操作。由于其操作权限较大且云手机没有物理接口,无法通过 USB 触发设备端的授权对话框。因此adb通过网络连接云手机,必须预先配置密钥对,让设备信任客户端,确保操作的安全。调用本接口CreateKeyPair可创建一对ADB密钥对。系统会为您保管密钥的公钥部分,并返回符合ADB连接规范的PEM编码的PKCS#8格式私钥。您需要自行妥善保管私钥部分。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '20'],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneDADB6I',
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****'],
],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'KeyPairName',
+ 'name' => 'MatrixSpec',
'in' => 'query',
'schema' => [
- 'description' => '密钥对名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以http://或https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。',
+ 'description' => '云手机矩阵规格。',
'type' => 'string',
- 'required' => true,
- 'example' => 'testKeyPairName',
- 'maxLength' => 128,
- 'minLength' => 2,
+ 'required' => false,
+ 'enumValueTitles' => ['cpm.gx7.10xlarge' => 'cpm.gx7.10xlarge', 'cpm.gx8.16xlarge' => 'cpm.gx8.16xlarge'],
+ 'example' => 'cpm.gx7.10xlarge',
+ 'enum' => ['cpm.gn6.gx2', 'cpm.gn6.gx1', 'cpm.8yx.gx1', 'cpm.gx8.16xlarge', 'cpm.gx7.10xlarge'],
],
],
+ [
+ 'name' => 'ChargeType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<KeyPairModel>',
+ 'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'KeyPairId' => [
- 'description' => 'ADB密钥对ID。',
- 'type' => 'string',
- 'example' => 'kp-6v2q33ae4tw3*****',
- ],
- 'KeyPairName' => [
- 'description' => '密钥对名称。',
- 'type' => 'string',
- 'example' => 'testKeyPairName',
- ],
- 'PrivateKeyBody' => [
- 'description' => '密钥对的私钥。符合ADB密钥对规范的PEM 编码的 PKCS#8 格式的私钥部分。',
- 'type' => 'string',
- 'example' => 'MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****',
- ],
- 'GmtCreated' => [
- 'title' => '创建时间',
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-06-30 08:45:09.0',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9888DAD-331E-5FBC-B5A0-F2445115****'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****'],
+ 'SpecInfoModel' => [
+ 'description' => '规格信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SpecId' => ['description' => '规格ID。', 'type' => 'string', 'example' => 'acp.basic.small'],
+ 'Core' => ['description' => 'CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'Memory' => ['description' => '内存大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
+ 'SystemDiskSize' => ['description' => '系统盘大小,单位:GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
+ 'SpecType' => ['description' => '规格类型。', 'type' => 'string', 'example' => 'ARM'],
+ 'SpecStatus' => ['description' => '规格状态。', 'type' => 'string', 'example' => 'Available'],
+ 'PhoneCount' => ['description' => '云手机实例开数。', 'type' => 'string', 'example' => '2'],
+ 'Resolution' => ['description' => '云手机实例的分辨率。', 'type' => 'string', 'example' => '1920*1080'],
+ 'MaxPhoneCount' => ['description' => '最大实例开数。', 'type' => 'string', 'example' => '40'],
+ 'MinPhoneCount' => ['description' => '最小实例开数。', 'type' => 'string', 'example' => '4'],
],
+ 'description' => '',
],
],
- 'RequestId' => [
- 'description' => '接口请求ID。',
- 'type' => 'string',
- 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****',
- ],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"KeyPairId\\": \\"kp-6v2q33ae4tw3*****\\",\\n \\"KeyPairName\\": \\"testKeyPairName\\",\\n \\"PrivateKeyBody\\": \\"MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****\\",\\n \\"GmtCreated\\": \\"2024-06-30 08:45:09.0\\"\\n },\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
- 'title' => '创建ADB密钥对',
- 'description' => '除了调用 CreateKeyPair 创建密钥对之外,您还可以使用ADB工具创建密钥对,然后上传( [ImportKeyPair](~~2807340~~) )到无影云手机控制台,其使用方法和系统为您创建的密钥对是一致的。'."\n"
- ."\n"
- .'每个租户的密钥对数最高为 500 对。',
- ],
- 'ImportKeyPair' => [
- 'summary' => '导入由ADB工具产生的ADB密钥对的公钥部分。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'https',
+ 'title' => '查询可用规格',
+ 'summary' => '查询云手机可用规格。 实例的创建需要指定规格参数,可通过该接口获取所有规格信息。对于矩阵创建的情况,可以通过该接口获取矩阵的最大和最小开数限制(单个矩阵创建实例数的限制)。',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-22T07:17:49.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-04T07:13:57.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-14T10:54:56.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-01-22T12:26:48.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-09-26T12:10:24.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9888DAD-331E-5FBC-B5A0-F2445115****\\",\\n \\"TotalCount\\": 4,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****\\",\\n \\"SpecInfoModel\\": [\\n {\\n \\"SpecId\\": \\"acp.basic.small\\",\\n \\"Core\\": 8,\\n \\"Memory\\": 16,\\n \\"SystemDiskSize\\": 32,\\n \\"SpecType\\": \\"ARM\\",\\n \\"SpecStatus\\": \\"Available\\",\\n \\"PhoneCount\\": \\"2\\",\\n \\"Resolution\\": \\"1920*1080\\",\\n \\"MaxPhoneCount\\": \\"40\\",\\n \\"MinPhoneCount\\": \\"4\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeSystemPropertyTemplates' => [
+ 'summary' => '查询系统属性模板。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneDADB6I',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVQDPK9'],
],
'parameters' => [
[
- 'name' => 'KeyPairName',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => 'ADB密钥对名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestKeyPairName',
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
+ 'schema' => ['description' => '本次读取的最大数据量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10'],
],
[
- 'name' => 'PublicKeyBody',
+ 'name' => 'NextToken',
'in' => 'query',
+ 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6k****'],
+ ],
+ [
+ 'name' => 'TemplateIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '密钥对的公钥。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ABC1234567*****',
- 'maxLength' => 1024,
- 'minLength' => 1,
+ 'description' => '属性模板ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '需要查询的模板ID列表。', 'type' => 'string', 'required' => false, 'example' => 'ap-0caoenwutkkx****'],
+ 'required' => false,
+ 'maxItems' => 100,
],
],
+ [
+ 'name' => 'TemplateName',
+ 'in' => 'query',
+ 'schema' => ['description' => '模板名称。', 'type' => 'string', 'required' => false, 'example' => 'Template 1'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<KeyPairModel>',
- 'description' => '返回参数。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'KeyPairId' => [
- 'description' => 'ADB密钥对的ID。',
- 'type' => 'string',
- 'example' => 'kp-6v2q33ae4tw3*****',
- ],
- 'KeyPairName' => [
- 'description' => 'ADB密钥对名称。',
- 'type' => 'string',
- 'example' => 'TestKeyPairName',
- ],
- 'GmtCreated' => [
- 'title' => '创建时间',
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2023-03-05T10:29:22Z',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****'],
+ 'NextToken' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU****'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'SystemPropertyTemplateModel' => [
+ 'description' => '属性模板对象列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '属性模板对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['description' => '属性模板ID。', 'type' => 'string', 'example' => 'ap-0caoenwutkkx****'],
+ 'TemplateName' => ['description' => '模板名称。', 'type' => 'string', 'example' => 'Template 1'],
+ 'Status' => ['description' => '模板状态。', 'type' => 'string', 'example' => 'init'],
+ 'SystemPropertyInfo' => [
+ 'description' => '系统属性模板信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoProductDevice' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'example' => 'null'],
+ 'CustomPropertyInfos' => [
+ 'description' => '自定义属性信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '自定义属性对象,由属性的Key和Value构成。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PropertyName' => ['description' => '属性名称。', 'type' => 'string', 'example' => 'propKey'],
+ 'PropertyValue' => ['description' => '属性值。', 'type' => 'string', 'example' => 'propValue'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'FilePath' => ['description' => '属性模板的文件URL路径。', 'type' => 'string', 'example' => 'https://filepath****.com'],
+ 'EnableAuto' => ['description' => '是否支持部分预置系统属性自动生成。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****',
- ],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"KeyPairId\\": \\"kp-6v2q33ae4tw3*****\\",\\n \\"KeyPairName\\": \\"TestKeyPairName\\",\\n \\"GmtCreated\\": \\"2023-03-05T10:29:22Z\\"\\n },\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
- 'title' => '导入ADB密钥对',
- 'description' => '注意:导入的必须是ADB工具生成的密钥对,否则ADB连接的时候鉴权可能会失败。',
- ],
- 'DescribeKeyPairs' => [
- 'summary' => '查询一个或多个密钥对。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU****\\",\\n \\"TotalCount\\": 10,\\n \\"SystemPropertyTemplateModel\\": [\\n {\\n \\"TemplateId\\": \\"ap-0caoenwutkkx****\\",\\n \\"TemplateName\\": \\"Template 1\\",\\n \\"Status\\": \\"init\\",\\n \\"SystemPropertyInfo\\": {\\n \\"RoProductDevice\\": \\"null\\",\\n \\"CustomPropertyInfos\\": [\\n {\\n \\"PropertyName\\": \\"propKey\\",\\n \\"PropertyValue\\": \\"propValue\\"\\n }\\n ]\\n },\\n \\"FilePath\\": \\"https://filepath****.com\\",\\n \\"EnableAuto\\": true\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询系统属性模板',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeTasks' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9079,74 +6595,140 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneDADB6I',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneWDBBSN', 'FEATUREcloudphoneDY533B', 'FEATUREcloudphoneQ3V7AF', 'FEATUREcloudphoneE62QJ7'],
],
'parameters' => [
[
- 'name' => 'KeyPairIds',
+ 'name' => 'InvokeId',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令执行ID,可以填写上一次操作返回的requestId。', 'type' => 'string', 'required' => false, 'example' => 'B8ED2BA9-0C6A-5643-818F-B5D60A64****'],
+ ],
+ [
+ 'name' => 'ResourceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '密钥对ID列表。',
+ 'description' => '资源ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => 'ADB密钥对ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'kp-6v2q33ae4tw3*****',
+ 'items' => ['description' => '资源ID,如果是查询云手机开机、关机、重启和重置的任务状态,资源ID填实例ID即可。', 'type' => 'string', 'required' => false, 'example' => 'acp-25nt4kk9whhok****'],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'TaskIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '任务ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => 't-bp67acfmxazb4p****'],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'ParentTaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '父任务ID。', 'type' => 'string', 'required' => false, 'example' => 't-iaej5dkbnmivx****'],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '任务类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'BackupFile' => '数据备份', 'StopInstance' => '实例关机', 'RebootInstance' => '实例重启', 'StartApp' => '启动应用', 'SendFile' => '上传文件', 'RunCommand' => '远程命令', 'RestartApp' => '重启应用', 'ResetInstance' => '实例重置', 'RecoverFile' => '数据恢复', 'UninstallApp' => '卸载应用',
+ 'StopApp' => '停止应用', 'Screenshot' => '截屏', 'InstallApp' => '安装应用', 'FetchFile' => '下载文件', 'UpdateGroupImage' => '更换镜像', 'StartInstance' => '实例开机',
],
+ 'example' => 'StartInstance',
+ ],
+ ],
+ [
+ 'name' => 'TaskTypes',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '任务类型列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '任务类型。', 'type' => 'string', 'required' => false, 'example' => 'StartInstance'],
'required' => false,
'maxItems' => 100,
],
],
[
- 'name' => 'KeyPairName',
+ 'name' => 'TaskStatus',
'in' => 'query',
'schema' => [
- 'description' => 'ADB密钥对名称。',
+ 'description' => '任务状态。',
'type' => 'string',
'required' => false,
- 'example' => 'testKeyPairName',
+ 'enumValueTitles' => ['PartFinished' => '部分成功', 'Finished' => '已完成', 'Failed' => '任务失败', 'Skipped' => '跳过', 'Processing' => '运行中', 'Waiting' => '等待'],
+ 'example' => 'Processing',
],
],
[
+ 'name' => 'TaskStatuses',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '任务状态列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '任务状态。', 'type' => 'string', 'required' => false, 'example' => 'Finished'],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'Level',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务级别,1表示批量任务;2表示实例级任务。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-2zecay9ponatdc4m****'],
+ ],
+ [
+ 'name' => 'InstanceName',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'defaultInstanceName'],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'schema' => ['description' => '扩展字段。', 'type' => 'string', 'required' => false, 'example' => 'param'],
+ ],
+ [
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
- 'description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为10。',
+ 'description' => '分页查询时每页的最大条目数。取值范围 1~100,默认值为 10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '0',
+ 'enumValueTitles' => [],
'example' => '10',
],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAYRHtOLVQzCYj17y+OP7LZQBUVVbi0GTu8g5****',
- ],
+ 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<NextTokenListResult<KeyPairModel>>',
+ 'title' => '',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。',
- 'type' => 'string',
- 'example' => 'FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0****',
- ],
+ 'NextToken' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
'Data' => [
'description' => '返回结果对象列表。',
'type' => 'array',
@@ -9154,176 +6736,201 @@
'description' => '返回结果对象。',
'type' => 'object',
'properties' => [
- 'KeyPairId' => [
- 'description' => 'ADB密钥对的ID。',
- 'type' => 'string',
- 'example' => 'kp-6v2q33ae4tw3a****',
- ],
- 'KeyPairName' => [
- 'description' => 'ADB密钥对名称。',
- 'type' => 'string',
- 'example' => 'testKeyPairName',
- ],
- 'GmtCreated' => [
- 'title' => '创建时间',
- 'description' => '创建时间。',
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-bp67acfmxazb4p****'],
+ 'InvokeId' => ['description' => '命令执行ID。', 'type' => 'string', 'example' => 'B8ED2BA9-0C6A-5643-818F-B5D60A64****'],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'acp-25nt4kk9whhok****'],
+ 'TaskType' => [
+ 'description' => '任务类型。',
'type' => 'string',
- 'example' => '2022-10-11T08:53:32Z',
+ 'enumValueTitles' => [],
+ 'example' => 'StartInstance',
],
+ 'TaskStatus' => ['description' => '任务状态。', 'type' => 'string', 'example' => 'Processing'],
+ 'StartTime' => ['title' => '创建时间', 'description' => '任务开始时间。', 'type' => 'string', 'example' => '2022-10-11T08:53:32Z'],
+ 'FinishTime' => ['title' => '修改时间', 'description' => '任务结束时间。', 'type' => 'string', 'example' => '2022-10-11T08:53:32Z'],
+ 'Param' => ['description' => '任务参数。', 'type' => 'string', 'example' => 'param'],
+ 'Result' => ['description' => '任务执行结果。', 'type' => 'string', 'example' => '{\'Success\': True}'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'SendFileFailed'],
+ 'ErrorMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'connect error.'],
+ 'Level' => ['description' => '任务级别。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FailedChildCount' => ['description' => '执行失败的子任务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'SuccessChildCount' => ['description' => '执行成功的子任务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '98'],
+ 'RunningChildCount' => ['description' => '运行中的子任务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TotalChildCount' => ['description' => '当前批量任务的子任务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-uto81vfd8t8z****'],
+ 'InstanceName' => ['description' => '实例名称', 'type' => 'string', 'example' => 'defaultInstanceName'],
+ 'InstanceStatus' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'RUNNING'],
+ 'Operator' => ['description' => '操作者。', 'type' => 'string', 'example' => 'test'],
+ 'ParentTaskId' => ['description' => '父任务ID。', 'type' => 'string', 'example' => 't-41oan3tza16vs****'],
],
],
],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '本次请求的ID。',
- 'type' => 'string',
- 'example' => '565FB06A-AE04-5AD0-8A32-5BA92CA5****',
- ],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B8ED2BA9-0C6A-5643-818F-B5D60A64****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0****\\",\\n \\"Data\\": [\\n {\\n \\"KeyPairId\\": \\"kp-6v2q33ae4tw3a****\\",\\n \\"KeyPairName\\": \\"testKeyPairName\\",\\n \\"GmtCreated\\": \\"2022-10-11T08:53:32Z\\"\\n }\\n ],\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"565FB06A-AE04-5AD0-8A32-5BA92CA5****\\"\\n}","type":"json"}]',
- 'title' => '查询ADB密钥对',
- ],
- 'ModifyKeyPairName' => [
- 'summary' => '调用本接口修改ADB密钥对的名称。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询任务',
+ 'summary' => '获取云手机实例当前任务列表。云手机很多(创建、开关机等)的操作都是异步进行,系统将产生一个任务ID供用户查询操作进度及结果。用户可通过调用该接口查询所有任务清单及执行情况。',
+ 'description' => '- 可以通过DescribeTasks接口查询批量或者单台云手机实例的操作状态。'."\n"
+ .'- 目前支持开机、关机、重启、重置、备份/恢复、安装应用、远程命令等操作的任务查询。'."\n"
+ .'- Level字段可区分任务等级。当Level=1,任务属于批量任务;Level=2,任务属于实例级任务。'."\n"
+ ."\n"
+ .'**举例说明:**'."\n"
+ ."\n"
+ .'假设您对实例ID为acp-25nt4kk9whhok****、实例ID为acp-j2taq887orj8l**** 的两台云手机实例执行了重启操作,返回这次操作的requestId为B8ED2BA9-0C6A-5643-818F-B5D60A64****。如果您希望知道这次批量操作的结果,可以调用DescribeTasks来查询,其中的InvokeId填写B8ED2BA9-0C6A-5643-818F-B5D60A64****;如果您希望拿到实例ID为acp-25nt4kk9whhok**** 的重启结果,入参ParentTaskId=批量任务ID,AndroidInstanceId=acp-25nt4kk9whhok****,可调用DescribeTasks即可。',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-03T11:17:53.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-12-17T05:04:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-11-14T10:59:55.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-08-21T08:15:03.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"Data\\": [\\n {\\n \\"TaskId\\": \\"t-bp67acfmxazb4p****\\",\\n \\"InvokeId\\": \\"B8ED2BA9-0C6A-5643-818F-B5D60A64****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceId\\": \\"acp-25nt4kk9whhok****\\",\\n \\"TaskType\\": \\"StartInstance\\",\\n \\"TaskStatus\\": \\"Processing\\",\\n \\"StartTime\\": \\"2022-10-11T08:53:32Z\\",\\n \\"FinishTime\\": \\"2022-10-11T08:53:32Z\\",\\n \\"Param\\": \\"param\\",\\n \\"Result\\": \\"{\'Success\': True}\\",\\n \\"ErrorCode\\": \\"SendFileFailed\\",\\n \\"ErrorMsg\\": \\"connect error.\\",\\n \\"Level\\": 1,\\n \\"FailedChildCount\\": 2,\\n \\"SuccessChildCount\\": 98,\\n \\"RunningChildCount\\": 0,\\n \\"TotalChildCount\\": 100,\\n \\"InstanceId\\": \\"acp-uto81vfd8t8z****\\",\\n \\"InstanceName\\": \\"defaultInstanceName\\",\\n \\"InstanceStatus\\": \\"RUNNING\\",\\n \\"Operator\\": \\"test\\",\\n \\"ParentTaskId\\": \\"t-41oan3tza16vs****\\"\\n }\\n ],\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"B8ED2BA9-0C6A-5643-818F-B5D60A64****\\"\\n}","type":"json"}]',
+ ],
+ 'DetachKeyPair' => [
+ 'summary' => '调用本接口解除ADB密钥对到一台或多台云手机实例的绑定关系。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneDADB6I',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphone0AEVFG'],
],
'parameters' => [
[
'name' => 'KeyPairId',
'in' => 'query',
- 'schema' => [
- 'description' => 'ADB密钥对的ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'kp-6v2q33ae4tw3a****',
- ],
+ 'schema' => ['description' => 'ADB密钥对的ID。', 'type' => 'string', 'required' => true, 'example' => 'kp-6v2q33ae4tw3a****'],
],
[
- 'name' => 'NewKeyPairName',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'ADB密钥对名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'newKeyPairName',
- 'minLength' => 2,
+ 'description' => '云手机实例ID列表,最多支持50个实例。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh431emkt6ua****'],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****',
+ 'Data' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'KeyPairId' => ['description' => 'ADB密钥对的ID。', 'type' => 'string', 'example' => 'kp-6v2q33ae4tw3a****'],
+ 'TotalCount' => ['description' => '尝试解绑的总实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'FailCount' => ['description' => '解绑失败的实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'DetachedInstanceIds' => [
+ 'description' => '解绑成功的实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-5hh431emkt6ua****'],
+ ],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
- 'title' => '修改ADB密钥对名称',
- ],
- 'DeleteKeyPairs' => [
- 'summary' => '调用本接口删除云手机密钥对。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '解绑ADB密钥对',
+ 'description' => '- 解绑密钥对以后,由于云手机没有存储合法的ADB公钥,ADB连接可能会鉴权失败。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-31T07:55:40.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"KeyPairId\\": \\"kp-6v2q33ae4tw3a****\\",\\n \\"TotalCount\\": 10,\\n \\"FailCount\\": 0,\\n \\"DetachedInstanceIds\\": [\\n \\"acp-5hh431emkt6ua****\\"\\n ]\\n },\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
+ ],
+ 'DisconnectAndroidInstance' => [
+ 'summary' => '将处于连接中的实例断开连接,或将被其他用户绑定的实例进行解绑。',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMEHI4H'],
],
'parameters' => [
[
- 'name' => 'KeyPairIds',
+ 'name' => 'InstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '密钥对ID列表。',
+ 'description' => '云手机实例ID列表,可设置 1~100 个。',
'type' => 'array',
- 'items' => [
- 'description' => '密钥对ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'kp-6v2q33ae4tw3a****',
- ],
+ 'items' => ['description' => '云手机实例ID列表。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh4a31emkt6u****', 'pattern' => '^[^\';<>=|\\(\\)]+$'],
'required' => false,
'maxItems' => 100,
],
],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => ['description' => '<props="china">如果使用的是云手机矩阵版,并且实例串流模式为协同模式,则可以通过指定`EndUserId`的方式断开指定用户的连接,并且令相应的Ticket失效。</props>'."\n"
+ ."\n"
+ .'<props="intl">本参数暂不对外开放使用。</props>', 'type' => 'string', 'required' => false, 'example' => 'user1'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
- 'description' => '返回参数。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E5138F7E-46B5-526A-8C99-82DEAE6B****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\"\\n}","type":"json"}]',
- 'title' => '删除ADB密钥对',
- 'description' => '- 如果已经有云手机实例绑定了该ADB 密钥对,则该密钥对不支持被删除。'."\n"
- .'- 删除ADB密钥对后,无法通过DescribeKeyPairs 查询到该ADB 密钥对。',
- ],
- 'AttachKeyPair' => [
- 'summary' => '调用AttachKeyPair绑定一个ADB密钥对到一台或多台云手机实例。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '断开实例的连接',
+ 'description' => '实例的连接通过[web sdk](~~2858136~~)完成。通过`session.stop()`断开连接后,系统仍会保持5分钟的用户与云机的连接绑定关系,这5分钟内其他用户不可连接,此时可通过`DisconnectAndroidInstance`接口进行立即解绑。'."\n"
+ .'<props="china">如果使用的是云手机矩阵版,并且实例串流模式为协同模式,则可以通过指定`EndUserId`的方式断开指定用户的连接,并且令相应的Ticket失效。</props>',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-28T12:53:31.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5138F7E-46B5-526A-8C99-82DEAE6B****\\"\\n}","type":"json"}]',
+ ],
+ 'DistributeImage' => [
+ 'summary' => '分发镜像。如需要在更多的地域使用此镜像,可使用分发镜像功能,将镜像文件传输到各个地域,支撑各地域根据该镜像创建云手机的需求。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9335,358 +6942,270 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone377ZZK',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphone3OZQF8'],
],
'parameters' => [
[
- 'name' => 'KeyPairId',
- 'in' => 'query',
+ 'name' => 'DistributeRegionList',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'ADB密钥对的ID。',
- 'type' => 'string',
+ 'description' => '分发地域列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '分发地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
'required' => true,
- 'example' => 'kp-6v2q33ae4tw3a****',
+ 'maxItems' => 100,
+ 'minItems' => 1,
],
],
[
- 'name' => 'InstanceIds',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '云手机实例ID列表,最多支持50个实例。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-5hh4a31emkt6u****',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'name' => 'ImageId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => true, 'example' => 'imgc-075cllfeuazh0****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<AttachKeyPairResult>',
+ 'title' => 'PlainResult<Integer>',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'KeyPairId' => [
- 'description' => 'ADB密钥对的ID。',
- 'type' => 'string',
- 'example' => 'kp-6v2q33ae4tw3a****',
- ],
- 'TotalCount' => [
- 'description' => '尝试绑定的总实例数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'FailCount' => [
- 'description' => '绑定失败的实例数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'AttachedInstanceIds' => [
- 'description' => '绑定成功的云手机实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-5hh431emkt6ua****',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '440D7342-5FC2-5E7C-B2DB-D0B4EAC2BDF1'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"KeyPairId\\": \\"kp-6v2q33ae4tw3a****\\",\\n \\"TotalCount\\": 100,\\n \\"FailCount\\": 0,\\n \\"AttachedInstanceIds\\": [\\n \\"acp-5hh431emkt6ua****\\"\\n ]\\n },\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
- 'title' => '绑定ADB密钥对',
- 'description' => '- 只有实例处于运行中(Running)状态,绑定ADB密钥对才能生效。'."\n"
- .'- 绑定密钥对以后,请注意要将密钥对的私钥拷贝到您本地的密钥对所在目录下(macOS或者Linux操作系统,目录为~/.android;Windows操作系统,目录为C:\\Users\\用户名\\.android。),并调用adb kill-server重启ADB进程,才能正常连接ADB,否则ADB连接可能会鉴权失败。',
- ],
- 'DetachKeyPair' => [
- 'summary' => '调用本接口解除ADB密钥对到一台或多台云手机实例的绑定关系。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"440D7342-5FC2-5E7C-B2DB-D0B4EAC2BDF1\\"\\n}","type":"json"}]',
+ 'title' => '分发镜像',
+ 'description' => '已分发地域不支持取消。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DowngradeAndroidInstanceGroup' => [
+ 'summary' => '降级实例组。目前仅支持释放实例组中的指定实例。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone0AEVFG',
- ],
+ 'operationType' => 'none',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMGJBSL'],
],
'parameters' => [
[
- 'name' => 'KeyPairId',
+ 'name' => 'InstanceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'ADB密钥对的ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'kp-6v2q33ae4tw3a****',
- ],
+ 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'ag-cuv4scs4obxhs****'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'AndroidInstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机实例ID列表,最多支持50个实例。',
+ 'description' => '待释放的实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-5hh431emkt6ua****',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-hangzhouarmw****'],
'required' => false,
- 'maxItems' => 200,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '是否自动付费。默认为false。',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => ['true' => '自动付费,请确保账号有足够的余额', 'false' => '手动付费'],
+ 'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'KeyPairId' => [
- 'description' => 'ADB密钥对的ID。',
- 'type' => 'string',
- 'example' => 'kp-6v2q33ae4tw3a****',
- ],
- 'TotalCount' => [
- 'description' => '尝试解绑的总实例数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'FailCount' => [
- 'description' => '解绑失败的实例数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'DetachedInstanceIds' => [
- 'description' => '解绑成功的实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-5hh431emkt6ua****',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '3AF82CE1-2801-52CE-BF64-B491DD7C****'],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '22326560487****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"KeyPairId\\": \\"kp-6v2q33ae4tw3a****\\",\\n \\"TotalCount\\": 10,\\n \\"FailCount\\": 0,\\n \\"DetachedInstanceIds\\": [\\n \\"acp-5hh431emkt6ua****\\"\\n ]\\n },\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
- 'title' => '解绑ADB密钥对',
- 'description' => '- 解绑密钥对以后,由于云手机没有存储合法的ADB公钥,ADB连接可能会鉴权失败。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '降级实例组',
+ 'description' => '目前仅支持释放实例组中的部分实例,即实例组缩容。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AF82CE1-2801-52CE-BF64-B491DD7C****\\",\\n \\"OrderId\\": \\"22326560487****\\"\\n}","type":"json"}]',
],
- 'BackupAndroidInstance' => [
- 'summary' => '对云手机实例进行整机备份,包括已安装的应用、属性等。',
+ 'EndCoordination' => [
+ 'summary' => '云手机所有者主动结束当前云手机实例的所有协同任务,协同码将同步失效。',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneE62QJ7',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMEHI4H'],
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIdList',
+ 'name' => 'OwnerUserId',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['description' => '协同发起方的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'xiaoming'],
+ ],
+ [
+ 'name' => 'CoordinatorUserId',
+ 'in' => 'query',
+ 'schema' => ['description' => '协同参与方的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'lina'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前正在协同的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-2zecay9ponatdc4m****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aic-ig2bdpk374l12****',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****'],
],
- 'deprecated' => false,
- 'required' => true,
- 'maxItems' => 100,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '结束协同',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\"\\n}","type":"json"}]',
+ ],
+ 'ExpandDataVolume' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Description',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneUQT9QO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'NodeIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'App文件名称',
- 'description' => '整机备份描述。',
- 'type' => 'string',
+ 'description' => '云手机矩阵ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '云手机矩阵ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-csbdhjcbvfd****'],
'required' => false,
- 'example' => 'this is a backup android instance',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'UploadEndpoint',
+ 'name' => 'ShareDataVolume',
'in' => 'query',
- 'schema' => [
- 'description' => '备份地域。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com',
- ],
+ 'schema' => ['description' => '矩阵共享存储大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
- 'name' => 'BackupFilePath',
+ 'name' => 'PhoneDataVolume',
'in' => 'query',
- 'schema' => [
- 'description' => '备份文件的上传地址。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab',
- ],
+ 'schema' => ['description' => '实例机身存储大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
- 'name' => 'BackupFileName',
+ 'name' => 'AutoPay',
'in' => 'query',
'schema' => [
- 'description' => '备份文件名称。',
- 'type' => 'string',
+ 'description' => '是否自动支付。默认为false。',
+ 'type' => 'boolean',
'required' => false,
- 'example' => 'abc',
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
+ 'example' => 'true',
],
],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'example' => '50003308011****'],
+ ],
+ [
+ 'name' => 'PaidCallBackUrl',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => 'PlainResult<Integer>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'BackupFileId' => [
- 'description' => '备份文件ID。',
- 'type' => 'string',
- 'example' => 'bf-b0qbg3pbpjkn7****',
- ],
- 'BackupFileName' => [
- 'description' => '备份文件名称。',
- 'type' => 'string',
- 'example' => 'a-58ftsoo90p0qa****.ab',
- ],
- 'AndroidInstanceId' => [
- 'description' => '云手机实例ID。',
- 'type' => 'string',
- 'example' => 'acp-34pqe4r0kd9kn****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-bp67acfmxazb4p****',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '440D7342-5FC2-5E7C-B2DB-D0B4EAC2BDF1',
- ],
- 'Count' => [
- 'description' => '备份的实例个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-14xwibw7pyrjd****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****'],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '22326560487****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '扩容云手机矩阵存储',
+ 'summary' => '扩容云手机矩阵存储。可以对共享机身存储(用于存储镜像等矩阵级文件)、独立机身存储进行扩容。存储空间扩容后将产生新的费用,接口调用的响应参数中包含了新费用的订单ID。',
+ 'description' => '本接口仅适用于中国站。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-05T06:13:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-08T10:57:57.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"BackupFileId\\": \\"bf-b0qbg3pbpjkn7****\\",\\n \\"BackupFileName\\": \\"a-58ftsoo90p0qa****.ab\\",\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-bp67acfmxazb4p****\\"\\n }\\n ],\\n \\"RequestId\\": \\"440D7342-5FC2-5E7C-B2DB-D0B4EAC2BDF1\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-14xwibw7pyrjd****\\"\\n}","type":"json"}]',
- 'title' => '整机备份',
- 'description' => '1. 为保证您的操作成功率,请您尽量在关机后操作数据备份,备份时操作云手机可能导致备份操作失败。'."\n"
- .'2. 请确保您的备份文件可以正常恢复,恢复完成后,请检查和验证您的数据是否全部完整、功能是否正常使用,再考虑删除原始备份文件和重置源实例,否则您的数据可能丢失。'."\n"
- .'3. 不同镜像版本不支持互相备份恢复,自定义镜像和公共镜像不支持互相备份恢复,跨架构(cpm.gx7.10xlarge和cpm.gx8.16xlarge)不支持互相备份恢复。',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"OrderId\\": \\"22326560487****\\"\\n}","type":"json"}]',
],
- 'BackupApp' => [
- 'summary' => '对云手机实例的部分应用进行应用备份,包括应用、应用缓存等。',
+ 'ExpandPhoneDataVolume' => [
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9695,167 +7214,76 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneE62QJ7',
- ],
+ 'operationType' => 'none',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneUQT9QO'],
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIdList',
+ 'name' => 'BizRegionId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-34pqe4r0kd9kn****'."\n",
- ],
- 'deprecated' => false,
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Description',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'App文件名称',
- 'description' => '备份应用描述。',
- 'type' => 'string',
+ 'description' => '云手机矩阵版本实例ID列表,可设置 1~100 个。',
+ 'type' => 'array',
+ 'items' => ['description' => '云手机矩阵版本实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-aw14zoevk6809****'],
'required' => false,
- 'example' => 'this is a backup app',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'UploadEndpoint',
+ 'name' => 'PhoneDataVolume',
'in' => 'query',
- 'schema' => [
- 'description' => '备份地域。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss-cn-shanghai-internal.aliyuncs.com',
- ],
+ 'schema' => ['description' => '扩容后期望的独立机身存储的大小。单位:GiB。><notice>新值必须大于实例原来的独立机身存储大小。></notice>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'BackupFilePath',
+ 'name' => 'AutoPay',
'in' => 'query',
- 'schema' => [
- 'description' => '备份文件地址。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://cloudphone-saved-bucket-****/backupDir/',
- ],
+ 'schema' => ['description' => '是否自动支付。默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'BackupFileName',
+ 'name' => 'PromotionId',
'in' => 'query',
- 'schema' => [
- 'description' => '备份文件名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MyBackup',
- ],
+ 'schema' => ['description' => '优惠ID。', 'type' => 'string', 'required' => false, 'example' => '50003308011****'],
],
[
- 'name' => 'SourceAppList',
+ 'name' => 'PaidCallBackUrl',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '备份的应用包名列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '备份的应用包名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'com.example.xhs',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => 'PlainResult<Integer>',
+ 'title' => 'Schema of Response',
+ 'description' => '请求返回参数。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'BackupFileId' => [
- 'description' => '备份文件ID。',
- 'type' => 'string',
- 'example' => 'bf-b0qbg3pbpjkn7****',
- ],
- 'BackupFileName' => [
- 'description' => '备份文件名称。',
- 'type' => 'string',
- 'example' => 'MyBackup',
- ],
- 'AndroidInstanceId' => [
- 'description' => '云手机实例ID。',
- 'type' => 'string',
- 'example' => 'acp-34pqe4r0kd9kn****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-4ks224ujixw****',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '本次请求的ID。',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
- ],
- 'Count' => [
- 'description' => '备份的实例个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TaskId' => [
- 'description' => '批量任务ID。',
- 'type' => 'string',
- 'example' => 't-14xwibw7pyrjd****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DB070C80-45AC-52CA-8101-937C25DA****'],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '223684716098****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '扩容独立机身存储',
+ 'summary' => '该接口用于扩容矩阵实例的独立机身存储。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"BackupFileId\\": \\"bf-b0qbg3pbpjkn7****\\",\\n \\"BackupFileName\\": \\"MyBackup\\",\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-4ks224ujixw****\\"\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-14xwibw7pyrjd****\\"\\n}","type":"json"}]',
- 'title' => '应用备份',
- 'description' => '1. 为保证您的操作成功率,请您尽量在关机后操作数据备份,备份时操作云手机可能导致备份操作失败。'."\n"
- .'2. 请确保您的备份文件可以正常恢复,恢复完成后,请检查和验证您的数据是否全部完整、功能是否正常使用,再考虑删除原始备份文件和重置源实例,否则您的数据可能丢失。'."\n"
- .'3. 不同镜像版本不支持互相备份恢复,自定义镜像和公共镜像不支持互相备份恢复,跨架构(cpm.gx7.10xlarge和cpm.gx8.16xlarge)不支持互相备份恢复。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB070C80-45AC-52CA-8101-937C25DA****\\",\\n \\"OrderId\\": \\"223684716098****\\"\\n}","type":"json"}]',
],
- 'RecoverAndroidInstance' => [
- 'summary' => '将整机备份产生的云手机实例备份文件恢复到另一台云手机实例。',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'FetchFile' => [
+ 'summary' => '从云手机拉取文件到OSS。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9867,277 +7295,275 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneWDBBSN',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphone0959GM'],
],
'parameters' => [
[
- 'name' => 'BackupFileId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'App oss地址',
- 'description' => '备份文件id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bf-azhps4rdyi2th****',
- ],
- ],
- [
'name' => 'AndroidInstanceIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID列表。',
+ 'description' => '实例列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-ig2bdpk374l12****',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-34pqe4r0kd9kn****'."\n"],
'deprecated' => false,
'required' => true,
'maxItems' => 100,
],
],
[
- 'name' => 'UploadEndpoint',
+ 'name' => 'SourceFilePath',
'in' => 'query',
- 'schema' => [
- 'description' => '备份地域。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com',
- ],
+ 'schema' => ['description' => '从指定的云手机文件路径拉取文件。', 'type' => 'string', 'required' => true, 'example' => '/data/a.txt'],
],
[
'name' => 'UploadType',
'in' => 'query',
- 'schema' => [
- 'description' => '上传类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OSS',
- ],
+ 'schema' => ['description' => '保存拉取文件的存储类型。'."\n"
+ ."\n"
+ .'> 目前仅支持的云端存储类型是OSS对象存储。', 'type' => 'string', 'required' => true, 'example' => 'OSS'],
],
[
- 'name' => 'BackupFilePath',
+ 'name' => 'UploadEndpoint',
'in' => 'query',
- 'schema' => [
- 'description' => '备份文件上传的OSS地址。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab',
- ],
+ 'schema' => ['description' => '从OSS拉取文件的服务域名。'."\n"
+ ."\n"
+ .'> 当云手机和OSS Bucket处于相同地域,域名可填写内网域名,加快传输速率,不产生公网网络费用,杭州为例: `oss-cn-hangzhou-internal.aliyuncs.com` 。具体的域名列表映射可参考[OSS地域和访问域名](~~31837~~)。', 'type' => 'string', 'required' => true, 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'],
+ ],
+ [
+ 'name' => 'UploadUrl',
+ 'in' => 'query',
+ 'schema' => ['description' => '从OSS拉取文件的云端地址。'."\n"
+ ."\n"
+ .'> 可使用的OSS桶名,必须以“cloudphone-saved-bucket-”前缀的Bucket桶,例如“cloudphone-saved-bucket-example”,并创建OSS文件夹作为备份目录。UploadUrl的拼写规则是“oss://”+“桶名”+“/”+“文件夹名称”。', 'type' => 'string', 'required' => true, 'example' => 'oss://cloudphone-saved-bucket-example/received'."\n"],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用于保证请求的幂等性,防止重复提交请求。不超过 100 个字符。', 'type' => 'string', 'required' => false, 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<Integer>',
- 'description' => 'PlainResult<Integer>',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => '返回结果对象。',
+ 'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '返回结果对象。',
'type' => 'object',
'properties' => [
- 'AndroidInstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-34pqe4r0kd9kn****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-bp67acfmxazb4p****',
- ],
+ 'AndroidInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-bp67acfmxazb4p****'],
],
],
+ 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'."\n",
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
- ],
- 'Count' => [
- 'description' => '恢复的实例个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TaskId' => [
- 'description' => '批量任务ID。',
- 'type' => 'string',
- 'example' => 't-1ljew7on6ay0j****',
- ],
+ 'RequestId' => ['description' => '请求唯一ID,如果遇到问题请提供这个请求ID,由工作人员为您排查。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'TaskId' => ['description' => '批量任务ID。', 'type' => 'string', 'example' => 't-ehs0yoedj0xe9****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-bp67acfmxazb4p****\\"\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"TaskId\\": \\"t-ehs0yoedj0xe9****\\"\\n}","type":"json"}]',
+ 'title' => '从云手机拉取文件',
+ 'description' => '目前仅支持将云手机的文件或文件夹拉取到OSS对象存储服务。',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-17T05:04:23.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-09-13T09:20:16.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-bp67acfmxazb4p****\\"\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-1ljew7on6ay0j****\\"\\n}","type":"json"}]',
- 'title' => '整机恢复',
- 'description' => '1. 为保证您的恢复成功率,我们将在整机恢复时执行云机重启,应用和数据恢复时无需重启云手机,请确保您的云手机为可用状态,在恢复过程中请勿操作云手机,否则恢复操作可能失败。'."\n"
- .'2. 请确保您的备份文件可以正常恢复,恢复完成后,请检查和验证您的数据是否全部完整、功能是否正常使用,再考虑删除原始备份文件和重置源实例,否则您的数据可能丢失。',
],
- 'RecoverApp' => [
- 'summary' => '将应用备份产生的备份文件恢复到另一台云手机实例。',
+ 'GenerateCoordinationCode' => [
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneWDBBSN',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMEHI4H'],
],
'parameters' => [
[
- 'name' => 'BackupFileId',
+ 'name' => 'OwnerUserId',
'in' => 'query',
- 'schema' => [
- 'title' => 'App oss地址',
- 'description' => '备份文件id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'bf-azhps4rdyi2th****',
- ],
+ 'schema' => ['description' => '当前实例分配的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'xiaoming'],
],
[
- 'name' => 'AndroidInstanceIdList',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-2zecay9ponatdc4m****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-34pqe4r0kd9kn****',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****'],
+ 'CoordinatorCode' => ['description' => '协同码。', 'type' => 'string', 'example' => 'CSHGDK'],
],
- 'deprecated' => false,
- 'required' => true,
- 'maxItems' => 100,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '生成协同码',
+ 'summary' => '云手机默认情况只能通过BatchGetAcpConnectionTicket接口获取连接Ticket,一个云手机只支持一个用户连接。如果需要多个用户连接同一个云手机。可为当前无影便捷账号连接中的云手机生成一个协同码,通过将协同码分享给其他便捷账号,则可实现其他账号连接到当前云手机的场景。',
+ 'description' => '<props="china">为当前无影便捷账号连接中的云手机生成一个协同码,其他便捷账号可以在云手机客户端(包括桌面端、移动端和Web端)使用该协同码连接到当前云手机,也可以通过[ApplyCoordinationWithCode](~~2863194~~)接口发起协同连接,获取协同连接凭证。</props>'."\n"
+ ."\n"
+ .'<props="intl">为当前无影便捷账号连接中的云手机生成一个协同码,其他便捷账号可以在云手机客户端(包括桌面端、移动端和Web端)使用该协同码连接到当前云手机。</props>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\",\\n \\"CoordinatorCode\\": \\"CSHGDK\\"\\n}","type":"json"}]',
+ ],
+ 'GetInstanceProperties' => [
+ 'summary' => '获取实例属性信息。系统将通过android getprop命令获取所有云手机属性信息。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'UploadEndpoint',
- 'in' => 'query',
- 'schema' => [
- 'description' => '备份地域。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss-cn-shanghai-internal.aliyuncs.com',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneA5LZN6'],
+ ],
+ 'parameters' => [
[
- 'name' => 'UploadType',
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-2ofr9kf41apy3****-014'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '备份类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OSS',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC******'],
+ 'PropertyTemplateModel' => [
+ 'description' => '实例属性信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '实例属性信息。'."\n"
+ ."\n"
+ .'> 属性格式为:`{ "propties":{"key1":"value1"}}`。', 'type' => 'string', 'example' => '{ "propties":{"key1":"value1"}}'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取实例属性',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC******\\",\\n \\"PropertyTemplateModel\\": {\\n \\"Content\\": \\"{ \\\\\\"propties\\\\\\":{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"}}\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetNetworkBlacklist' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'BackupFilePath',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphone89PVC7'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Type',
'in' => 'query',
'schema' => [
- 'description' => '备份文件上传的OSS地址。',
+ 'description' => '用于指定查询类型(IP 或 Domain),若不填写则默认返回所有类型的黑名单信息。',
'type' => 'string',
- 'required' => true,
- 'example' => 'oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab',
+ 'required' => false,
+ 'example' => 'IP',
+ 'enum' => ['Domain', 'IP'],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => 'PlainResult<Integer>',
+ 'title' => 'Schema of Response',
+ 'description' => '接口返回数据。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'AndroidInstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-34pqe4r0kd9kn****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-22ex666a653gq****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => 'A578AD3A-8E7C-54FE-A09F-B060941*****'],
+ 'NetworkBlacklistModel' => [
+ 'description' => '网络黑名单',
+ 'type' => 'object',
+ 'properties' => [
+ 'IpBlacklist' => [
+ 'description' => 'IP地址黑名单列表',
+ 'type' => 'array',
+ 'items' => ['description' => 'IP地址或IP段', 'type' => 'string', 'example' => '12.34.56.78'],
+ ],
+ 'DomainBlacklist' => [
+ 'description' => '域名黑名单列表',
+ 'type' => 'array',
+ 'items' => ['description' => '域名', 'type' => 'string', 'example' => 'malicious.com'],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '6C8439B9-7DBF-57F4-92AE-55A9B9D3****',
- ],
- 'Count' => [
- 'description' => '恢复的实例个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-1ljew7on6ay0j****',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询网络访问黑名单',
+ 'summary' => '查询IP或域名网络访问黑名单信息。',
+ 'description' => '- 需使用镜像版本 26.01 及更高版本'."\n"
+ .'- 通过此接口,用户可以查询其账户下设置的网络访问黑名单,包括IP地址和域名。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-22ex666a653gq****\\"\\n }\\n ],\\n \\"RequestId\\": \\"6C8439B9-7DBF-57F4-92AE-55A9B9D3****\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-1ljew7on6ay0j****\\"\\n}","type":"json"}]',
- 'title' => '应用恢复',
- 'description' => '1. 为保证您的恢复成功率,我们将在整机恢复时执行云机重启,应用和数据恢复时无需重启云手机,请确保您的云手机为可用状态,在恢复过程中请勿操作云手机,否则恢复操作可能失败。'."\n"
- .'2. 如果原云机已经有需要恢复的应用,我们将为您卸载原应用并安装您的备份文件中的应用以防止应用版本的差异。'."\n"
- .'3. 请确保您的备份文件可以正常恢复,恢复完成后,请检查和验证您的数据是否全部完整、功能是否正常使用,再考虑删除原始备份文件和重置源实例,否则您的数据可能丢失。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A578AD3A-8E7C-54FE-A09F-B060941*****\\",\\n \\"NetworkBlacklistModel\\": {\\n \\"IpBlacklist\\": [\\n \\"12.34.56.78\\"\\n ],\\n \\"DomainBlacklist\\": [\\n \\"malicious.com\\"\\n ]\\n }\\n}","type":"json"}]',
],
- 'BackupFile' => [
- 'summary' => '生成备份文件并上传到远端存储。 使用场景:可以基于数据安全的角度进行定期备份,也可以备份一机文件,恢复到多机,实现类似复制迁移的效果。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ImportImage' => [
+ 'summary' => '导入自定义镜像。',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10149,796 +7575,821 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneE62QJ7',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneLJI39N'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIdList',
+ 'name' => 'ImageFileURL',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aic-ig2bdpk374l12****',
- ],
- 'deprecated' => false,
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '镜像url地址(必须是阿里云oss地址)。', 'type' => 'string', 'required' => false, 'example' => 'https://xxx.oss-xxx/xxxx.tgz'],
],
[
- 'name' => 'Description',
+ 'name' => 'ImageName',
'in' => 'query',
- 'schema' => [
- 'title' => 'App文件名称',
- 'description' => '备份文件描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '这是一个备份/data的请求。',
- ],
+ 'schema' => ['description' => '镜像的名称。', 'type' => 'string', 'required' => false, 'example' => 'import custom image'],
],
[
- 'name' => 'SourceFilePathList',
+ 'name' => 'ImageDescription',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['description' => '镜像描述。', 'type' => 'string', 'required' => false, 'example' => 'android 12 custom image'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '备份的文件路径列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Android 系统的源文件目录绝对路径。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/data',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'ImageId' => ['title' => 'ImageId', 'description' => 'ImageId', 'type' => 'string', 'example' => 'imgc-06zyt9m93zwax****'],
],
- 'required' => false,
- 'maxItems' => 100,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '导入自定义镜像。',
+ 'description' => '1. 导入自定义镜像适用于用户有定制化功能或服务开发的场景。'."\n"
+ ."\n"
+ .'2. 用户需要先从平台获取所需要的 AOSP 镜像基线,进行自定义构建,并将构建完成的镜像导入平台进行使用。详细操作步骤可联系无影技术支持。'."\n"
+ ."\n"
+ .'3. 请保证镜像tar包小于2GB,否则可能导致镜像解析失败。'."\n"
+ ."\n"
+ .'4. 请保证您的 OSS 地址为内地地址,海外或香港地区可能导致镜像文件下载超时。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"ImageId\\": \\"imgc-06zyt9m93zwax****\\"\\n}","type":"json"}]',
+ ],
+ 'ImportKeyPair' => [
+ 'summary' => '导入由ADB工具产生的ADB密钥对的公钥部分。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'SourceAppList',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '备份的应用包名列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '备份的应用包名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'com.example.xhs',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneDADB6I'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'UploadType',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => '备份类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'OSS' => '备份文件上传到OSS Bucket',
- ],
- 'example' => 'OSS',
- ],
+ 'schema' => ['description' => 'ADB密钥对名称。', 'type' => 'string', 'required' => true, 'example' => 'TestKeyPairName', 'maxLength' => 128, 'minLength' => 1],
],
[
- 'name' => 'UploadEndpoint',
+ 'name' => 'PublicKeyBody',
'in' => 'query',
+ 'schema' => ['description' => '密钥对的公钥。', 'type' => 'string', 'required' => true, 'example' => 'ABC1234567*****', 'maxLength' => 1024, 'minLength' => 1],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '备份地址的域名。'."\n"
- ."\n"
- .'> 如果上传到OSS Bucket,调用describeBuckets接口获取Bucket,如果云手机和Bucket是同地域,获取intranetEndpoint字段;如果是不同地域获取extranetEndpoint字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss-cn-shanghai-internal.aliyuncs.com',
+ 'title' => 'PlainResult<KeyPairModel>',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'KeyPairId' => ['description' => 'ADB密钥对的ID。', 'type' => 'string', 'example' => 'kp-6v2q33ae4tw3*****'],
+ 'KeyPairName' => ['description' => 'ADB密钥对名称。', 'type' => 'string', 'example' => 'TestKeyPairName'],
+ 'GmtCreated' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2023-03-05T10:29:22Z'],
+ ],
+ ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****'],
+ ],
],
],
+ ],
+ 'title' => '导入ADB密钥对',
+ 'description' => '注意:导入的必须是ADB工具生成的密钥对,否则ADB连接的时候鉴权可能会失败。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"KeyPairId\\": \\"kp-6v2q33ae4tw3*****\\",\\n \\"KeyPairName\\": \\"TestKeyPairName\\",\\n \\"GmtCreated\\": \\"2023-03-05T10:29:22Z\\"\\n },\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
+ ],
+ 'InstallApp' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'BackupFilePath',
- 'in' => 'query',
- 'schema' => [
- 'description' => '备份文件的上传地址。'."\n"
- .'> 如果上传到OSS Bucket,调用describeBuckets接口获取bucketName,选择ossObjectList获取key,key是OSS Bucket的文件夹路径,拼接成`oss://${bucketName}/${key}`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://cloudphone-saved-bucket-****/backupDir/',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneL912BU'],
+ ],
+ 'parameters' => [
[
- 'name' => 'BackupFileName',
+ 'name' => 'AppIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '备份文件名称。',
- 'type' => 'string',
+ 'description' => '应用ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => '12710'],
'required' => false,
- 'example' => 'MyBackup',
+ 'maxItems' => 100,
+ 'minItems' => 1,
],
],
[
- 'name' => 'BackupAll',
+ 'name' => 'InstanceGroupIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '是否整机备份。',
- 'type' => 'boolean',
+ 'description' => '实例组列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-ayyhomlal7mvm****'],
'required' => false,
- 'example' => 'false',
+ 'maxItems' => 100,
+ 'minItems' => 0,
],
],
[
- 'name' => 'ExcludeSourceFilePathList',
+ 'name' => 'InstanceIdList',
'in' => 'query',
- 'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
+ 'description' => '实例列表。',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-dvbhknfasf123****'],
'required' => false,
- 'maxItems' => 100,
+ 'maxItems' => 1000,
+ 'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
+ 'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E5138F7E-46B5-526A-8C99-82DEAE6B****'],
+ 'TaskId' => ['title' => '父任务ID', 'description' => '任务ID。', 'type' => 'string', 'example' => 't-14xwibw7yp73q****'],
+ 'ChildTaskInfo' => [
+ 'title' => '子任务信息。',
+ 'description' => '子任务信息。',
'type' => 'array',
'items' => [
+ 'title' => '子任务对象。',
+ 'description' => '子任务对象。',
'type' => 'object',
'properties' => [
- 'BackupFileId' => [
- 'description' => '备份文件ID。',
- 'type' => 'string',
- 'example' => 'bf-b0qbg3pbpjkn7****',
- ],
- 'BackupFileName' => [
- 'description' => '备份文件名称。',
- 'type' => 'string',
- 'example' => 'MyBackup',
- ],
- 'AndroidInstanceId' => [
- 'description' => '云手机实例ID。',
- 'type' => 'string',
- 'example' => 'acp-34pqe4r0kd9kn****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-22ex666a653gq****',
- ],
+ 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'example' => 'acp-ty3bnd7b9xxxx'],
+ 'ChildTaskId' => ['title' => '子任务ID。', 'description' => '子任务ID。', 'type' => 'string', 'example' => 't-ybde48cevxxxx'],
+ 'AppId' => ['type' => 'string'],
],
],
- 'example' => '6C8439B9-7DBF-57F4-92AE-55A9B9D3****'."\n",
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '6C8439B9-7DBF-57F4-92AE-55A9B9D3****',
- ],
- 'Count' => [
- 'description' => '备份的实例个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TaskId' => [
- 'description' => '批量任务ID。',
- 'type' => 'string',
- 'example' => 't-14xwibw7pyrjd****',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"BackupFileId\\": \\"bf-b0qbg3pbpjkn7****\\",\\n \\"BackupFileName\\": \\"MyBackup\\",\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-22ex666a653gq****\\"\\n }\\n ],\\n \\"RequestId\\": \\"6C8439B9-7DBF-57F4-92AE-55A9B9D3****\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-14xwibw7pyrjd****\\"\\n}","type":"json"}]',
- 'title' => '创建备份文件',
- 'description' => '目前仅支持云手机生成的备份文件保存在OSS对象存储服务。',
- ],
- 'RecoveryFile' => [
- 'summary' => '恢复备份文件。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '安装应用',
+ 'summary' => '批量在无影云手机实例中安装应用。',
+ 'description' => '须先通过[CreateApp](~~2807330~~)接口进行应用创建,基于已经创建的应用安装至指定云手机中。此接口为异步接口,操作结果可以在任务中心查看。查询任务接口为[DescribeTasks](~~DescribeTasks~~)。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-22T13:03:49.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-17T03:35:22.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-08-19T09:35:42.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5138F7E-46B5-526A-8C99-82DEAE6B****\\",\\n \\"TaskId\\": \\"t-14xwibw7yp73q****\\",\\n \\"ChildTaskInfo\\": [\\n {\\n \\"InstanceId\\": \\"acp-ty3bnd7b9xxxx\\",\\n \\"ChildTaskId\\": \\"t-ybde48cevxxxx\\",\\n \\"AppId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'InstallMonitorAgent' => [
+ 'summary' => '一键安装监控插件,只有安装了监控插件,实例才会有监控数据。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMPR6T6',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVQDPK9'],
],
'parameters' => [
[
- 'name' => 'BackupFileId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'App oss地址',
- 'description' => '备份文件ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bf-azhps4rdyi2th****',
- ],
- ],
- [
- 'name' => 'AndroidInstanceIdList',
- 'in' => 'query',
+ 'name' => 'AndroidInstanceIds',
+ 'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '云手机实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-ig2bdpk374l12****',
- ],
- 'deprecated' => false,
- 'required' => true,
- 'maxItems' => 100,
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-a1qp88ohp3a8g****-040'],
+ 'required' => false,
+ 'maxItems' => 1000,
],
],
[
- 'name' => 'UploadType',
- 'in' => 'query',
+ 'name' => 'SaleMode',
+ 'in' => 'formData',
'schema' => [
- 'description' => '备份类型。',
+ 'description' => '监控类型。'."\n"
+ ."\n"
+ .'- 实例模式:Instance'."\n"
+ .'- 节点模式:Node',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'OSS' => '备份文件保存在OSS桶。',
+ 'enumValueTitles' => ['Instance' => '实例模式', 'Node' => '节点模式'],
+ 'example' => 'NODE',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DB070C80-45AC-52CA-8101-937C25DA****'],
],
- 'example' => 'OSS',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '安装监控插件',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB070C80-45AC-52CA-8101-937C25DA****\\"\\n}","type":"json"}]',
+ ],
+ 'InstanceHealer' => [
+ 'summary' => '云手机矩阵实例诊断恢复,目前仅可以清理实例的系统日志文件,避免磁盘打满之后实例异常无法恢复。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'UploadEndpoint',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneYYGTDB'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '备份地址的域名。'."\n"
- .'<notice>调用DescribeBuckets接口获取Bucket,如果云手机和bucket是同地域,获取IntranetEndpoint字段;如果是不同地域获取ExtranetEndpoint字段。></notice>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com',
+ 'description' => '实例列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-42do7k******-001'],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'BackupFilePath',
+ 'name' => 'Timeout',
'in' => 'query',
- 'schema' => [
- 'description' => '备份文件上传的OSS地址。'."\n"
- .'<notice>调用describeBuckets接口获取bucketName,选择ossObjectList获取key,key是备份文件的路径,拼接成“oss://${bucketName}/${key}”。</notice>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab',
- ],
+ 'schema' => ['description' => '超时时间。不传默认30秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'],
],
[
- 'name' => 'BackupAll',
+ 'name' => 'Strategy',
'in' => 'query',
'schema' => [
- 'description' => '是否整机备份。',
- 'type' => 'boolean',
+ 'description' => '策略类型,目前仅支持清理系统日志文件。',
+ 'type' => 'string',
'required' => false,
- 'example' => 'false',
+ 'enumValueTitles' => ['Clean' => '清理系统日志'],
+ 'example' => 'Clean',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => '返回参数。',
+ 'title' => 'Schema of Response',
+ 'description' => '返回值。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'AndroidInstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-34pqe4r0kd9kn****',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-ehs0yoedsskom****',
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7B9EFA4F-4305-5968-BAEE-BD8B8DE5****'],
+ 'InstanceHealerModel' => [
+ 'description' => '诊断结果对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => ['description' => '任务执行结果。', 'type' => 'string', 'example' => 'True'],
],
- 'example' => '6AD56E39-430B-5401-AB4A-7B086454****'."\n",
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '6AD56E39-430B-5401-AB4A-7B086454****',
- ],
- 'Count' => [
- 'description' => '恢复的实例个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TaskId' => [
- 'description' => '批量任务ID。',
- 'type' => 'string',
- 'example' => 't-3eourrxaoliqq****',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '实例诊断恢复',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-ehs0yoedsskom****\\"\\n }\\n ],\\n \\"RequestId\\": \\"6AD56E39-430B-5401-AB4A-7B086454****\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-3eourrxaoliqq****\\"\\n}","type":"json"}]',
- 'title' => '恢复备份文件',
- 'description' => '目前仅支持云手机生成的备份文件保存在OSS对象存储服务。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B9EFA4F-4305-5968-BAEE-BD8B8DE5****\\",\\n \\"InstanceHealerModel\\": {\\n \\"Result\\": \\"True\\"\\n }\\n}","type":"json"}]',
],
- 'DescribeBackupFiles' => [
- 'summary' => '查询备份文件列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListInstanceAdbAttributes' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMPR6T6',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphone89PVC7'],
],
'parameters' => [
[
- 'name' => 'BackupFileId',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'App文件地址',
- 'description' => '备份文件ID。',
- 'type' => 'string',
+ 'description' => '云手机实例ID列表,可设置 1~100 个。',
+ 'type' => 'array',
+ 'items' => ['description' => '云手机实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh431emkt6u*****'],
'required' => false,
- 'example' => 'bf-dxrh5jrv0zpb8****',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'BackupFileName',
+ 'name' => 'ExternalIp',
'in' => 'query',
- 'schema' => [
- 'title' => 'App文件名称',
- 'description' => '备份文件名称。支持模糊查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abc',
- ],
+ 'schema' => ['description' => '公网IP地址。', 'type' => 'string', 'required' => false, 'example' => '106.38.188.223'],
],
[
- 'name' => 'InstanceGroupId',
+ 'name' => 'InternalIp',
'in' => 'query',
- 'schema' => [
- 'title' => 'App oss地址',
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ag-fxdx91jsfyiy3****',
- ],
+ 'schema' => ['description' => '内网IP地址。', 'type' => 'string', 'required' => false, 'example' => '10.0.3.23'],
],
[
- 'name' => 'AndroidInstanceId',
+ 'name' => 'InternalPort',
'in' => 'query',
- 'schema' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-34pqe4r0kd9kn****',
- ],
+ 'schema' => ['description' => 'ADB端口号。', 'type' => 'string', 'required' => false, 'example' => '5555'],
],
[
- 'name' => 'AndroidInstanceName',
+ 'name' => 'IpProtocol',
'in' => 'query',
- 'schema' => [
- 'description' => '实例名称。支持模糊查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-34pqe4r0kd9kn****',
- ],
+ 'schema' => ['description' => '网络协议类型。', 'type' => 'string', 'required' => false, 'example' => 'TCP'],
],
[
- 'name' => 'Description',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '描述。支持模糊查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'desc',
- ],
+ 'schema' => ['description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '20', 'default' => '20'],
],
[
- 'name' => 'StatusList',
+ 'name' => 'NextToken',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '备份文件状态列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '备份文件状态。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'AVAILABLE' => '可用',
- 'BACKUPING' => '备份中',
- 'RECOVERING' => '恢复中',
- 'DELETING' => '删除中',
- 'BACKUP_FAILED' => '备份失败',
- 'RECOVERY_FAILED' => '恢复失败',
- 'PART_BACKUP_FINISHED' => '部分备份成功',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => '接口返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => '实例ADB连接信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '实例ADB连接信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GmtCreated' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-05-15 17:33:59'],
+ 'GmtModified' => ['description' => '修改时间', 'type' => 'string', 'example' => '2024-05-15 17:33:59'],
+ 'InstanceId' => ['description' => '云手机实例ID。', 'type' => 'string', 'example' => 'acp-uto81vfd8t8z****'],
+ 'ExternalIp' => ['description' => '公网IP地址。', 'type' => 'string', 'example' => '183.201.219.157'],
+ 'ExternalPort' => ['description' => '公网端口号。', 'type' => 'string', 'example' => '14840/14849'],
+ 'InternalIp' => ['description' => '内网IP地址。', 'type' => 'string', 'example' => '10.0.0.239'],
+ 'InternalPort' => ['description' => '私网端口号。', 'type' => 'string', 'example' => '5555/5555'],
+ 'IpProtocol' => ['description' => '网络协议类型。', 'type' => 'string', 'example' => 'TCP'],
+ ],
+ ],
],
- 'example' => 'AVAILABLE',
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CB95E410-FD1D-53C5-9F7D-93CC44D7****'],
+ 'NextToken' => ['description' => '下一次查询的令牌(Token)。如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
+ 'MaxResults' => ['description' => '本次读取的最大数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
- 'required' => false,
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '查询当前时间之后的备份文件。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-05-23 10:00:00',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询实例ADB连接信息',
+ 'summary' => '查询实例ADB连接信息(仅限标准网络)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreated\\": \\"2024-05-15 17:33:59\\",\\n \\"GmtModified\\": \\"2024-05-15 17:33:59\\",\\n \\"InstanceId\\": \\"acp-uto81vfd8t8z****\\",\\n \\"ExternalIp\\": \\"183.201.219.157\\",\\n \\"ExternalPort\\": \\"14840/14849\\",\\n \\"InternalIp\\": \\"10.0.0.239\\",\\n \\"InternalPort\\": \\"5555/5555\\",\\n \\"IpProtocol\\": \\"TCP\\"\\n }\\n ],\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"CB95E410-FD1D-53C5-9F7D-93CC44D7****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MaxResults\\": 100\\n}","type":"json"}]',
+ ],
+ 'ListPolicyGroups' => [
+ 'summary' => '查询策略详细信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'EndTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '查询当前时间之前的备份文件。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-05-20 10:00:00',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneS5VM56'],
+ ],
+ 'parameters' => [
[
- 'name' => 'EndUserId',
- 'in' => 'query',
+ 'name' => 'PolicyGroupIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '备份文件的Owner。',
- 'type' => 'string',
+ 'description' => '策略ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-jc31jdxfdcsclk****'],
'required' => false,
- 'example' => 'test1',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'BackupAll',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否整机备份。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
- ],
- 'example' => 'false',
- ],
+ 'name' => 'PolicyGroupName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '策略名称。', 'type' => 'string', 'required' => false, 'example' => 'Default policy'],
],
[
'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为10。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '10',
- 'default' => '20',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20'],
],
[
'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '用来标记当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
],
[
- 'name' => 'SaleMode',
- 'in' => 'query',
+ 'name' => 'PolicyType',
+ 'in' => 'formData',
'schema' => [
+ 'description' => '策略类型。',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => ['Instance' => 'Instance', 'Node' => 'Node'],
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Node'],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
+ 'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7B9EFA4F-4305-5968-BAEE-BD8B8DE5****'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '31'],
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****'],
+ 'PolicyGroupModel' => [
+ 'description' => '策略信息。',
'type' => 'array',
'items' => [
- 'description' => '返回结果对象。',
+ 'description' => '策略信息。',
'type' => 'object',
'properties' => [
- 'GmtCreated' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-05-15 17:33:59',
- ],
- 'GmtModified' => [
- 'description' => '更新时间',
- 'type' => 'string',
- 'example' => '2024-05-15 17:33:59',
- ],
- 'BackupFileId' => [
- 'description' => '备份文件ID。',
- 'type' => 'string',
- 'example' => 'bf-b0qbg3pbpjkn7****',
- ],
- 'BackupFileName' => [
- 'description' => '备份文件名称。',
+ 'PolicyGroupId' => ['description' => '策略ID。', 'type' => 'string', 'example' => 'pg-9q6o8qpiy8opkj****'],
+ 'PolicyGroupName' => ['description' => '策略名称。', 'type' => 'string', 'example' => 'Default policy.'],
+ 'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '2024-06-04 10:28:54'],
+ 'Clipboard' => [
+ 'description' => '剪切板权限。',
'type' => 'string',
- 'example' => 'a-58ftsoo90p0qa****.ab',
+ 'enumValueTitles' => ['read' => '单向允许', 'readwrite' => '双向允许', 'off' => '双向禁止'],
+ 'example' => 'readwrite',
],
- 'InstanceGroupId' => [
- 'description' => '实例ID。',
+ 'Html5FileTransfer' => [
+ 'description' => 'HTML5客户端文件传输策略。',
'type' => 'string',
- 'example' => 'ag-58ftsoo90p0qi****',
+ 'enumValueTitles' => ['all' => '允许上传下载', 'download' => '允许下载', 'upload' => '允许上传', 'off' => '关闭'],
+ 'example' => 'download',
],
- 'AndroidInstanceId' => [
- 'description' => '实例ID。',
+ 'CameraRedirect' => [
+ 'description' => '是否开启本地摄像头重定向。',
'type' => 'string',
- 'example' => 'acp-34pqe4r0kd9kn****',
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'on',
],
- 'AndroidInstanceName' => [
- 'description' => '实例名称。',
+ 'LocalDrive' => [
+ 'description' => '本地磁盘映射权限。',
'type' => 'string',
- 'example' => '测试云手机',
+ 'enumValueTitles' => ['read' => '只读', 'readwrite' => '读写', 'off' => '关闭'],
+ 'example' => 'off',
],
- 'TaskId' => [
- 'description' => '任务ID。',
+ 'LockResolution' => [
+ 'description' => '锁定分辨率',
'type' => 'string',
- 'example' => 't-bp67acfmxazb4p****',
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
],
- 'EndUserId' => [
- 'description' => '备份文件的Owner。',
- 'type' => 'string',
- 'example' => 'test',
+ 'NetRedirectPolicy' => [
+ 'description' => '网络重定向。',
+ 'type' => 'object',
+ 'properties' => [
+ 'NetRedirect' => [
+ 'description' => '是否开启网络重定向。开启后,默认重定向至端侧网络。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
+ ],
+ 'CustomProxy' => [
+ 'description' => '是否手动配置透明代理。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
+ ],
+ 'ProxyType' => [
+ 'description' => '代理协议类型。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['socks5' => 'socks5'],
+ 'example' => 'socks5',
+ ],
+ 'HostAddr' => ['description' => '透明代理IP。格式为IPv4地址。', 'type' => 'string', 'example' => '47.100.XX.XX'],
+ 'Port' => ['description' => '透明代理端口。端口取值范围为1~65535。', 'type' => 'string', 'example' => '1145'],
+ 'ProxyUserName' => ['description' => '代理用户名。长度范围为1~256,不允许包含中文字符和空白字符。', 'type' => 'string', 'example' => 'username'],
+ 'ProxyPassword' => ['description' => '代理密码。长度范围为1~256,不允许包含中文字符和空白字符。', 'type' => 'string', 'example' => 'password'],
+ 'Rules' => [
+ 'description' => '代理规则列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '代理规则',
+ 'type' => 'object',
+ 'properties' => [
+ 'Target' => ['description' => '应用包名或域名', 'type' => 'string', 'example' => '*.baidu.com'],
+ 'RuleType' => [
+ 'description' => '规则类型',
+ 'type' => 'string',
+ 'enumValueTitles' => ['prc' => '应用包名', 'domain' => '域名'],
+ 'example' => 'domain',
+ ],
+ ],
+ ],
+ ],
+ ],
],
- 'Status' => [
- 'description' => '备份文件状态。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'AVAILABLE' => '可用',
- 'RECOVERING' => '恢复中',
+ 'SessionResolutionHeight' => ['description' => '分辨率的高度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1080'],
+ 'SessionResolutionWidth' => ['description' => '分辨率的宽度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1920'],
+ 'PolicyRelatedResources' => [
+ 'description' => '策略关联资源。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AndroidInstanceGroupIds' => [
+ 'description' => '实例组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'example' => 'ag-2dzpub83srxt*****'],
+ ],
+ 'CloudPhoneMatrixIds' => [
+ 'description' => '矩阵ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '矩阵ID。', 'type' => 'string', 'example' => 'cpn-3dskdfjj245s*****'],
+ ],
],
- 'example' => 'AVAILABLE',
],
- 'SourceFilePathList' => [
- 'description' => '源备份文件的目录列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '源备份文件的目录。',
- 'type' => 'string',
- 'example' => '/data/media',
+ 'Watermark' => [
+ 'description' => '屏幕水印。',
+ 'type' => 'object',
+ 'properties' => [
+ 'WatermarkSwitch' => [
+ 'description' => '屏幕水印开关。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
+ 'example' => 'off',
+ ],
+ 'WatermarkTypes' => [
+ 'description' => '屏幕水印内容。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '屏幕水印内容。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['Username' => '用户名', 'CustomText' => '自定义文字', 'ClientIpAddress' => '客户端IP地址', 'IpAddress' => 'IP地址', 'ClientTime' => '当前时间'],
+ 'example' => 'Username',
+ ],
+ ],
+ 'WatermarkCustomText' => ['description' => '水印自定义内容。长度不超过10个字符,且不支持emoji字符。', 'type' => 'string', 'example' => 'custom text'],
+ 'WatermarkFontSize' => ['description' => '水印字体大小。 取值范围:10\\~20。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'WatermarkColor' => ['description' => '水印字体颜色。 取值范围: 0\\~16777215。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'WatermarkTransparencyValue' => ['description' => '水印不透明度,值越大,透明度越小。 取值范围: 10\\~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
],
],
- 'SourceAppInfoList' => [
- 'description' => '备份的应用包名列表。',
+ 'AccessPolicies' => [
'type' => 'array',
'items' => [
- 'description' => '备份的应用包名。',
- 'type' => 'string',
- 'example' => 'com.example.xhs',
- ],
- ],
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'FileSize' => [
- 'description' => '源备份文件总大小。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10227168',
- ],
- 'UploadType' => [
- 'description' => '备份类型。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'OSS' => '备份文件保存在OSS桶。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessPolicyRuleId' => ['type' => 'integer', 'format' => 'int64'],
+ 'CidrIp' => ['type' => 'string'],
+ 'Policy' => ['type' => 'string'],
+ 'Priority' => ['type' => 'integer', 'format' => 'int32'],
+ 'Description' => ['type' => 'string'],
+ ],
],
- 'example' => 'OSS',
- ],
- 'UploadEndpoint' => [
- 'description' => '上传地址的域名。',
- 'type' => 'string',
- 'example' => 'oss-cn-hangzhou.aliyuncs.com',
- ],
- 'BackupFilePath' => [
- 'description' => '备份文件保存的目录。',
- 'type' => 'string',
- 'example' => 'oss://cloudphone-saved-bucket-cn-shanghai/backup/aic-58ftsoo90p0qa****.ab',
- ],
- 'Description' => [
- 'description' => '备份文件的描述信息。',
- 'type' => 'string',
- 'example' => '这是备份/data/media目录的备份文件。',
- ],
- 'BackupAll' => [
- 'description' => '是否整机备份。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'SystemVersion' => [
- 'type' => 'string',
],
],
],
],
- 'RequestId' => [
- 'description' => '请求唯一ID,如果遇到问题请提供这个请求ID,由工作人员为您排查。',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
- ],
- 'NextToken' => [
- 'description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****',
- ],
- 'MaxResults' => [
- 'description' => '本次读取的最大数据量。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '91',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreated\\": \\"2024-05-15 17:33:59\\",\\n \\"GmtModified\\": \\"2024-05-15 17:33:59\\",\\n \\"BackupFileId\\": \\"bf-b0qbg3pbpjkn7****\\",\\n \\"BackupFileName\\": \\"a-58ftsoo90p0qa****.ab\\",\\n \\"InstanceGroupId\\": \\"ag-58ftsoo90p0qi****\\",\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"AndroidInstanceName\\": \\"测试云手机\\",\\n \\"TaskId\\": \\"t-bp67acfmxazb4p****\\",\\n \\"EndUserId\\": \\"test\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"SourceFilePathList\\": [\\n \\"/data/media\\"\\n ],\\n \\"SourceAppInfoList\\": [\\n \\"com.example.xhs\\"\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FileSize\\": 10227168,\\n \\"UploadType\\": \\"OSS\\",\\n \\"UploadEndpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"BackupFilePath\\": \\"oss://cloudphone-saved-bucket-cn-shanghai/backup/aic-58ftsoo90p0qa****.ab\\",\\n \\"Description\\": \\"这是备份/data/media目录的备份文件。\\",\\n \\"BackupAll\\": false,\\n \\"SystemVersion\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": 91\\n}","type":"json"}]',
- 'title' => '查询备份文件列表',
- 'description' => '目前仅支持云手机生成的备份文件保存在OSS对象存储服务。',
- ],
- 'DeleteBackupFile' => [
- 'summary' => '批量删除备份文件。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'https',
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
+ 'title' => '查询策略详细信息',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-25T11:27:20.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-04-17T12:43:42.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-04-03T10:00:32.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-01-21T07:20:10.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-01-09T15:07:06.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-11-15T01:35:07.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-09-26T11:32:59.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-08-20T03:54:01.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-08-19T09:42:45.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B9EFA4F-4305-5968-BAEE-BD8B8DE5****\\",\\n \\"TotalCount\\": 31,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****\\",\\n \\"PolicyGroupModel\\": [\\n {\\n \\"PolicyGroupId\\": \\"pg-9q6o8qpiy8opkj****\\",\\n \\"PolicyGroupName\\": \\"Default policy.\\",\\n \\"GmtCreate\\": \\"2024-06-04 10:28:54\\",\\n \\"Clipboard\\": \\"readwrite\\",\\n \\"Html5FileTransfer\\": \\"download\\",\\n \\"CameraRedirect\\": \\"on\\",\\n \\"LocalDrive\\": \\"off\\",\\n \\"LockResolution\\": \\"off\\",\\n \\"NetRedirectPolicy\\": {\\n \\"NetRedirect\\": \\"off\\",\\n \\"CustomProxy\\": \\"off\\",\\n \\"ProxyType\\": \\"socks5\\",\\n \\"HostAddr\\": \\"47.100.XX.XX\\",\\n \\"Port\\": \\"1145\\",\\n \\"ProxyUserName\\": \\"username\\",\\n \\"ProxyPassword\\": \\"password\\",\\n \\"Rules\\": [\\n {\\n \\"Target\\": \\"*.baidu.com\\",\\n \\"RuleType\\": \\"domain\\"\\n }\\n ]\\n },\\n \\"SessionResolutionHeight\\": 1080,\\n \\"SessionResolutionWidth\\": 1920,\\n \\"PolicyRelatedResources\\": {\\n \\"AndroidInstanceGroupIds\\": [\\n \\"ag-2dzpub83srxt*****\\"\\n ],\\n \\"CloudPhoneMatrixIds\\": [\\n \\"cpn-3dskdfjj245s*****\\"\\n ]\\n },\\n \\"Watermark\\": {\\n \\"WatermarkSwitch\\": \\"off\\",\\n \\"WatermarkTypes\\": [\\n \\"Username\\"\\n ],\\n \\"WatermarkCustomText\\": \\"custom text\\",\\n \\"WatermarkFontSize\\": 12,\\n \\"WatermarkColor\\": 0,\\n \\"WatermarkTransparencyValue\\": 25\\n },\\n \\"AccessPolicies\\": [\\n {\\n \\"AccessPolicyRuleId\\": 0,\\n \\"CidrIp\\": \\"\\",\\n \\"Policy\\": \\"\\",\\n \\"Priority\\": 0,\\n \\"Description\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListTagResources' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMPR6T6',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneDADB6I'],
],
'parameters' => [
[
- 'name' => 'BackupFileIdList',
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '地域ID。'."\n"
+ .'<props="china">该参数的值固定传入`cn-shanghai`。</props>'."\n"
+ .'<props="intl">该参数的值固定传入`ap-southeast-1`。</props>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai / ap-southeast-1'],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '资源类型。',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => ['ALIYUN::ACP::INSTANCE' => '云手机'],
+ 'example' => 'ALIYUN::ACP::INSTANCE',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来标记当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****'],
+ ],
+ [
+ 'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '备份文件ID列表',
+ 'description' => '资源 ID 列表,即云手机ID 列表。可包含 1~50 个。',
+ 'type' => 'array',
+ 'items' => ['description' => '资源 ID,即云手机ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-123456abc****'],
+ 'required' => false,
+ 'maxItems' => 50,
+ ],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '标签列表。',
'type' => 'array',
'items' => [
- 'description' => '备份文件ID',
- 'type' => 'string',
+ 'description' => '标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。可包含 1~20 个。', 'type' => 'string', 'required' => false, 'example' => 'department'],
+ 'Value' => ['description' => '标签值。可包含 1~20 个。', 'type' => 'string', 'required' => false, 'example' => 'design'],
+ ],
'required' => false,
- 'example' => 'bf-islptramvb730****',
],
- 'required' => true,
- 'maxItems' => 100,
+ 'required' => false,
+ 'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Integer>',
- 'description' => 'PlainResult<Integer>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '本次请求的ID。',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
+ 'NextToken' => ['description' => '用来表示当前开始读取的位置。置空表示从头开始。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20393E53-8FF1-524C-B494-B478A5369733'],
+ 'TagResources' => [
+ 'description' => '资源及其标签信息集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '查询到的实例和标签详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'TF'],
+ 'ResourceType' => [
+ 'description' => '资源类型。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['ALIYUN::ACP::INSTANCE' => '云手机'],
+ 'example' => 'ALIYUN::ACP::INSTANCE',
+ ],
+ 'ResourceId' => ['description' => '资源 ID,即云手机ID。', 'type' => 'string', 'example' => 'acp-8jwttemxb4t6y****'],
+ 'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'department'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询云手机已添加标签的列表',
+ 'summary' => '查询云手机已添加的标签的列表。',
+ 'description' => '请求中至少指定一个参数:`ResourceId.N`、`Tag.N.Key`或者`Tag.N.Value`,以确定查询对象。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\"\\n}","type":"json"}]',
- 'title' => '删除备份文件',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****\\",\\n \\"RequestId\\": \\"20393E53-8FF1-524C-B494-B478A5369733\\",\\n \\"TagResources\\": [\\n {\\n \\"TagValue\\": \\"TF\\",\\n \\"ResourceType\\": \\"ALIYUN::ACP::INSTANCE\\",\\n \\"ResourceId\\": \\"acp-8jwttemxb4t6y****\\",\\n \\"TagKey\\": \\"department\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'CreatePolicyGroup' => [
- 'summary' => '创建策略。策略用于对云手机进行统一的设置,例如网络重定向策略、水印、分辨率、剪贴板等功能设置。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ModifyAndroidInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10947,291 +8398,314 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneS5VM56',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVGR0HK'],
],
'parameters' => [
[
- 'name' => 'Html5FileTransfer',
- 'in' => 'formData',
+ 'name' => 'AndroidInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '单个实例ID,当该字段有值时会忽略InstanceIds(多个实例ID)', 'type' => 'string', 'required' => false, 'example' => 'acp-8v5bjld0r7tkl****'."\n"],
+ ],
+ [
+ 'name' => 'NewAndroidInstanceName',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例的新名称。'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> - 实例名称长度不超过30个字符;请以大/小写字母或中文开头,不能以http://和https://开头,仅支持中文、英文、数字、半角冒号(:)、下划线(_)、点号(.)或者连字符(-)', 'type' => 'string', 'required' => false, 'example' => 'new_name'],
+ ],
+ [
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '无影Web客户端文件传输策略。',
- 'type' => 'string',
+ 'description' => '云手机实例ID列表,可设置 1~100 个。',
+ 'type' => 'array',
+ 'items' => ['description' => '云手机实例ID', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh4a31emkt6u****'],
'required' => false,
- 'enumValueTitles' => [
- 'all' => '允许上传下载',
- 'download' => '允许下载',
- 'upload' => '允许上传',
- 'off' => '关闭',
- ],
- 'example' => 'off',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'LocalDrive',
- 'in' => 'formData',
+ 'name' => 'UpBandwidthLimit',
+ 'in' => 'query',
+ 'schema' => ['description' => '上行带宽限速,单位Mbps', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ ],
+ [
+ 'name' => 'DownBandwidthLimit',
+ 'in' => 'query',
+ 'schema' => ['description' => '下行带宽限速,单位Mbps', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '本地磁盘映射权限。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'read' => '只读',
- 'readwrite' => '读写',
- 'off' => '关闭',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E5138F7E-46B5-526A-8C99-82DEAE6B****'],
],
- 'example' => 'off',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改实例信息',
+ 'summary' => '修改云手机实例信息,目前仅支持修改实例名称、上下行带宽限制。',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-15T07:46:27.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5138F7E-46B5-526A-8C99-82DEAE6B****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyAndroidInstanceGroup' => [
+ 'summary' => '修改云手机实例组的信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'PolicyGroupName',
- 'in' => 'formData',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVGR0HK'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-cuv4scs4obxhs****'."\n"],
+ ],
+ [
+ 'name' => 'NewInstanceGroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例组的新名称。'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> - 实例组名称长度不超过30个字符;请以大/小写字母或中文开头,不能以http://和https://开头,仅支持中文、英文、数字、半角冒号(:)、下划线(_)、点号(.)或者连字符(-)', 'type' => 'string', 'required' => false, 'example' => 'newName'],
+ ],
+ [
+ 'name' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-2w97kp89gnsif****'],
+ ],
+ [
+ 'name' => 'StreamMode',
+ 'in' => 'query',
'schema' => [
- 'description' => '策略名称。',
- 'type' => 'string',
+ 'description' => '实例组下实例的串流模式,该参数不传默认为抢占模式。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => '默认策略',
+ 'enumValueTitles' => [1 => '抢占模式 [默认值]', '协同模式'],
+ 'example' => '1',
],
],
- [
- 'name' => 'CameraRedirect',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '是否开启本地摄像头重定向。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6C83EBE3-F267-5F11-ABF8-4E7B90B****'],
],
- 'example' => 'off',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '修改实例组信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C83EBE3-F267-5F11-ABF8-4E7B90B****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyApp' => [
+ 'summary' => '修改应用信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Clipboard',
- 'in' => 'formData',
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none'],
+ 'parameters' => [
+ [
+ 'name' => 'AppId',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1234'],
+ ],
+ [
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'Application name'],
+ ],
+ [
+ 'name' => 'IconUrl',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Icon地址。', 'type' => 'string', 'required' => false, 'example' => 'https://defaultIcon.png'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用描述。', 'type' => 'string', 'required' => false, 'example' => 'Application description'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '剪贴板权限。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'read' => '单向允许',
- 'readwrite' => '双向允许',
- 'off' => '双向禁止',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83418504-5A82-5896-A24C-B2D468F0****'],
],
- 'example' => 'readwrite',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"83418504-5A82-5896-A24C-B2D468F0****\\"\\n}","type":"json"}]',
+ 'title' => '修改应用信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'ModifyCloudPhoneNode' => [
+ 'summary' => '修改云手机矩阵信息。'."\n"
+ ."\n"
+ .'在无影云手机系统中,矩阵(Cloud Phone Server)是一个逻辑上的资源管理单元,代表一个物理服务器实例。该物理服务器可以被划分为多个独立运行的云手机实例,这些实例共享矩阵底层的计算、存储和网络资源。创建一个矩阵,相当于获得一台物理服务器,您可以在其上创建相应的云手机实例(配置不同对应的云手机数量不同)。',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ResolutionHeight',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '分辨率的高度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1280',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneE7UBTJ'],
+ ],
+ 'parameters' => [
[
- 'name' => 'ResolutionWidth',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '分辨率的宽度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '720',
- ],
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => ['description' => '云手机矩阵ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-0ugbptfu473fy****'],
],
[
- 'name' => 'LockResolution',
- 'in' => 'formData',
+ 'name' => 'NewNodeName',
+ 'in' => 'query',
+ 'schema' => ['description' => '云手机矩阵的新名称。', 'type' => 'string', 'required' => false, 'example' => 'node_name_new'],
+ ],
+ [
+ 'name' => 'StreamMode',
+ 'in' => 'query',
'schema' => [
- 'description' => '是否锁定分辨率。',
- 'type' => 'string',
+ 'description' => '云手机矩阵下实例的串流模式,该参数不传默认为抢占模式。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
+ 'enumValueTitles' => [1 => '抢占模式', '协同模式'],
+ 'example' => '1',
],
],
- [
- 'name' => 'NetRedirectPolicy',
- 'in' => 'formData',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '网络重定向。',
+ 'title' => 'Schema of Response',
+ 'description' => '请求信息。',
'type' => 'object',
'properties' => [
- 'NetRedirect' => [
- 'description' => '是否开启网络重定向。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
- ],
- 'CustomProxy' => [
- 'description' => '是否手动配置透明代理。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
- ],
- 'ProxyType' => [
- 'description' => '代理协议类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'socks5' => 'socks5',
- ],
- 'example' => 'socks5',
- ],
- 'HostAddr' => [
- 'description' => '透明代理IP。格式为IPv4地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '47.100.XX.XX',
- ],
- 'Port' => [
- 'description' => '透明代理端口。端口取值范围为1\\~65535。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1145',
- ],
- 'ProxyUserName' => [
- 'description' => '代理用户名。长度范围为1\\~256,不允许包含中文字符和空白字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'username',
- ],
- 'ProxyPassword' => [
- 'description' => '代理密码。长度范围为1\\~256,不允许包含中文字符和空白字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'password',
- ],
- 'Rules' => [
- 'description' => '代理规则列表(最多100条)',
- 'type' => 'array',
- 'items' => [
- 'description' => '代理规则',
- 'type' => 'object',
- 'properties' => [
- 'Target' => [
- 'description' => '应用包名或域名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '*.baidu.com',
- ],
- 'RuleType' => [
- 'description' => '规则类型',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'prc' => '应用包名',
- 'domain' => '域名',
- ],
- 'example' => 'domain',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7B9EFA4F-4305-5968-BAEE-BD8B8DE5****'],
],
- 'required' => false,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改云手机矩阵信息',
+ 'description' => '修改云手机矩阵串流模式是异步接口,请勿频繁修改。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-28T12:53:31.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B9EFA4F-4305-5968-BAEE-BD8B8DE5****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyDisplayConfig' => [
+ 'summary' => '修改显示设置。',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'PolicyType',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVB2A7J'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AndroidInstanceIds',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '策略类型。',
- 'type' => 'string',
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-9y1nwysxr9d6lk2xq-****'],
'required' => false,
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Node',
- ],
+ 'maxItems' => 100,
],
],
[
- 'name' => 'Watermark',
+ 'name' => 'DisplayConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '屏幕水印。',
+ 'description' => '显示设置。',
'type' => 'object',
'properties' => [
- 'WatermarkSwitch' => [
- 'description' => '屏幕水印开关。',
+ 'ResolutionHeight' => ['description' => '分辨率的高度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1920'],
+ 'ResolutionWidth' => ['description' => '分辨率的宽度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720'],
+ 'Dpi' => ['description' => 'DPI。取值范围:72~600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '240'],
+ 'Fps' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'],
+ 'LockResolution' => [
+ 'description' => '是否锁定分辨率。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
- 'WatermarkTypes' => [
- 'description' => '屏幕水印内容。',
- 'type' => 'array',
- 'items' => [
- 'description' => '屏幕水印内容。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Username' => '用户名',
- 'CustomText' => '自定义文字',
- 'ClientIpAddress' => '客户端IP地址',
- 'IpAddress' => 'IP地址',
- 'ClientTime' => '当前时间',
- ],
- 'example' => 'Username',
- ],
- 'required' => false,
- ],
- 'WatermarkCustomText' => [
- 'description' => '水印自定义内容。长度不超过10个字符,且不支持Emoji表情符号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'custom text',
- ],
- 'WatermarkFontSize' => [
- 'description' => '水印字体大小。 取值范围:10\\~20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '12',
- ],
- 'WatermarkColor' => [
- 'description' => '水印字体颜色。 取值范围: 0\\~16777215。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'WatermarkTransparencyValue' => [
- 'description' => '水印不透明度,值越大,透明度越小。 取值范围: 10\\~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '25',
- ],
],
'required' => false,
],
@@ -11241,43 +8715,27 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => '请求信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC******',
- ],
- 'PolicyGroupId' => [
- 'description' => '策略ID。',
- 'type' => 'string',
- 'example' => 'pg-exbuu6yrpvb******',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A578AD3A-8E7C-54FE-A09F-B060941*****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改显示设置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC******\\",\\n \\"PolicyGroupId\\": \\"pg-exbuu6yrpvb******\\"\\n}","type":"json"}]',
- 'title' => '创建策略',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A578AD3A-8E7C-54FE-A09F-B060941*****\\"\\n}","type":"json"}]',
],
- 'ListPolicyGroups' => [
- 'summary' => '查询策略详细信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ModifyInstanceChargeType' => [
+ 'summary' => '修改实例的付费方式。目前只支持按量付费转为包年包月。',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11286,370 +8744,238 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneS5VM56',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneTVG3Y7'],
],
'parameters' => [
[
- 'name' => 'PolicyGroupIds',
- 'in' => 'formData',
+ 'name' => 'InstanceGroupIds',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '策略ID列表。',
+ 'description' => '实例组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '策略ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pg-jc31jdxfdcsclk****',
- ],
- 'required' => false,
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-25nt4kk9whhdh****'],
+ 'required' => true,
'maxItems' => 100,
],
],
[
- 'name' => 'PolicyGroupName',
- 'in' => 'formData',
+ 'name' => 'ChargeType',
+ 'in' => 'query',
'schema' => [
- 'description' => '策略名称。',
+ 'description' => '实例付费类型。'."\n"
+ .'> 目前只支持**按量付费转为包年包月**。',
'type' => 'string',
- 'required' => false,
- 'example' => '默认策略',
+ 'required' => true,
+ 'enumValueTitles' => ['PrePaid' => '包年包月'],
+ 'example' => 'PrePaid',
],
],
[
- 'name' => 'MaxResults',
- 'in' => 'formData',
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => '购买资源的时长,单位由PeriodUnit指定。'."\n"
+ .'取值范围:1个月、2个月、3个月、6个月、1年。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => '购买资源的时长单位。'."\n"
+ .'取值范围:'."\n"
+ .'- **Month**:月。'."\n"
+ .'- **Year**:年。', 'type' => 'string', 'required' => false, 'example' => 'Month'],
+ ],
+ [
+ 'name' => 'AutoPay',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否自动支付。默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启自动续费。默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '分页查询时每页的最大条目数。取值范围1~100,默认值为20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****'],
+ 'InstanceGroupIds' => [
+ 'description' => '实例组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'example' => 'ag-cuv4scs4obxch****'],
+ ],
+ 'OrderId' => ['description' => '生成的订单ID。', 'type' => 'string', 'example' => '22326560487****'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改实例的付费方式',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-05T07:55:24.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\",\\n \\"InstanceGroupIds\\": [\\n \\"ag-cuv4scs4obxch****\\"\\n ],\\n \\"OrderId\\": \\"22326560487****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyJVSInstance' => [
+ 'summary' => '修改JVS实例配置',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'NextToken',
- 'in' => 'formData',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '用来标记当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
+ 'title' => '实例ID列表',
+ 'description' => '实例ID列表',
+ 'type' => 'array',
+ 'items' => ['description' => '云手机实例ID列表,可设置 1~100 个。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh4a31emkt6u****'],
'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'PolicyType',
- 'in' => 'formData',
+ 'name' => 'CreditConfig',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '策略类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Instance' => 'Instance',
- 'Node' => 'Node',
+ 'title' => '积分配置',
+ 'description' => 'Credit限额配置。多次下发后续配额配置会覆盖之前配置。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Credit限额配置。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreditLimit' => ['description' => '限额大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ 'LimitPeriod' => [
+ 'description' => '当前Credit所在的维度。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['total' => '使用总上限', 'month' => '月,按照资源开通时间为一个周期清空', 'day' => '天,0点清空'],
+ 'example' => 'day',
+ ],
+ ],
+ 'required' => false,
],
- 'example' => 'Instance',
- 'enum' => [
- 'Instance',
- 'Node',
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'ApplyToAll',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否应用到所有实例', 'description' => '是否应用到所有实例', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'InstanceName',
+ 'in' => 'query',
+ 'schema' => ['title' => '节点名称', 'description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'defaultInstanceName'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6C8439B9-7DBF-57F4-92AE-55A9B9D3****'],
],
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改JVS实例配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C8439B9-7DBF-57F4-92AE-55A9B9D3****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyKeyPairName' => [
+ 'summary' => '调用本接口修改ADB密钥对的名称。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneDADB6I'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'KeyPairId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'ADB密钥对的ID。', 'type' => 'string', 'required' => true, 'example' => 'kp-6v2q33ae4tw3a****'],
+ ],
+ [
+ 'name' => 'NewKeyPairName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'ADB密钥对名称。', 'type' => 'string', 'required' => true, 'example' => 'newKeyPairName', 'minLength' => 2],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => 'BaseResult',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7B9EFA4F-4305-5968-BAEE-BD8B8DE5****',
- ],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '31',
- ],
- 'NextToken' => [
- 'description' => '用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****',
- ],
- 'PolicyGroupModel' => [
- 'description' => '策略信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '策略信息。',
- 'type' => 'object',
- 'properties' => [
- 'PolicyGroupId' => [
- 'description' => '策略ID。',
- 'type' => 'string',
- 'example' => 'pg-9q6o8qpiy8opkj****',
- ],
- 'PolicyGroupName' => [
- 'description' => '策略名称。',
- 'type' => 'string',
- 'example' => '默认策略。',
- ],
- 'GmtCreate' => [
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-06-04 10:28:54',
- ],
- 'Clipboard' => [
- 'description' => '剪切板权限。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'read' => '单向允许',
- 'readwrite' => '双向允许',
- 'off' => '双向禁止',
- ],
- 'example' => 'readwrite',
- ],
- 'Html5FileTransfer' => [
- 'description' => 'HTML5客户端文件传输策略。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'all' => '允许上传下载',
- 'download' => '允许下载',
- 'upload' => '允许上传',
- 'off' => '关闭',
- ],
- 'example' => 'download',
- ],
- 'CameraRedirect' => [
- 'description' => '是否开启本地摄像头重定向。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'on',
- ],
- 'LocalDrive' => [
- 'description' => '本地磁盘映射权限。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'read' => '只读',
- 'readwrite' => '读写',
- 'off' => '关闭',
- ],
- 'example' => 'off',
- ],
- 'LockResolution' => [
- 'description' => '锁定分辨率',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
- ],
- 'NetRedirectPolicy' => [
- 'description' => '网络重定向。',
- 'type' => 'object',
- 'properties' => [
- 'NetRedirect' => [
- 'description' => '是否开启网络重定向。开启后,默认重定向至端侧网络。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
- ],
- 'CustomProxy' => [
- 'description' => '是否手动配置透明代理。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
- ],
- 'ProxyType' => [
- 'description' => '代理协议类型。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'socks5' => 'socks5',
- ],
- 'example' => 'socks5',
- ],
- 'HostAddr' => [
- 'description' => '透明代理IP。格式为IPv4地址。',
- 'type' => 'string',
- 'example' => '47.100.XX.XX',
- ],
- 'Port' => [
- 'description' => '透明代理端口。端口取值范围为1~65535。',
- 'type' => 'string',
- 'example' => '1145',
- ],
- 'ProxyUserName' => [
- 'description' => '代理用户名。长度范围为1~256,不允许包含中文字符和空白字符。',
- 'type' => 'string',
- 'example' => 'username',
- ],
- 'ProxyPassword' => [
- 'description' => '代理密码。长度范围为1~256,不允许包含中文字符和空白字符。',
- 'type' => 'string',
- 'example' => 'password',
- ],
- 'Rules' => [
- 'description' => '代理规则列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '代理规则',
- 'type' => 'object',
- 'properties' => [
- 'Target' => [
- 'description' => '应用包名或域名',
- 'type' => 'string',
- 'example' => '*.baidu.com',
- ],
- 'RuleType' => [
- 'description' => '规则类型',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'prc' => '应用包名',
- 'domain' => '域名',
- ],
- 'example' => 'domain',
- ],
- ],
- ],
- ],
- ],
- ],
- 'SessionResolutionHeight' => [
- 'description' => '分辨率的高度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1080',
- ],
- 'SessionResolutionWidth' => [
- 'description' => '分辨率的宽度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1920',
- ],
- 'PolicyRelatedResources' => [
- 'description' => '策略关联资源。',
- 'type' => 'object',
- 'properties' => [
- 'AndroidInstanceGroupIds' => [
- 'description' => '实例组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'example' => 'ag-2dzpub83srxt*****',
- ],
- ],
- 'CloudPhoneMatrixIds' => [
- 'description' => '矩阵ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '矩阵ID。',
- 'type' => 'string',
- 'example' => 'cpn-3dskdfjj245s*****',
- ],
- ],
- ],
- ],
- 'Watermark' => [
- 'description' => '屏幕水印。',
- 'type' => 'object',
- 'properties' => [
- 'WatermarkSwitch' => [
- 'description' => '屏幕水印开关。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
- ],
- 'WatermarkTypes' => [
- 'description' => '屏幕水印内容。',
- 'type' => 'array',
- 'items' => [
- 'description' => '屏幕水印内容。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Username' => '用户名',
- 'CustomText' => '自定义文字',
- 'ClientIpAddress' => '客户端IP地址',
- 'IpAddress' => 'IP地址',
- 'ClientTime' => '当前时间',
- ],
- 'example' => 'Username',
- ],
- ],
- 'WatermarkCustomText' => [
- 'description' => '水印自定义内容。长度不超过10个字符,且不支持emoji字符。',
- 'type' => 'string',
- 'example' => 'custom text',
- ],
- 'WatermarkFontSize' => [
- 'description' => '水印字体大小。 取值范围:10\\~20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'WatermarkColor' => [
- 'description' => '水印字体颜色。 取值范围: 0\\~16777215。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'WatermarkTransparencyValue' => [
- 'description' => '水印不透明度,值越大,透明度越小。 取值范围: 10\\~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '25',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '修改ADB密钥对名称',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-22T06:44:12.000Z', 'description' => '请求参数发生变更'],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B9EFA4F-4305-5968-BAEE-BD8B8DE5****\\",\\n \\"TotalCount\\": 31,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****\\",\\n \\"PolicyGroupModel\\": [\\n {\\n \\"PolicyGroupId\\": \\"pg-9q6o8qpiy8opkj****\\",\\n \\"PolicyGroupName\\": \\"默认策略。\\",\\n \\"GmtCreate\\": \\"2024-06-04 10:28:54\\",\\n \\"Clipboard\\": \\"readwrite\\",\\n \\"Html5FileTransfer\\": \\"download\\",\\n \\"CameraRedirect\\": \\"on\\",\\n \\"LocalDrive\\": \\"off\\",\\n \\"LockResolution\\": \\"off\\",\\n \\"NetRedirectPolicy\\": {\\n \\"NetRedirect\\": \\"off\\",\\n \\"CustomProxy\\": \\"off\\",\\n \\"ProxyType\\": \\"socks5\\",\\n \\"HostAddr\\": \\"47.100.XX.XX\\",\\n \\"Port\\": \\"1145\\",\\n \\"ProxyUserName\\": \\"username\\",\\n \\"ProxyPassword\\": \\"password\\",\\n \\"Rules\\": [\\n {\\n \\"Target\\": \\"*.baidu.com\\",\\n \\"RuleType\\": \\"domain\\"\\n }\\n ]\\n },\\n \\"SessionResolutionHeight\\": 1080,\\n \\"SessionResolutionWidth\\": 1920,\\n \\"PolicyRelatedResources\\": {\\n \\"AndroidInstanceGroupIds\\": [\\n \\"ag-2dzpub83srxt*****\\"\\n ],\\n \\"CloudPhoneMatrixIds\\": [\\n \\"cpn-3dskdfjj245s*****\\"\\n ]\\n },\\n \\"Watermark\\": {\\n \\"WatermarkSwitch\\": \\"off\\",\\n \\"WatermarkTypes\\": [\\n \\"Username\\"\\n ],\\n \\"WatermarkCustomText\\": \\"custom text\\",\\n \\"WatermarkFontSize\\": 12,\\n \\"WatermarkColor\\": 0,\\n \\"WatermarkTransparencyValue\\": 25\\n }\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询策略详细信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
],
'ModifyPolicyGroup' => [
'summary' => '修改策略信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11661,9 +8987,7 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVB2A7J',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVB2A7J'],
],
'parameters' => [
[
@@ -11673,12 +8997,7 @@
'description' => '无影Web客户端文件传输策略。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'all' => '允许上传下载',
- 'download' => '允许下载',
- 'upload' => '允许上传',
- 'off' => '关闭',
- ],
+ 'enumValueTitles' => ['all' => '允许上传下载', 'download' => '允许下载', 'upload' => '允许上传', 'off' => '关闭'],
'example' => 'off',
],
],
@@ -11689,11 +9008,7 @@
'description' => '本地磁盘映射权限。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'read' => '只读',
- 'readwrite' => '读写',
- 'off' => '关闭',
- ],
+ 'enumValueTitles' => ['read' => '只读', 'readwrite' => '读写', 'off' => '关闭'],
'example' => 'off',
],
],
@@ -11704,10 +9019,7 @@
'description' => '是否开启本地摄像头重定向。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
@@ -11718,55 +9030,29 @@
'description' => '剪贴板权限。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'read' => '只读',
- 'readwrite' => '读写',
- 'off' => '关闭',
- ],
+ 'enumValueTitles' => ['read' => '只读', 'readwrite' => '读写', 'off' => '关闭'],
'example' => 'readwrite',
],
],
[
'name' => 'PolicyGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => '策略ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pg-4bi18ebi9tfjh****',
- ],
+ 'schema' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-4bi18ebi9tfjh****'],
],
[
'name' => 'PolicyGroupName',
'in' => 'formData',
- 'schema' => [
- 'description' => '策略名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '默认策略',
- ],
+ 'schema' => ['description' => '策略名称。', 'type' => 'string', 'required' => false, 'example' => 'Default policy'],
],
[
'name' => 'ResolutionHeight',
'in' => 'formData',
- 'schema' => [
- 'description' => '分辨率的高度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1280',
- ],
+ 'schema' => ['description' => '分辨率的高度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1280'],
],
[
'name' => 'ResolutionWidth',
'in' => 'formData',
- 'schema' => [
- 'description' => '分辨率的宽度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '720',
- ],
+ 'schema' => ['description' => '分辨率的宽度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720'],
],
[
'name' => 'LockResolution',
@@ -11775,10 +9061,7 @@
'description' => '是否锁定分辨率。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
@@ -11794,55 +9077,27 @@
'description' => '是否开启网络重定向。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
'CustomProxy' => [
'description' => '是否手动配置透明代理。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
'ProxyType' => [
'description' => '代理协议类型。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'socks5' => 'socks5',
- ],
+ 'enumValueTitles' => ['socks5' => 'socks5'],
'example' => 'socks5',
],
- 'HostAddr' => [
- 'description' => '透明代理IP。格式为IPv4地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '47.100.XX.XX',
- ],
- 'Port' => [
- 'description' => '透明代理端口。端口取值范围为1\\~65535。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1145',
- ],
- 'ProxyUserName' => [
- 'description' => '代理用户名。长度范围为1\\~256,不允许包含中文字符和空白字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'username',
- ],
- 'ProxyPassword' => [
- 'description' => '代理密码。长度范围为1\\~256,不允许包含中文字符和空白字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'password',
- ],
+ 'HostAddr' => ['description' => '透明代理IP。格式为IPv4地址。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX'],
+ 'Port' => ['description' => '透明代理端口。端口取值范围为1\\~65535。', 'type' => 'string', 'required' => false, 'example' => '1145'],
+ 'ProxyUserName' => ['description' => '代理用户名。长度范围为1\\~256,不允许包含中文字符和空白字符。', 'type' => 'string', 'required' => false, 'example' => 'username'],
+ 'ProxyPassword' => ['description' => '代理密码。长度范围为1\\~256,不允许包含中文字符和空白字符。', 'type' => 'string', 'required' => false, 'example' => 'password'],
'Rules' => [
'description' => '代理规则。',
'type' => 'array',
@@ -11850,20 +9105,12 @@
'description' => '代理规则。',
'type' => 'object',
'properties' => [
- 'Target' => [
- 'description' => '应用包名或域名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'example.com',
- ],
+ 'Target' => ['description' => '应用包名或域名。', 'type' => 'string', 'required' => false, 'example' => 'example.com'],
'RuleType' => [
'description' => '规则类型。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'prc' => '应用包名',
- 'domain' => '域名',
- ],
+ 'enumValueTitles' => ['prc' => '应用包名', 'domain' => '域名'],
'example' => 'domain',
],
],
@@ -11887,10 +9134,7 @@
'description' => '屏幕水印开关。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
+ 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
'WatermarkTypes' => [
@@ -11900,44 +9144,15 @@
'description' => '屏幕水印内容。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'Username' => '用户名',
- 'CustomText' => '自定义文字',
- 'ClientIpAddress' => '客户端IP地址',
- 'IpAddress' => 'IP地址',
- 'ClientTime' => '当前时间',
- ],
+ 'enumValueTitles' => ['Username' => '用户名', 'CustomText' => '自定义文字', 'ClientIpAddress' => '客户端IP地址', 'IpAddress' => 'IP地址', 'ClientTime' => '当前时间'],
'example' => 'Username',
],
'required' => false,
],
- 'WatermarkCustomText' => [
- 'description' => '水印自定义内容。长度不超过10个字符,且不支持emoji字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'custom text',
- ],
- 'WatermarkFontSize' => [
- 'description' => '水印字体大小。 取值范围:10\\~20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '12',
- ],
- 'WatermarkColor' => [
- 'description' => '水印字体颜色。 取值范围: 0\\~16777215。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'WatermarkTransparencyValue' => [
- 'description' => '水印不透明度,值越大,透明度越小。 取值范围: 10\\~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '25',
- ],
+ 'WatermarkCustomText' => ['description' => '水印自定义内容。长度不超过10个字符,且不支持emoji字符。', 'type' => 'string', 'required' => false, 'example' => 'custom text'],
+ 'WatermarkFontSize' => ['description' => '水印字体大小。 取值范围:10\\~20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12'],
+ 'WatermarkColor' => ['description' => '水印字体颜色。 取值范围: 0\\~16777215。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'WatermarkTransparencyValue' => ['description' => '水印不透明度,值越大,透明度越小。 取值范围: 10\\~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '25'],
],
'required' => false,
],
@@ -11950,96 +9165,35 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '552B7EED-D434-511F-B838-29EA4E906034',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '552B7EED-D434-511F-B838-29EA4E906034'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"552B7EED-D434-511F-B838-29EA4E906034\\"\\n}","type":"json"}]',
'title' => '修改策略信息',
- ],
- 'DeletePolicyGroup' => [
- 'summary' => '删除策略。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
- 'parameters' => [
- [
- 'name' => 'PolicyGroupIds',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '策略ID列表。如存在任意一个策略绑定了未删除的实例组,则整体删除失败。',
- 'type' => 'array',
- 'items' => [
- 'description' => '策略ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pg-gx4ger9hynfov****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '17C731AB-AAEE-5844-A352-D8D0352D3F0B',
- ],
- ],
- ],
- ],
+ 'changeSet' => [
+ ['createdAt' => '2025-04-25T11:27:20.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-16T06:34:33.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-15T01:35:07.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-26T11:32:59.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-08-20T03:54:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-08-19T09:42:45.000Z', 'description' => '请求参数发生变更'],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17C731AB-AAEE-5844-A352-D8D0352D3F0B\\"\\n}","type":"json"}]',
- 'title' => '删除策略',
- 'description' => '如绑定了未删除的实例组,则不允许删除',
],
- 'CreateSystemPropertyTemplate' => [
- 'summary' => '创建系统属性模板。属性模板中定义的属性键值对,将下发到云手机并通过setprop命令设置到云手机android系统中,APK或相关程序可读取这些属性值。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ModifySystemPropertyTemplate' => [
+ 'summary' => '修改属性模板。',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -12051,25 +9205,18 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone3OZQF8',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVQDPK9'],
],
'parameters' => [
[
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => ['description' => '属性模板ID。', 'type' => 'string', 'required' => false, 'example' => 'ap-angyvganxlf****'],
+ ],
+ [
'name' => 'TemplateName',
'in' => 'query',
- 'schema' => [
- 'description' => '模板的名称。必须符合以下要求:'."\n"
- ."\n"
- .'- 长度2~32个英文或中文字符。'."\n"
- .'- 必须以大小写字母或中文开头,不能以`http://`或`https://`开头。'."\n"
- .'- 可以包含字母、数字、汉字、半角冒号(:)、下划线(_)或短划线(-),不支持点号(.)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Template1',
- ],
+ 'schema' => ['description' => '模板名称。', 'type' => 'string', 'required' => false, 'example' => 'Template 1'],
],
[
'name' => 'SystemPropertyInfo',
@@ -12079,96 +9226,21 @@
'description' => '系统属性模板信息。',
'type' => 'object',
'properties' => [
- 'RoBuildFingerprint' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoProductModel' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoProductManufacturer' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoProductBrand' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildUser' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildId' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBootloader' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildTags' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoProductBoard' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoProductDevice' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildProduct' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildType' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildHost' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildDisplayId' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RwRoSerialNo' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'RoBuildFingerprint' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoProductModel' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoProductManufacturer' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoProductBrand' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildUser' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildId' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBootloader' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildTags' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoProductBoard' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoProductDevice' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildProduct' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildType' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildHost' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RoBuildDisplayId' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'RwRoSerialNo' => ['description' => '> 该参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
'CustomPropertyInfos' => [
'description' => '自定义属性信息。',
'type' => 'array',
@@ -12176,18 +9248,8 @@
'description' => '自定义属性信息。',
'type' => 'object',
'properties' => [
- 'PropertyName' => [
- 'description' => '自定义属性Key。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'propKey',
- ],
- 'PropertyValue' => [
- 'description' => '自定义属性Value。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'propValue',
- ],
+ 'PropertyName' => ['description' => '自定义属性Key。', 'type' => 'string', 'required' => false, 'example' => 'propKey'],
+ 'PropertyValue' => ['description' => '自定义属性Value。', 'type' => 'string', 'required' => false, 'example' => 'propValue'],
],
'required' => false,
],
@@ -12201,24 +9263,14 @@
[
'name' => 'FilePath',
'in' => 'query',
- 'schema' => [
- 'description' => '属性模板的文件URL路径。接口会同步解析文件内容,如果文件内容格式有问题,则会报错解析失败。'."\n"
- .'> 文件模板格式:`{ "propties":{"key1":"value1"}}`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://filepath****.com'."\n",
- 'maxLength' => 512,
- ],
+ 'schema' => ['description' => '属性模板的文件URL路径。接口会同步解析文件内容,如果文件内容格式有问题,则会报错解析失败。'."\n"
+ ."\n"
+ .'> 文件模板格式:`{ "propties":{"key1":"value1", "key2":"value2"}}`。', 'type' => 'string', 'required' => false, 'example' => 'https://filepath****.com', 'maxLength' => 512],
],
[
'name' => 'EnableAuto',
'in' => 'query',
- 'schema' => [
- 'description' => '是否支持部分预置系统属性自动生成。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否支持部分预置系统属性自动生成。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -12228,94 +9280,120 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
- ],
- 'TemplateId' => [
- 'description' => '属性模板ID。',
- 'type' => 'string',
- 'example' => 'ap-g6gyv4a4xlf****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****'],
+ 'TemplateId' => ['description' => '属性模板ID。', 'type' => 'string', 'example' => 'ap-angyvganxlf****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"TemplateId\\": \\"ap-angyvganxlf****\\"\\n}","type":"json"}]',
+ 'title' => '修改系统属性模板',
+ 'description' => '修改属性模板不会触发[SendSystemPropertyTemplate](~~2950220~~),如需要作用到云手机,请调用[SendSystemPropertyTemplate](~~2950220~~)接口。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"TemplateId\\": \\"ap-g6gyv4a4xlf****\\"\\n}","type":"json"}]',
- 'title' => '创建系统属性模板',
],
- 'SendSystemPropertyTemplate' => [
- 'summary' => '发送属性模板。将下发到云手机并通过setprop命令设置到云手机android系统中,APK或相关程序可读取这些属性值。如果指定了多个模板ID,则随机组合属性模板和云手机实例。',
+ 'OperateApp' => [
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVQDPK9',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneL912BU'],
],
'parameters' => [
[
- 'name' => 'TemplateId',
+ 'name' => 'InstanceIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '属性模板ID。',
- 'type' => 'string',
+ 'description' => '实例列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例列表。', 'type' => 'string', 'required' => false, 'example' => 'acp-dvbhknfasf123****'],
'required' => false,
- 'example' => 'ap-angyvganxlf****',
+ 'maxItems' => 1000,
],
],
[
- 'name' => 'AndroidInstanceIds',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'AppId',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1234'],
+ ],
+ [
+ 'name' => 'OperateType',
+ 'in' => 'query',
'schema' => [
- 'description' => '实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-25nt4kk9whhok****',
- ],
+ 'description' => '操作类型。支持开启、关闭和重启操作类型。',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 200,
+ 'enumValueTitles' => ['stop' => '关闭应用', 'restart' => '重启应用', 'start' => '打开应用'],
+ 'example' => 'start',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '响应。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-imr0fufqgac2z****'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '操作应用',
+ 'summary' => '操作云手机内应用,支持打开、关闭、重启应用。',
+ 'description' => '此接口为异步接口,操作结果可以在任务中心查看。查询任务接口为[DescribeTasks](~~DescribeTasks~~)。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-22T13:03:48.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"TaskId\\": \\"t-imr0fufqgac2z****\\"\\n}","type":"json"}]',
+ ],
+ 'PauseAgentTask' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'TemplateIds',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TaskIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '属性模板ID列表。如果传入多个模板,则将给定的实例随机匹配所有给定属性模板。',
+ 'description' => '任务ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '属性模板ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ap-0caoenwutkkxb0****',
- ],
- 'required' => false,
+ 'items' => ['description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => 't-bp67acfmxazb4p****'],
+ 'required' => true,
'maxItems' => 100,
],
],
@@ -12327,31 +9405,58 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC******',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E38B41A8-8E00-5AE4-A957-6636ACB8****'],
+ 'Code' => ['description' => '接口状态码。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '接口返回信息。', 'type' => 'string', 'example' => 'Success.'],
+ 'Tasks' => [
+ 'description' => '任务list。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务 ID,全局唯一。', 'type' => 'string', 'example' => 't-imr0fufqd7cle****'],
+ 'InstanceId' => ['description' => 'Mobile节点 ID。', 'type' => 'string', 'example' => 'acp-anzzuho371azi44xr'],
+ 'PreviousStatus' => ['description' => '任务暂停前状态,参考下方状态枚举,取值如下:'."\n"
+ ."\n"
+ .'RUNNING 任务运行中。', 'type' => 'string', 'example' => 'RUNNING'],
+ 'CurrentStatus' => ['description' => '任务当前状态,参考下方状态枚举,取值如下:'."\n"
+ ."\n"
+ .'PENDING 任务创建中。'."\n"
+ ."\n"
+ .'RUNNING 任务运行中。'."\n"
+ ."\n"
+ .'COMPLETED 任务已完成。'."\n"
+ ."\n"
+ .'FAILED 任务失败。'."\n"
+ ."\n"
+ .'TIMEOUT 任务执行超时。'."\n"
+ ."\n"
+ .'PAUSING 任务暂停中。'."\n"
+ ."\n"
+ .'PAUSED 任务暂停。', 'type' => 'string', 'example' => 'PAUSING'],
+ 'PausingAt' => ['description' => '任务暂停时间,ISO 8601 格式。', 'type' => 'string', 'example' => '2026-04-13T17:42:19Z'],
+ 'FailedReason' => ['description' => '暂停任务失败原因。', 'type' => 'string', 'example' => 'Task status [COMPLETED] does not support pause, only RUNNING tasks can be paused.'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '暂停 Agent 任务。',
+ 'summary' => '暂停Mobile 节点上正在运行的 Agent 任务。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC******\\"\\n}","type":"json"}]',
- 'title' => '下发系统属性模板',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E38B41A8-8E00-5AE4-A957-6636ACB8****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Tasks\\": [\\n {\\n \\"TaskId\\": \\"t-imr0fufqd7cle****\\",\\n \\"InstanceId\\": \\"acp-anzzuho371azi44xr\\",\\n \\"PreviousStatus\\": \\"RUNNING\\",\\n \\"CurrentStatus\\": \\"PAUSING\\",\\n \\"PausingAt\\": \\"2026-04-13T17:42:19Z\\",\\n \\"FailedReason\\": \\"Task status [COMPLETED] does not support pause, only RUNNING tasks can be paused.\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DescribeSystemPropertyTemplates' => [
- 'summary' => '查询系统属性模板。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RebootAndroidInstancesInGroup' => [
+ 'summary' => '重启(先关机再开机)云手机实例。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -12363,149 +9468,75 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVQDPK9',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneO96MC6'],
],
'parameters' => [
[
- 'name' => 'MaxResults',
+ 'name' => 'AndroidInstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '本次读取的最大数据量。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-sgicbcdadjs****'],
'required' => false,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '10',
+ 'maxItems' => 100,
+ 'minItems' => 1,
],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ForceStop',
'in' => 'query',
'schema' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
+ 'description' => '是否强制重启。当云手机遇到系统、网络等异常原因导致无法关机时,可选择强制重启(可能会丢失未保存数据)。',
+ 'type' => 'boolean',
'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6k****',
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
+ 'example' => 'false',
],
],
[
- 'name' => 'TemplateIds',
+ 'name' => 'SaleMode',
'in' => 'query',
- 'style' => 'repeatList',
'schema' => [
- 'description' => '属性模板ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '需要查询的模板ID列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ap-0caoenwutkkx****',
- ],
+ 'description' => '售卖模式。该参数已废弃!',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 100,
+ 'enumValueTitles' => ['Instance' => '云手机实例模式', 'Node' => '云手机矩阵模式'],
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Node'],
],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'IgnoreParamValidation',
'in' => 'query',
- 'schema' => [
- 'description' => '模板名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '模板1',
- ],
+ 'schema' => ['type' => 'boolean'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****',
- ],
- 'NextToken' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU****',
- ],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'SystemPropertyTemplateModel' => [
- 'description' => '属性模板对象列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '属性模板对象。',
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'description' => '属性模板ID。',
- 'type' => 'string',
- 'example' => 'ap-0caoenwutkkx****',
- ],
- 'TemplateName' => [
- 'description' => '模板名称。',
- 'type' => 'string',
- 'example' => '模板1',
- ],
- 'Status' => [
- 'description' => '模板状态。',
- 'type' => 'string',
- 'example' => 'init',
- ],
- 'SystemPropertyInfo' => [
- 'description' => '系统属性模板信息',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '227CBB4C-F5DC-589D-A667-C5CA3D52****'],
+ 'Tasks' => [
+ 'title' => '任务信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'ParentTaskId' => ['title' => '父任务ID', 'type' => 'string', 'example' => 't-xxxx'],
+ 'ChildTasks' => [
+ 'title' => '子任务',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '子任务对象',
'type' => 'object',
'properties' => [
- 'RoProductDevice' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'CustomPropertyInfos' => [
- 'description' => '自定义属性信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '自定义属性对象,由属性的Key和Value构成。',
- 'type' => 'object',
- 'properties' => [
- 'PropertyName' => [
- 'description' => '属性名称。',
- 'type' => 'string',
- 'example' => 'propKey',
- ],
- 'PropertyValue' => [
- 'description' => '属性值。',
- 'type' => 'string',
- 'example' => 'propValue',
- ],
- ],
- ],
- ],
+ 'InstanceId' => ['title' => '实例ID', 'type' => 'string', 'example' => 'acp-xxxx'],
+ 'TaskId' => ['title' => '子任务ID', 'type' => 'string', 'example' => 't-xxxx'],
],
],
- 'FilePath' => [
- 'description' => '属性模板的文件URL路径。',
- 'type' => 'string',
- 'example' => 'https://filepath****.com',
- ],
- 'EnableAuto' => [
- 'description' => '是否支持部分预置系统属性自动生成。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
],
],
@@ -12513,319 +9544,311 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '重启实例',
+ 'description' => '只有实例处于**可用、异常、备份失败、恢复失败**状态时才支持重启。',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-07T03:35:38.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-07-02T02:05:34.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU****\\",\\n \\"TotalCount\\": 10,\\n \\"SystemPropertyTemplateModel\\": [\\n {\\n \\"TemplateId\\": \\"ap-0caoenwutkkx****\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"Status\\": \\"init\\",\\n \\"SystemPropertyInfo\\": {\\n \\"RoProductDevice\\": \\"null\\",\\n \\"CustomPropertyInfos\\": [\\n {\\n \\"PropertyName\\": \\"propKey\\",\\n \\"PropertyValue\\": \\"propValue\\"\\n }\\n ]\\n },\\n \\"FilePath\\": \\"https://filepath****.com\\",\\n \\"EnableAuto\\": true\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询系统属性模板',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"227CBB4C-F5DC-589D-A667-C5CA3D52****\\",\\n \\"Tasks\\": {\\n \\"ParentTaskId\\": \\"t-xxxx\\",\\n \\"ChildTasks\\": [\\n {\\n \\"InstanceId\\": \\"acp-xxxx\\",\\n \\"TaskId\\": \\"t-xxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'GetInstanceProperties' => [
- 'summary' => '获取实例属性信息。系统将通过android getprop命令获取所有云手机属性信息。',
+ 'RecoverAndroidInstance' => [
+ 'summary' => '将整机备份产生的云手机实例备份文件恢复到另一台云手机实例。',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneA5LZN6',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneWDBBSN'],
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'BackupFileId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'App oss地址', 'description' => '备份文件id。', 'type' => 'string', 'required' => false, 'example' => 'bf-azhps4rdyi2th****'],
+ ],
+ [
+ 'name' => 'AndroidInstanceIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-2ofr9kf41apy3****-014',
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-ig2bdpk374l12****'],
+ 'deprecated' => false,
+ 'required' => true,
+ 'maxItems' => 100,
],
],
+ [
+ 'name' => 'UploadEndpoint',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份地域。', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'],
+ ],
+ [
+ 'name' => 'UploadType',
+ 'in' => 'query',
+ 'schema' => ['description' => '上传类型。', 'type' => 'string', 'required' => true, 'example' => 'OSS'],
+ ],
+ [
+ 'name' => 'BackupFilePath',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份文件上传的OSS地址。', 'type' => 'string', 'required' => true, 'example' => 'oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => 'PlainResult<Integer>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC******',
- ],
- 'PropertyTemplateModel' => [
- 'description' => '实例属性信息',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '实例属性信息。'."\n"
- ."\n"
- .'> 属性格式为:`{ "propties":{"key1":"value1"}}`。',
- 'type' => 'string',
- 'example' => '{ "propties":{"key1":"value1"}}',
+ 'Data' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AndroidInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-bp67acfmxazb4p****'],
],
],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'Count' => ['description' => '恢复的实例个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TaskId' => ['description' => '批量任务ID。', 'type' => 'string', 'example' => 't-1ljew7on6ay0j****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '整机恢复',
+ 'description' => '1. 为保证您的恢复成功率,我们将在整机恢复时执行云机重启,应用和数据恢复时无需重启云手机,请确保您的云手机为可用状态,在恢复过程中请勿操作云手机,否则恢复操作可能失败。'."\n"
+ .'2. 请确保您的备份文件可以正常恢复,恢复完成后,请检查和验证您的数据是否全部完整、功能是否正常使用,再考虑删除原始备份文件和重置源实例,否则您的数据可能丢失。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC******\\",\\n \\"PropertyTemplateModel\\": {\\n \\"Content\\": \\"{ \\\\\\"propties\\\\\\":{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"}}\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取实例属性',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-bp67acfmxazb4p****\\"\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-1ljew7on6ay0j****\\"\\n}","type":"json"}]',
],
- 'ModifySystemPropertyTemplate' => [
- 'summary' => '修改属性模板。',
+ 'RecoverApp' => [
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVQDPK9',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneWDBBSN'],
],
'parameters' => [
[
- 'name' => 'TemplateId',
+ 'name' => 'BackupFileId',
'in' => 'query',
- 'schema' => [
- 'description' => '属性模板ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ap-angyvganxlf****',
- ],
+ 'schema' => ['title' => 'App oss地址', 'description' => '备份文件id。', 'type' => 'string', 'required' => true, 'example' => 'bf-azhps4rdyi2th****'],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'AndroidInstanceIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '模板名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '模板1',
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'deprecated' => false,
+ 'required' => true,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'SystemPropertyInfo',
+ 'name' => 'UploadEndpoint',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => '备份地域。', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-shanghai-internal.aliyuncs.com'],
+ ],
+ [
+ 'name' => 'UploadType',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份类型。', 'type' => 'string', 'required' => true, 'example' => 'OSS'],
+ ],
+ [
+ 'name' => 'BackupFilePath',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份文件上传的OSS地址。', 'type' => 'string', 'required' => true, 'example' => 'oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '系统属性模板信息。',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => 'PlainResult<Integer>',
'type' => 'object',
'properties' => [
- 'RoBuildFingerprint' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoProductModel' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoProductManufacturer' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoProductBrand' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildUser' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildId' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBootloader' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildTags' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoProductBoard' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoProductDevice' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildProduct' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildType' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildHost' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RoBuildDisplayId' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'RwRoSerialNo' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'CustomPropertyInfos' => [
- 'description' => '自定义属性信息。',
+ 'Data' => [
+ 'description' => '返回结果对象。',
'type' => 'array',
'items' => [
- 'description' => '自定义属性信息。',
+ 'description' => '返回结果对象。',
'type' => 'object',
'properties' => [
- 'PropertyName' => [
- 'description' => '自定义属性Key。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'propKey',
- ],
- 'PropertyValue' => [
- 'description' => '自定义属性Value。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'propValue',
- ],
+ 'AndroidInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-22ex666a653gq****'],
],
- 'required' => false,
],
- 'required' => false,
- 'maxItems' => 100,
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6C8439B9-7DBF-57F4-92AE-55A9B9D3****'],
+ 'Count' => ['description' => '恢复的实例个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-1ljew7on6ay0j****'],
],
- 'required' => false,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '应用恢复',
+ 'summary' => '将应用备份产生的备份文件恢复到另一台云手机实例。',
+ 'description' => '1. 为保证您的恢复成功率,我们将在整机恢复时执行云机重启,应用和数据恢复时无需重启云手机,请确保您的云手机为可用状态,在恢复过程中请勿操作云手机,否则恢复操作可能失败。'."\n"
+ .'2. 如果原云机已经有需要恢复的应用,我们将为您卸载原应用并安装您的备份文件中的应用以防止应用版本的差异。'."\n"
+ .'3. 请确保您的备份文件可以正常恢复,恢复完成后,请检查和验证您的数据是否全部完整、功能是否正常使用,再考虑删除原始备份文件和重置源实例,否则您的数据可能丢失。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-22ex666a653gq****\\"\\n }\\n ],\\n \\"RequestId\\": \\"6C8439B9-7DBF-57F4-92AE-55A9B9D3****\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-1ljew7on6ay0j****\\"\\n}","type":"json"}]',
+ ],
+ 'RecoveryFile' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'FilePath',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMPR6T6'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BackupFileId',
'in' => 'query',
+ 'schema' => ['title' => 'App oss地址', 'description' => '备份文件ID。', 'type' => 'string', 'required' => false, 'example' => 'bf-azhps4rdyi2th****'],
+ ],
+ [
+ 'name' => 'AndroidInstanceIdList',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '属性模板的文件URL路径。接口会同步解析文件内容,如果文件内容格式有问题,则会报错解析失败。'."\n"
- ."\n"
- .'> 文件模板格式:`{ "propties":{"key1":"value1", "key2":"value2"}}`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://filepath****.com',
- 'maxLength' => 512,
+ 'description' => '实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '云手机实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-ig2bdpk374l12****'],
+ 'deprecated' => false,
+ 'required' => true,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'EnableAuto',
+ 'name' => 'UploadType',
'in' => 'query',
'schema' => [
- 'description' => '是否支持部分预置系统属性自动生成。',
- 'type' => 'boolean',
+ 'description' => '备份类型。',
+ 'type' => 'string',
'required' => false,
- 'example' => 'true',
+ 'enumValueTitles' => ['OSS' => '备份文件保存在OSS桶。'],
+ 'example' => 'OSS',
],
],
+ [
+ 'name' => 'UploadEndpoint',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份地址的域名。'."\n"
+ .'<notice>调用DescribeBuckets接口获取Bucket,如果云手机和bucket是同地域,获取IntranetEndpoint字段;如果是不同地域获取ExtranetEndpoint字段。></notice>', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'],
+ ],
+ [
+ 'name' => 'BackupFilePath',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份文件上传的OSS地址。'."\n"
+ .'<notice>调用describeBuckets接口获取bucketName,选择ossObjectList获取key,key是备份文件的路径,拼接成“oss://${bucketName}/${key}”。</notice>', 'type' => 'string', 'required' => false, 'example' => 'oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab'],
+ ],
+ [
+ 'name' => 'BackupAll',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否整机备份。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****',
- ],
- 'TemplateId' => [
- 'description' => '属性模板ID。',
- 'type' => 'string',
- 'example' => 'ap-angyvganxlf****',
+ 'Data' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AndroidInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-ehs0yoedsskom****'],
+ ],
+ ],
+ 'example' => '6AD56E39-430B-5401-AB4A-7B086454****'."\n",
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6AD56E39-430B-5401-AB4A-7B086454****'],
+ 'Count' => ['description' => '恢复的实例个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TaskId' => ['description' => '批量任务ID。', 'type' => 'string', 'example' => 't-3eourrxaoliqq****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"TemplateId\\": \\"ap-angyvganxlf****\\"\\n}","type":"json"}]',
- 'title' => '修改系统属性模板',
- 'description' => '修改属性模板不会触发[SendSystemPropertyTemplate](~~2950220~~),如需要作用到云手机,请调用[SendSystemPropertyTemplate](~~2950220~~)接口。',
- ],
- 'DeleteSystemPropertyTemplates' => [
- 'summary' => '删除系统属性模板。',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '恢复备份文件',
+ 'summary' => '恢复备份文件。',
+ 'description' => '目前仅支持云手机生成的备份文件保存在OSS对象存储服务。',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-03T11:17:53.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-17T05:04:23.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-10-16T09:05:59.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-08-12T07:39:51.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-ehs0yoedsskom****\\"\\n }\\n ],\\n \\"RequestId\\": \\"6AD56E39-430B-5401-AB4A-7B086454****\\",\\n \\"Count\\": 1,\\n \\"TaskId\\": \\"t-3eourrxaoliqq****\\"\\n}","type":"json"}]',
+ ],
+ 'RefreshAuthTokens' => [
+ 'summary' => '刷新模型认证令牌。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -12834,781 +9857,638 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVQDPK9',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
],
'parameters' => [
[
- 'name' => 'TemplateIds',
+ 'name' => 'LicenseKeys',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '属性模板ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '属性模板ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ap-6f1z5z9d85qq7****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['title' => '许可证Key列表', 'description' => '许可证Key列表', 'type' => 'string', 'required' => false, 'example' => 'lk-abcdef1234567890,lk-abcdef1234567891'],
+ ],
+ [
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'schema' => ['title' => '实例ID列表', 'description' => '实例ID列表', 'type' => 'string', 'required' => false, 'example' => 'acp-2zef0gov2nh2l3xxx,acp-2zef0gov2nh2l3yyy'],
+ ],
+ [
+ 'name' => 'ExpireSeconds',
+ 'in' => 'query',
+ 'schema' => ['title' => '有效期秒数', 'description' => '有效期秒数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '600'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<CreateAuthTokensModel>',
+ 'description' => 'PlainResult<CreateAuthTokensModel>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****',
- ],
- 'Code' => [
- 'description' => '错误码。'."\n"
- ."\n"
- .'> 仅当接口调用出错时会出现该参数。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'Success.',
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '9A51B1DF-96FF-3BCC-B08C-783161D3****'],
+ 'Data' => [
+ 'title' => '令牌数据。',
+ 'description' => '令牌数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'BaseUrl' => ['title' => '模型网关访问URL。', 'description' => '模型网关访问URL。', 'type' => 'string', 'example' => 'https://ai-gateway.example.com/v1'],
+ 'Tokens' => [
+ 'title' => '令牌列表。',
+ 'description' => '令牌列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthToken' => ['title' => '授权令牌值。', 'description' => '授权令牌值。', 'type' => 'string', 'example' => 'cp******lp'],
+ 'ExpireSeconds' => ['title' => '有效期秒数。', 'description' => '有效期秒数。', 'type' => 'integer', 'format' => 'int64', 'example' => '600'],
+ 'ExpireAt' => ['title' => '过期时间戳。', 'description' => '过期时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1719648600'],
+ 'IssuedAt' => ['title' => '签发时间戳。', 'description' => '签发时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1719648000'],
+ 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'example' => 'acp-2zef0gov2nh2l3xxx'],
+ 'LicenseKey' => ['title' => '许可证Key。', 'description' => '许可证Key。', 'type' => 'string', 'example' => 'lk-abcdef1234567890'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '刷新模型认证令牌',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\"\\n}","type":"json"}]',
- 'title' => '删除系统属性模板',
- 'description' => '删除属性模板不会对已经调用[SendSystemPropertyTemplate](~~2950220~~)的实例产生任何影响。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9A51B1DF-96FF-3BCC-B08C-783161D3****\\",\\n \\"Data\\": {\\n \\"BaseUrl\\": \\"https://ai-gateway.example.com/v1\\",\\n \\"Tokens\\": [\\n {\\n \\"AuthToken\\": \\"cp******lp\\",\\n \\"ExpireSeconds\\": 600,\\n \\"ExpireAt\\": 1719648600,\\n \\"IssuedAt\\": 1719648000,\\n \\"InstanceId\\": \\"acp-2zef0gov2nh2l3xxx\\",\\n \\"LicenseKey\\": \\"lk-abcdef1234567890\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'DescribeTasks' => [
- 'summary' => '获取云手机实例当前任务列表。云手机很多(创建、开关机等)的操作都是异步进行,系统将产生一个任务ID供用户查询操作进度及结果。用户可通过调用该接口查询所有任务清单及执行情况。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RenewAndroidInstanceGroups' => [
+ 'summary' => '续费云手机实例组。预付费(包年包月)已到期 15天系统将自动删除实例组及其实例,且不可恢复,请及时进行续费操作。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneWDBBSN',
- 'FEATUREcloudphoneDY533B',
- 'FEATUREcloudphoneQ3V7AF',
- 'FEATUREcloudphoneE62QJ7',
- ],
+ 'operationType' => 'none',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMR1L7E'],
],
'parameters' => [
[
- 'name' => 'InvokeId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '命令执行ID,可以填写上一次操作返回的requestId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'B8ED2BA9-0C6A-5643-818F-B5D60A64****',
- ],
- ],
- [
- 'name' => 'ResourceIds',
+ 'name' => 'InstanceGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '资源ID列表。',
+ 'description' => '实例组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '资源ID,如果是查询云手机开机、关机、重启和重置的任务状态,资源ID填实例ID即可。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-25nt4kk9whhok****',
- ],
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-aobj3xwnvexhs****'],
'required' => false,
'maxItems' => 100,
+ 'minItems' => 1,
],
],
[
- 'name' => 'TaskIds',
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => '指定续费时长。单位由PeriodUnit指定。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6'],
+ ],
+ [
+ 'name' => 'PeriodUnit',
'in' => 'query',
- 'style' => 'repeatList',
'schema' => [
- 'description' => '任务ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 't-bp67acfmxazb4p****',
- ],
+ 'description' => '续费时长的时间单位,即参数Period的单位。默认值:Month。',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 100,
+ 'enumValueTitles' => ['Month' => '月', 'Year' => '年'],
+ 'example' => 'Month',
],
],
[
- 'name' => 'ParentTaskId',
+ 'name' => 'AutoPay',
'in' => 'query',
'schema' => [
- 'description' => '父任务ID。',
- 'type' => 'string',
+ 'description' => '是否自动支付。',
+ 'type' => 'boolean',
'required' => false,
- 'example' => 't-iaej5dkbnmivx****',
+ 'enumValueTitles' => ['true' => '自动付费,请确保账号有足够的余额', 'false' => '手动付费'],
+ 'example' => 'true',
],
],
[
- 'name' => 'TaskType',
+ 'name' => 'PromotionId',
'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'PaidCallBackUrl',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '任务类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'BackupFile' => '数据备份',
- 'StopInstance' => '实例关机',
- 'RebootInstance' => '实例重启',
- 'StartApp' => '启动应用',
- 'SendFile' => '上传文件',
- 'RunCommand' => '远程命令',
- 'RestartApp' => '重启应用',
- 'ResetInstance' => '实例重置',
- 'RecoverFile' => '数据恢复',
- 'UninstallApp' => '卸载应用',
- 'StopApp' => '停止应用',
- 'Screenshot' => '截屏',
- 'InstallApp' => '安装应用',
- 'FetchFile' => '下载文件',
- 'UpdateGroupImage' => '更换镜像',
- 'StartInstance' => '实例开机',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4B886792-2051-5DB4-8AE6-C8E45D3B4****'],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '22326560487****'],
],
- 'example' => 'StartInstance',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '续费实例组',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-05T06:13:13.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4B886792-2051-5DB4-8AE6-C8E45D3B4****\\",\\n \\"OrderId\\": \\"22326560487****\\"\\n}","type":"json"}]',
+ ],
+ 'RenewCloudPhoneNodes' => [
+ 'summary' => '续费云手机矩阵。',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphone3XZF7I'],
+ ],
+ 'parameters' => [
[
- 'name' => 'TaskTypes',
- 'in' => 'query',
+ 'name' => 'NodeIds',
+ 'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => '任务类型列表。',
+ 'description' => '云手机矩阵ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '任务类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'StartInstance',
- ],
+ 'items' => ['description' => '云手机矩阵ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-csbdhjcbvfd****'],
'required' => false,
'maxItems' => 100,
+ 'minItems' => 1,
],
],
[
- 'name' => 'TaskStatus',
- 'in' => 'query',
+ 'name' => 'PeriodUnit',
+ 'in' => 'formData',
'schema' => [
- 'description' => '任务状态。',
+ 'description' => '购买资源的时长单位。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'PartFinished' => '部分成功',
- 'Finished' => '已完成',
- 'Failed' => '任务失败',
- 'Skipped' => '跳过',
- 'Processing' => '运行中',
- 'Waiting' => '等待',
- ],
- 'example' => 'Processing',
+ 'enumValueTitles' => ['Month' => '月 [默认值]', 'Year' => '年'],
+ 'example' => 'Month',
],
],
[
- 'name' => 'TaskStatuses',
- 'in' => 'query',
- 'style' => 'repeatList',
+ 'name' => 'Period',
+ 'in' => 'formData',
+ 'schema' => ['description' => '购买资源的时长,单位由`PeriodUnit`指定。'."\n"
+ ."\n"
+ .'- 当`PeriodUnit`为**year**时,取值只能为1。'."\n"
+ .'- 当`PeriodUnit`为**month**时,取值范围为1、2、3、6。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'formData',
'schema' => [
- 'description' => '任务状态列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务状态。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Finished',
- ],
+ 'description' => '是否开启自动续费。',
+ 'type' => 'boolean',
'required' => false,
- 'maxItems' => 100,
+ 'enumValueTitles' => ['true' => '启用自动续费,实例到期后由系统自动续费', 'false' => '不自动续费,实例到期后手动续费 [默认值]'],
+ 'example' => 'true',
],
],
[
- 'name' => 'Level',
+ 'name' => 'AutoPay',
'in' => 'query',
'schema' => [
- 'description' => '任务级别,1表示批量任务;2表示实例级任务。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '是否自动支付。默认为false。',
+ 'type' => 'boolean',
'required' => false,
- 'example' => '1',
+ 'enumValueTitles' => ['true' => '自动支付,调用API后自动完成支付', 'false' => '需要前往阿里云费用与成本中心手动支付 [默认值]'],
+ 'example' => 'false',
],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'PromotionId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-2zecay9ponatdc4m****',
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
- 'name' => 'InstanceName',
+ 'name' => 'PaidCallBackUrl',
'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'defaultInstanceName',
+ 'title' => 'Schema of Response',
+ 'description' => '请求信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC****'],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '22365781890****'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '续费云手机矩阵',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-05T06:13:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-25T11:15:35.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC****\\",\\n \\"OrderId\\": \\"22365781890****\\"\\n}","type":"json"}]',
+ ],
+ 'RenewMobileAgentPackage' => [
+ 'summary' => '续费套餐包。',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Param',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => '购买资源的时长,单位由`PeriodUnit`指定。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6'],
+ ],
+ [
+ 'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
- 'description' => '扩展字段。',
+ 'description' => '购买资源的时长单位。'."\n"
+ .'取值范围:'."\n"
+ .'- **Month**:月。'."\n"
+ .'- **Year**:年。',
'type' => 'string',
'required' => false,
- 'example' => 'param',
+ 'enumValueTitles' => ['Month' => '月', 'Year' => '年'],
+ 'example' => 'Month',
],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'AutoPay',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的最大条目数。取值范围 1~100,默认值为 10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '0',
- 'enumValueTitles' => [],
- 'example' => '10',
- ],
+ 'schema' => ['description' => '是否自动支付。取值范围:'."\n"
+ ."\n"
+ .'- **true**:自动支付。您需要确保账户余额充足。'."\n"
+ .'- **false**(默认):只生成订单不扣费。'."\n"
+ ."\n\n"
+ ."\n\n"
+ .'> 如果您的支付方式余额不足,可以将此参数设置为false,此时会生成未支付订单,您可以登录无影云手机管理控制台自行支付。'."\n"
+ .'>', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'PromotionId',
'in' => 'query',
+ 'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'example' => '50003308011****'],
+ ],
+ [
+ 'name' => 'MobileAgentPackageIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
+ 'description' => '套餐包ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '套餐包ID。', 'type' => 'string', 'required' => false, 'example' => 'cmag-shdbcudbaib****'],
'required' => false,
- 'example' => 'FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0****',
+ 'maxItems' => 100,
],
],
+ [
+ 'name' => 'PaidCallbackUrl',
+ 'in' => 'query',
+ 'schema' => ['description' => '支付成功页跳转链接。', 'type' => 'string', 'required' => false, 'example' => 'https://aim.wuying.aliyun.com/nodes'],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启自动续费。默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '',
- 'description' => '返回参数。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****',
- ],
- 'Data' => [
- 'description' => '返回结果对象列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 't-bp67acfmxazb4p****',
- ],
- 'InvokeId' => [
- 'description' => '命令执行ID。',
- 'type' => 'string',
- 'example' => 'B8ED2BA9-0C6A-5643-818F-B5D60A64****',
- ],
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'ResourceId' => [
- 'description' => '资源ID。',
- 'type' => 'string',
- 'example' => 'acp-25nt4kk9whhok****',
- ],
- 'TaskType' => [
- 'description' => '任务类型。',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'StartInstance',
- ],
- 'TaskStatus' => [
- 'description' => '任务状态。',
- 'type' => 'string',
- 'example' => 'Processing',
- ],
- 'StartTime' => [
- 'title' => '创建时间',
- 'description' => '任务开始时间。',
- 'type' => 'string',
- 'example' => '2022-10-11T08:53:32Z',
- ],
- 'FinishTime' => [
- 'title' => '修改时间',
- 'description' => '任务结束时间。',
- 'type' => 'string',
- 'example' => '2022-10-11T08:53:32Z',
- ],
- 'Param' => [
- 'description' => '任务参数。',
- 'type' => 'string',
- 'example' => 'param',
- ],
- 'Result' => [
- 'description' => '任务执行结果。',
- 'type' => 'string',
- 'example' => '{\'Success\': True}',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'SendFileFailed',
- ],
- 'ErrorMsg' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'connect error.',
- ],
- 'Level' => [
- 'description' => '任务级别。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'FailedChildCount' => [
- 'description' => '执行失败的子任务总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'SuccessChildCount' => [
- 'description' => '执行成功的子任务总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '98',
- ],
- 'RunningChildCount' => [
- 'description' => '运行中的子任务总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TotalChildCount' => [
- 'description' => '当前批量任务的子任务总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'InstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'acp-uto81vfd8t8z****',
- ],
- 'InstanceName' => [
- 'description' => '实例名称',
- 'type' => 'string',
- 'example' => 'defaultInstanceName',
- ],
- 'InstanceStatus' => [
- 'description' => '实例状态。',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'Operator' => [
- 'description' => '操作者。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'ParentTaskId' => [
- 'description' => '父任务ID。',
- 'type' => 'string',
- 'example' => 't-41oan3tza16vs****',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'B8ED2BA9-0C6A-5643-818F-B5D60A64****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7B9EFA4F-4305-5968-BAEE-BD8B8DE5****'],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '223684716098****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '续费套餐包',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"Data\\": [\\n {\\n \\"TaskId\\": \\"t-bp67acfmxazb4p****\\",\\n \\"InvokeId\\": \\"B8ED2BA9-0C6A-5643-818F-B5D60A64****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceId\\": \\"acp-25nt4kk9whhok****\\",\\n \\"TaskType\\": \\"StartInstance\\",\\n \\"TaskStatus\\": \\"Processing\\",\\n \\"StartTime\\": \\"2022-10-11T08:53:32Z\\",\\n \\"FinishTime\\": \\"2022-10-11T08:53:32Z\\",\\n \\"Param\\": \\"param\\",\\n \\"Result\\": \\"{\'Success\': True}\\",\\n \\"ErrorCode\\": \\"SendFileFailed\\",\\n \\"ErrorMsg\\": \\"connect error.\\",\\n \\"Level\\": 1,\\n \\"FailedChildCount\\": 2,\\n \\"SuccessChildCount\\": 98,\\n \\"RunningChildCount\\": 0,\\n \\"TotalChildCount\\": 100,\\n \\"InstanceId\\": \\"acp-uto81vfd8t8z****\\",\\n \\"InstanceName\\": \\"defaultInstanceName\\",\\n \\"InstanceStatus\\": \\"RUNNING\\",\\n \\"Operator\\": \\"test\\",\\n \\"ParentTaskId\\": \\"t-41oan3tza16vs****\\"\\n }\\n ],\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"B8ED2BA9-0C6A-5643-818F-B5D60A64****\\"\\n}","type":"json"}]',
- 'title' => '查询任务',
- 'description' => '- 可以通过DescribeTasks接口查询批量或者单台云手机实例的操作状态。'."\n"
- .'- 目前支持开机、关机、重启、重置、备份/恢复、安装应用、远程命令等操作的任务查询。'."\n"
- .'- Level字段可区分任务等级。当Level=1,任务属于批量任务;Level=2,任务属于实例级任务。'."\n"
- ."\n"
- .'**举例说明:**'."\n"
- ."\n"
- .'假设您对实例ID为acp-25nt4kk9whhok****、实例ID为acp-j2taq887orj8l**** 的两台云手机实例执行了重启操作,返回这次操作的requestId为B8ED2BA9-0C6A-5643-818F-B5D60A64****。如果您希望知道这次批量操作的结果,可以调用DescribeTasks来查询,其中的InvokeId填写B8ED2BA9-0C6A-5643-818F-B5D60A64****;如果您希望拿到实例ID为acp-25nt4kk9whhok**** 的重启结果,入参ParentTaskId=批量任务ID,AndroidInstanceId=acp-25nt4kk9whhok****,可调用DescribeTasks即可。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B9EFA4F-4305-5968-BAEE-BD8B8DE5****\\",\\n \\"OrderId\\": \\"223684716098****\\"\\n}","type":"json"}]',
],
- 'InstallMonitorAgent' => [
- 'summary' => '一键安装监控插件,只有安装了监控插件,实例才会有监控数据。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ResetAndroidInstancesInGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVQDPK9',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneEDCJTJ'],
],
'parameters' => [
[
'name' => 'AndroidInstanceIds',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-a1qp88ohp3a8g****-040',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-scaucydkl****'],
'required' => false,
- 'maxItems' => 1000,
+ 'maxItems' => 100,
+ 'minItems' => 1,
],
],
[
'name' => 'SaleMode',
- 'in' => 'formData',
+ 'in' => 'query',
'schema' => [
- 'description' => '监控类型。'."\n"
- ."\n"
- .'- 实例模式:Instance'."\n"
- .'- 节点模式:Node',
+ 'description' => '售卖模式。该参数已废弃!',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'Instance' => '实例模式',
- 'Node' => '节点模式',
- ],
- 'example' => 'NODE',
+ 'enumValueTitles' => ['Instance' => '云手机实例模式', 'Node' => '云手机矩阵模式'],
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Node'],
+ ],
+ ],
+ [
+ 'name' => 'SettingResetType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '<props="china">重置是否保留属性设置,不传则默认不保留属性配置,该参数仅针对云手机矩阵实例生效。可执行wya dump config命令查看保留的属性详情。</props>'."\n"
+ .'<props="intl">国际站不支持此参数</props>',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'enumValueTitles' => ['不保留属性设置', '保留属性设置'],
+ 'example' => '1',
],
],
+ [
+ 'name' => 'IgnoreParamValidation',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应体',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'DB070C80-45AC-52CA-8101-937C25DA****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****'],
+ 'Tasks' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParentTaskId' => ['type' => 'string', 'example' => 't-xxxx'],
+ 'ChildTasks' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['type' => 'string', 'example' => 'acp-xxxx'],
+ 'TaskId' => ['type' => 'string', 'example' => 't-xxxx'],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB070C80-45AC-52CA-8101-937C25DA****\\"\\n}","type":"json"}]',
- 'title' => '安装监控插件',
- ],
- 'UninstallMonitorAgent' => [
- 'summary' => '卸载监控插件。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '重置实例(初始化系统)',
+ 'summary' => '重置云手机实例。 重置是使用该云手机的镜像进行重装系统的过程,例如云手机创建时使用的镜像被删除将重置失败。',
+ 'description' => '只有实例处于**可用、已关机、异常、备份失败、恢复失败**状态时才支持重置(初始化系统)。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-31T07:55:40.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-07T03:35:38.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\",\\n \\"Tasks\\": {\\n \\"ParentTaskId\\": \\"t-xxxx\\",\\n \\"ChildTasks\\": [\\n {\\n \\"InstanceId\\": \\"acp-xxxx\\",\\n \\"TaskId\\": \\"t-xxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ResumeAgentTask' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVQDPK9',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneGXZ7W8'],
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIds',
- 'in' => 'formData',
+ 'name' => 'TaskIds',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID列表。',
+ 'description' => '任务ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-9y1nwysxr9d6l****-016',
- ],
- 'required' => false,
- 'maxItems' => 1000,
+ 'items' => ['description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => 't-bp67acfmxazb4p****'],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'SaleMode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '监控类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Instance' => '实例模式',
- 'Node' => '节点模式',
- ],
- 'example' => 'Node',
- ],
+ 'name' => 'AdditionalPrompt',
+ 'in' => 'query',
+ 'schema' => ['description' => '追加prompt(只有任务被动暂停时生效,比如暂停等待用户确认)。', 'type' => 'string', 'required' => false, 'example' => '验证码为***。'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应体。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '6C8439B9-7DBF-57F4-92AE-55A9B9D3****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****'],
+ 'Code' => ['description' => '接口状态码。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '接口返回信息。', 'type' => 'string', 'example' => 'Success.'],
+ 'Tasks' => [
+ 'description' => '任务list。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务 ID,全局唯一。', 'type' => 'string', 'example' => 't-imr0fufqd7cle****'],
+ 'InstanceId' => ['description' => 'Mobile节点 ID。', 'type' => 'string', 'example' => 'acp-ek65k51zoxia3x8xz'],
+ 'CurrentStatus' => ['description' => '任务当前状态,参考下方状态枚举,取值如下:'."\n"
+ ."\n"
+ .'PENDING 任务创建中。'."\n"
+ ."\n"
+ .'RUNNING 任务运行中。'."\n"
+ ."\n"
+ .'COMPLETED 任务已完成。'."\n"
+ ."\n"
+ .'FAILED 任务失败。'."\n"
+ ."\n"
+ .'TIMEOUT 任务执行超时。'."\n"
+ ."\n"
+ .'PAUSING 任务暂停中。'."\n"
+ ."\n"
+ .'PAUSED 任务暂停。', 'type' => 'string', 'example' => 'RUNNING'],
+ 'ResumingAt' => ['description' => '任务继续时间,ISO 8601 格式。', 'type' => 'string', 'example' => '2026-04-13T17:42:19Z'],
+ 'FailedReason' => ['description' => '继续任务失败原因。', 'type' => 'string', 'example' => 'Task status [COMPLETED] does not support resume, only PAUSED tasks can be resumed.'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '继续 Agent 任务。',
+ 'summary' => '继续Mobile 节点上正在运行的 Agent 自动化任务。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C8439B9-7DBF-57F4-92AE-55A9B9D3****\\"\\n}","type":"json"}]',
- 'title' => '卸载监控插件',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Tasks\\": [\\n {\\n \\"TaskId\\": \\"t-imr0fufqd7cle****\\",\\n \\"InstanceId\\": \\"acp-ek65k51zoxia3x8xz\\",\\n \\"CurrentStatus\\": \\"RUNNING\\",\\n \\"ResumingAt\\": \\"2026-04-13T17:42:19Z\\",\\n \\"FailedReason\\": \\"Task status [COMPLETED] does not support resume, only PAUSED tasks can be resumed.\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DescribeMetricLast' => [
- 'summary' => '查询实例或矩阵的最新监控数据。支持 CPU、内存、磁盘、网络等监控数据的查询。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunAgentTask' => [
+ 'summary' => '触发 Mobile 节点上 Agent 执行 AI 自动化任务。',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVQDPK9',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneWY4NGN'],
],
'parameters' => [
[
- 'name' => 'MetricNames',
- 'in' => 'formData',
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '监控指标列表。',
+ 'description' => 'Mobile节点ID列表。一次请求最多支持100个节点。',
'type' => 'array',
- 'items' => [
- 'description' => '监控项名称。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cpu_utilization' => 'CPU使用率',
- 'diskusage_utilization' => '存储使用率',
- 'bandwidth_package_usage_out' => '带宽包流出带宽(仅限标准网络)',
- 'memory_used_utilization' => '内存使用率',
- 'intranet_out_rate' => '连接流出带宽',
- 'gpu_memory_used_utilization' => 'GPU显存使用率(仅限矩阵)',
- 'bandwidth_package_usage_in' => '带宽包流入带宽(仅限标准网络)',
- 'process_memory' => '进程内存使用率',
- 'intranet_in_rate' => '连接流入带宽',
- 'process_cpu' => '进程cpu使用率',
- 'gpu_used_utilization' => 'GPU使用率(仅限矩阵)',
- ],
- 'example' => 'cpu_utilization',
- ],
- 'required' => true,
- 'enumValueTitles' => [],
+ 'items' => ['description' => 'Mobile节点 ID,如 acp-xxx。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh4a31emkt6u****'],
+ 'required' => false,
'maxItems' => 100,
],
],
[
- 'name' => 'AndroidInstanceIds',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例级别的监控,传入云手机实例ID列表。'."\n"
- ."\n"
- .'<props="china">矩阵级别的监控,传入矩阵ID列表。</props>',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例级别的监控,传入云手机实例ID。 '."\n"
- .'<props="china">矩阵级别的监控,传入矩阵ID。</props>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-6nongia0tuev7****',
- ],
- 'required' => false,
- 'maxItems' => 50,
- ],
+ 'name' => 'UserPrompt',
+ 'in' => 'query',
+ 'schema' => ['title' => '用户指令文本。当传入 TaskConfigId 时可省略,系统自动从配置中读取', 'description' => '用户指令(自然语言),Agent 据此完成操作。', 'type' => 'string', 'required' => false, 'example' => '去应用宝下载钉钉'],
],
[
- 'name' => 'Period',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '监控数据的统计周期。'."\n"
- ."\n"
- .'取值:60、900 和 3600。'."\n"
- ."\n"
- .'单位:秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 60 => '60',
- 900 => '900',
- 3600 => '3600',
- ],
- 'example' => '60',
- ],
+ 'name' => 'MaxSteps',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Task最大执行步骤数,防止无限循环。范围 30~1000,默认1000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
- 'name' => 'StartTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '查询监控项的开始时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2019-01-31 10:00:00',
- ],
+ 'name' => 'TimeoutSeconds',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务超时时间(秒)。范围 300~3600,默认3600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600'],
],
[
- 'name' => 'EndTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '查询监控项的结束时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2019-01-31 11:00:00',
- ],
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Mobile节点所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
- 'name' => 'NextToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用来标记当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****',
- ],
+ 'name' => 'TaskConfigId',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务配置ID,用于触发指定配置的任务', 'description' => '任务配置ID,用于触发指定配置的任务', 'type' => 'string', 'required' => false, 'example' => 'tsk-260625-49be****'],
],
[
- 'name' => 'Length',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '返回监控数据的每页大小,用于分页查询。'."\n"
- ."\n"
- .'默认值:1000,即每页 1000 条监控数据。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1000',
- ],
+ 'name' => 'ScheduleId',
+ 'in' => 'query',
+ 'schema' => ['title' => '调度计划ID,传入时执行记录关联到对应的定时任务,便于按调度维度聚合查询', 'description' => '调度计划ID,传入时执行记录关联到对应的定时任务,便于按调度维度聚合查询', 'type' => 'string', 'required' => false, 'example' => 'sch-260625-pbj2****'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'Targets',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '指定监控资源的维度'."\n",
- 'description' => '实例ID列表。',
+ 'description' => 'Targets 是一个数组,每个元素是包含 InstanceId 和 SessionId 的对象。',
'type' => 'array',
'items' => [
- 'title' => '实例id',
- 'description' => '实例ID。'."\n"
- ."\n"
- .'> 传入带宽包ID,可查询带宽包最新带宽数据',
- 'type' => 'string',
+ 'description' => 'Target 对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => 'Mobile 节点 ID,如 acp-xxx。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh4a31emkt6u****'."\n"],
+ 'SessionId' => ['description' => '会话ID,同sessionid的任务共享上下文,如ses-260702-21b****。', 'type' => 'string', 'required' => false, 'example' => 'ses-260702-21bh****。'],
+ ],
'required' => false,
- 'example' => 'np-5hh4a31emkt6u****'."\n",
],
'required' => false,
'maxItems' => 50,
@@ -13619,141 +10499,50 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '接口返回数据。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2B9E6946-0E2A-5D2B-B275-361DF81F****',
- ],
- 'Count' => [
- 'description' => '数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'NextToken' => [
- 'description' => '下一次查询的令牌(Token)。如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****',
- ],
- 'MetricTotalModel' => [
- 'description' => '实例监控结果列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一 ID。', 'type' => 'string', 'example' => '6C8439B9-7DBF-57F4-92AE-55A9B9D3****'],
+ 'Code' => ['description' => '接口状态码。', 'type' => 'string', 'example' => '例如 "200" 表示成功。'],
+ 'Message' => ['description' => '接口返回信息。', 'type' => 'string', 'example' => 'Success.'],
+ 'Count' => ['description' => '任务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Tasks' => [
+ 'description' => '任务list。',
'type' => 'array',
'items' => [
- 'description' => '实例监控结果。',
+ 'description' => '任务。',
'type' => 'object',
'properties' => [
- 'AndroidInstanceId' => [
- 'description' => '实例级别的监控,返回云手机实例ID。 '."\n"
- .'<props="china">矩阵级别的监控,返回矩阵ID。</props>',
- 'type' => 'string',
- 'example' => 'acp-fkuit0cmyru4p****',
- ],
- 'MetricModelList' => [
- 'description' => '指标监控结果列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '指标监控结果。',
- 'type' => 'object',
- 'properties' => [
- 'MetricName' => [
- 'description' => '监控项名称。',
- 'type' => 'string',
- 'example' => 'cpu_utilization',
- ],
- 'DataPoints' => [
- 'description' => '监控统计数据点列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '监控统计数据点。',
- 'type' => 'object',
- 'properties' => [
- 'Timestamp' => [
- 'description' => '统计时间戳。单位:毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1548777660000',
- ],
- 'Minimum' => [
- 'description' => '最小值。单位:%。'."\n"
- .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '93.1',
- ],
- 'Average' => [
- 'description' => '平均值。单位:%。'."\n"
- .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '99.52',
- ],
- 'Maximum' => [
- 'description' => '最大值。单位:%。'."\n"
- .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'GpuId' => [
- 'description' => '显卡ID。',
- 'type' => 'string',
- 'example' => 'cpn-1t1bxvp9az2pk****-gpu-0',
- ],
- ],
- ],
- ],
- 'ProcessLastInfos' => [
- 'description' => '进程监控指标列表。'."\n"
- ."\n"
- .'> 监控项为process_cpu和process_memory时返回此项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '进程监控指标。',
- 'type' => 'object',
- 'properties' => [
- 'Timestamp' => [
- 'description' => '统计时间戳。单位:毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1548777660000',
- ],
- 'Name' => [
- 'description' => '进程名。',
- 'type' => 'string',
- 'example' => 'com.offerup',
- ],
- 'ProcessIds' => [
- 'description' => '进程号列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '进程号。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100056',
- ],
- ],
- 'MemoryUsage' => [
- 'description' => '存储使用率。单位:%。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '50',
- ],
- 'CpuUsage' => [
- 'description' => 'CPU使用率。单位:%。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '50',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'TaskId' => ['description' => '任务 ID,全局唯一。', 'type' => 'string', 'example' => 't-imr0fufqd7cle****'],
+ 'InstanceId' => ['description' => 'Mobile节点 ID。', 'type' => 'string', 'example' => 'acp-ek65k51zoxia3x8xz'],
+ 'UserPrompt' => ['description' => '用户指令(自然语言),Agent 据此完成操作。', 'type' => 'string', 'example' => '去应用宝下载钉钉'],
+ 'CurrentStatus' => ['description' => '任务当前状态,参考下方状态枚举,取值如下:'."\n"
+ ."\n"
+ .'PENDING 任务创建中。'."\n"
+ ."\n"
+ .'RUNNING 任务运行中。'."\n"
+ ."\n"
+ .'COMPLETED 任务已完成。'."\n"
+ ."\n"
+ .'FAILED 任务失败。'."\n"
+ ."\n"
+ .'TIMEOUT 任务执行超时。'."\n"
+ ."\n"
+ .'CALL_FOR_USER 等待用户操作。'."\n"
+ ."\n"
+ .'PAUSING 暂停中。'."\n"
+ ."\n"
+ .'PAUSED 已暂停。'."\n"
+ ."\n"
+ .'CANCELLING 取消中。'."\n"
+ ."\n"
+ .'CANCELED 已取消。'."\n"
+ ."\n"
+ .'STOPPED 已停止。'."\n"
+ ."\n"
+ .'TIMEOUT 超时。', 'type' => 'string', 'example' => 'COMPLETED'],
+ 'RunningAt' => ['description' => '任务创建时间,ISO 8601 格式。', 'type' => 'string', 'example' => '2026-04-13T17:42:19Z'],
+ 'SessionId' => ['description' => '会话ID,同sessionid的任务共享上下文。', 'type' => 'string', 'example' => 'ses-260702-21bh****。'],
],
],
],
@@ -13761,198 +10550,175 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '执行 Agent 任务。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B9E6946-0E2A-5D2B-B275-361DF81F****\\",\\n \\"Count\\": 100,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MetricTotalModel\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-fkuit0cmyru4p****\\",\\n \\"MetricModelList\\": [\\n {\\n \\"MetricName\\": \\"cpu_utilization\\",\\n \\"DataPoints\\": [\\n {\\n \\"Timestamp\\": 1548777660000,\\n \\"Minimum\\": 93.1,\\n \\"Average\\": 99.52,\\n \\"Maximum\\": 100,\\n \\"GpuId\\": \\"cpn-1t1bxvp9az2pk****-gpu-0\\"\\n }\\n ],\\n \\"ProcessLastInfos\\": [\\n {\\n \\"Timestamp\\": 1548777660000,\\n \\"Name\\": \\"com.offerup\\",\\n \\"ProcessIds\\": [\\n 100056\\n ],\\n \\"MemoryUsage\\": 50,\\n \\"CpuUsage\\": 50\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询指定云机的最新监控数据',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C8439B9-7DBF-57F4-92AE-55A9B9D3****\\",\\n \\"Code\\": \\"例如 \\\\\\"200\\\\\\" 表示成功。\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Count\\": 1,\\n \\"Tasks\\": [\\n {\\n \\"TaskId\\": \\"t-imr0fufqd7cle****\\",\\n \\"InstanceId\\": \\"acp-ek65k51zoxia3x8xz\\",\\n \\"UserPrompt\\": \\"去应用宝下载钉钉\\",\\n \\"CurrentStatus\\": \\"COMPLETED\\",\\n \\"RunningAt\\": \\"2026-04-13T17:42:19Z\\",\\n \\"SessionId\\": \\"ses-260702-21bh****。\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DescribeMetricList' => [
- 'summary' => '查询指定监控项的监控数据,支持网络带宽等监控数据的查询。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunCommand' => [
+ 'summary' => '在云手机实例中执行命令。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVQDPK9',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneYYGTDB'],
],
'parameters' => [
[
- 'name' => 'MetricNames',
- 'in' => 'formData',
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '监控指标列表。',
+ 'description' => '实例ID列表。一次请求最多支持50个实例。',
'type' => 'array',
- 'items' => [
- 'description' => '监控项名称。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cpu_utilization' => 'CPU使用率',
- 'bandwidth_package_usage_out' => '带宽包流出带宽(仅限标准网络)',
- 'diskusage_utilization' => '存储使用率',
- 'memory_used_utilization' => '内存使用率',
- 'intranet_out_rate' => '连接流出带宽',
- 'gpu_memory_used_utilization' => 'GPU显存使用率(仅限矩阵)',
- 'bandwidth_package_usage_in' => '带宽包流入带宽(仅限标准网络)',
- 'process_memory' => '进程内存使用率',
- 'intranet_in_rate' => '连接流入带宽',
- 'process_cpu' => '进程cpu使用率',
- 'gpu_used_utilization' => 'GPU使用率(仅限矩阵)',
- ],
- 'example' => 'bandwidth_package_usage_in',
- ],
- 'required' => true,
- 'maxItems' => 100,
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-7b15ex96****'],
+ 'required' => false,
+ 'maxItems' => 1000,
+ 'minItems' => 1,
],
],
[
- 'name' => 'AndroidInstanceIds',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'CommandContent',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令内容。', 'type' => 'string', 'required' => false, 'example' => 'ls'],
+ ],
+ [
+ 'name' => 'Timeout',
+ 'in' => 'query',
+ 'schema' => ['description' => '超时时间。单位秒,如果超过该时间命令仍然没有执行完成,则命令执行状态为超时,如果不填则默认为60秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'],
+ ],
+ [
+ 'name' => 'AgentType',
+ 'in' => 'query',
'schema' => [
- 'description' => '实例级别的监控,传入云手机实例ID列表。'."\n"
- ."\n"
- .'<props="china">矩阵级别的监控,传入矩阵ID列表。</props>',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例级别的监控,传入云手机实例ID。 '."\n"
- .'<props="china">矩阵级别的监控,传入矩阵ID。</props>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-25nt4kk9whhok****',
- ],
+ 'description' => '执行命令的通道类型。',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 50,
+ 'enumValueTitles' => ['EdsAgent' => 'EdsAgent通道', 'CloudAssistant' => '云助手'],
+ 'example' => 'EdsAgent',
],
],
[
- 'name' => 'InstanceIds',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'ContentEncoding',
+ 'in' => 'query',
'schema' => [
- 'description' => '实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。'."\n"
- .'> 传入带宽包ID,可查询带宽包带宽数据',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'np-5hh4a31emkt6u****',
- ],
+ 'description' => '命令内容(`CommandContent`)的编码方式。不区分大小写。'."\n"
+ ."\n"
+ .'> 若传入的值不在枚举值范围内,则一律视为`PlainText`处理。',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 50,
+ 'enumValueTitles' => ['Base64' => 'Base64编码', 'PlainText' => '不编码,采用明文传输 [默认值]'],
+ 'example' => 'PlainText',
],
],
- [
- 'name' => 'ProcessInfos',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '进程监控指标列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '进程监控指标。',
- 'type' => 'object',
- 'properties' => [
- 'ProcessName' => [
- 'description' => '进程名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'php-fpm',
- ],
- 'ProcessIds' => [
- 'description' => '进程号列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '进程号。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => 'approval-process-c47080c1f238e889',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '440D7342-5E7C-B2DB-D0B4EAC2BDF1****'],
+ 'InvokeId' => ['description' => '命令执行ID,可以通过这个ID查询命令执行结果。', 'type' => 'string', 'example' => 't-gov2ujrk32v4****'],
+ 'TaskId' => ['type' => 'string'],
+ 'RunCommandInfos' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InvokeId' => ['type' => 'string', 'description' => ''],
+ 'InstanceId' => ['type' => 'string', 'description' => ''],
+ 'ChildTaskId' => ['type' => 'string'],
],
- 'required' => false,
- 'maxItems' => 100,
+ 'description' => '',
],
+ 'description' => '',
],
- 'required' => false,
],
- 'required' => false,
- 'maxItems' => 100,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '执行命令',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-22T13:03:49.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-08-27T11:57:03.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-04T01:39:16.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-14T02:07:10.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"440D7342-5E7C-B2DB-D0B4EAC2BDF1****\\",\\n \\"InvokeId\\": \\"t-gov2ujrk32v4****\\",\\n \\"TaskId\\": \\"\\",\\n \\"RunCommandInfos\\": [\\n {\\n \\"InvokeId\\": \\"\\",\\n \\"InstanceId\\": \\"\\",\\n \\"ChildTaskId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'RunSyncCommand' => [
+ 'summary' => '执行云手机命令,并尝试返回结果。',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Period',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '监控数据的统计周期。'."\n"
- ."\n"
- .'取值:60、900 和 3600。'."\n"
- ."\n"
- .'单位:秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '60',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneYYGTDB'],
+ ],
+ 'parameters' => [
[
- 'name' => 'StartTime',
- 'in' => 'formData',
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '查询监控项的开始时间。',
- 'type' => 'string',
+ 'description' => '云手机实例ID列表。一次请求最多支持50个实例。',
+ 'type' => 'array',
+ 'items' => ['description' => '云手机实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh431emkt6u*****'],
'required' => false,
- 'example' => '2019-01-31 10:00:00',
+ 'maxItems' => 500,
+ 'minItems' => 1,
],
],
[
- 'name' => 'EndTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '查询监控项的结束时间。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2019-01-31 11:00:00',
- ],
+ 'name' => 'CommandContent',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令内容。', 'type' => 'string', 'required' => false, 'example' => 'ls'],
],
[
- 'name' => 'NextToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用来标记当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****',
- ],
+ 'name' => 'WaitTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '等待时间,单位为毫秒。取值范围500\\~3000,默认值为1000。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '3000', 'minimum' => '500', 'example' => '1000', 'default' => '1000'],
],
[
- 'name' => 'Length',
- 'in' => 'formData',
+ 'name' => 'ContentEncoding',
+ 'in' => 'query',
'schema' => [
- 'description' => '返回监控数据的每页大小,用于分页查询。'."\n"
- ."\n"
- .'默认值:1000,即每页 1000 条监控数据。',
+ 'description' => '脚本内容的编码方式。若该参数传入的值不在枚举值范围内,则一律视为传入默认值`PlainText`。',
'type' => 'string',
'required' => false,
- 'example' => '1000',
+ 'enumValueTitles' => ['Base64' => 'Base64编码', 'PlainText' => '不编码,采用明文传输 [默认值]'],
+ 'example' => 'PlainText',
],
],
],
@@ -13960,113 +10726,24 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '接口返回数据。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
- ],
- 'Count' => [
- 'description' => '数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NextToken' => [
- 'description' => '下一次查询的令牌(Token)。如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****',
- ],
- 'MetricTotalModel' => [
- 'description' => '实例监控结果列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5C5CEF0A-D6E1-58D3-8750-67DB4F82****'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'string', 'example' => '31'],
+ 'Data' => [
+ 'description' => '返回结果对象。',
'type' => 'array',
'items' => [
- 'description' => '实例监控结果。',
+ 'description' => '返回结果对象。',
'type' => 'object',
'properties' => [
- 'AndroidInstanceId' => [
- 'description' => '实例级别的监控,返回云手机实例ID。 '."\n"
- .'<props="china">矩阵级别的监控,返回矩阵ID。</props>',
- 'type' => 'string',
- 'example' => 'acp-fkuit0cmyru4p****',
- ],
- 'MetricModelList' => [
- 'description' => '指标监控结果列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '指标监控结果。',
- 'type' => 'object',
- 'properties' => [
- 'MetricName' => [
- 'description' => '监控项名称。',
- 'type' => 'string',
- 'example' => 'cpu_utilization',
- ],
- 'ProcessName' => [
- 'description' => '进程名称。',
- 'type' => 'string',
- 'example' => '需要',
- ],
- 'DataPoints' => [
- 'description' => '监控统计数据点列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '监控统计数据点。',
- 'type' => 'object',
- 'properties' => [
- 'Timestamp' => [
- 'description' => '统计时间戳。单位:毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1548777660000',
- ],
- 'Minimum' => [
- 'description' => '最小值。单位:%。'."\n"
- .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '93.1',
- ],
- 'Average' => [
- 'description' => '平均值。单位:%。'."\n"
- .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '99.52',
- ],
- 'Maximum' => [
- 'description' => '最大值。单位:%。'."\n"
- .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'Value' => [
- 'description' => '数据值。单位:%。'."\n"
- .'> 监控项为bandwidth_package_usage_out和bandwidth_package_usage_in时单位是bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => 'tf-testacc-oos-parameter',
- ],
- 'GpuId' => [
- 'description' => '显卡ID。',
- 'type' => 'string',
- 'example' => 'cpn-1t1bxvp9az2pk****-gpu-0'."\n",
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'InstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'np-5hh4a31emkt6u****'."\n",
- ],
+ 'InvocationId' => ['description' => '命令执行ID。', 'type' => 'string', 'example' => 't-15775dc8****'],
+ 'StartTime' => ['description' => '命令开始执行时间。', 'type' => 'string', 'example' => '2022-10-11T08:53:32Z'],
+ 'FinishTime' => ['description' => '命令结束执行时间。', 'type' => 'string', 'example' => '2022-08-11 17:45:03'],
+ 'Output' => ['description' => '命令执行输出的结果。', 'type' => 'string', 'example' => 'success'],
+ 'InstanceId' => ['description' => '执行当前命令的实例ID。', 'type' => 'string', 'example' => 'acp-uto81vfd8t8z****'],
+ 'InvocationStatus' => ['description' => '命令执行进度状态。', 'type' => 'string', 'example' => 'RUNNING'],
],
],
],
@@ -14074,363 +10751,201 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MetricTotalModel\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-fkuit0cmyru4p****\\",\\n \\"MetricModelList\\": [\\n {\\n \\"MetricName\\": \\"cpu_utilization\\",\\n \\"ProcessName\\": \\"需要\\",\\n \\"DataPoints\\": [\\n {\\n \\"Timestamp\\": 1548777660000,\\n \\"Minimum\\": 93.1,\\n \\"Average\\": 99.52,\\n \\"Maximum\\": 100,\\n \\"Value\\": 0,\\n \\"GpuId\\": \\"cpn-1t1bxvp9az2pk****-gpu-0\\\\n\\"\\n }\\n ]\\n }\\n ],\\n \\"InstanceId\\": \\"np-5hh4a31emkt6u****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询指定监控项的监控数据',
- ],
- 'DescribeMetricTop' => [
- 'summary' => '查询排序后的最新监控数据,支持实例网络带宽等监控数据的查询。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5CEF0A-D6E1-58D3-8750-67DB4F82****\\",\\n \\"TotalCount\\": \\"31\\",\\n \\"Data\\": [\\n {\\n \\"InvocationId\\": \\"t-15775dc8****\\",\\n \\"StartTime\\": \\"2022-10-11T08:53:32Z\\",\\n \\"FinishTime\\": \\"2022-08-11 17:45:03\\",\\n \\"Output\\": \\"success\\",\\n \\"InstanceId\\": \\"acp-uto81vfd8t8z****\\",\\n \\"InvocationStatus\\": \\"RUNNING\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '同步执行远程命令',
+ 'description' => '`RunSyncCommand`适合能快速返回结果(毫秒级)的命令。对于执行时间较长(秒级)的命令,建议使用[RunCommand](~~RunCommand~~)接口。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'SendFile' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVQDPK9',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphone0959GM'],
],
'parameters' => [
[
- 'name' => 'MetricNames',
- 'in' => 'formData',
+ 'name' => 'AndroidInstanceIdList',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '监控指标列表。',
+ 'description' => '实例列表。',
'type' => 'array',
- 'items' => [
- 'description' => '监控项名称。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'instance_out_traffic' => '流出带宽(仅限标准网络)',
- 'instance_in_traffic' => '流入带宽(仅限标准网络)',
- ],
- 'example' => 'instance_in_traffic',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'deprecated' => false,
'required' => true,
'maxItems' => 100,
],
],
[
- 'name' => 'AndroidInstanceIds',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'SourceFilePath',
+ 'in' => 'query',
+ 'schema' => ['description' => '将文件上传到云手机内部的上传路径。'."\n"
+ ."\n"
+ .'> 当UploadType是OSS或者OSS_BRIDGED,云手机内部的上传路径SourceFilePath必须是目录,例如:/sdcard/Download;当UploadType是DOWNLOAD_URL,云手机内部的上传路径SourceFilePath必须是文件,例如:/sdcard/Download/MyFile.txt。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => '/sdcard/Download'],
+ ],
+ [
+ 'name' => 'UploadType',
+ 'in' => 'query',
'schema' => [
- 'description' => '实例级别的监控,传入云手机实例ID列表。'."\n"
+ 'description' => '上传文件所在的存储类型。'."\n"
."\n"
- .'<props="china">矩阵级别的监控,传入矩阵ID列表。</props>',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例级别的监控,传入云手机实例ID。 '."\n"
- .'<props="china">矩阵级别的监控,传入矩阵ID。</props>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-sgicbcdadjs****',
- ],
- 'required' => false,
- 'maxItems' => 50,
+ .'- OSS'."\n"
+ .' 当上传的文件是OSS资源,上传文件所在的存储类型是OSS。'."\n"
+ .'- DOWNLOAD_URL'."\n"
+ .' 当上传的文件是文件的公网下载链接,上传文件所在的存储类型是DOWNLOAD_URL。'."\n"
+ .'- OSS_BRIDGED'."\n"
+ .' 通过公网下载链接同步到OSS,再通过OSS内网分发到云手机实例。',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => ['OSS_BRIDGED' => '公网下载链接同步OSS后分发', 'DOWNLOAD_URL' => '文件公网下载链接', 'OSS' => 'OSS文件资源'],
+ 'example' => 'OSS',
],
],
[
- 'name' => 'Period',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '监控数据的统计周期。'."\n"
- .'单位:秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '60',
- ],
+ 'name' => 'UploadEndpoint',
+ 'in' => 'query',
+ 'schema' => ['description' => '文件上传到OSS的服务域名,UploadType为OSS和OSS_BRIDGED时,UploadEndpoint必填。'."\n"
+ ."\n"
+ .'> 当云手机和OSS Bucket处于相同地域,域名可填写内网域名,加快传输速率,不产生公网网络费用,杭州为例: `oss-cn-hangzhou-internal.aliyuncs.com` 。具体的域名列表映射可参考[OSS地域和访问域名](~~31837~~)。', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'],
],
[
- 'name' => 'StartTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '查询监控项的开始时间。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2019-01-31 10:00:00',
- ],
+ 'name' => 'UploadUrl',
+ 'in' => 'query',
+ 'schema' => ['description' => '- 当UploadType是OSS,UploadUrl是文件上传到OSS的云端地址。'."\n"
+ .'> 可使用的OSS Bucket名,必须以“cloudphone-saved-bucket-”前缀的Bucket Bucket,例如“cloudphone-saved-bucket-example”,并创建OSS文件夹作为备份目录。UploadUrl的拼写规则是“oss://”+“Bucket名”+“/”+“文件夹名称”+“上传的文件名称”。'."\n"
+ .'- 当UploadType是DOWNLOAD或者OSS_BRIDGED,UploadUrl是文件的公网下载地址。', 'type' => 'string', 'required' => true, 'example' => 'oss://cloudphone-saved-bucket-example/send/a.txt'],
],
[
- 'name' => 'EndTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '查询监控项的结束时间。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2019-01-31 11:00:00',
- ],
+ 'name' => 'TargetFileName',
+ 'in' => 'query',
+ 'schema' => ['description' => '从OSS上传到云手机的文件名称。'."\n"
+ ."\n"
+ .'> 当UploadType是OSS或者OSS_BRIDGED,TargetFileName字段选填,如果TargetFileName为空,OSS文件上传到云手机的文件名称保留源文件名称,如果TargetFileName不为空,源文件上传到云手机的SourceFilePath路径下文件名称为TargetFileName的值;当UploadType是DOWNLOAD_URL,TargetFileName字段不生效。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => 'test.txt'],
],
[
- 'name' => 'NextToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用来标记当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****',
- ],
+ 'name' => 'AutoInstall',
+ 'in' => 'query',
+ 'schema' => ['description' => '上传的应用是否自动安装。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'Length',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '返回监控数据的每页大小,用于分页查询。'."\n"
- .'> 监控项为instance_in_traffic和instance_out_traffic时,最大值为100。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '100',
- ],
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用于保证请求的幂等性,防止重复提交请求。不超过 100 个字符。', 'type' => 'string', 'required' => false, 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
],
[
- 'name' => 'InstanceIds',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。'."\n"
- ."\n"
- .'> 传入带宽包ID,可查询带宽包下按带宽降序后Top N (N 小于等于100)带宽数据',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'np-5hh4a31emkt6u****',
- ],
- 'required' => false,
- 'maxItems' => 50,
- ],
+ 'name' => 'FileMd5',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '接口返回数据。',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '4610632D-D661-5982-B3D7-5D3FD183F****',
- ],
- 'Count' => [
- 'description' => '数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NextToken' => [
- 'description' => '下一次查询的令牌(Token)。如果一次查询结果并没有完整返回所有的结果,则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****',
- ],
- 'MetricTotalModel' => [
- 'description' => '实例监控结果列表。',
+ 'Data' => [
+ 'description' => '返回数据。',
'type' => 'array',
'items' => [
- 'description' => '实例监控结果。',
+ 'description' => '返回结果对象。',
'type' => 'object',
'properties' => [
- 'AndroidInstanceId' => [
- 'description' => '实例级别的监控,返回云手机实例ID。 '."\n"
- .'<props="china">矩阵级别的监控,返回矩阵ID。</props>',
- 'type' => 'string',
- 'example' => 'acp-fkuit0cmyru4p****',
- ],
- 'InstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'np-5hh4a31emkt6u****',
- ],
- 'MetricModelList' => [
- 'description' => '指标监控结果列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '指标监控结果。',
- 'type' => 'object',
- 'properties' => [
- 'MetricName' => [
- 'description' => '监控项名称。',
- 'type' => 'string',
- 'example' => 'instance_in_traffic',
- ],
- 'DataPoints' => [
- 'description' => '监控统计数据点。',
- 'type' => 'array',
- 'items' => [
- 'description' => '监控统计数据点。',
- 'type' => 'object',
- 'properties' => [
- 'Timestamp' => [
- 'description' => '统计时间戳。单位:毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1548777660000',
- ],
- 'Minimum' => [
- 'description' => '最小值。'."\n"
- .'> 监控项为instance_in_traffic和instance_out_traffic时单位是bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '93.1',
- ],
- 'Average' => [
- 'description' => '平均值。单位:%。'."\n"
- .'> 监控项为instance_in_traffic和instance_out_traffic时单位是bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '99.52',
- ],
- 'Maximum' => [
- 'description' => '最大值。单位:%。'."\n"
- .'> 监控项为instance_in_traffic和instance_out_traffic时单位是bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'Name' => [
- 'description' => '名称。',
- 'type' => 'string',
- 'example' => 'cloudPhone-****',
- ],
- 'Id' => [
- 'description' => 'ID信息。',
- 'type' => 'string',
- 'example' => 'acp-fkuit0cmyru4p****'."\n",
- ],
- 'Properties' => [
- 'description' => '属性信息。'."\n"
- .'> 返回扩展属性信息字符串(Json格式) 。',
- 'type' => 'string',
- 'example' => '{"IP":"192.168.*.***"}',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'AndroidInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'acp-34pqe4r0kd9kn****'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 't-4ks224ujixw****'],
],
],
+ 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'."\n",
],
+ 'RequestId' => ['description' => '请求唯一ID,如果遇到问题请提供这个请求ID,由工作人员为您排查。', 'type' => 'string', 'example' => '425F351C-3F8E-5218-A520-B6311D0D****'],
+ 'TaskId' => ['description' => '批量任务ID。', 'type' => 'string', 'example' => 't-ehs0yoedj0xe9****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '文件上传到云手机',
+ 'summary' => '将OSS文件或者公网下载链接的文件推送到云手机。',
+ 'description' => '目前仅支持将OSS对象存储服务的文件或者文件夹发送到云手机。',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-01T03:15:43.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-14T09:49:56.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-21T09:43:23.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-17T05:04:23.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-09-13T09:20:16.000Z', 'description' => '响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4610632D-D661-5982-B3D7-5D3FD183F****\\",\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****\\",\\n \\"MetricTotalModel\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-fkuit0cmyru4p****\\",\\n \\"InstanceId\\": \\"np-5hh4a31emkt6u****\\",\\n \\"MetricModelList\\": [\\n {\\n \\"MetricName\\": \\"instance_in_traffic\\",\\n \\"DataPoints\\": [\\n {\\n \\"Timestamp\\": 1548777660000,\\n \\"Minimum\\": 93.1,\\n \\"Average\\": 99.52,\\n \\"Maximum\\": 100,\\n \\"Name\\": \\"cloudPhone-****\\",\\n \\"Id\\": \\"acp-fkuit0cmyru4p****\\\\n\\",\\n \\"Properties\\": \\"{\\\\\\"IP\\\\\\":\\\\\\"192.168.*.***\\\\\\"}\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询排序后的最新监控数据',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AndroidInstanceId\\": \\"acp-34pqe4r0kd9kn****\\",\\n \\"TaskId\\": \\"t-4ks224ujixw****\\"\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"TaskId\\": \\"t-ehs0yoedj0xe9****\\"\\n}","type":"json"}]',
],
- 'TagResources' => [
- 'summary' => '给云手机打标签。',
+ 'SendSystemPropertyTemplate' => [
+ 'summary' => '发送属性模板。将下发到云手机并通过setprop命令设置到云手机android系统中,APK或相关程序可读取这些属性值。如果指定了多个模板ID,则随机组合属性模板和云手机实例。',
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneDADB6I',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVQDPK9'],
],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'TemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => '资源类型,取值固定为ALIYUN::ACP::INSTANCE。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ALIYUN::ACP::INSTANCE',
- ],
+ 'schema' => ['description' => '属性模板ID。', 'type' => 'string', 'required' => false, 'example' => 'ap-angyvganxlf****'],
],
[
- 'name' => 'ResourceId',
- 'in' => 'query',
+ 'name' => 'AndroidInstanceIds',
+ 'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => '资源 ID 列表,即云手机 ID 列表。可包含 1~50 个。',
+ 'description' => '实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '资源ID,即云手机ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-123456ab****',
- ],
- 'required' => true,
- 'maxItems' => 50,
- 'minItems' => 1,
+ 'items' => ['description' => '实例ID列表。', 'type' => 'string', 'required' => false, 'example' => 'cpn-25nt4kk9whhok****'],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
[
- 'name' => 'Tag',
+ 'name' => 'TemplateIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '标签列表。可包含 1~20 个。',
+ 'description' => '属性模板ID列表。如果传入多个模板,则将给定的实例随机匹配所有给定属性模板。',
'type' => 'array',
- 'items' => [
- 'description' => '标签列表。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以aliyun和acs:开头,不能包含http://或者https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'department',
- 'maxLength' => 128,
- ],
- 'Value' => [
- 'description' => '标签值。可以为空字符串。最多支持 128 个字符,不能以acs:开头,不能包含http://或者https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'design ',
- 'maxLength' => 256,
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'maxItems' => 20,
- 'minItems' => 1,
+ 'items' => ['description' => '属性模板ID。', 'type' => 'string', 'required' => false, 'example' => 'ap-0caoenwutkkxb0****'],
+ 'required' => false,
+ 'maxItems' => 100,
],
],
],
@@ -14441,29 +10956,27 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F07A1DA1-E1EB-5CCA-8EED-12F85D32****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC******'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC******\\"\\n}","type":"json"}]',
+ 'title' => '下发系统属性模板',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F07A1DA1-E1EB-5CCA-8EED-12F85D32****\\"\\n}","type":"json"}]',
- 'title' => '为云手机添加标签',
],
- 'UntagResources' => [
- 'summary' => '为云手机移除标签。移除标签后,如果该标签没有被添加到任何云手机上,则标签会被自动删除。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SetAdbSecure' => [
+ 'summary' => '设置实例的ADB鉴权状态。'."\n"
+ ."\n"
+ .'如果设置ADB鉴权状态为开启,通过ADB去连接云手机实例时,云手机实例会校验ADB密钥对的合法性;此时建议您绑定ADB密钥对后,再通过ADB连接云手机实例。'."\n"
+ ."\n"
+ .'如果设置ADB鉴权状态为关闭,通过ADB去连接云手机实例时,云手机实例不会校验ADB密钥对的合法性,即只要网络是通的,就能通过ADB连接上云手机实例。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -14475,68 +10988,121 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneDADB6I',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneDADB6I'],
],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '资源类型。'."\n"
- ."\n"
- .'枚举值:'."\n"
- .'ALIYUN::ACP::INSTANCE:云手机。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ALIYUN::ACP::INSTANCE',
+ 'description' => '云手机实例ID列表,最多支持50个实例。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh431emkt6ua****'],
+ 'required' => false,
+ 'maxItems' => 50,
],
],
[
- 'name' => 'All',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => '是否解绑资源上的所有标签。仅当未设置 TagKey.N 时,该参数生效。默认为 false。',
- 'type' => 'boolean',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'true',
+ 'title' => '安全模式',
+ 'description' => 'ADB鉴权开关状态。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'enumValueTitles' => ['ADB鉴权关闭', 'ADB鉴权开启'],
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'PlainResult<SetAdbSecureResult>',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => '返回结果对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => '尝试设置的总实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'FailCount' => ['description' => '设置失败的实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'InstanceIds' => [
+ 'description' => '设置成功的云手机实例ID列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '实例ID。',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'acp-5hh431emkt6ua****',
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => ['description' => '接口请求ID。', 'type' => 'string', 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****'],
+ ],
],
],
+ ],
+ 'title' => '设置ADB鉴权开关',
+ 'description' => '只有实例处于运行中(Running)状态,设置ADB鉴权开关才能生效。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 100,\\n \\"FailCount\\": 0,\\n \\"InstanceIds\\": [\\n \\"acp-5hh431emkt6ua****\\"\\n ]\\n },\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
+ ],
+ 'SetNetworkBlacklist' => [
+ 'summary' => '用于增加或清除IP地址和域名的网络访问黑名单。',
+ 'path' => '/instances/{instanceId}',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ResourceId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneLYX9LP'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'IpBlacklist',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '资源 ID 列表,即云手机 ID 列表。可包含 1~50 个。',
+ 'description' => 'IP地址黑名单列表。'."\n"
+ .'> 最多支持200个IP地址或IP段。',
'type' => 'array',
- 'items' => [
- 'description' => '资源 ID,即云手机ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-123456ab****',
- ],
- 'required' => true,
- 'maxItems' => 50,
+ 'items' => ['description' => '单个IP地址或IP段。'."\n"
+ .'> 若传入空字符"",则会清除所有已配置的 IP 黑名单条目。', 'type' => 'string', 'required' => false, 'example' => '12.34.56.78', 'maxLength' => 20, 'minLength' => 1],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
[
- 'name' => 'TagKey',
+ 'name' => 'DomainBlacklist',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '标签键。可包含 1~20 个。',
+ 'description' => '域名黑名单列表。'."\n"
+ ."\n"
+ .'> 最多支持 200 个域名。',
'type' => 'array',
- 'items' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'department',
- ],
+ 'items' => ['description' => '域名。'."\n"
+ .'> 单个域名最大支持100个字符。'."\n"
+ .'> - 若传入空字符"",则会清除所有已配置的域名黑名单条目。', 'type' => 'string', 'required' => false, 'example' => 'malicious.com', 'maxLength' => 100, 'minLength' => 1],
'required' => false,
- 'maxItems' => 20,
+ 'maxItems' => 200,
],
],
],
@@ -14544,33 +11110,31 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '接口返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2B9E6946-0E2A-5D2B-B275-361DF81F****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '设置网络访问黑名单',
+ 'description' => '- 需使用镜像版本 26.01 及更高版本。'."\n"
+ .'- 该接口支持同步更新IP地址黑名单与域名黑名单。'."\n"
+ .'- IP地址黑名单支持单个IP及IP段,采用覆盖式更新方式;若传入空字符"",则会清除所有已配置的IP黑名单条目。'."\n"
+ .'- 域名黑名单仅支持精准匹配,不支持正则表达式;若传入空字符"",则将清除所有已配置的域名黑名单条目。'."\n"
+ .'- 配置更改后需要重启云手机以使新的黑名单规则生效,特别是当使用代理时,请注意这些规则可能不会生效。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\"\\n}","type":"json"}]',
- 'title' => '为云手机移除标签',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B9E6946-0E2A-5D2B-B275-361DF81F****\\"\\n}","type":"json"}]',
],
- 'ListTagResources' => [
- 'summary' => '查询云手机已添加的标签的列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'StartAndroidInstance' => [
+ 'summary' => '启动(开机)云手机实例。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -14579,109 +11143,159 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneDADB6I',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphone5C0MVL'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'AndroidInstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '地域ID。'."\n"
- .'<props="china">该参数的值固定传入`cn-shanghai`。</props>'."\n"
- .'<props="intl">该参数的值固定传入`ap-southeast-1`。</props>',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai / ap-southeast-1',
+ 'description' => '实例列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-hk34lbnw0qhi7****'],
+ 'required' => false,
+ 'maxItems' => 1000,
],
],
[
- 'name' => 'ResourceType',
+ 'name' => 'SaleMode',
'in' => 'query',
'schema' => [
- 'description' => '资源类型。',
+ 'description' => '售卖模式。该参数已废弃!',
'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'enumValueTitles' => [
- 'ALIYUN::ACP::INSTANCE' => '云手机',
+ 'required' => false,
+ 'enumValueTitles' => ['Instance' => '云手机实例模式', 'Node' => '云手机矩阵模式'],
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Node'],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '17C731AB-AAEE-5844-A352-D8D0352D****'],
],
- 'example' => 'ALIYUN::ACP::INSTANCE',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '启动实例',
+ 'description' => '只有实例处于 **已关机、备份失败、恢复失败** 状态时才支持启动。',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-07T03:35:38.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17C731AB-AAEE-5844-A352-D8D0352D****\\"\\n}","type":"json"}]',
+ ],
+ 'StartInstanceAdb' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'MaxResults',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneLYX9LP'],
+ 'autoTest' => true,
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '分页查询时每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '10',
+ 'description' => '云手机实例ID列表,可设置 1~100 个。',
+ 'type' => 'array',
+ 'items' => ['description' => '云手机实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh431emkt6u*****'],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '用来标记当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****',
+ 'title' => 'PlainResult<Integer>',
+ 'description' => '接口返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '开启实例ADB连接功能',
+ 'summary' => '开启实例ADB连接功能,为实例创建ADB端口公网映射规则(仅限标准网络)。',
+ 'description' => '只有实例处于 **非异常**(**UNAVAILABLE**)状态,且成功分配**私网IP**时才支持启动。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
+ ],
+ 'StopAndroidInstance' => [
+ 'summary' => '停止(关机)云手机实例。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ResourceId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneRXVHCU'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AndroidInstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '资源 ID 列表,即云手机ID 列表。可包含 1~50 个。',
+ 'description' => '实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '资源 ID,即云手机ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-123456abc****',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-3kzpiqqsjwtw7****'],
'required' => false,
- 'maxItems' => 50,
+ 'maxItems' => 1000,
],
],
[
- 'name' => 'Tag',
+ 'name' => 'ForceStop',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否强制关机。当云手机遇到系统、网络等异常原因导致无法关机时,可选择强制关机(可能会丢失未保存数据)。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'SaleMode',
'in' => 'query',
- 'style' => 'repeatList',
'schema' => [
- 'description' => '标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。可包含 1~20 个。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'department',
- ],
- 'Value' => [
- 'description' => '标签值。可包含 1~20 个。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'design',
- ],
- ],
- 'required' => false,
- ],
+ 'description' => '售卖模式。该参数已废弃!',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 20,
+ 'enumValueTitles' => ['Instance' => '云手机实例模式', 'Node' => '云手机矩阵模式'],
+ 'example' => 'Instance',
+ 'enum' => ['Instance', 'Node'],
],
],
],
@@ -14689,103 +11303,55 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'description' => '用来表示当前开始读取的位置。置空表示从头开始。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20393E53-8FF1-524C-B494-B478A5369733',
- ],
- 'TagResources' => [
- 'description' => '资源及其标签信息集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '查询到的实例和标签详情。',
- 'type' => 'object',
- 'properties' => [
- 'TagValue' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'TF',
- ],
- 'ResourceType' => [
- 'description' => '资源类型。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'ALIYUN::ACP::INSTANCE' => '云手机',
- ],
- 'example' => 'ALIYUN::ACP::INSTANCE',
- ],
- 'ResourceId' => [
- 'description' => '资源 ID,即云手机ID。',
- 'type' => 'string',
- 'example' => 'acp-8jwttemxb4t6y****',
- ],
- 'TagKey' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'department',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E38B41A8-8E00-5AE4-A957-6636ACB8****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****\\",\\n \\"RequestId\\": \\"20393E53-8FF1-524C-B494-B478A5369733\\",\\n \\"TagResources\\": [\\n {\\n \\"TagValue\\": \\"TF\\",\\n \\"ResourceType\\": \\"ALIYUN::ACP::INSTANCE\\",\\n \\"ResourceId\\": \\"acp-8jwttemxb4t6y****\\",\\n \\"TagKey\\": \\"department\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询云手机已添加标签的列表',
- 'description' => '请求中至少指定一个参数:`ResourceId.N`、`Tag.N.Key`或者`Tag.N.Value`,以确定查询对象。',
- ],
- 'DescribeBuckets' => [
- 'summary' => '查询bucket信息,仅查询bucket名称以「cloudphone-saved-bucket-」打头的bucket list',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '停止实例',
+ 'description' => '只有实例处于**可用、备份失败、恢复失败**状态时才支持停止。',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-07T03:35:38.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-07-02T02:05:34.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E38B41A8-8E00-5AE4-A957-6636ACB8****\\"\\n}","type":"json"}]',
+ ],
+ 'StopInstanceAdb' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneMPR6T6',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneLYX9LP'],
+ 'autoTest' => true,
],
'parameters' => [
[
- 'name' => 'FileType',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'OSS文件类型。'."\n"
- ."\n"
- .'> 该参数暂未开放',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'docx',
- 'enum' => [
- 'FILE',
- 'DIR',
- ],
+ 'description' => '云手机实例ID列表,可设置 1~100 个。',
+ 'type' => 'array',
+ 'items' => ['description' => '云手机实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-5hh4a31emkt6u****'],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
],
@@ -14793,184 +11359,27 @@
200 => [
'schema' => [
'title' => 'PlainResult<Integer>',
- 'description' => 'PlainResult<Integer>',
+ 'description' => '接口返回数据。',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'GmtCreated' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-05-15 17:33:59',
- ],
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'BucketName' => [
- 'description' => '存储空间名称。',
- 'type' => 'string',
- 'example' => 'zydctest',
- ],
- 'ExtranetEndpoint' => [
- 'description' => 'Bucket访问的外网域名。',
- 'type' => 'string',
- 'example' => 'oss-cn-hangzhou.aliyuncs.com',
- ],
- 'IntranetEndpoint' => [
- 'description' => '同地域ECS访问Bucket的内网域名。',
- 'type' => 'string',
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'."\n"
- ."\n",
- ],
- 'Location' => [
- 'description' => 'HDFS或OSS等存放路径。',
- 'type' => 'string',
- 'example' => 'center',
- ],
- 'OssObjectList' => [
- 'description' => '存储空间(Bucket)中的文件(Object)的信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '存储空间(Bucket)中的文件(Object)的信息',
- 'type' => 'object',
- 'properties' => [
- 'BucketName' => [
- 'description' => 'Bucket名称。',
- 'type' => 'string',
- 'example' => 'tf-testacceu-central-1ensbucketlifecycle44222',
- ],
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'con',
- ],
- 'ETag' => [
- 'description' => 'ETag (Entity Tag) 在每个Object生成时创建,用于标识一个Object的内容。'."\n"
- ."\n"
- .'- 对于PutObject请求创建的Object,ETag值是其内容的MD5值。'."\n"
- ."\n"
- .'- 对于其他方式创建的Object,ETag值是基于一定计算规则生成的唯一值,但不是其内容的MD5值。'."\n"
- ."\n"
- .'- ETag值可以用于检查Object内容是否发生变化。不建议使用ETag值作为Object内容的MD5校验数据完整性的依据。',
- 'type' => 'string',
- 'example' => '5B3C1A2E053D763E1B002CC607C5A0FE1****'."\n"
- ."\n",
- ],
- 'Size' => [
- 'description' => '文件大小,单位:KB。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9',
- ],
- 'LastModified' => [
- 'description' => 'Object最后被修改的时间。',
- 'type' => 'string',
- 'example' => '2012-02-24T08:42:32.000Z',
- ],
- 'StorageClass' => [
- 'description' => 'Bucket的存储类型。 取值范围如下:'."\n"
- ."\n"
- .'- Standard(默认):标准存储'."\n"
- .'- IA:低频访问'."\n"
- .'- Archive:归档存储'."\n"
- .'- ColdArchive:冷归档存储'."\n"
- .'- DeepColdArchive:深度冷归档存储',
- 'type' => 'string',
- 'example' => 'ARCHIVE',
- ],
- 'Owner' => [
- 'description' => 'Bucket拥有者信息',
- 'type' => 'object',
- 'properties' => [
- 'DisplayName' => [
- 'description' => 'Bucket拥有者的名称 。',
- 'type' => 'string',
- 'example' => '佳钰',
- ],
- 'Id' => [
- 'description' => 'Bucket拥有者的唯一标识符。',
- 'type' => 'string',
- 'example' => '395',
- ],
- ],
- ],
- 'Type' => [
- 'description' => '触发方式类型。',
- 'type' => 'string',
- 'example' => 'InstanceGroup',
- ],
- 'RestoreInfo' => [
- 'description' => '恢复数据库类型为MSSQL时,数据库恢复信息。格式为JSON字符串格式,取值:'."\n"
- .'- **name**:数据库名称'."\n"
- .'- **files**:数据库文件路径',
- 'type' => 'string',
- 'example' => 'ongoing-request="true"',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
- ],
- 'Success' => [
- 'description' => '请求结果。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'description' => '错误码。'."\n"
- ."\n"
- .'> 仅当接口调用出错时会出现该参数。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'Success.',
- ],
- 'HttpStatusCode' => [
- 'description' => '请求返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC******'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '关闭实例ADB连接',
+ 'summary' => '关闭实例ADB连接功能,删除实例ADB端口转发规则(仅限标准网络)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreated\\": \\"2024-05-15 17:33:59\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"BucketName\\": \\"zydctest\\",\\n \\"ExtranetEndpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"IntranetEndpoint\\": \\"oss-cn-hangzhou-internal.aliyuncs.com\\\\n\\\\n\\",\\n \\"Location\\": \\"center\\",\\n \\"OssObjectList\\": [\\n {\\n \\"BucketName\\": \\"tf-testacceu-central-1ensbucketlifecycle44222\\",\\n \\"Key\\": \\"con\\",\\n \\"ETag\\": \\"5B3C1A2E053D763E1B002CC607C5A0FE1****\\\\n\\\\n\\",\\n \\"Size\\": 9,\\n \\"LastModified\\": \\"2012-02-24T08:42:32.000Z\\",\\n \\"StorageClass\\": \\"ARCHIVE\\",\\n \\"Owner\\": {\\n \\"DisplayName\\": \\"佳钰\\",\\n \\"Id\\": \\"395\\"\\n },\\n \\"Type\\": \\"InstanceGroup\\",\\n \\"RestoreInfo\\": \\"ongoing-request=\\\\\\"true\\\\\\"\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '查询可用于备份的oss Bucket信息',
- 'description' => '目前仅支持云手机生成的备份文件保存在OSS对象存储服务。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC******\\"\\n}","type":"json"}]',
],
- 'SetAdbSecure' => [
- 'summary' => '设置实例的ADB鉴权状态。'."\n"
- ."\n"
- .'如果设置ADB鉴权状态为开启,通过ADB去连接云手机实例时,云手机实例会校验ADB密钥对的合法性;此时建议您绑定ADB密钥对后,再通过ADB连接云手机实例。'."\n"
- ."\n"
- .'如果设置ADB鉴权状态为关闭,通过ADB去连接云手机实例时,云手机实例不会校验ADB密钥对的合法性,即只要网络是通的,就能通过ADB连接上云手机实例。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'TagResources' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -14982,184 +11391,126 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneDADB6I',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneDADB6I'],
],
'parameters' => [
[
- 'name' => 'InstanceIds',
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => ['description' => '资源类型,取值固定为ALIYUN::ACP::INSTANCE。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ALIYUN::ACP::INSTANCE'],
+ ],
+ [
+ 'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云手机实例ID列表,最多支持50个实例。',
+ 'description' => '资源 ID 列表,即云手机 ID 列表。可包含 1~50 个。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acp-5hh431emkt6ua****',
- ],
- 'required' => false,
+ 'items' => ['description' => '资源ID,即云手机ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-123456ab****'],
+ 'required' => true,
'maxItems' => 50,
+ 'minItems' => 1,
],
],
[
- 'name' => 'Status',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '安全模式',
- 'description' => 'ADB鉴权开关状态。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'enumValueTitles' => [
- 'ADB鉴权关闭',
- 'ADB鉴权开启',
+ 'description' => '标签列表。可包含 1~20 个。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以aliyun和acs:开头,不能包含http://或者https://。', 'type' => 'string', 'required' => false, 'example' => 'department', 'maxLength' => 128],
+ 'Value' => ['description' => '标签值。可以为空字符串。最多支持 128 个字符,不能以acs:开头,不能包含http://或者https://。', 'type' => 'string', 'required' => false, 'example' => 'design ', 'maxLength' => 256],
+ ],
+ 'required' => false,
],
- 'example' => '1',
+ 'required' => true,
+ 'maxItems' => 20,
+ 'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<SetAdbSecureResult>',
- 'description' => '返回参数。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '返回结果对象。',
- 'type' => 'object',
- 'properties' => [
- 'TotalCount' => [
- 'description' => '尝试设置的总实例数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'FailCount' => [
- 'description' => '设置失败的实例数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'InstanceIds' => [
- 'description' => '设置成功的云手机实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'acp-5hh431emkt6ua****',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '接口请求ID。',
- 'type' => 'string',
- 'example' => '69BCBBE4-FCF2-59B8-AD9D-531EB422****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F07A1DA1-E1EB-5CCA-8EED-12F85D32****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 100,\\n \\"FailCount\\": 0,\\n \\"InstanceIds\\": [\\n \\"acp-5hh431emkt6ua****\\"\\n ]\\n },\\n \\"RequestId\\": \\"69BCBBE4-FCF2-59B8-AD9D-531EB422****\\"\\n}","type":"json"}]',
- 'title' => '设置ADB鉴权开关',
- 'description' => '只有实例处于运行中(Running)状态,设置ADB鉴权开关才能生效。',
- ],
- 'ModifyDisplayConfig' => [
- 'summary' => '修改显示设置。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '为云手机添加标签',
+ 'summary' => '给云手机打标签。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F07A1DA1-E1EB-5CCA-8EED-12F85D32****\\"\\n}","type":"json"}]',
+ ],
+ 'UninstallApp' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVB2A7J',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphonePZ72CH'],
],
'parameters' => [
[
- 'name' => 'AndroidInstanceIds',
- 'in' => 'formData',
+ 'name' => 'AppIdList',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID列表。',
+ 'description' => '应用ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-9y1nwysxr9d6lk2xq-****',
- ],
+ 'items' => ['description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => '12345'],
'required' => false,
'maxItems' => 100,
+ 'minItems' => 1,
],
],
[
- 'name' => 'DisplayConfig',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'InstanceGroupIdList',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '显示设置。',
- 'type' => 'object',
- 'properties' => [
- 'ResolutionHeight' => [
- 'description' => '分辨率的高度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1920',
- ],
- 'ResolutionWidth' => [
- 'description' => '分辨率的宽度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '720',
- ],
- 'Dpi' => [
- 'description' => 'DPI。取值范围:72~600。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '240',
- ],
- 'Fps' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => 'null',
- ],
- 'LockResolution' => [
- 'description' => '是否锁定分辨率。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
- ],
- ],
+ 'description' => '实例组ID列表。'."\n"
+ .'该参数与InstanceIdList参数选填一个。如果两者同时有值,则仅InstanceGroupIdList有效。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-ferag1vraw****'],
'required' => false,
+ 'maxItems' => 100,
+ 'minItems' => 0,
+ ],
+ ],
+ [
+ 'name' => 'InstanceIdList',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '实例ID列表。'."\n"
+ .'该参数与InstanceGroupIdList参数选填一个。如果两者同时有值,则仅InstanceGroupIdList有效。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-3eourrxapshn2****'],
+ 'required' => false,
+ 'maxItems' => 1000,
+ 'minItems' => 0,
],
],
],
@@ -15167,49 +11518,59 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '请求信息。',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A578AD3A-8E7C-54FE-A09F-B060941*****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E5138F7E-46B5-526A-8C99-82DEAE6B****'],
+ 'TaskId' => ['title' => '父任务ID', 'description' => '任务ID。', 'type' => 'string', 'example' => 't-1ljew7on6ay0j****'],
+ 'ChildTaskInfo' => [
+ 'title' => '子任务信息。',
+ 'description' => '子任务信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '子任务对象。',
+ 'description' => '子任务对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'example' => 'acp-ty3bnd7b9xxxx'],
+ 'ChildTaskId' => ['title' => '子任务ID。', 'description' => '子任务ID。', 'type' => 'string', 'example' => 't-ybde48cevxxxx'],
+ 'AppId' => ['type' => 'string'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A578AD3A-8E7C-54FE-A09F-B060941*****\\"\\n}","type":"json"}]',
- 'title' => '修改显示设置',
- ],
- 'DescribeDisplayConfig' => [
- 'summary' => '查询显示设置。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '卸载应用',
+ 'summary' => '批量从无影云手机实例中卸载应用。',
+ 'description' => '此接口为异步接口,操作结果可以在任务中心查看。查询任务接口为[DescribeTasks](~~DescribeTasks~~)。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-22T13:03:48.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-17T03:35:22.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5138F7E-46B5-526A-8C99-82DEAE6B****\\",\\n \\"TaskId\\": \\"t-1ljew7on6ay0j****\\",\\n \\"ChildTaskInfo\\": [\\n {\\n \\"InstanceId\\": \\"acp-ty3bnd7b9xxxx\\",\\n \\"ChildTaskId\\": \\"t-ybde48cevxxxx\\",\\n \\"AppId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'UninstallMonitorAgent' => [
+ 'summary' => '卸载监控插件。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneVB2A7J',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudphoneVQDPK9'],
],
'parameters' => [
[
@@ -15219,14 +11580,20 @@
'schema' => [
'description' => '实例ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cpn-jewjt8xryuituz4qn-****',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-9y1nwysxr9d6l****-016'],
'required' => false,
- 'maxItems' => 100,
+ 'maxItems' => 1000,
+ ],
+ ],
+ [
+ 'name' => 'SaleMode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '监控类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['Instance' => '实例模式', 'Node' => '节点模式'],
+ 'example' => 'Node',
],
],
],
@@ -15234,83 +11601,25 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '请求信息。',
+ 'description' => '响应体。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'FFEF7EFE-1E36-56D1-B5BF-5BACE43B****',
- ],
- 'DisplayConfigModel' => [
- 'description' => '显示设置列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '显示设置。',
- 'type' => 'object',
- 'properties' => [
- 'AndroidInstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'cpn-jewjt8xryuituz4qn-****',
- ],
- 'ResolutionHeight' => [
- 'description' => '分辨率的高度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1280',
- ],
- 'ResolutionWidth' => [
- 'description' => '分辨率的宽度。单位:像素。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '720',
- ],
- 'Dpi' => [
- 'description' => 'DPI。取值范围:72~600。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '240',
- ],
- 'Fps' => [
- 'description' => '> 该参数暂未对外开放使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'null',
- ],
- 'LockResolution' => [
- 'description' => '是否锁定分辨率。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'off' => '关闭',
- 'on' => '开启',
- ],
- 'example' => 'off',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6C8439B9-7DBF-57F4-92AE-55A9B9D3****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '卸载监控插件',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FFEF7EFE-1E36-56D1-B5BF-5BACE43B****\\",\\n \\"DisplayConfigModel\\": [\\n {\\n \\"AndroidInstanceId\\": \\"cpn-jewjt8xryuituz4qn-****\\",\\n \\"ResolutionHeight\\": 1280,\\n \\"ResolutionWidth\\": 720,\\n \\"Dpi\\": 240,\\n \\"Fps\\": 0,\\n \\"LockResolution\\": \\"off\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询显示设置',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C8439B9-7DBF-57F4-92AE-55A9B9D3****\\"\\n}","type":"json"}]',
],
- 'ImportImage' => [
- 'summary' => '导入自定义镜像。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UntagResources' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -15319,43 +11628,47 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneLJI39N',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneDADB6I'],
],
'parameters' => [
[
- 'name' => 'ImageFileURL',
+ 'name' => 'ResourceType',
'in' => 'query',
- 'schema' => [
- 'description' => '镜像url地址(必须是阿里云oss地址)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://xxx.oss-xxx/xxxx.tgz',
- ],
+ 'schema' => ['description' => '资源类型。'."\n"
+ ."\n"
+ .'枚举值:'."\n"
+ .'ALIYUN::ACP::INSTANCE:云手机。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ALIYUN::ACP::INSTANCE'],
],
[
- 'name' => 'ImageName',
+ 'name' => 'All',
'in' => 'query',
+ 'schema' => ['description' => '是否解绑资源上的所有标签。仅当未设置 TagKey.N 时,该参数生效。默认为 false。', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '镜像的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'import custom image',
+ 'description' => '资源 ID 列表,即云手机 ID 列表。可包含 1~50 个。',
+ 'type' => 'array',
+ 'items' => ['description' => '资源 ID,即云手机ID。', 'type' => 'string', 'required' => false, 'example' => 'acp-123456ab****'],
+ 'required' => true,
+ 'maxItems' => 50,
],
],
[
- 'name' => 'ImageDescription',
+ 'name' => 'TagKey',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '镜像描述。',
- 'type' => 'string',
+ 'description' => '标签键。可包含 1~20 个。',
+ 'type' => 'array',
+ 'items' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'department'],
'required' => false,
- 'example' => 'android 12 custom image',
+ 'maxItems' => 20,
],
],
],
@@ -15366,235 +11679,512 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '425F351C-3F8E-5218-A520-B6311D0D****',
- ],
- 'ImageId' => [
- 'title' => 'ImageId',
- 'description' => 'ImageId',
- 'type' => 'string',
- 'example' => 'imgc-06zyt9m93zwax****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '为云手机移除标签',
+ 'summary' => '为云手机移除标签。移除标签后,如果该标签没有被添加到任何云手机上,则标签会被自动删除。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"425F351C-3F8E-5218-A520-B6311D0D****\\",\\n \\"ImageId\\": \\"imgc-06zyt9m93zwax****\\"\\n}","type":"json"}]',
- 'title' => '导入自定义镜像。',
- 'description' => '1. 导入自定义镜像适用于用户有定制化功能或服务开发的场景。'."\n"
- ."\n"
- .'2. 用户需要先从平台获取所需要的 AOSP 镜像基线,进行自定义构建,并将构建完成的镜像导入平台进行使用。详细操作步骤可联系无影技术支持。'."\n"
- ."\n"
- .'3. 请保证镜像tar包小于2GB,否则可能导致镜像解析失败。'."\n"
- ."\n"
- .'4. 请保证您的 OSS 地址为内地地址,海外或香港地区可能导致镜像文件下载超时。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\"\\n}","type":"json"}]',
],
- 'GetNetworkBlacklist' => [
- 'summary' => '查询IP或域名网络访问黑名单信息。',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ 'UpdateCustomImageName' => [
+ 'summary' => '更新自定义镜像名称。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneCPBVX1'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ImageId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'imgc-075cllfeuazh0****'],
+ ],
+ [
+ 'name' => 'ImageName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '镜像名称。', 'type' => 'string', 'required' => false, 'example' => 'imagename', 'maxLength' => 30],
+ ],
],
- 'schemes' => [
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'PlainResult<Integer>',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '552B7EED-D434-511F-B838-29EA4E906034'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新自定义镜像名称',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-28T04:34:39.000Z', 'description' => '请求参数发生变更'],
],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"552B7EED-D434-511F-B838-29EA4E906034\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateInstanceGroupImage' => [
+ 'summary' => '变更实例组镜像。会作用于该实例组下的所有实例。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
+ 'operationType' => 'update',
+ 'riskType' => 'high',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphone89PVC7',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneE7UBTJ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceGroupIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '实例组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-3kzpiqqsjwpy9****'],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => true, 'example' => 'imgc-075cllfeuazh****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'PlainResult<Integer>',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '55726272-E40B-530D-914F-5126B19C79B3'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '变更实例组镜像',
+ 'description' => '镜像的状态为可用且可用地域中包含实例组的地域,实例组状态为可用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"55726272-E40B-530D-914F-5126B19C79B3\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateInstanceImage' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
],
- 'tenantRelevance' => 'publicInformation',
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREcloudphone3OZQF8'],
],
'parameters' => [
[
- 'name' => 'Type',
+ 'name' => 'InstanceIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '用于指定查询类型(IP 或 Domain),若不填写则默认返回所有类型的黑名单信息。',
- 'type' => 'string',
+ 'description' => '实例列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '实例ID列表。', 'type' => 'string', 'required' => false, 'example' => 'acp-dvbhknfasf123****'],
'required' => false,
- 'example' => 'IP',
- 'enum' => [
- 'Domain',
- 'IP',
- ],
+ 'maxItems' => 100,
],
],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => ['description' => '镜像ID。可以通过调用[DescribeImageList](~~2807324~~)查询云手机的镜像列表。', 'type' => 'string', 'required' => false, 'example' => 'imgc-075cllfeuazh0****'],
+ ],
+ [
+ 'name' => 'Reset',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否重置。重置将清除该实例上的所有用户数据。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'IgnoreParamValidation',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '接口返回数据。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => 'A578AD3A-8E7C-54FE-A09F-B060941*****',
- ],
- 'NetworkBlacklistModel' => [
- 'description' => '网络黑名单',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1A923337-44D9-5CAD-9A53-95084BD4****'],
+ 'Tasks' => [
'type' => 'object',
'properties' => [
- 'IpBlacklist' => [
- 'description' => 'IP地址黑名单列表',
+ 'ParentTaskId' => ['type' => 'string', 'example' => 't-xxxx'],
+ 'ChildTasks' => [
'type' => 'array',
'items' => [
- 'description' => 'IP地址或IP段',
- 'type' => 'string',
- 'example' => '12.34.56.78',
- ],
- ],
- 'DomainBlacklist' => [
- 'description' => '域名黑名单列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '域名',
- 'type' => 'string',
- 'example' => 'malicious.com',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['type' => 'string', 'example' => 'acp-xxxx'],
+ 'TaskId' => ['type' => 'string', 'example' => 't-xxxx'],
+ ],
],
],
],
],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 't-1ljew7on6ay0j****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A578AD3A-8E7C-54FE-A09F-B060941*****\\",\\n \\"NetworkBlacklistModel\\": {\\n \\"IpBlacklist\\": [\\n \\"12.34.56.78\\"\\n ],\\n \\"DomainBlacklist\\": [\\n \\"malicious.com\\"\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '查询网络访问黑名单',
- 'description' => '- 需使用镜像版本 26.01 及更高版本'."\n"
- .'- 通过此接口,用户可以查询其账户下设置的网络访问黑名单,包括IP地址和域名。',
- ],
- 'SetNetworkBlacklist' => [
- 'summary' => '用于增加或清除IP地址和域名的网络访问黑名单。',
- 'path' => '/instances/{instanceId}',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '变更实例镜像',
+ 'summary' => '变更云手机矩阵实例镜像。仅支持对运行中、关机、镜像变更失败这三种状态的实例进行镜像变更。目标镜像的GPU厂商必须与当前实例所在的服务器GPU厂商匹配。如果是跨版本变更镜像,例如从Android 10升级到Android 12,则系统将强制清空所有数据(等同于变更镜像+重置)。',
+ 'description' => '<props="china">目前只可变更云手机矩阵实例镜像,其他类型实例暂不支持。</props>'."\n"
+ .'<props="intl">暂不支持国际站。</props>',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-22T08:01:59.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A923337-44D9-5CAD-9A53-95084BD4****\\",\\n \\"Tasks\\": {\\n \\"ParentTaskId\\": \\"t-xxxx\\",\\n \\"ChildTasks\\": [\\n {\\n \\"InstanceId\\": \\"acp-xxxx\\",\\n \\"TaskId\\": \\"t-xxxx\\"\\n }\\n ]\\n },\\n \\"TaskId\\": \\"t-1ljew7on6ay0j****\\"\\n}","type":"json"}]',
+ ],
+ 'UpgradeAndroidInstanceGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREcloudphoneLYX9LP',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'operationType' => 'none',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREcloudphoneMGJBSL'],
],
'parameters' => [
[
- 'name' => 'IpBlacklist',
+ 'name' => 'InstanceGroupId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'IP地址黑名单列表。'."\n"
- .'> 最多支持200个IP地址或IP段。',
- 'type' => 'array',
- 'items' => [
- 'description' => '单个IP地址或IP段。'."\n"
- .'> 若传入空字符"",则会清除所有已配置的 IP 黑名单条目。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12.34.56.78',
- 'maxLength' => 20,
- 'minLength' => 1,
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-asguicdjh****'],
],
[
- 'name' => 'DomainBlacklist',
+ 'name' => 'IncreaseNumberOfInstance',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例组中需要增加的实例数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'AutoPay',
'in' => 'query',
- 'style' => 'repeatList',
'schema' => [
- 'description' => '域名黑名单列表。'."\n"
- ."\n"
- .'> 最多支持 200 个域名。',
- 'type' => 'array',
- 'items' => [
- 'description' => '域名。'."\n"
- .'> 单个域名最大支持100个字符。'."\n"
- .'> - 若传入空字符"",则会清除所有已配置的域名黑名单条目。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'malicious.com',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
+ 'description' => '是否自动支付。',
+ 'type' => 'boolean',
'required' => false,
- 'maxItems' => 200,
+ 'enumValueTitles' => ['true' => '自动付费,请确保账号有足够的余额', 'false' => '手动付费'],
+ 'example' => 'true',
],
],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'PaidCallBackUrl',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '接口返回数据。',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2B9E6946-0E2A-5D2B-B275-361DF81F****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '310A783E-CC46-5452-A8A3-71AE5DB59****'],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '223684716098****'],
+ 'InstanceIds' => ['description' => '扩容产生的实例ID。', 'type' => 'string', 'example' => '[\'acp-2iowaqjyw9nrd****\', \'acp-2iowaqjyw9nrd****\']'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '升级实例组',
+ 'summary' => '升级实例组。目前仅支持增加实例组中的实例数量,即实例组扩容。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-05T06:13:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-07-24T09:34:56.000Z', 'description' => '响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B9E6946-0E2A-5D2B-B275-361DF81F****\\"\\n}","type":"json"}]',
- 'title' => '设置网络访问黑名单',
- 'description' => '- 需使用镜像版本 26.01 及更高版本。'."\n"
- .'- 该接口支持同步更新IP地址黑名单与域名黑名单。'."\n"
- .'- IP地址黑名单支持单个IP及IP段,采用覆盖式更新方式;若传入空字符"",则会清除所有已配置的IP黑名单条目。'."\n"
- .'- 域名黑名单仅支持精准匹配,不支持正则表达式;若传入空字符"",则将清除所有已配置的域名黑名单条目。'."\n"
- .'- 配置更改后需要重启云手机以使新的黑名单规则生效,特别是当使用代理时,请注意这些规则可能不会生效。',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"310A783E-CC46-5452-A8A3-71AE5DB59****\\",\\n \\"OrderId\\": \\"223684716098****\\",\\n \\"InstanceIds\\": \\"[\'acp-2iowaqjyw9nrd****\', \'acp-2iowaqjyw9nrd****\']\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'eds-aic.ap-southeast-1.aliyuncs.com', 'endpoint' => 'eds-aic.ap-southeast-1.aliyuncs.com', 'vpc' => 'eds-aic-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'eds-aic.cn-shanghai.aliyuncs.com', 'endpoint' => 'eds-aic.cn-shanghai.aliyuncs.com', 'vpc' => 'eds-aic-vpc.cn-shanghai.aliyuncs.com'],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CheckResourceStock'],
+ ],
+ 'createdAt' => '2024-11-18T16:14:39.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateApp'],
+ ],
+ 'createdAt' => '2024-11-15T02:07:30.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
+ ['description' => '响应参数发生变更', 'api' => 'ListPolicyGroups'],
+ ['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
+ ],
+ 'createdAt' => '2024-11-15T01:35:18.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'BackupFile'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeBackupFiles'],
+ ['description' => '响应参数发生变更', 'api' => 'DescribeTasks'],
+ ],
+ 'createdAt' => '2024-11-14T11:00:04.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeRegions'],
+ ],
+ 'createdAt' => '2024-11-07T12:32:15.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'RunCommand'],
+ ],
+ 'createdAt' => '2024-11-04T01:39:31.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateAndroidInstanceGroup'],
+ ],
+ 'createdAt' => '2024-10-24T13:02:25.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'BackupFile'],
+ ['description' => '响应参数发生变更', 'api' => 'RecoveryFile'],
+ ],
+ 'createdAt' => '2024-10-16T09:06:15.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribeApps'],
+ ],
+ 'createdAt' => '2024-10-16T06:49:37.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeSpec'],
+ ],
+ 'createdAt' => '2024-09-26T12:10:33.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeAndroidInstances'],
+ ],
+ 'createdAt' => '2024-09-26T12:10:16.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
+ ['description' => '响应参数发生变更', 'api' => 'ListPolicyGroups'],
+ ['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
+ ],
+ 'createdAt' => '2024-09-26T11:33:14.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'RunCommand'],
+ ],
+ 'createdAt' => '2024-09-14T02:07:33.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'FetchFile'],
+ ['description' => '响应参数发生变更', 'api' => 'SendFile'],
+ ],
+ 'createdAt' => '2024-09-13T09:20:30.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CheckResourceStock'],
+ ],
+ 'createdAt' => '2024-09-05T14:17:20.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribeTasks'],
+ ],
+ 'createdAt' => '2024-08-21T08:15:16.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
+ ['description' => '响应参数发生变更', 'api' => 'ListPolicyGroups'],
+ ['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
+ ],
+ 'createdAt' => '2024-08-20T03:54:27.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateAndroidInstanceGroup'],
+ ['description' => '请求参数发生变更', 'api' => 'DescribeAndroidInstances'],
+ ],
+ 'createdAt' => '2024-08-19T09:50:14.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
+ ['description' => '响应参数发生变更', 'api' => 'ListPolicyGroups'],
+ ['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
+ ],
+ 'createdAt' => '2024-08-19T09:42:54.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateCustomImage'],
+ ],
+ 'createdAt' => '2024-08-19T09:36:31.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'eds-aic.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'InstallApp'],
+ ],
+ 'createdAt' => '2024-08-19T09:35:55.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'RecoveryFile'],
+ ],
+ 'createdAt' => '2024-08-12T07:40:03.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CheckResourceStock'],
+ ],
+ 'createdAt' => '2024-07-29T15:02:53.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'eds-aic.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribeImageList'],
+ ],
+ 'createdAt' => '2024-07-24T09:35:56.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateAndroidInstanceGroup'],
+ ['description' => '响应参数发生变更', 'api' => 'DescribeAndroidInstanceGroups'],
+ ['description' => '响应参数发生变更', 'api' => 'DescribeAndroidInstances'],
+ ['description' => '响应参数发生变更', 'api' => 'UpgradeAndroidInstanceGroup'],
+ ],
+ 'createdAt' => '2024-07-24T09:35:10.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateAndroidInstanceGroup'],
+ ['description' => '响应参数发生变更', 'api' => 'DescribeAndroidInstanceGroups'],
+ ['description' => '请求参数发生变更', 'api' => 'RebootAndroidInstancesInGroup'],
+ ['description' => '请求参数发生变更', 'api' => 'StopAndroidInstance'],
+ ],
+ 'createdAt' => '2024-07-02T02:05:46.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateApp'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeApps'],
+ ],
+ 'createdAt' => '2024-06-26T12:41:16.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
],
],
];