'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'appstream-center', 'version' => '2021-09-01', ], 'directories' => [ [ 'id' => 166315, 'title' => '地域', 'type' => 'directory', 'children' => [ 'ListRegions', ], ], [ 'id' => 166366, 'title' => '资源', 'type' => 'directory', 'children' => [ 'ListNodes', 'ModifyNodePoolAmount', 'ListNodeInstanceType', 'GetResourcePrice', 'GetResourceRenewPrice', ], ], [ 'id' => 286385, 'title' => '镜像', 'type' => 'directory', 'children' => [ 'ListImage', 'CreateImageByInstance', 'StartTaskForDistributeImage', 'DeleteImage', ], ], [ 'id' => 166320, 'title' => '交付组', 'type' => 'directory', 'children' => [ 'CreateAppInstanceGroup', 'GetAppInstanceGroup', 'ListAppInstanceGroup', 'PageListAppInstanceGroupUser', 'RenewAppInstanceGroup', 'UpdateAppInstanceGroupImage', 'ModifyAppInstanceGroupAttribute', 'ModifyNodePoolAttribute', 'AuthorizeInstanceGroup', 'LogOffAllSessionsInAppInstanceGroup', 'DeleteAppInstanceGroup', 'ModifyAppPolicy', 'ListAuthorizedUserGroups', ], ], [ 'id' => 182244, 'title' => '应用实例', 'type' => 'directory', 'children' => [ 'ListAppInstances', 'DeleteAppInstances', 'ListPersistentAppInstances', ], ], [ 'id' => 180891, 'title' => '连接', 'type' => 'directory', 'children' => [ 'GetConnectionTicket', 'Unbind', 'ListBindInfo', ], ], [ 'id' => 182247, 'title' => '调试', 'type' => 'directory', 'children' => [ 'CreateImageFromAppInstanceGroup', 'GetDebugAppInstance', ], ], [ 'id' => 170452, 'title' => 'OTA升级', 'type' => 'directory', 'children' => [ 'ListOtaTask', 'GetOtaTaskByTaskId', 'ApproveOtaTask', ], ], [ 'id' => 178496, 'title' => '管理员账号', 'type' => 'directory', 'children' => [ 'ListTenantConfig', 'ModifyTenantConfig', ], ], [ 'id' => 203812, 'title' => '资源标签', 'type' => 'directory', 'children' => [ 'ListTagCloudResources', 'TagCloudResources', 'UntagCloudResources', ], ], [ 'id' => 263171, 'title' => '无影工作站', 'type' => 'directory', 'children' => [ 'DescribeWuyingServerEipInfo', 'CreateWuyingServer', 'ListWuyingServer', 'StartWuyingServer', 'StopWuyingServer', 'RestartWuyingServer', 'ModifyWuyingServerAttribute', 'UpdateWuyingServerImage', 'RenewWuyingServer', 'DeleteWuyingServer', ], ], [ 'id' => 313380, 'title' => '其他', 'type' => 'directory', 'children' => [ 'ModifyBrowserInstanceGroup', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'ListRegions' => [ 'summary' => '查询无影云应用支持的地域。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '指定产品类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'BizSource', 'in' => 'query', 'schema' => [ 'description' => '> 该参数不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null', ], ], ], '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-67E1FC5F****', ], 'RegionModels' => [ 'description' => '地域ID列表。', 'type' => 'array', 'items' => [ 'description' => '地域ID。', 'type' => 'object', 'properties' => [ 'regionId' => [ 'description' => '地域ID。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'cn-hangzhou', ], ], 'example' => 'cn-hangzhou', ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"RegionModels\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询支持的地域', 'description' => '> 通过该接口查询到的地域，并非全部是可用地域。关于可用地域的信息，参见[支持的地域](~~426036~~)。', ], 'ListNodes' => [ 'summary' => '查询资源节点列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '265984', 'abilityTreeNodes' => [ 'FEATUREappstreamingEP3FXS', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => '每页的查询结果数量。取值范围：1\\~200。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => '需展示的查询结果页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-53fvrq1oanz6c****', ], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], ], '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'PerPageSize' => [ 'description' => '当前分页页面大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ToPage' => [ 'description' => '当前返回是第几页数据。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Count' => [ 'description' => '可返回的数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'NodeModels' => [ 'description' => '资源节点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'NodeId' => [ 'description' => '资源节点ID。'."\n" .'> 只有所属交付组的售卖模式为按资源售卖（ChargeResourceMode=Node）时，才会返回本参数。', 'type' => 'string', 'example' => 'i-bp13********', ], 'ChargeType' => [ 'description' => '资源节点的付费类型。'."\n" ."\n" .'> 只有所属交付组的售卖模式为按资源售卖（ChargeResourceMode=Node）时，才会返回本参数。', 'type' => 'string', 'enumValueTitles' => [ 'PostPaid' => '按量付费（后付费）', 'PrePaid' => '包年包月（预付费）', ], 'example' => 'PostPaid', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PerPageSize\\": 10,\\n \\"ToPage\\": 1,\\n \\"Count\\": 100,\\n \\"NodeModels\\": [\\n {\\n \\"NodeId\\": \\"i-bp13********\\",\\n \\"ChargeType\\": \\"PostPaid\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询资源节点列表', ], 'ModifyNodePoolAmount' => [ 'summary' => '包年包月交付组节点数量升级。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '263378', 'abilityTreeNodes' => [ 'FEATUREappstreamingU1TTUH', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'title' => '产品类型。', 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '交付组ID。', 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], [ 'name' => 'NodePool', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '节点池相关变配参数', 'description' => '节点池变配相关参数。', 'type' => 'object', 'properties' => [ 'NodeAmount' => [ 'title' => '升级后固定节点的数量', 'description' => '升级后预付费节点的总数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'PrePaidNodeAmountModifyMode' => [ 'title' => '预付费节点修改模式。EXPAND_FROM_POST_PAID_EXPLICIT：指定按量节点转换。', 'description' => '预付费节点修改模式。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'EXPAND_FROM_POST_PAID_EXPLICIT' => '指定按量节点转换', ], 'example' => 'EXPAND_FROM_POST_PAID_EXPLICIT', ], 'PrePaidNodeAmountModifyNodeIds' => [ 'title' => '待修改计费类型节点列表。', 'description' => '待修改计费类型节点列表。', 'type' => 'array', 'items' => [ 'description' => '待修改计费类型的节点。', 'type' => 'string', 'required' => false, 'example' => 'i-fgssxxx', ], 'required' => false, ], ], 'required' => true, ], ], ], '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'Data' => [ 'description' => '返回数据对象。', 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => '订单ID。', 'type' => 'string', 'example' => '23429322113****', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"23429322113****\\"\\n }\\n}","type":"json"}]', 'title' => '资源节点池中节点变配', ], 'ListNodeInstanceType' => [ 'summary' => '查询创建交付组时可选购的资源规格。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '需展示的查询结果页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页的查询结果数量。取值范围：1~100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'OsType', 'in' => 'query', 'schema' => [ 'description' => '支持的操作系统类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Windows' => 'Windows操作系统', ], 'example' => 'Windows', ], ], [ 'name' => 'BizRegionId', 'in' => 'query', 'schema' => [ 'description' => '资源所属的地域ID。关于支持的地域详情，请参见[使用限制](~~426036~~)。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'cn-shanghai' => '华东2（上海）', 'cn-hangzhou' => '华东1（杭州）', ], 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => [ 'description' => '语言类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'en-US' => '英语（美国）', 'zh-CN' => '简体中文', ], 'example' => 'zh-CN', ], ], [ 'name' => 'NodeInstanceType', 'in' => 'query', 'schema' => [ 'description' => '指定要查询的资源规格类型。如果不填写，则返回所有规格类型。', 'type' => 'string', 'required' => false, 'example' => 'appstreaming.vgpu.4c8g.2g', ], ], [ 'name' => 'NodeInstanceTypeFamily', 'in' => 'query', 'schema' => [ 'description' => '规格族', 'type' => 'string', 'required' => false, 'example' => 'appstreaming.vgpu', ], ], [ 'name' => 'Cpu', 'in' => 'query', 'schema' => [ 'description' => 'CPU核数。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '2', ], ], [ 'name' => 'Gpu', 'in' => 'query', 'schema' => [ 'description' => 'GPU数量。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Memory', 'in' => 'query', 'schema' => [ 'description' => '内存大小，单位为MB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10240', ], ], [ 'name' => 'GpuMemory', 'in' => 'query', 'schema' => [ 'description' => '显存大小。对于GPU型云电脑，该返回值有实际意义。单位：MB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2048', ], ], [ 'name' => 'SortType', 'in' => 'query', 'schema' => [ 'title' => 'DESC/ASC', 'description' => 'DESC/ASC', 'type' => 'string', 'required' => false, 'example' => 'ASC', ], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'title' => 'CPU/Memory', 'description' => 'CPU/Memory', 'type' => 'string', 'required' => false, 'example' => 'CPU', ], ], ], '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-67E1FC5F****', ], 'TotalCount' => [ 'description' => '查询结果的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'PageSize' => [ 'description' => '每页的查询结果数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'description' => '当前展示的查询结果页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeInstanceTypeModels' => [ 'description' => '资源规格列表。', 'type' => 'array', 'items' => [ 'description' => '资源规格。', 'type' => 'object', 'properties' => [ 'NodeInstanceType' => [ 'description' => '资源规格类型ID。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'appstreaming.vgpu.4c8g.2g', ], 'NodeInstanceTypeFamily' => [ 'description' => '资源规格族。', 'type' => 'string', 'enumValueTitles' => [ 'appstreaming.general' => '无影-通用型', 'appstreaming.vgpu' => '无影-图形型', ], 'example' => 'appstreaming.vgpu', ], 'Cpu' => [ 'description' => 'vCPU数量。', 'type' => 'string', 'example' => '4', ], 'Gpu' => [ 'description' => 'GPU数量。', 'type' => 'string', 'example' => '2', ], 'Memory' => [ 'description' => '内存大小，单位为MB。'."\n" ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8192', ], 'GpuMemory' => [ 'description' => '显卡内存大小，单位为MB。', 'type' => 'integer', 'format' => 'int64', 'example' => '8192', ], 'MaxCapacity' => [ 'description' => '最大并发会话数，即单个资源可同时连接的会话数。如果同时连接的会话数过多，可能导致应用的使用体验下降。取值范围因资源规格不同而不同。各资源规格对应的取值范围分别是：'."\n" ."\n" .'- appstreaming.general.2c4g: 1；'."\n" .'- appstreaming.general.4c8g：1\\~2；'."\n" .'- appstreaming.general.8c16g：1\\~4；'."\n" .'- appstreaming.vgpu.8c16g.4g：1\\~4；'."\n" .'- appstreaming.vgpu.8c31g.16g：1\\~4；'."\n" .'- appstreaming.vgpu.14c93g.12g：1\\~7；'."\n" .'- appstreaming.vgpu.4c10g.2gt4：1\\~2；'."\n" .'- appstreaming.vgpu.4c16g.2ga10：1\\~2；'."\n" .'- appstreaming.vgpu.8c16g.4g：1\\~4；'."\n" .'- appstreaming.vgpu.8c31g.16g：1\\~4；'."\n" .'- appstreaming.vgpu.8c16g.4gt4：1\\~4；'."\n" .'- appstreaming.vgpu.8c32g.4ga10：1\\~4；'."\n" .'- appstreaming.vgpu.12c46g.11g28：1\\~6；'."\n" .'- appstreaming.vgpu.14c93g.12g：1\\~7；'."\n" .'- appstreaming.vgpu.16c32g.8g：1\\~8；'."\n" .'- appstreaming.vgpu.16c62g.8ga10：1\\~8；', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'NodeTypeName' => [ 'description' => '资源规格名称。', 'type' => 'string', 'example' => '无影-通用型_4核8G', ], ], ], ], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 6,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"NodeInstanceTypeModels\\": [\\n {\\n \\"NodeInstanceType\\": \\"appstreaming.vgpu.4c8g.2g\\",\\n \\"NodeInstanceTypeFamily\\": \\"appstreaming.vgpu\\",\\n \\"Cpu\\": \\"4\\",\\n \\"Gpu\\": \\"2\\",\\n \\"Memory\\": 8192,\\n \\"GpuMemory\\": 8192,\\n \\"MaxCapacity\\": 4,\\n \\"NodeTypeName\\": \\"无影-通用型_4核8G\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询资源规格', ], 'GetResourcePrice' => [ 'summary' => '查询资源的价格信息。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'NodeInstanceType', 'in' => 'query', 'schema' => [ 'description' => '购买资源的规格类型ID，可通过[ListNodeInstanceType](~~428502~~)接口获取。'."\n" ."\n" .'AppInstanceType与NodeInstanceType其中一个必须有值。若两个都有值则使用NodeInstanceType。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'appstreaming.vgpu.8c16g.4g' => '无影-图形型_8核16G 4G显存', 'appstreaming.general.8c16g' => '无影-通用型_8核16G', 'appstreaming.general.4c8g' => '无影-通用型_4核8G', 'appstreaming.vgpu.14c93g.12g' => '无影-图形型_14核93G 12G显存', 'appstreaming.vgpu.8c31g.16g' => '无影-图形型_8核31G 16G显存', ], 'example' => 'appstreaming.vgpu.4c8g.2g', ], ], [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => '付费方式。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'PostPaid' => '按量付费', 'PrePaid' => '包年包月', ], 'example' => 'PrePaid', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => '资源购买时长的数量部分，与`PeriodUnit`一起表示完整的购买时长。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ 'description' => '资源购买时长的单位部分，与`Period`一起表示完整的购买时长。可使用的`Period`与`PeriodUnit`的搭配如下：'."\n" ."\n" .'- 1 Week（1周）'."\n" .'- 1 Month（1个月）'."\n" .'- 2 Month（2个月）'."\n" .'- 3 Month（3个月）'."\n" .'- 6 Month（6个月）'."\n" .'- 1 Year（1年）'."\n" .'- 2 Year（2年）'."\n" .'- 3 Year（3年）'."\n" ."\n" .'> 该参数区分大小写。例如，`Week`是有效的，`week`是无效的。另外，如果请求参数不符合上述搭配，例如`2 Week`，虽然调用本接口会成功，但最终在下单阶段会出错。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Month' => '月', 'Year' => '年', 'Week' => '周', ], 'example' => 'Week', ], ], [ 'name' => 'Amount', 'in' => 'query', 'schema' => [ 'description' => '购买资源的数量。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'BizRegionId', 'in' => 'query', 'schema' => [ 'description' => '交付组所属的地域ID。关于支持的地域详情，请参见[使用限制](~~426036~~)。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'cn-shanghai' => '华东2（上海）', 'cn-hangzhou' => '华东1（杭州）', ], 'example' => 'cn-hangzhou', ], ], [ 'name' => 'AppInstanceType', 'in' => 'query', 'schema' => [ 'description' => '购买会话的规格类型ID，可通过`ListAppInstanceType`接口获取。'."\n" ."\n" .'AppInstanceType与NodeInstanceType其中一个必须有值。若两个都有值则使用NodeInstanceType。', 'type' => 'string', 'required' => false, 'example' => 'appstreaming.general', ], ], ], '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-67E1FC5F****', ], 'Code' => [ 'description' => '出错时的错误码。', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', ], 'Message' => [ 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', ], 'PriceModel' => [ 'description' => '价格对象。'."\n" ."\n" .'请求参数NodeInstanceType有值时返回此参数。', 'type' => 'object', 'properties' => [ 'Price' => [ 'description' => '价格详情。', 'type' => 'object', 'properties' => [ 'OriginalPrice' => [ 'description' => '原价。', 'type' => 'string', 'example' => '11.00', ], 'DiscountPrice' => [ 'description' => '折减的价格，原价减去折减的价格即为实际价格。', 'type' => 'string', 'example' => '1.00', ], 'TradePrice' => [ 'description' => '实际价格，原价减去折减的价格即为实际价格。', 'type' => 'string', 'example' => '10.00', ], 'Currency' => [ 'description' => '币种。', 'type' => 'string', 'example' => 'CNY', ], 'Promotions' => [ 'description' => '优惠券元数据。', 'type' => 'array', 'items' => [ 'description' => '优惠券元数据。', 'type' => 'object', 'properties' => [ 'OptionCode' => [ 'description' => '优惠券代号。', 'type' => 'string', 'example' => 'coupon****', ], 'PromotionId' => [ 'description' => '优惠券ID。', 'type' => 'string', 'example' => '17440009****', ], 'PromotionName' => [ 'description' => '优惠券名称。', 'type' => 'string', 'example' => '**优惠', ], 'PromotionDesc' => [ 'description' => '优惠券描述。', 'type' => 'string', 'example' => '**活动期间的优惠', ], 'Selected' => [ 'description' => '是否选用优惠券。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '选用', 'false' => '不选用', ], 'example' => 'true', ], ], ], ], ], ], 'Rules' => [ 'description' => '价格计算规则。', 'type' => 'array', 'items' => [ 'description' => '价格计算规则。', 'type' => 'object', 'properties' => [ 'RuleId' => [ 'description' => '价格计算规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '102002100393****', ], 'Description' => [ 'description' => '价格计算规则描述。', 'type' => 'string', 'example' => '用户优惠', ], ], ], ], ], ], 'PriceList' => [ 'description' => '价格对象列表。'."\n" ."\n" .'请求参数AppInstanceType有值时返回此参数。', 'type' => 'array', 'items' => [ 'description' => '价格对象。', 'type' => 'object', 'properties' => [ 'PriceType' => [ 'description' => '价格类型。', 'type' => 'string', 'enumValueTitles' => [ 'Connected' => '使用阶段', 'Standby' => '预开阶段', ], 'example' => 'Standby', ], 'Price' => [ 'description' => '价格详情。', 'type' => 'object', 'properties' => [ 'OriginalPrice' => [ 'description' => '原价。', 'type' => 'string', 'example' => '6700', ], 'DiscountPrice' => [ 'description' => '折减的价格，原价减去折减的价格即为实际价格。', 'type' => 'string', 'example' => '999.0', ], 'TradePrice' => [ 'description' => '实际价格，原价减去折减的价格即为实际价格。', 'type' => 'string', 'example' => '5278.0', ], 'Currency' => [ 'description' => '币种。', 'type' => 'string', 'example' => 'CNY', ], 'Promotions' => [ 'description' => '优惠券元数据。', 'type' => 'array', 'items' => [ 'description' => '优惠券元数据。', 'type' => 'object', 'properties' => [ 'OptionCode' => [ 'description' => '优惠券代号。', 'type' => 'string', 'example' => 'coupon****', ], 'PromotionId' => [ 'description' => '优惠券ID。', 'type' => 'string', 'example' => '1847709****', ], 'PromotionName' => [ 'description' => '优惠券名称。', 'type' => 'string', 'example' => '**优惠', ], 'PromotionDesc' => [ 'description' => '优惠券描述。', 'type' => 'string', 'example' => '**活动期间的优惠', ], 'Selected' => [ 'description' => '是否选用优惠券。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '选用', 'false' => '不选用', ], 'example' => 'true', ], ], ], ], ], ], 'Rules' => [ 'description' => '价格计算规则。', 'type' => 'array', 'items' => [ 'description' => '价格计算规则。', 'type' => 'object', 'properties' => [ 'RuleId' => [ 'description' => '价格计算规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '260904273633****', ], 'Description' => [ 'description' => '价格计算规则描述。', 'type' => 'string', 'example' => '用户优惠。', ], ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\",\\n \\"PriceModel\\": {\\n \\"Price\\": {\\n \\"OriginalPrice\\": \\"11.00\\",\\n \\"DiscountPrice\\": \\"1.00\\",\\n \\"TradePrice\\": \\"10.00\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Promotions\\": [\\n {\\n \\"OptionCode\\": \\"coupon****\\",\\n \\"PromotionId\\": \\"17440009****\\",\\n \\"PromotionName\\": \\"**优惠\\",\\n \\"PromotionDesc\\": \\"**活动期间的优惠\\",\\n \\"Selected\\": true\\n }\\n ]\\n },\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"Description\\": \\"用户优惠\\"\\n }\\n ]\\n },\\n \\"PriceList\\": [\\n {\\n \\"PriceType\\": \\"Standby\\",\\n \\"Price\\": {\\n \\"OriginalPrice\\": \\"6700\\",\\n \\"DiscountPrice\\": \\"999.0\\",\\n \\"TradePrice\\": \\"5278.0\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Promotions\\": [\\n {\\n \\"OptionCode\\": \\"coupon****\\",\\n \\"PromotionId\\": \\"1847709****\\",\\n \\"PromotionName\\": \\"**优惠\\",\\n \\"PromotionDesc\\": \\"**活动期间的优惠\\",\\n \\"Selected\\": true\\n }\\n ]\\n },\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"Description\\": \\"用户优惠。\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询资源价格', ], 'GetResourceRenewPrice' => [ 'summary' => '查询无影云应用资源的续费价格。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品类型。'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => '资源购买时长的数量部分，与`PeriodUnit`一起表示完整的购买时长。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ 'description' => '资源购买时长的单位部分，与`Period`一起表示完整的购买时长。可使用的`Period`与`PeriodUnit`的搭配如下：'."\n" ."\n" .'- 1 Week（1周）'."\n" .'- 1 Month（1个月）'."\n" .'- 2 Month（2个月）'."\n" .'- 3 Month（3个月）'."\n" .'- 6 Month（6个月）'."\n" .'- 1 Year（1年）'."\n" .'- 2 Year（2年）'."\n" .'- 3 Year（3年）'."\n" ."\n" .'> 该参数区分大小写。例如，`Week`是有效的，`week`是无效的。另外，如果请求参数不符合上述搭配，例如`2 Week`，虽然调用本接口会成功，但最终在下单阶段会出错。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Month' => '月', 'Year' => '年', 'Week' => '周', ], 'example' => 'Week', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'query', 'schema' => [ 'description' => '交付组ID。可通过接口[ListAppInstanceGroup](~~428506~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'Data' => [ 'description' => '价格对象。', 'type' => 'object', 'properties' => [ 'Price' => [ 'description' => '价格详情。', 'type' => 'object', 'properties' => [ 'OriginalPrice' => [ 'description' => '原价。', 'type' => 'string', 'example' => '11'."\n", ], 'DiscountPrice' => [ 'description' => '折减的价格，原价减去折减的价格即为实际价格。', 'type' => 'string', 'example' => '1', ], 'TradePrice' => [ 'description' => '实际价格，原价减去折减的价格即为实际价格。', 'type' => 'string', 'example' => '10', ], 'Currency' => [ 'description' => '币种。', 'type' => 'string', 'example' => 'CNY', ], 'Promotions' => [ 'description' => '优惠券描述。', 'type' => 'array', 'items' => [ 'description' => '优惠券元数据。', 'type' => 'object', 'properties' => [ 'OptionCode' => [ 'description' => '优惠券代号。', 'type' => 'string', 'example' => 'coupon****', ], 'PromotionId' => [ 'description' => '优惠券ID。', 'type' => 'string', 'example' => '139965*****', ], 'PromotionName' => [ 'description' => '优惠券名称。', 'type' => 'string', 'example' => '**活动', ], 'PromotionDesc' => [ 'description' => '优惠券描述。', 'type' => 'string', 'example' => '**活动', ], 'Selected' => [ 'description' => '是否选用优惠券。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '选用', 'false' => '不选用', ], 'example' => 'true', ], ], ], ], ], ], 'Rules' => [ 'description' => '价格计算规则。', 'type' => 'array', 'items' => [ 'description' => '价格计算规则。', 'type' => 'object', 'properties' => [ 'RuleId' => [ 'description' => '价格计算规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '20002****', ], 'Description' => [ 'description' => '价格计算规则描述。', 'type' => 'string', 'example' => '**活动', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"Price\\": {\\n \\"OriginalPrice\\": \\"11\\\\n\\",\\n \\"DiscountPrice\\": \\"1\\",\\n \\"TradePrice\\": \\"10\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Promotions\\": [\\n {\\n \\"OptionCode\\": \\"coupon****\\",\\n \\"PromotionId\\": \\"139965*****\\",\\n \\"PromotionName\\": \\"**活动\\",\\n \\"PromotionDesc\\": \\"**活动\\",\\n \\"Selected\\": true\\n }\\n ]\\n },\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"Description\\": \\"**活动\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询资源续费价格', ], 'ListImage' => [ 'summary' => '查询镜像信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '213313', 'abilityTreeNodes' => [ 'FEATUREappstreamingSH8DGI', 'FEATUREappstreamingDG81PX', ], ], 'parameters' => [ [ 'name' => 'ImageId', 'in' => 'formData', 'schema' => [ 'title' => '镜像id', 'description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'img-bp13mu****', ], ], [ 'name' => 'ImageName', 'in' => 'formData', 'schema' => [ 'title' => '镜像名称', 'description' => '镜像名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'DemoImage', ], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => [ 'title' => '镜像状态:INIT/CREATING/AVAILABLE/CREATE_FAILED', 'description' => '镜像状态，用户查询对应状态的镜像，默认是查询所有未删除状态的镜像。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'AVAILABLE' => '可用', 'INIT' => '初始化中', 'CREATE_FAILED' => '创建失败', 'CREATING' => '创建中', ], 'example' => 'INIT', ], ], [ 'name' => 'ImageType', 'in' => 'formData', 'schema' => [ 'title' => '镜像类型', 'description' => '镜像类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'User' => '自定义镜像', 'Shared' => '共享镜像', 'System' => '系统镜像', 'Community' => '社区镜像', ], 'example' => 'User', ], ], [ 'name' => 'PackageType', 'in' => 'formData', 'schema' => [ 'title' => '镜像封装类型', 'description' => '镜像封装类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Ecs_Container' => 'ECS+Docker镜像', 'Ecs' => 'Ecs镜像', ], 'example' => 'Ecs', ], ], [ 'name' => 'OsType', 'in' => 'formData', 'schema' => [ 'title' => '镜像操作系统类型', 'description' => '镜像操作系统类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Linux' => 'Linux', 'Unknown' => '未知', 'Windows' => 'Windows', 'Android' => 'Android', ], 'example' => 'Windows', ], ], [ 'name' => 'BizType', 'in' => 'formData', 'schema' => [ 'title' => '业务类型', 'description' => '业务类型。暂不对外透出使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ 1 => '[默认值]', ], 'example' => '1', ], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'title' => '产品类型', 'description' => '产品类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'CloudDesktop' => '无影云电脑', 'CloudApp' => '无影云应用', 'WuyingServer' => '无影工作站', ], 'example' => 'CloudApp', ], ], [ 'name' => 'ProtocolType', 'in' => 'formData', 'schema' => [ 'title' => '镜像协议类型', 'description' => '镜像协议类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议', ], 'example' => 'ASP', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => '分页查询时每页的行数。最大值：100。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ProductTypeList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '当镜像支持多个产品时可以支持的产品列表。', 'type' => 'array', 'items' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'CloudDesktop' => '无影云电脑', 'CloudApp' => '无影云应用', 'WuyingServer' => '无影工作站', ], 'example' => 'CloudApp', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'BizTypeList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '所有业务类型列表，暂不对外透出使用。', 'type' => 'array', 'items' => [ 'description' => '业务类型。根据您使用的业务填写使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ 1 => '[默认值]', ], 'example' => '1', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'FeatureList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '镜像支持的特征列表。', 'type' => 'array', 'items' => [ 'description' => '镜像支持的特征。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'FotaChannel' => '支持的fota渠道', 'Builder' => '支持镜像Builder', 'MultiSession' => '支持多Session', 'GPU' => '支持GPU', ], 'example' => 'GPU', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'LanguageType', 'in' => 'formData', 'schema' => [ 'title' => 'zh-CN,zh-HK,en-US,ja-JP,CN,EN,JP,CN-HK', 'description' => '语言。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'en-US' => '英语', 'zh-HK' => '繁体中文（香港）', 'zh-CN' => '简体中文', 'ja-JP' => '日语', ], 'example' => 'zh-CN', ], ], [ 'name' => 'ResourceInstanceType', 'in' => 'formData', 'schema' => [ 'description' => '查找某些固定规格的镜像。', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.2c4g', ], ], [ 'name' => 'FotaVersion', 'in' => 'formData', 'schema' => [ 'description' => '镜像版本信息。', 'type' => 'string', 'required' => false, 'example' => '2.0.3-xxxx', ], ], [ 'name' => 'PlatformName', 'in' => 'formData', 'schema' => [ 'description' => '操作系统平台名称。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Ubuntu' => 'Ubuntu操作系统', 'Debian' => 'Debian操作系统', 'Windows Server 2022' => 'Windows Server 2022操作系统', 'Windows Server 2019' => 'Windows Server 2019操作系统', 'Windows Server 2016' => 'Windows Server 2016操作系统', 'Windows 11' => 'Windows 11操作系统', 'Windows 10' => 'Windows 10操作系统', ], 'example' => 'Windows Server 2019', ], ], [ 'name' => 'BizRegionIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '支持地域列表。'."\n" .'无影镜像是中心化的，通过这个查询该镜像部署的地域。', 'type' => 'array', 'items' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'TagList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '标签查询。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '用户自定义的标签Key。', 'type' => 'string', 'required' => false, 'example' => 'env', ], 'Value' => [ 'description' => '用户自定义的标签Value。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'PlatformNameList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '支持的平台类型列表，枚举值参考上面的PlatformName。', 'type' => 'array', 'items' => [ 'description' => '镜像平台名称。', 'type' => 'string', 'required' => false, 'example' => 'Windows 11', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ImageBaseInfoModel', 'description' => '镜像信息结构体。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'title' => '每页展示数据条数。', 'description' => '每页展示数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'title' => '返回数据的页数。', 'description' => '返回数据的页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Data' => [ 'title' => '返回对象。', 'description' => '返回数据对象。', 'type' => 'array', 'items' => [ 'title' => '返回对象。', 'description' => '返回对象。', 'type' => 'object', 'properties' => [ 'GmtCreate' => [ 'title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2025-04-25 15:13:57', ], 'GmtModified' => [ 'title' => '更新时间', 'description' => '更新时间。', 'type' => 'string', 'example' => '2025-04-25 15:13:57', ], 'AliUid' => [ 'title' => '租户ID，0是系统镜像', 'description' => '租户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789', ], 'ImageId' => [ 'title' => '系统镜像id有含义，自定义镜像自动生成', 'description' => '系统镜像ID有含义，自定义镜像自动生成。', 'type' => 'string', 'example' => 'imgc-xxxx', ], 'ImageName' => [ 'title' => '镜像名称', 'description' => '镜像名称。', 'type' => 'string', 'example' => 'DemoImage', ], 'ImageType' => [ 'title' => '镜像类型', 'description' => '镜像类型。', 'type' => 'string', 'example' => 'User', ], 'PackageType' => [ 'title' => '镜像封装类型 ECS/VHD/Container/ECS_APP', 'description' => '镜像封装类型。', 'type' => 'string', 'example' => 'ECS', ], 'Description' => [ 'title' => '镜像描述', 'description' => '镜像描述。', 'type' => 'string', 'example' => '描述', ], 'OsType' => [ 'title' => '镜像类型', 'description' => '镜像类型。', 'type' => 'string', 'example' => 'Windows', ], 'ProtocolType' => [ 'title' => '协议类型 ASP/HDX/ALL', 'description' => '协议类型。', 'type' => 'string', 'example' => 'ASP', ], 'BizType' => [ 'title' => '业务线', 'description' => '业务类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ProductType' => [ 'title' => '产品线', 'description' => '产品类型。', 'type' => 'string', 'example' => 'CloudApp', ], 'VersionId' => [ 'title' => '镜像版本', 'description' => '镜像版本。', 'type' => 'string', 'example' => 'iv-xxx', ], 'OnlineVersionId' => [ 'title' => '当前镜像最新版本', 'description' => '当前镜像标记从该子版本读取主镜像信息。（一个镜像是由多个子版本组成）', 'type' => 'string', 'example' => 'iv-xxxx', ], 'LatestVersionId' => [ 'title' => '该镜像的最新版本', 'description' => '该镜像的最新子版本。（一个镜像是由多个子版本组成）', 'type' => 'string', 'example' => 'iv-xxx', ], 'Status' => [ 'title' => '状态 ImageStatusEnum', 'description' => '镜像状态。', 'type' => 'string', 'example' => 'INIT', ], 'ParentImageId' => [ 'title' => '父镜像ID，只表示继承关系，系统镜像无父镜像', 'description' => '父镜像ID，只表示继承关系，系统镜像无父镜像。', 'type' => 'string', 'example' => 'imgc-xxx', ], 'ParentImageVersion' => [ 'title' => '父镜像版本', 'description' => '父镜像版本。', 'type' => 'string', 'example' => 'iv-xxx', ], 'BaseImageId' => [ 'title' => '基础镜像ID', 'description' => '基础镜像ID。', 'type' => 'string', 'example' => 'imgc-xxx', ], 'BaseImageVersion' => [ 'title' => '基础镜像版本', 'description' => '基础镜像版本。', 'type' => 'string', 'example' => 'iv-xxx', ], 'FotaVersion' => [ 'title' => 'fota版本', 'description' => 'FOTA版本。', 'type' => 'string', 'example' => '2.3.0-xxx', ], 'Language' => [ 'title' => '镜像语言', 'description' => '镜像语言。如果封装类型为VHD/Container时，继承于该镜像组合的封装类型为ECS的镜像属性。', 'type' => 'string', 'example' => 'zh-CN', ], 'Platform' => [ 'title' => '镜像平台类型整型值', 'description' => '镜像操作系统平台。'."\n" ."\n" .'> 如果封装类型为VHD/Container，继承于该镜像组合的封装类型为ECS的镜像属性。', 'type' => 'integer', 'format' => 'int32', 'example' => 'Windows', ], 'OnlineVersion' => [ 'title' => '当前版本是否是生效版本', 'description' => '当前版本是否是生效版本。', 'type' => 'boolean', 'example' => 'true', ], 'SystemDiskSize' => [ 'title' => '系统盘大小。单位：GiB', 'description' => '系统盘大小。单位：GiB。'."\n" ."\n" .'> 系统盘大小不能小于镜像文件。', 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'DataDiskSize' => [ 'title' => '数据盘大小。单位：GiB', 'description' => '数据盘大小。单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'AppList' => [ 'title' => '应用配置列表', 'description' => '应用配置。', 'type' => 'array', 'items' => [ 'title' => '应用配置', 'description' => '应用配置', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => '应用ID', 'description' => '应用ID。', 'type' => 'string', 'example' => 'ca-xxx', ], 'AppName' => [ 'title' => '应用名称', 'description' => '应用名称。', 'type' => 'string', 'example' => '应用名称', ], ], ], ], 'FeatureList' => [ 'title' => '镜像特征标记', 'description' => '镜像特征标记列表。', 'type' => 'array', 'items' => [ 'title' => '镜像特征标记', 'description' => '镜像特征标记。', 'type' => 'string', 'example' => 'Builder', ], ], 'ImageCreateMode' => [ 'title' => '镜像创建类型', 'description' => '镜像创建类型', 'type' => 'string', 'enumValueTitles' => [ 'BY_SNAPSHOT_ID' => '从快照创建或者只包含系统盘时', 'BUILDER_MANUAL' => '手动生成镜像', 'INSTANCE_AUTO' => '基于实例自动化生成镜像', 'BY_INSTANCE_ID' => '从实例创建或者包含系统盘和数据盘时', ], 'example' => 'BUILDER_MANUAL', ], 'ImageRegionList' => [ 'title' => '地域对象', 'description' => '地域。', 'type' => 'array', 'items' => [ 'title' => '地域对象', 'description' => '地域对象。', 'type' => 'string', 'example' => '地域对象。', ], ], 'Distro' => [ 'title' => '发行版名字', 'description' => '发行版名字。', 'type' => 'string', 'example' => 'Ubuntu 22.04 64位', ], 'VersionName' => [ 'title' => '版本名称', 'description' => '版本名称。', 'type' => 'string', 'example' => 'v0.1.0', ], 'ResourceInstanceCategory' => [ 'title' => '镜像支持资源类型', 'description' => '镜像支持资源类型。', 'type' => 'string', 'example' => '["eds.cpu.category"]', ], 'PlatformName' => [ 'title' => '镜像平台类型', 'description' => '系统平台名称。', 'type' => 'string', 'example' => 'Windows Server 2022', ], 'SupportedLanguageList' => [ 'title' => '支持语言列表', 'description' => '支持语言列表。', 'type' => 'array', 'items' => [ 'title' => '支持语言', 'description' => '支持语言。', 'type' => 'string', 'example' => 'zh-CN', ], ], 'VolumeEncryptionEnabled' => [ 'title' => '是否开启磁盘加密', 'description' => '是否开启磁盘加密。', 'type' => 'boolean', 'example' => 'true', ], 'VolumeEncryptionKey' => [ 'title' => '开启磁盘加密的情况下使用的KMS的密钥ID', 'description' => '开启磁盘加密的情况下使用的KMS的密钥ID。', 'type' => 'string', 'example' => 'a7b3c0c8-xxxx', ], 'SessionType' => [ 'title' => '会话类型', 'description' => '会话类型。', 'type' => 'string', 'enumValueTitles' => [ 'SINGLE_SESSION' => '单会话', 'MULTIPLE_SESSION' => '多会话', ], 'example' => 'SINGLE_SESSION', ], 'ImageRegionDistributeList' => [ 'title' => '叠层有效地域信息', 'description' => '叠层有效地域信息。', 'type' => 'array', 'items' => [ 'title' => '镜像地域列表', 'description' => '镜像地域列表', 'type' => 'object', 'properties' => [ 'ImageId' => [ 'title' => '系统镜像id有含义，自定义镜像自动生成', 'description' => '系统镜像ID有含义，自定义镜像自动生成。', 'type' => 'string', 'example' => 'imgc-xxx', ], 'RegionId' => [ 'title' => '支持地域', 'description' => '支持地域。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'Status' => [ 'title' => '状态', 'description' => '状态。', 'type' => 'string', 'example' => 'INIT', ], 'VersionId' => [ 'title' => '镜像版本', 'description' => '镜像版本。', 'type' => 'string', 'example' => 'iv-xxx', ], 'Progress' => [ 'title' => '进度百分比', 'description' => '进度百分比。', 'type' => 'string', 'example' => '70%', ], ], ], ], 'FotaChannel' => [ 'title' => '> 此参数暂未对外开放使用。', 'description' => '> 此参数暂未对外开放使用。', 'type' => 'string', 'example' => '镜像支持的fota渠道，暂未启用', ], 'CompatibleMode' => [ 'title' => '是否为兼容模式。', 'description' => '是否为兼容模式。', 'type' => 'boolean', 'example' => 'true', ], 'DriverList' => [ 'title' => '驱动列表。', 'description' => '驱动信息列表。', 'type' => 'array', 'items' => [ 'title' => '驱动ID', 'description' => '驱动列表。', 'type' => 'string', 'example' => '["00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]', ], ], 'Scene' => [ 'title' => '镜像使用的场景', 'description' => '镜像使用的场景', 'type' => 'string', 'example' => 'AIGC', ], 'Rating' => [ 'title' => '镜像评分值，满分100', 'description' => '镜像评分值，满分100', 'type' => 'integer', 'format' => 'int32', 'example' => '95', ], 'ImageIconUrl' => [ 'title' => '镜像图标URL', 'description' => '镜像图标URL', 'type' => 'string', ], 'EnvironmentId' => [ 'title' => '镜像使用环境ID', 'description' => '镜像使用环境ID', 'type' => 'string', 'example' => 'env-164c321f405ca84143e4b730dbe4', ], 'TagList' => [ 'title' => '标签列表', 'description' => '标签列表', 'type' => 'array', 'items' => [ 'title' => '标签列表', 'description' => '标签列表', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'example' => '1630348213973321', ], 'Value' => [ 'title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'example' => 'inner', ], ], ], ], 'SnapshotList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SnapshotId' => [ 'type' => 'string', ], 'VersionId' => [ 'type' => 'string', ], 'DiskType' => [ 'type' => 'string', ], 'DiskSubType' => [ 'type' => 'string', ], 'BindType' => [ 'type' => 'string', ], 'DiskCategory' => [ 'type' => 'string', ], 'Size' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], ], ], 'Count' => [ 'title' => '总条数。', 'description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'Success' => [ 'title' => '是否调用成功。', 'description' => '是否调用成功。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '调用成功', 'false' => '调用失败', ], 'example' => 'true', ], 'Code' => [ 'title' => '错误码。', 'description' => '错误码。', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'title' => '接口请求返回的信息。', 'description' => '接口请求返回的信息。', 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '8737D130-BFD0-5D51-96F6-C08EB1139A25', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'Internal error.', ], [ 'errorCode' => 'InvalidBizType', 'errorMessage' => 'The bizType parameter is invalid.', ], ], 403 => [ [ 'errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'You are not authorized to access this page.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": \\"2025-04-25 15:13:57\\",\\n \\"GmtModified\\": \\"2025-04-25 15:13:57\\",\\n \\"AliUid\\": 123456789,\\n \\"ImageId\\": \\"imgc-xxxx\\",\\n \\"ImageName\\": \\"DemoImage\\",\\n \\"ImageType\\": \\"User\\",\\n \\"PackageType\\": \\"ECS\\",\\n \\"Description\\": \\"描述\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"BizType\\": 1,\\n \\"ProductType\\": \\"CloudApp\\",\\n \\"VersionId\\": \\"iv-xxx\\",\\n \\"OnlineVersionId\\": \\"iv-xxxx\\",\\n \\"LatestVersionId\\": \\"iv-xxx\\",\\n \\"Status\\": \\"INIT\\",\\n \\"ParentImageId\\": \\"imgc-xxx\\",\\n \\"ParentImageVersion\\": \\"iv-xxx\\",\\n \\"BaseImageId\\": \\"imgc-xxx\\",\\n \\"BaseImageVersion\\": \\"iv-xxx\\",\\n \\"FotaVersion\\": \\"2.3.0-xxx\\",\\n \\"Language\\": \\"zh-CN\\",\\n \\"Platform\\": 0,\\n \\"OnlineVersion\\": true,\\n \\"SystemDiskSize\\": 40,\\n \\"DataDiskSize\\": 100,\\n \\"AppList\\": [\\n {\\n \\"AppId\\": \\"ca-xxx\\",\\n \\"AppName\\": \\"应用名称\\"\\n }\\n ],\\n \\"FeatureList\\": [\\n \\"Builder\\"\\n ],\\n \\"ImageCreateMode\\": \\"BUILDER_MANUAL\\",\\n \\"ImageRegionList\\": [\\n \\"地域对象。\\"\\n ],\\n \\"Distro\\": \\"Ubuntu 22.04 64位\\",\\n \\"VersionName\\": \\"v0.1.0\\",\\n \\"ResourceInstanceCategory\\": \\"[\\\\\\"eds.cpu.category\\\\\\"]\\",\\n \\"PlatformName\\": \\"Windows Server 2022\\",\\n \\"SupportedLanguageList\\": [\\n \\"zh-CN\\"\\n ],\\n \\"VolumeEncryptionEnabled\\": true,\\n \\"VolumeEncryptionKey\\": \\"a7b3c0c8-xxxx\\",\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"ImageRegionDistributeList\\": [\\n {\\n \\"ImageId\\": \\"imgc-xxx\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Status\\": \\"INIT\\",\\n \\"VersionId\\": \\"iv-xxx\\",\\n \\"Progress\\": \\"70%\\"\\n }\\n ],\\n \\"FotaChannel\\": \\"镜像支持的fota渠道，暂未启用\\",\\n \\"CompatibleMode\\": true,\\n \\"DriverList\\": [\\n \\"[\\\\\\"00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\\\\\"]\\"\\n ],\\n \\"Scene\\": \\"AIGC\\",\\n \\"Rating\\": 95,\\n \\"ImageIconUrl\\": \\"\\",\\n \\"EnvironmentId\\": \\"env-164c321f405ca84143e4b730dbe4\\",\\n \\"TagList\\": [\\n {\\n \\"Key\\": \\"1630348213973321\\",\\n \\"Value\\": \\"inner\\"\\n }\\n ],\\n \\"SnapshotList\\": [\\n {\\n \\"SnapshotId\\": \\"\\",\\n \\"VersionId\\": \\"\\",\\n \\"DiskType\\": \\"\\",\\n \\"DiskSubType\\": \\"\\",\\n \\"BindType\\": \\"\\",\\n \\"DiskCategory\\": \\"\\",\\n \\"Size\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Count\\": 22,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"8737D130-BFD0-5D51-96F6-C08EB1139A25\\"\\n}","type":"json"}]', 'title' => '查询镜像信息', ], 'CreateImageByInstance' => [ 'summary' => '通过已部署好的无影实例创建自定义镜像，以便快速创建更多相同配置的无影实例，避免每次创建时重复配置实例环境。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '248026', 'abilityTreeNodes' => [ 'FEATUREappstreamingSH8DGI', ], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'ImageName', 'in' => 'formData', 'schema' => [ 'title' => '镜像名称', 'description' => '镜像名称。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'test', ], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => [ 'title' => '镜像描述', 'description' => '镜像描述。', 'type' => 'string', 'required' => false, 'example' => 'my test image v1.0', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'title' => '实例ID', 'description' => '无影实例ID。该实例可以是云桌面实例，工作站实例。为了保障镜像中的数据数据一致性， 建议将实例关机之后再发起镜像制作。', 'type' => 'string', 'required' => false, 'example' => 'ws-0buj1s9gm******', ], ], [ 'name' => 'SubInstanceId', 'in' => 'formData', 'schema' => [ 'title' => '实例版本', 'description' => '子实例ID，云电脑场景不涉及。工作站场景，需要传入持久会话ID，确保定位到一个具体的实例。', 'type' => 'string', 'required' => false, 'example' => 'p-0cc7s3n1l*****', ], ], [ 'name' => 'InstanceType', 'in' => 'formData', 'schema' => [ 'title' => '实例类型', 'description' => '实例类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'CloudDesktop' => '云桌面', 'WuyingServer' => '工作站', ], 'example' => 'WuyingServer', ], ], [ 'name' => 'AutoCleanUserdata', 'in' => 'formData', 'schema' => [ 'description' => '该参数目前仅适用于实例类型是云桌面场景。'."\n" .'是否清除用户个人数据。若设为true，制作的镜像会清除C:\\Users目录下除Administrator、Public之外的其他目录的数据。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '清理', 'false' => '不清理', ], 'example' => 'false', ], ], [ 'name' => 'DiskType', 'in' => 'formData', 'schema' => [ 'description' => '镜像中包含的磁盘数据种类，默认包含实例的系统盘和数据盘。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'SYSTEM' => '仅系统盘', 'ALL' => '系统盘+数据盘', ], 'example' => 'ALL', ], ], [ 'name' => 'BizType', 'in' => 'formData', 'schema' => [ 'title' => '业务线 1:BASE/2:PERSONAL/3:CLOUD_OFFICE/4:CLOUD_FLOW/10:STANDARD', 'description' => '该参数暂不对外使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'title' => '产品类型 CloudGame/CloudApp/CloudBrowser/CloudDesktop', 'description' => '该参数暂不对外使用。', 'type' => 'string', 'required' => false, 'example' => 'WuyingServer', ], ], [ 'name' => 'TagList', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'type' => 'string', 'required' => false, ], 'Value' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => '请求响应结构体。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '返回对象。', 'type' => 'object', 'properties' => [ 'ImageId' => [ 'title' => '系统镜像id有含义，自定义镜像自动生成', 'description' => '无影镜像ID。', 'type' => 'string', 'example' => 'imgc-07hnjj5fp****', ], 'VersionId' => [ 'title' => '镜像版本', 'description' => '镜像版本。', 'type' => 'string', 'example' => 'iv-0abxi0lbi*****', ], 'TaskId' => [ 'title' => '任务id', 'description' => '制作镜像的任务ID。', 'type' => 'string', 'example' => 'tid-0abxi0lbih******', ], ], ], 'Success' => [ 'description' => '请求成功与否，成功返回为true，失败为false。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '出错时的错误码。', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'NULL', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Instance.NotFound', 'errorMessage' => 'The instance is not found.', ], [ 'errorCode' => 'DesktopInstance.NotFound', 'errorMessage' => 'The cloud computer instance does not exist.', ], [ 'errorCode' => 'Instance.ImageUnsupported', 'errorMessage' => 'A non-centralized image does not support this type of operation.', ], [ 'errorCode' => 'Instance.PhysicalNodeNotExist', 'errorMessage' => 'The instance physical node does not exist.', ], [ 'errorCode' => 'ImageCreateByInstance.TaskExist', 'errorMessage' => 'The image task of instance creation already exists.', ], [ 'errorCode' => 'ExceedBuilderQuota', 'errorMessage' => 'The maximum number of builders is reached.', ], [ 'errorCode' => 'InvalidBaseImage.NotConfigured', 'errorMessage' => 'Configuration required for Vhd/Container images.', ], [ 'errorCode' => 'CreateDesktopImageRecord.Failed', 'errorMessage' => 'Create cloud computer image failed.', ], [ 'errorCode' => 'Image.NotExist', 'errorMessage' => 'The image does not exist.', ], [ 'errorCode' => 'ImageRegionDistribute.NotAllow', 'errorMessage' => 'This image cannot be distributed.', ], [ 'errorCode' => 'ImageUpdateFailed.NotAllow', 'errorMessage' => 'The image is not allowed to be modified.', ], [ 'errorCode' => 'ImageUpdateSharedImageFailed.NotAllow', 'errorMessage' => 'The shared image is not allowed to be modified.', ], [ 'errorCode' => 'ParentImageRegionDistribute.NotExist', 'errorMessage' => 'The target distribution region of the parent image does not exist.', ], [ 'errorCode' => 'InternalError', 'errorMessage' => 'Internal error.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ImageId\\": \\"imgc-07hnjj5fp****\\",\\n \\"VersionId\\": \\"iv-0abxi0lbi*****\\",\\n \\"TaskId\\": \\"tid-0abxi0lbih******\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"NULL\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '通过实例创建自定义镜像', ], 'StartTaskForDistributeImage' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '219723', 'abilityTreeNodes' => [ 'FEATUREappstreamingSH8DGI', ], ], 'parameters' => [ [ 'name' => 'ImageId', 'in' => 'formData', 'schema' => [ 'title' => '镜像id', 'description' => '镜像id', 'type' => 'string', 'required' => true, 'example' => 'imgc-07jyldnd9i*****', ], ], [ 'name' => 'VersionId', 'in' => 'formData', 'schema' => [ 'title' => '版本id', 'description' => '镜像版本ID，不填默认使用最新的镜像版本。', 'type' => 'string', 'required' => false, 'example' => 'iv-07jyldnd9i****', ], ], [ 'name' => 'RetryType', 'in' => 'formData', 'schema' => [ 'title' => 'RESET/CONTINUE', 'description' => '该参数暂不对外透出。', 'type' => 'string', 'required' => false, 'example' => 'RETRY', ], ], [ 'name' => 'DestinationRegionList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '需要复制的目标地域列表。', 'type' => 'array', 'items' => [ 'description' => '阿里云地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'CloudDesktop' => '无影云桌面', 'CloudApp' => '无影云应用', 'WuyingServer' => '无影工作站', ], 'example' => 'CloudApp', ], ], [ 'name' => 'SourceRegion', 'in' => 'formData', 'schema' => [ 'description' => '指定复制镜像的源地域，不设置则随机选择。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => '返回数据结构体。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '返回的镜像复制任务ID。', 'type' => 'string', 'example' => 'tid-06xnr5lyp77e7****', ], 'Success' => [ 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '出错时的错误码。', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => '请求的ID。', 'type' => 'string', 'example' => '419F31B9-1FDF-5644-ABA3-D00026FA****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Instance.NotFound', 'errorMessage' => 'The instance is not found.', ], [ 'errorCode' => 'DesktopInstance.NotFound', 'errorMessage' => 'The cloud computer instance does not exist.', ], [ 'errorCode' => 'Instance.ImageUnsupported', 'errorMessage' => 'A non-centralized image does not support this type of operation.', ], [ 'errorCode' => 'Instance.PhysicalNodeNotExist', 'errorMessage' => 'The instance physical node does not exist.', ], [ 'errorCode' => 'ImageCreateByInstance.TaskExist', 'errorMessage' => 'The image task of instance creation already exists.', ], [ 'errorCode' => 'ExceedBuilderQuota', 'errorMessage' => 'The maximum number of builders is reached.', ], [ 'errorCode' => 'InvalidBaseImage.NotConfigured', 'errorMessage' => 'Configuration required for Vhd/Container images.', ], [ 'errorCode' => 'CreateDesktopImageRecord.Failed', 'errorMessage' => 'Create cloud computer image failed.', ], [ 'errorCode' => 'Image.NotExist', 'errorMessage' => 'The image does not exist.', ], [ 'errorCode' => 'ImageRegionDistribute.NotAllow', 'errorMessage' => 'This image cannot be distributed.', ], [ 'errorCode' => 'ImageUpdateFailed.NotAllow', 'errorMessage' => 'The image is not allowed to be modified.', ], [ 'errorCode' => 'ImageUpdateSharedImageFailed.NotAllow', 'errorMessage' => 'The shared image is not allowed to be modified.', ], [ 'errorCode' => 'ParentImageRegionDistribute.NotExist', 'errorMessage' => 'The target distribution region of the parent image does not exist.', ], [ 'errorCode' => 'InternalError', 'errorMessage' => 'Internal error.', ], [ 'errorCode' => 'ImageDistribute.TargetDistributeRegionListEmpty', 'errorMessage' => 'The target distribution region list is empty.', ], [ 'errorCode' => 'ImageDistribute.ImageNotSupport', 'errorMessage' => 'The image does not support region distribution.', ], [ 'errorCode' => 'ImageDistribute.RepeatedDistribution', 'errorMessage' => 'This image has been distributed to this region.', ], [ 'errorCode' => 'ImageDistribute.Undistributed', 'errorMessage' => 'The image has not been distributed to any region.', ], [ 'errorCode' => 'ImageRegion.NotConfigured', 'errorMessage' => 'The image does not have any region configuration.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"tid-06xnr5lyp77e7****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"419F31B9-1FDF-5644-ABA3-D00026FA****\\"\\n}","type":"json"}]', 'title' => '发起镜像地域复制任务', 'summary' => '发起镜像复制到其他地域的任务。', ], 'DeleteImage' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '219749', 'abilityTreeNodes' => [ 'FEATUREappstreamingSH8DGI', ], ], 'parameters' => [ [ 'name' => 'ImageId', 'in' => 'formData', 'schema' => [ 'title' => '镜像名称', 'description' => '无影镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'img-bp13mu****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResult', 'description' => '请求返回结构体。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '删除是否成功。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '删除成功', 'false' => '删除失败', ], 'example' => 'true', ], 'Success' => [ 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '状态码：'."\n" ."\n" .'- `200`：成功。'."\n" .'- `400`：出错。', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'Internal error.', ], [ 'errorCode' => 'Image.NotExist', 'errorMessage' => 'The image does not exist.', ], [ 'errorCode' => 'ImageDeleteFailed.NotAllow', 'errorMessage' => 'The image is not allowed to be deleted.', ], [ 'errorCode' => 'ImageDeleteFailed.NotAllowCommunityParent', 'errorMessage' => 'The parent image of a community image is not allowed to be deleted.', ], [ 'errorCode' => 'ImageDeleteFailed.NotAllowSharedImage', 'errorMessage' => 'The shared image is not allowed to be deleted.', ], [ 'errorCode' => 'ImageNotAllowDelete', 'errorMessage' => 'The image cannot be deleted, because shared cloud computers already exist.', ], [ 'errorCode' => 'InvalidImageOperation.ImageIsCreating', 'errorMessage' => 'Failed to operation the image, it is creating.', ], [ 'errorCode' => 'DeleteTemplate.Failed', 'errorMessage' => 'Delete template failed.', ], [ 'errorCode' => 'QueryTemplate.Failed', 'errorMessage' => 'Query template failed.', ], [ 'errorCode' => 'InvalidTemplate.NotFound', 'errorMessage' => 'Template not found.', ], [ 'errorCode' => 'ImageDeleteFailed.HasSharedImage', 'errorMessage' => 'The shared image is not allowed to be deleted.', ], ], 500 => [ [ 'errorCode' => 'ServiceUnavailable', 'errorMessage' => 'Service unavailable. Please try again later.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '删除自定义镜像', 'summary' => '删除一个自定义的无影镜像', 'description' => '- 只能删除用户所属的自定义镜像。'."\n" .'- 针对产品线是无影云电脑池，无影云应用，无影工作站的镜像，确保没有无影实例使用该镜像，才能正常删除。'."\n" .'- 无影云桌面模板引用镜像，在删除镜像的时候会将模板也一起删除。'."\n" .'- 针对镜像包含多个地域的，删除镜像时所有地域的镜像都会删除。', ], 'CreateAppInstanceGroup' => [ 'summary' => '创建交付组。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '134193', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'AppCenterImageId', 'in' => 'formData', 'schema' => [ 'description' => '应用镜像ID。可从[无影云应用控制台](https://appstreaming.console.aliyun.com/)的**运维**>**自定义镜像**或**系统镜像**页面获取。', 'type' => 'string', 'required' => true, 'example' => 'img-8z4nztpaqvay4****', ], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppInstanceGroupName', 'in' => 'formData', 'schema' => [ 'description' => '交付组名称。', 'type' => 'string', 'required' => false, 'example' => '办公应用', ], ], [ 'name' => 'Users', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '需添加到交付组分配用户的用户名称列表。', 'type' => 'array', 'items' => [ 'description' => '需添加到交付组分配用户的用户名称。格式为Users.N=`<用户名>`，其中N取值为大于0的整数。', 'type' => 'string', 'required' => false, 'example' => 'Users.1=username1'."\n" .'Users.2=username2', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '需添加到交付组分配用户的用户信息。如果填写了`Users`参数，则该字段为必需。', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '用户账号类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Simple' => '便捷账号', ], 'example' => 'Simple', ], ], 'required' => false, ], ], [ 'name' => 'ChargeType', 'in' => 'formData', 'schema' => [ 'description' => '付费方式。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'PostPaid' => '按量付费', 'PrePaid' => '包年包月', ], 'example' => 'PrePaid', ], ], [ 'name' => 'PromotionId', 'in' => 'formData', 'schema' => [ 'description' => '优惠ID。可通过[GetResourcePrice](~~428503~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => '17440009****', ], ], [ 'name' => 'AutoPay', 'in' => 'formData', 'schema' => [ 'description' => '是否自动付费。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '自动付费', 'false' => '手动付费 [默认值]', ], 'example' => 'false', ], ], [ 'name' => 'AutoRenew', 'in' => 'formData', 'schema' => [ 'description' => '是否自动续费。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '自动续费', 'false' => '手动续费 [默认值]', ], 'example' => 'false', ], ], [ 'name' => 'Period', 'in' => 'formData', 'schema' => [ 'description' => '当参数`ChargeType`取值为`PrePaid`时，该参数表示购买资源的时长，且为必填值。单位由`PeriodUnit`指定。'."\n" ."\n" .'- 如果`PeriodUnit`为`Week`，该参数的取值范围为：'."\n" ."\n" .' - 1'."\n" ."\n" .'- 如果`PeriodUnit`为`Month`，该参数的取值范围为：'."\n" ."\n" .' - 1'."\n" .' - 2'."\n" .' - 3'."\n" .' - 6'."\n" ."\n" .'- 如果`PeriodUnit`为`Year`，该参数的取值范围为：'."\n" ."\n" .' - 1'."\n" .' - 2'."\n" .' - 3'."\n" ."\n" .'> 当参数`ChargeType`取值为`PostPaid`时，该参数请填写固定值1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PeriodUnit', 'in' => 'formData', 'schema' => [ 'description' => '当参数`ChargeType`取值为`PrePaid`时，该参数表示购买资源的时长单位。'."\n" ."\n" .'> 该参数区分大小写。例如，`Week`是有效的，`week`是无效的。'."\n" .'另外，如果请求参数不符合上述搭配，例如`2 Week`，虽然调用本接口会成功，但最终在下单阶段会出错。'."\n" ."\n" .'> 当参数`ChargeType`取值为`PostPaid`时，该参数请填写固定值`Month`。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Month' => '月', 'Year' => '年', 'Week' => '周', ], 'example' => 'Week', ], ], [ 'name' => 'SessionTimeout', 'in' => 'formData', 'schema' => [ 'description' => '应用回收时间，单位为分钟。终端用户将云应用断开连接一段时间后，云上应用进程即退出，这段时间就是应用回收时间。如果永不回收，则填写`-1`。取值范围：-1和3~300，且值为整数。默认值为`15`。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '300', 'example' => '15', ], ], [ 'name' => 'BizRegionId', 'in' => 'formData', 'schema' => [ 'description' => '交付组所属的地域ID。关于支持的地域详情，请参见[使用限制](~~426036~~)。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'cn-shanghai' => '华东2（上海）', 'cn-hangzhou' => '华东1（杭州）', ], 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ChargeResourceMode', 'in' => 'formData', 'schema' => [ 'description' => '售卖模式。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Node' => '按资源售卖', ], 'example' => 'Node', ], ], [ 'name' => 'NodePool', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '节点池对象。', 'type' => 'object', 'properties' => [ 'NodeInstanceType' => [ 'description' => '购买资源的规格类型ID，可通过[ListNodeInstanceType](~~428502~~)接口获取。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'appstreaming.vgpu.8c16g.4g' => '无影-图形型_8核16G 4G显存', 'appstreaming.general.8c16g' => '无影-通用型_8核16G', 'appstreaming.general.4c8g' => '无影-通用型_4核8G', 'appstreaming.vgpu.14c93g.12g' => '无影-图形型_14核93G 12G显存', 'appstreaming.vgpu.8c31g.16g' => '无影-图形型_8核31G 16G显存', ], 'example' => 'appstreaming.general.4c8g', ], 'NodeAmount' => [ 'description' => '购买资源的数量。取值范围：1~100。'."\n" ."\n" .'>- 若为包年包月资源，则该参数必填。'."\n" .'>- 若为按量付费资源，则当弹性模式（`StrategyType`）为固定数量（`NODE_FIXED`）或自动扩缩容（`NODE_SCALING_BY_USAGE`）时该参数必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'NodeCapacity' => [ 'description' => '并发会话数，即单个资源可同时连接的会话数。如果同时连接的会话数过多，可能导致应用的使用体验下降。取值范围因资源规格不同而不同。各资源规格对应的取值范围可通过ListNodeInstanceType接口获取。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'StrategyType' => [ 'description' => '弹性模式。'."\n" ."\n" .'> '."\n" .'>- `NODE_FIXED`（固定数量）：适用于包年包月资源和按量付费资源。'."\n" .'>- `NODE_SCALING_BY_USAGE`（自动扩缩容）：适用于包年包月资源和按量付费资源。'."\n" .'>- `NODE_SCALING_BY_SCHEDULE`（定时扩缩容）：仅适用于按量付费资源。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'NODE_FIXED' => '固定数量（不使用弹性扩缩容）', 'NODE_SCALING_BY_SCHEDULE' => '定时扩缩容', 'NODE_SCALING_BY_USAGE' => '自动扩缩容', ], 'example' => 'NODE_FIXED', ], 'MaxScalingAmount' => [ 'description' => '扩容时最多创建资源的数量。`StrategyType`设为`NODE_SCALING_BY_USAGE`（使用弹性资源）时，该字段必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], 'MaxIdleAppInstanceAmount' => [ 'description' => '空闲会话数上限。指定该值时，当会话使用率超过`ScalingUsageThreshold`且当前交付组空闲会话数小于`MaxIdleAppInstanceAmount`时，才会触发自动扩容，否则认为交付组空闲会话已足够使用，不自动扩容。该参数可用于灵活控制弹性扩容行为和降低使用成本。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], 'ScalingStep' => [ 'description' => '扩容时每次创建资源的数量。取值范围：1~10。`StrategyType`设为`NODE_SCALING_BY_USAGE`（使用弹性资源）时，该字段必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'ScalingUsageThreshold' => [ 'description' => '会话使用率上限阈值（%）。当会话使用率超过该阈值时，将触发自动扩容。会话使用率的计算公式为`会话使用率=当前会话数÷(资源总数×资源并发会话数)×100%`。`StrategyType`设为`NODE_SCALING_BY_USAGE`（使用弹性资源）时，该字段必填。取值范围：0~100。默认值：85。', 'type' => 'string', 'required' => false, 'example' => '85', ], 'ScalingDownAfterIdleMinutes' => [ 'description' => '无会话连接的资源最多保留的时长（分钟）。当资源内无会话连接时，将按照此处设置的时长开始倒计时，倒计时结束时将完成缩容。取值范围：5\\~120。默认值：5。但有以下例外情况：'."\n" ."\n" .'- 若缩容后将导致重新触发自动扩容，则不会执行缩容，以免导致反复产生缩容、扩容。'."\n" .'- 若此时间段内，因会话数增加而触发自动扩容，则该资源不会按原计划缩容，倒计时也将重新开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], 'StrategyEnableDate' => [ 'description' => '策略生效日期。格式为：yyyy-MM-dd。该日期必须大于或等于当前日期。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => '2022-08-01', ], 'StrategyDisableDate' => [ 'description' => '策略失效日期。格式为：yyyy-MM-dd。失效日期与生效日期的间隔必须介于7天到1年之间（含7天和1年）。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => '2022-09-08', ], 'WarmUp' => [ 'description' => '是否开启资源预热策略。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'RecurrenceSchedules' => [ 'description' => '策略执行周期列表。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期。', 'type' => 'object', 'properties' => [ 'RecurrenceType' => [ 'description' => '策略执行周期的类型。必须同时指定`RecurrenceType`和`RecurrenceValues`。 ', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'weekly' => '周（每周指定几天重复执行一次定时任务）', ], 'example' => 'weekly', ], 'RecurrenceValues' => [ 'description' => '策略执行周期的数值列表。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期的数值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ 1 => '周一', '周二', '周三', '周四', '周五', '周六', '周日', ], 'example' => '1', ], 'required' => false, 'maxItems' => 7, ], 'TimerPeriods' => [ 'description' => '策略执行周期的时间段列表。时间段设置要求：'."\n" ."\n" .'- 最多可添加3个时间段。'."\n" .'- 时间段之间不重叠。'."\n" .'- 时间段之间的间隔大于或等于5分钟。'."\n" .'- 单个时间段的时长大于或等于15分钟。'."\n" .'- 所有时间段累计不跨天。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期的时间段。', 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => '开始时间。格式为HH:mm。', 'type' => 'string', 'required' => false, 'example' => '12:00', ], 'EndTime' => [ 'description' => '结束时间。格式为HH:mm。', 'type' => 'string', 'required' => false, 'example' => '15:00', ], 'Amount' => [ 'description' => '资源数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 5, ], ], 'required' => false, ], 'required' => false, 'maxItems' => 7, ], ], 'required' => false, ], ], [ 'name' => 'Network', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '网络配置。'."\n" ."\n" .'> 如需使用该参数，请提交工单。', 'type' => 'object', 'properties' => [ 'StrategyType' => [ 'description' => '网络策略类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Mixed' => '混合模式，单VPC、双网卡+独立公网IP', 'Shared' => '共享模式，单网卡、NAT网管访问公网', ], 'example' => 'Shared', ], 'Routes' => [ 'description' => '路由配置。仅当网络策略类型（`StrategyType`）的值为混合模式（`Mixed`）时可配置。', 'type' => 'array', 'items' => [ 'description' => '路由配置。', 'type' => 'object', 'properties' => [ 'Destination' => [ 'description' => '访问目标。CIDR格式。', 'type' => 'string', 'required' => false, 'example' => '139.196.XX.XX/32', ], 'Mode' => [ 'description' => '网络出口模式。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Shared' => '通过NAT网管访问', ], 'example' => 'Shared', ], ], 'required' => false, ], 'required' => false, ], 'IpExpireMinutes' => [ 'description' => '公网IP地址使用时长超过这个值时，在下次登录时就会触发IP地址更新。最小值为60。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '60', 'example' => '60', ], 'OfficeSiteId' => [ 'description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong+dir-842567****', ], 'VSwitchIds' => [ 'description' => '虚拟交换机ID列表。'."\n" ."\n" .'- 仅定制办公网络有效.', 'type' => 'array', 'items' => [ 'description' => '虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-m5ef1sjhf7bbvqvvy****', ], 'required' => false, ], 'DomainRules' => [ 'description' => '域名规则配置。', 'type' => 'array', 'items' => [ 'description' => '域名规则。', 'type' => 'object', 'properties' => [ 'Domain' => [ 'description' => '域名。', 'type' => 'string', 'required' => false, 'example' => 'www.example.com', ], 'Policy' => [ 'description' => '策略值。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'allow' => '允许访问', 'block' => '禁止访问', ], 'example' => 'block', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'StoragePolicy', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '存储策略。', 'type' => 'object', 'properties' => [ 'StorageTypeList' => [ 'description' => '存储类型列表。', 'type' => 'array', 'items' => [ 'description' => '存储类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'OFF' => '关闭', 'PDS' => '网盘与相册服务（Drive and Photo Service）', ], 'example' => 'PDS', ], 'required' => false, ], 'UserProfile' => [ 'description' => '用户数据漫游配置。', 'type' => 'object', 'properties' => [ 'UserProfileSwitch' => [ 'description' => '用户数据漫游开关。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'false' => '关闭', 'true' => '开启', ], 'example' => 'false', ], 'RemoteStorageType' => [ 'description' => '用户数据漫游使用的远程存储类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'NAS' => 'NAS', ], 'example' => 'NAS', ], 'RemoteStoragePath' => [ 'description' => '用户数据漫游远程存储路径。'."\n" .'- 不填写时，默认为交付组id。'."\n" .'- 跨交付组（同VPC）用户数据漫游时，需给漫游的多个交付组设置同一个值。', 'type' => 'string', 'required' => false, 'example' => 'ID20250101', ], ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'PreOpenAppId', 'in' => 'formData', 'schema' => [ 'description' => '预开的AppId。', 'type' => 'string', 'required' => false, 'example' => 'cag-b2ronxxd****', ], ], [ 'name' => 'VideoPolicy', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '显示策略。', 'type' => 'object', 'properties' => [ 'FrameRate' => [ 'description' => '帧率（FPS）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ 30 => '30 FPS', 60 => '60 FPS', ], 'example' => '60', ], 'TerminalResolutionAdaptive' => [ 'description' => '是否使用自适应分辨率。'."\n" ."\n" .'- `true`：会话分辨率跟随终端显示区域变化。此时`SessionResolutionWidth`和`SessionResolutionHeight`为分辨率变化的最大值。'."\n" ."\n" .'- `false`：会话分辨率不跟随终端显示区域变化。此时分辨率固定为`SessionResolutionWidth`和`SessionResolutionHeight`的值。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'SessionResolutionWidth' => [ 'description' => '分辨率的宽度，单位为像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1920', ], 'SessionResolutionHeight' => [ 'description' => '分辨率的高度，单位为像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1080', ], 'StreamingMode' => [ 'description' => '流模式。与`Webrtc`参数搭配表示协议类型。'."\n" ."\n" .'- `Webrtc`=`true`且`StreamingMode`=`video`，表示WebRTC流。'."\n" .'- `Webrtc`=`false`且`StreamingMode`=`video`，表示视频流。'."\n" .'- `Webrtc`=`false`且`StreamingMode`=`mix`，表示混合流。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'video' => '视频流', 'mix' => '混合流', ], 'example' => 'video', ], 'Webrtc' => [ 'description' => '是否开启WebRTC。与`StreamingMode`参数搭配表示协议类型。'."\n" ."\n" .'- `Webrtc`=`true`且`StreamingMode`=`video`，表示WebRTC流。'."\n" .'- `Webrtc`=`false`且`StreamingMode`=`video`，表示视频流。'."\n" .'- `Webrtc`=`false`且`StreamingMode`=`mix`，表示混合流。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], 'required' => false, ], ], [ 'name' => 'RuntimePolicy', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '运行时策略。', 'type' => 'object', 'properties' => [ 'SessionType' => [ 'description' => '会话类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'CONSOLE' => 'Console会话', 'NORMAL' => 'RDP会话', ], 'example' => 'NORMAL', ], 'DebugMode' => [ 'description' => '是否开启调试模式。如需调用`GetDebugAppInstance`和`CreateImageFromAppInstanceGroup`，则必须将此字段设为`ON`。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'OFF' => '关闭', 'ON' => '开启', ], 'example' => 'OFF', ], 'SessionUserGenerationMode' => [ 'description' => 'Session用户的生成模式。'."\n" .'- wyid，此时预开sessionPreOpen必须设置为false。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'wyid' => 'wyid', ], 'example' => 'wyid', ], 'SessionPreOpen' => [ 'description' => 'Session预开开关。'."\n" .'- 不填写，默认是true', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'true' => '开启', 'false' => '关闭', ], 'example' => 'false', ], 'PerSessionPerApp' => [ 'description' => '一个会话内只允许打开一个应用。'."\n" .'- 开启后，如果打开交付组内的多个应用，将会为每个应用分配一个会话，消耗更多的会话数量。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '开启', 'false' => '关闭', ], 'example' => 'false', ], 'PersistentAppInstanceScheduleMode' => [ 'title' => '持久会话调度模式。'."\n" .'DYNAMIC：动态调度 - 同一个持久会话可调度到不同节点上。'."\n" .'FIX_NODE：固定节点调度 - 同一个持久会话只能调度到固定的节点上。', 'description' => '持久会话调度模式。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'DYNAMIC' => '动态调度 - 同一个持久会话可调度到不同节点上', 'FIX_NODE' => '固定节点调度 - 同一个持久会话只能调度到固定的节点上', ], 'example' => 'DYNAMIC', 'default' => 'DYNAMIC', 'enum' => [ 'DYNAMIC', 'FIX_NODE', ], ], ], 'required' => false, ], ], [ 'name' => 'SecurityPolicy', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '安全策略。', 'type' => 'object', 'properties' => [ 'ResetAfterUnbind' => [ 'description' => '解绑后是否重置。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '重置', 'false' => '不重置', ], 'example' => 'true', ], 'SkipUserAuthCheck' => [ 'description' => '是否跳过用户授权校验。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '不校验', 'false' => '校验 [默认值]', ], 'example' => 'false', ], ], 'required' => false, ], ], [ 'name' => 'UserDefinePolicy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '用户自定义策略', 'type' => 'object', 'properties' => [ 'CustomConfig' => [ 'description' => '自定义策略内容，需要满足镜像版本规范，如需使用该参数，请提交工单申请开启白名单。', 'type' => 'string', 'required' => false, 'example' => '[{"target":"agent","config":{"abc":"xxx"}}]', ], ], 'required' => false, ], ], [ 'name' => 'AppPolicyId', 'in' => 'formData', 'schema' => [ 'description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-0clfzcy0adpcf****', ], ], [ 'name' => 'ClusterId', 'in' => 'formData', 'schema' => [ 'description' => '集群ID', 'type' => 'string', 'required' => false, 'example' => 'cls-d39iq73l5c0a8****', ], ], [ 'name' => 'SubPayType', 'in' => 'formData', 'schema' => [ 'description' => '付费方式子类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'postPaid' => '后付费[按量]', 'monthPackage' => '套餐包[仅云浏览器支持]', 'prePaid' => '预付费[包年包月]', ], 'example' => 'postPaid', ], ], [ 'name' => 'AppPackageType', 'in' => 'formData', 'schema' => [ 'description' => '套餐包类型。', 'type' => 'string', 'required' => false, 'example' => 'browser.package.5.250.appstreaming.general.basic', ], ], [ 'name' => 'AuthMode', 'in' => 'formData', 'schema' => [ 'title' => '交付组授权模式。', 'description' => '交付组授权模式。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'App' => '应用授权', 'AppInstanceGroup' => '交付组授权', 'Session' => '持久会话授权', ], 'example' => 'App', 'default' => 'App', 'enum' => [ 'App', 'Session', 'AppInstanceGroup', ], ], ], [ 'name' => 'UserGroupIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '授权用户组ID列表。', 'description' => '授权用户组ID列表。', 'type' => 'array', 'items' => [ 'title' => '授权用户组ID。', 'description' => '授权用户组ID。', 'type' => 'string', 'required' => false, ], 'required' => false, 'maxItems' => 10, ], ], ], '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'AppInstanceGroupModel' => [ 'description' => '交付组。', 'type' => 'object', 'properties' => [ 'AppInstanceGroupId' => [ 'description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-9ciijz60n4xsv****', ], 'OrderId' => [ 'description' => '订单ID。', 'type' => 'string', 'example' => '12345****', ], 'NodePoolId' => [ 'description' => '资源组ID。如果同时创建了资源组，则返回该参数。', 'type' => 'string', 'example' => 'rg-ew7va2g1wl3vm****', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'StockError.NoStock', 'errorMessage' => 'The selected specification is out of stock. Please try again later or select other specifications.', ], ], 500 => [ [ 'errorCode' => 'StockError.InvalidResourceRequest', 'errorMessage' => 'Your request cannot be processed currently due to an error. Please try again later.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AppInstanceGroupModel\\": {\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"OrderId\\": \\"12345****\\",\\n \\"NodePoolId\\": \\"rg-ew7va2g1wl3vm****\\"\\n }\\n}","type":"json"}]', 'title' => '创建交付组', 'description' => '请确保在使用该接口前，已充分了解无影云应用的[计费方式和价格](~~426039~~)。'."\n" ."\n" .'交付组是向终端用户交付云应用的逻辑分组，包括底层依赖的云应用资源、包含云应用的镜像、资源管理策略以及用户分配设置等。详情参见[发布交付组](~~426046~~)。', ], 'GetAppInstanceGroup' => [ 'summary' => '查询指定交付组详细信息。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '150264', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'AppInstanceGroupId', 'in' => 'query', 'schema' => [ 'description' => '交付组ID。可调用接口[ListAppInstanceGroup](~~ListAppInstanceGroup~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], ], '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-67E1FC5F****', ], 'AppInstanceGroupModels' => [ 'title' => 'AppInstanceGroupModels', 'description' => 'AppInstanceGroupModels', 'type' => 'object', 'properties' => [ 'Apps' => [ 'description' => '应用信息列表。', 'type' => 'array', 'items' => [ 'description' => '应用信息。', 'type' => 'object', 'properties' => [ 'AppId' => [ 'description' => '应用ID。', 'type' => 'string', 'example' => 'ca-i87mycyn419nu****', ], 'AppName' => [ 'description' => '应用名称。', 'type' => 'string', 'example' => '办公应用', ], 'AppVersion' => [ 'description' => '应用版本。', 'type' => 'string', 'example' => '1.0.0', ], 'AppVersionName' => [ 'description' => '应用版本名称。', 'type' => 'string', 'example' => '初始版本', ], 'AppIcon' => [ 'description' => '应用图标。', 'type' => 'string', 'example' => 'https://app-center-icon-****.png', ], ], ], ], 'AppCenterImageId' => [ 'description' => '应用镜像ID。', 'type' => 'string', 'example' => 'img-8z4nztpaqvay4****', ], 'RegionId' => [ 'description' => '交付组所属的地域ID。关于支持的地域详情，请参见[使用限制](~~426036~~)。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ProductType' => [ 'description' => '产品类型。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'CloudApp', ], 'AppInstanceType' => [ 'description' => '交付组规格类型。', 'type' => 'string', 'example' => '__dynamic__', ], 'AppInstanceTypeName' => [ 'description' => '交付组规格类型名称', 'type' => 'string', 'example' => 'test001', ], 'AppInstanceGroupId' => [ 'description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-9ciijz60n4xsv****', ], 'Amount' => [ 'description' => '用户设置的包年包月资源的数量。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MinAmount' => [ 'description' => '实例数最小值。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MaxAmount' => [ 'description' => '实例数最大值。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ReserveAmountRatio' => [ 'description' => '预留实例百分比，即交付组中未使用的会话比例。取值范围为0~99。', 'type' => 'string', 'example' => '20', ], 'ReserveMinAmount' => [ 'description' => '最小预留实例数，即交付组中未使用会话的最小数量。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ReserveMaxAmount' => [ 'description' => '最大预留实例数，即交付组中未使用会话的最大数量。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ScalingStep' => [ 'description' => '扩容时每次创建会话的数量。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ScalingUsageThreshold' => [ 'description' => '会话使用率上限阈值（%）。当会话使用率超过该阈值时，将触发自动扩容。会话使用率的计算公式为会话使用率=当前使用中的会话数÷总会话数×100%。取值范围为0~99。', 'type' => 'string', 'example' => '85', ], 'ScalingDownAfterIdleMinutes' => [ 'description' => '无会话连接时长，单位为分钟。当资源内处于无会话连接状态达到此处设置的时长后，将触发自动缩容。最小值为0。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ChargeType' => [ 'description' => '付费方式。', 'type' => 'string', 'enumValueTitles' => [ 'PostPaid' => '按量付费', 'PrePaid' => '包年包月', ], 'example' => 'PrePaid', ], 'ChargeResourceMode' => [ 'description' => '售卖模式。', 'type' => 'string', 'enumValueTitles' => [ 'AppInstance' => '按会话售卖', 'Node' => '按资源售卖', ], 'example' => 'Node', ], 'GmtCreate' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2022-04-26T15:06:16.000+00:00', ], 'Status' => [ 'description' => '交付组状态。', 'type' => 'string', 'enumValueTitles' => [ 'PUBLISHED' => '发布成功', 'FAILED' => '发布失败', 'MAINTAIN_FAILED' => '更新失败', 'EXPIRED' => '已到期', 'MAINTAINING' => '更新中', 'CEASED' => '已欠费', 'EXPIRED_RECYCLING' => '过期回收中', 'DEPLOYING' => '发布中', ], 'example' => 'PUBLISHED', ], 'NodePool' => [ 'description' => '资源组信息。', 'type' => 'array', 'items' => [ 'description' => '资源组信息。', 'type' => 'object', 'properties' => [ 'NodePoolId' => [ 'description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-g6922kced36hx****', ], 'NodeInstanceType' => [ 'description' => '购买资源的规格类型ID。', 'type' => 'string', 'example' => 'appstreaming.vgpu.4c8g.2g', ], 'NodeAmount' => [ 'description' => '当前包年包月资源的总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeUsed' => [ 'description' => '使用中的包年包月资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeCapacity' => [ 'description' => '并发会话数，即单个资源可同时连接的会话数。如果同时连接的会话数过多，可能导致应用的使用体验下降。取值范围因资源规格不同而不同。各资源规格对应的取值范围分别是：'."\n" ."\n" .'- appstreaming.general.4c8g：1\\~2；'."\n" .'- appstreaming.general.8c16g：1\\~4；'."\n" .'- appstreaming.vgpu.8c16g.4g：1\\~4；'."\n" .'- appstreaming.vgpu.8c31g.16g：1\\~4；'."\n" .'- appstreaming.vgpu.14c93g.12g：1\\~6；', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ScalingNodeAmount' => [ 'description' => '弹性资源总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'ScalingNodeUsed' => [ 'description' => '使用中的弹性资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'StrategyType' => [ 'description' => '弹性策略类型。'."\n" ."\n" .'> `NODE_SCALING_BY_USAGE`（按用量伸缩策略）仅适用于`PrePaid`（包年包月）资源；`NODE_SCALING_BY_SCHEDULE`（定时伸缩策略）仅适用于`PostPaid`（按量付费）资源。', 'type' => 'string', 'enumValueTitles' => [ 'NODE_FIXED' => '不使用弹性资源', 'NODE_SCALING_BY_SCHEDULE' => '定时伸缩', 'NODE_SCALING_BY_USAGE' => '按用量伸缩策略', ], 'example' => 'NODE_FIXED', ], 'Amount' => [ 'description' => '创建交付组时购买资源的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'MaxScalingAmount' => [ 'description' => '扩容时最多创建资源的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'MaxIdleAppInstanceAmount' => [ 'description' => '空闲会话数上限。指定该值时，当会话使用率超过`ScalingUsageThreshold`且当前交付组空闲会话数小于`MaxIdleAppInstanceAmount`时，才会触发自动扩容，否则认为交付组空闲会话已足够使用，不自动扩容。该参数可用于灵活控制弹性扩容行为和降低使用成本。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'ScalingStep' => [ 'description' => '扩容时每次创建资源的数量。取值范围：1~10。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ScalingUsageThreshold' => [ 'description' => '会话使用率上限阈值（%）。当会话使用率超过该阈值时，将触发自动扩容。会话使用率的计算公式为`会话使用率=当前会话数÷(资源总数×资源并发会话数)×100%`。', 'type' => 'string', 'example' => '85', ], 'ScalingDownAfterIdleMinutes' => [ 'description' => '无会话连接时长，单位为分钟。当资源内处于无会话连接状态达到此处设置的时长后，将触发自动缩容。默认值：5。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'RecurrenceSchedules' => [ 'description' => '策略执行周期列表。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期。', 'type' => 'object', 'properties' => [ 'RecurrenceType' => [ 'description' => '策略执行周期的类型。必须同时指定`RecurrenceType`和`RecurrenceValues`。 ', 'type' => 'string', 'example' => 'Weekly', ], 'RecurrenceValues' => [ 'description' => '策略执行周期的数值列表。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期的数值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'TimerPeriods' => [ 'description' => '策略执行周期的时间段列表。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期的时间段。', 'type' => 'object', 'properties' => [ 'Amount' => [ 'description' => '目标资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'EndTime' => [ 'description' => '结束时间。格式为HH:mm', 'type' => 'string', 'example' => '11:00', ], 'StartTime' => [ 'description' => '开始时间。格式为HH:mm', 'type' => 'string', 'example' => '09:30', ], ], ], ], ], ], ], 'StrategyDisableDate' => [ 'description' => '策略失效日期。格式为：yyyy-MM-dd。', 'type' => 'string', 'example' => '2022-09-08', ], 'StrategyEnableDate' => [ 'description' => '策略生效日期。格式为：yyyy-MM-dd。', 'type' => 'string', 'example' => '2022-08-01', ], 'WarmUp' => [ 'description' => '是否开启资源预热策略。', 'type' => 'boolean', 'example' => 'false', ], 'NodeTypeName' => [ 'description' => '资源规格名称。', 'type' => 'string', 'example' => '无影-通用型_4核8G', ], ], ], ], 'SpecId' => [ 'description' => '与交付组ID唯一对应的ID。', 'type' => 'string', 'example' => 'spec-8o18t8uc31qib0****', ], 'SessionTimeout' => [ 'description' => '会话断连保留时长，单位为分钟。终端用户会话断开连接后，会话将保留此处设置的时长，然后再注销。如果始终保留，则填写`-1`。取值范围：-1和3~300。默认值为`15`。', 'type' => 'string', 'example' => '15', ], 'AppInstanceGroupName' => [ 'description' => '交付组名称。', 'type' => 'string', 'example' => '办公应用', ], 'ExpiredTime' => [ 'description' => '交付组到期时间。', 'type' => 'string', 'example' => '2022-04-27T16:00:00.000+00:00', ], 'OtaInfo' => [ 'description' => 'OTA升级任务信息。', 'type' => 'object', 'properties' => [ 'OtaVersion' => [ 'title' => '当前ota版本', 'description' => '当前OTA版本。', 'type' => 'string', 'example' => '0.0.1-D-20220615.11****', ], 'NewOtaVersion' => [ 'title' => '新ota版本,为空表示没有新版本', 'description' => '新的OTA版本。为空表示没有新版本。', 'type' => 'string', 'example' => '0.0.1-D-20220630.11****', ], 'TaskId' => [ 'title' => '任务id', 'description' => 'OTA升级任务ID。', 'type' => 'string', 'example' => 'ota-e49929gv8acz5****', ], ], ], 'OsType' => [ 'title' => '系统类型', 'description' => '系统类型。', 'type' => 'string', 'example' => 'Windows', 'enum' => [ 'Windows', 'Linux', 'Android', ], ], 'AppCenterImageName' => [ 'description' => '应用镜像名称。', 'type' => 'string', 'example' => 'OfficeApps', ], 'ResourceStatus' => [ 'description' => '资源状态。', 'type' => 'string', 'example' => 'AVAILABLE', ], 'OfficeSiteId' => [ 'description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-beijing+dir-172301****'."\n", ], 'AppPolicyId' => [ 'description' => '应用策略ID。', 'type' => 'string', 'example' => 'pg-g3k5wa2ms2****', ], 'SkipUserAuthCheck' => [ 'description' => '是否跳过用户授权校验。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '不校验', 'false' => '校验 [默认值]', ], 'example' => 'false', ], 'SessionType' => [ 'description' => '会话类型。', 'type' => 'string', 'enumValueTitles' => [ 'CONSOLE' => 'Console会话', 'NORMAL' => 'RDP会话', ], 'example' => 'NORMAL', ], 'Tags' => [ 'title' => '资源标签列表。', 'description' => '资源标签列表。', 'type' => 'array', 'items' => [ 'title' => '资源标签。', 'description' => '资源标签。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'example' => 'department', ], 'Value' => [ 'title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'example' => 'design', ], 'Scope' => [ 'title' => '标签类型。取值范围：'."\n" .'Custom：自定义标签。'."\n" .'System：系统标签。', 'description' => '标签类型。', 'type' => 'string', 'enumValueTitles' => [ 'Custom' => '自定义标签', 'System' => '系统标签', ], 'example' => 'Custom', ], ], ], ], 'AuthMode' => [ 'title' => '授权模式。', 'description' => '授权模式。', 'type' => 'string', 'enumValueTitles' => [ 'App' => '应用授权', 'AppInstanceGroup' => '交付组授权', 'Session' => '会话授权', ], 'example' => 'App', 'default' => 'App', 'enum' => [ 'App', 'Session', 'AppInstanceGroup', ], ], 'AccessType' => [ 'title' => '接入类型。', 'description' => '接入类型。', 'type' => 'string', 'enumValueTitles' => [ 'INTERNET' => '互联网', 'VPC' => '企业专网（VPC）', 'ANY' => '互联网和企业专网（VPC）', ], 'example' => 'INTERNET', 'default' => 'INTERNET', 'enum' => [ 'INTERNET', 'VPC', 'ANY', ], ], 'SupportUserGroupMixedAuth' => [ 'title' => '是否支持用户和用户组混合授权。', 'description' => '是否支持用户和用户组混合授权。', 'type' => 'boolean', 'default' => 'true', ], 'UserGroupAuthMode' => [ 'title' => '用户和用户组授权模式。', 'description' => '用户和用户组授权模式。', 'type' => 'string', 'example' => 'Mixed', 'default' => 'Mixed', 'enum' => [ 'Mixed', 'User', 'UserGroup', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AppInstanceGroupModels\\": {\\n \\"Apps\\": [\\n {\\n \\"AppId\\": \\"ca-i87mycyn419nu****\\",\\n \\"AppName\\": \\"办公应用\\",\\n \\"AppVersion\\": \\"1.0.0\\",\\n \\"AppVersionName\\": \\"初始版本\\",\\n \\"AppIcon\\": \\"https://app-center-icon-****.png\\"\\n }\\n ],\\n \\"AppCenterImageId\\": \\"img-8z4nztpaqvay4****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ProductType\\": \\"CloudApp\\",\\n \\"AppInstanceType\\": \\"__dynamic__\\",\\n \\"AppInstanceTypeName\\": \\"test001\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"Amount\\": 1,\\n \\"MinAmount\\": 1,\\n \\"MaxAmount\\": 10,\\n \\"ReserveAmountRatio\\": \\"20\\",\\n \\"ReserveMinAmount\\": 1,\\n \\"ReserveMaxAmount\\": 5,\\n \\"ScalingStep\\": 10,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"ChargeResourceMode\\": \\"Node\\",\\n \\"GmtCreate\\": \\"2022-04-26T15:06:16.000+00:00\\",\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"NodePool\\": [\\n {\\n \\"NodePoolId\\": \\"rg-g6922kced36hx****\\",\\n \\"NodeInstanceType\\": \\"appstreaming.vgpu.4c8g.2g\\",\\n \\"NodeAmount\\": 1,\\n \\"NodeUsed\\": 1,\\n \\"NodeCapacity\\": 2,\\n \\"ScalingNodeAmount\\": 8,\\n \\"ScalingNodeUsed\\": 4,\\n \\"StrategyType\\": \\"NODE_FIXED\\",\\n \\"Amount\\": 2,\\n \\"MaxScalingAmount\\": 8,\\n \\"MaxIdleAppInstanceAmount\\": 3,\\n \\"ScalingStep\\": 2,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"RecurrenceSchedules\\": [\\n {\\n \\"RecurrenceType\\": \\"Weekly\\",\\n \\"RecurrenceValues\\": [\\n 1\\n ],\\n \\"TimerPeriods\\": [\\n {\\n \\"Amount\\": 5,\\n \\"EndTime\\": \\"11:00\\",\\n \\"StartTime\\": \\"09:30\\"\\n }\\n ]\\n }\\n ],\\n \\"StrategyDisableDate\\": \\"2022-09-08\\",\\n \\"StrategyEnableDate\\": \\"2022-08-01\\",\\n \\"WarmUp\\": false,\\n \\"NodeTypeName\\": \\"无影-通用型_4核8G\\"\\n }\\n ],\\n \\"SpecId\\": \\"spec-8o18t8uc31qib0****\\",\\n \\"SessionTimeout\\": \\"15\\",\\n \\"AppInstanceGroupName\\": \\"办公应用\\",\\n \\"ExpiredTime\\": \\"2022-04-27T16:00:00.000+00:00\\",\\n \\"OtaInfo\\": {\\n \\"OtaVersion\\": \\"0.0.1-D-20220615.11****\\",\\n \\"NewOtaVersion\\": \\"0.0.1-D-20220630.11****\\",\\n \\"TaskId\\": \\"ota-e49929gv8acz5****\\"\\n },\\n \\"OsType\\": \\"Windows\\",\\n \\"AppCenterImageName\\": \\"OfficeApps\\",\\n \\"ResourceStatus\\": \\"AVAILABLE\\",\\n \\"OfficeSiteId\\": \\"cn-beijing+dir-172301****\\\\n\\",\\n \\"AppPolicyId\\": \\"pg-g3k5wa2ms2****\\",\\n \\"SkipUserAuthCheck\\": false,\\n \\"SessionType\\": \\"NORMAL\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"design\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"AuthMode\\": \\"App\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"SupportUserGroupMixedAuth\\": true,\\n \\"UserGroupAuthMode\\": \\"Mixed\\"\\n }\\n}","type":"json"}]', 'title' => '查询指定交付组详细信息', ], 'ListAppInstanceGroup' => [ 'summary' => '查询多个交付组详细信息，即不指定特定的交付组，而是查询所有满足条件的交付组的详细信息。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '134196', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页的查询结果数量，不可超过`100`。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '20', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '需展示的查询结果页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Status', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '交付组状态列表。', 'type' => 'array', 'items' => [ 'description' => '交付组状态。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PUBLISHED' => '发布成功', 'FAILED' => '发布失败', 'MAINTAIN_FAILED' => '更新失败', 'EXPIRED' => '已到期', 'MAINTAINING' => '更新中', 'CEASED' => '已欠费', 'EXPIRED_RECYCLING' => '过期回收中', 'DEPLOYING' => '发布中', ], 'example' => '"Status.1":"PUBLISHED","Status.2":"FAILED"', ], 'required' => false, 'maxItems' => 1000, ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'query', 'schema' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => false, 'example' => 'aig-9ciijz60n4xsv****', ], ], [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppInstanceGroupName', 'in' => 'query', 'schema' => [ 'description' => '交付组名称，查询时采用模糊匹配规则。例如，假设填写的交付组名称为`办公应用`，则名称中包含`办公应用`的交付组都会被查询到，例如名为`我的办公应用`、`办公应用A`的交付组。', 'type' => 'string', 'required' => false, 'example' => '办公应用', ], ], [ 'name' => 'AppCenterImageId', 'in' => 'query', 'schema' => [ 'title' => '应用中心镜像ID', 'description' => '应用镜像ID，可从无影云应用控制台的镜像管理页面获取。', 'type' => 'string', 'required' => false, 'example' => 'img-8z4nztpaqvay4****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => '地域ID', 'description' => '地域ID。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'BizRegionId', 'in' => 'query', 'schema' => [ 'description' => '交付组所属的地域ID。关于支持的地域详情，请参见[使用限制](~~426036~~)。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'cn-shanghai' => '华东2（上海）', 'cn-hangzhou' => '华东1（杭州）', ], 'example' => 'cn-hangzhou', ], ], [ 'name' => 'NodeInstanceType', 'in' => 'query', 'schema' => [ 'description' => '购买资源的规格类型ID。可通过[ListNodeInstanceType](~~ListNodeInstanceType~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => 'appstreaming.vgpu.4c8g.2g', ], ], [ 'name' => 'OfficeSiteId', 'in' => 'query', 'schema' => [ 'description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong+dir-643067****', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'title' => '标签列表。', 'description' => '标签列表。', 'type' => 'array', 'items' => [ 'title' => '标签。', 'description' => '标签。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'department', ], 'Value' => [ 'title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'design', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, 'minItems' => 0, ], ], [ 'name' => 'UserGroupIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '授权用户组ID列表。', 'description' => '授权用户组ID列表。', 'type' => 'array', 'items' => [ 'title' => '授权用户组ID。', 'description' => '授权用户组ID。', 'type' => 'string', 'required' => false, ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'ExcludedUserGroupIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '排除授权用户组ID列表。', 'description' => '排除授权用户组ID列表。', 'type' => 'array', 'items' => [ 'title' => '排除授权用户组ID。', 'description' => '排除授权用户组ID。', 'type' => 'string', 'required' => false, ], 'required' => false, 'maxItems' => 10, ], ], ], '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-67E1FC5F****', ], 'TotalCount' => [ 'description' => '查询结果的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'PageSize' => [ 'description' => '每页的查询结果数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'description' => '当前展示的查询结果页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AppInstanceGroupModels' => [ 'title' => 'AppInstanceGroupModels', 'description' => '交付组信息。', 'type' => 'array', 'items' => [ 'description' => '交付组信息。', 'type' => 'object', 'properties' => [ 'Apps' => [ 'description' => '应用信息。', 'type' => 'array', 'items' => [ 'description' => '应用信息。', 'type' => 'object', 'properties' => [ 'AppId' => [ 'description' => '应用ID。', 'type' => 'string', 'example' => 'ca-i87mycyn419nu****', ], 'AppName' => [ 'description' => '应用名称。', 'type' => 'string', 'example' => '办公应用', ], 'AppVersion' => [ 'description' => '应用版本。', 'type' => 'string', 'example' => '1.0.0', ], 'AppVersionName' => [ 'description' => '应用版本名称。', 'type' => 'string', 'example' => '初始版本', ], 'AppIcon' => [ 'description' => '应用图标。', 'type' => 'string', 'example' => 'https://app-center-icon-****.png', ], ], ], ], 'AppCenterImageId' => [ 'description' => '应用镜像ID。', 'type' => 'string', 'example' => 'img-8z4nztpaqvay4****', ], 'RegionId' => [ 'description' => '交付组所属的地域ID。关于支持的地域详情，请参见[使用限制](~~426036~~)。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'cn-hangzhou', ], 'ProductType' => [ 'description' => '产品类型。', 'type' => 'string', 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], 'AppInstanceType' => [ 'description' => '交付组规格类型。', 'type' => 'string', 'example' => '__dynamic__', ], 'AppInstanceGroupId' => [ 'description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-9ciijz60n4xsv****', ], 'Amount' => [ 'description' => '用户设置的包年包月资源的数量。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MinAmount' => [ 'description' => '实例数最小值。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MaxAmount' => [ 'description' => '实例数最大值。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ReserveAmountRatio' => [ 'description' => '预留实例百分比，即交付组中未使用的会话比例。取值范围为0~99。', 'type' => 'string', 'example' => '20', ], 'ReserveMinAmount' => [ 'description' => '最小预留实例数，即交付组中未使用会话的最小数量。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ReserveMaxAmount' => [ 'description' => '最大预留实例数，即交付组中未使用会话的最大数量。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ScalingStep' => [ 'description' => '扩容时每次创建会话的数量。最小值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ScalingUsageThreshold' => [ 'description' => '会话使用率上限阈值（%）。当会话使用率超过该阈值时，将触发自动扩容。会话使用率的计算公式为会话使用率=当前使用中的会话数÷总会话数×100%。取值范围为0~99。', 'type' => 'string', 'example' => '85', ], 'ScalingDownAfterIdleMinutes' => [ 'description' => '无会话连接时长，单位为分钟。当资源内处于无会话连接状态达到此处设置的时长后，将触发自动缩容。最小值为0。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ChargeType' => [ 'description' => '付费方式。', 'type' => 'string', 'enumValueTitles' => [ 'PostPaid' => '按量付费', 'PrePaid' => '包年包月', ], 'example' => 'PrePaid', ], 'GmtCreate' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2022-04-26T15:06:16.000+00:00', ], 'Status' => [ 'description' => '交付组状态。', 'type' => 'string', 'enumValueTitles' => [ 'PUBLISHED' => '发布成功', 'FAILED' => '发布失败', 'MAINTAIN_FAILED' => '更新失败', 'EXPIRED' => '已到期', 'MAINTAINING' => '更新中', 'CEASED' => '已欠费', 'EXPIRED_RECYCLING' => '过期回收中', 'DEPLOYING' => '发布中', ], 'example' => 'PUBLISHED', ], 'NodePool' => [ 'description' => '资源组信息。', 'type' => 'array', 'items' => [ 'description' => '资源组对象。', 'type' => 'object', 'properties' => [ 'NodePoolId' => [ 'description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-g6922kced36hx****', ], 'NodeInstanceType' => [ 'description' => '购买资源的规格类型ID。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'appstreaming.vgpu.4c8g.2g', ], 'NodeAmount' => [ 'description' => '当前包年包月资源的总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeUsed' => [ 'description' => '使用中的包年包月资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeCapacity' => [ 'description' => '并发会话数，即单个资源可同时连接的会话数。如果同时连接的会话数过多，可能导致应用的使用体验下降。取值范围因资源规格不同而不同。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ScalingNodeAmount' => [ 'description' => '弹性资源总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'ScalingNodeUsed' => [ 'description' => '使用中的弹性资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'StrategyType' => [ 'description' => '弹性策略类型。'."\n" ."\n" .'> `NODE_SCALING_BY_USAGE`（按用量伸缩策略）仅适用于`PrePaid`（包年包月）资源；`NODE_SCALING_BY_SCHEDULE`（定时伸缩策略）仅适用于`PostPaid`（按量付费）资源。', 'type' => 'string', 'enumValueTitles' => [ 'NODE_FIXED' => '不使用弹性资源', 'NODE_SCALING_BY_SCHEDULE' => '定时伸缩', 'NODE_SCALING_BY_USAGE' => '按用量伸缩策略', ], 'example' => 'NODE_FIXED', ], 'Amount' => [ 'description' => '创建交付组时购买资源的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'MaxScalingAmount' => [ 'description' => '扩容时最多创建资源的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'MaxIdleAppInstanceAmount' => [ 'description' => '空闲会话数上限。指定该值时，当会话使用率超过`ScalingUsageThreshold`且当前交付组空闲会话数小于`MaxIdleAppInstanceAmount`时，才会触发自动扩容，否则认为交付组空闲会话已足够使用，不自动扩容。该参数可用于灵活控制弹性扩容行为和降低使用成本。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'ScalingStep' => [ 'description' => '扩容时每次创建资源的数量。取值范围：1~10。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ScalingUsageThreshold' => [ 'description' => '会话使用率上限阈值（%）。当会话使用率超过该阈值时，将触发自动扩容。会话使用率的计算公式为`会话使用率=当前会话数÷(资源总数×资源并发会话数)×100%`。', 'type' => 'string', 'example' => '85', ], 'ScalingDownAfterIdleMinutes' => [ 'description' => '无会话连接时长，单位为分钟。当资源内处于无会话连接状态达到此处设置的时长后，将触发自动缩容。默认值：5。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'RecurrenceSchedules' => [ 'description' => '策略执行周期列表。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期。', 'type' => 'object', 'properties' => [ 'RecurrenceType' => [ 'description' => '策略执行周期的类型。必须同时指定`RecurrenceType`和`RecurrenceValues`。 ', 'type' => 'string', 'enumValueTitles' => [ 'weekly' => '周（每周指定几天重复执行一次定时任务）', ], 'example' => 'Weekly', ], 'RecurrenceValues' => [ 'description' => '策略执行周期的数值列表。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期的数值。', 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [ 1 => '周一', '周二', '周三', '周四', '周五', '周六', '周日', ], 'example' => '1', ], ], 'TimerPeriods' => [ 'description' => '策略执行周期的时间段列表。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期的时间段。', 'type' => 'object', 'properties' => [ 'Amount' => [ 'description' => '目标资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'EndTime' => [ 'description' => '结束时间。格式为HH:mm', 'type' => 'string', 'example' => '11:00', ], 'StartTime' => [ 'description' => '开始时间。格式为HH:mm', 'type' => 'string', 'example' => '09:30', ], ], ], ], ], ], ], 'StrategyDisableDate' => [ 'description' => '策略失效日期。格式为：yyyy-MM-dd。', 'type' => 'string', 'example' => '2022-09-08', ], 'StrategyEnableDate' => [ 'description' => '策略生效日期。格式为：yyyy-MM-dd。', 'type' => 'string', 'example' => '2022-08-01', ], 'WarmUp' => [ 'description' => '是否开启资源预热策略。', 'type' => 'boolean', 'example' => 'false', ], 'NodeTypeName' => [ 'description' => '资源规格名称。', 'type' => 'string', 'example' => '无影-通用型_4核8G', ], ], ], ], 'SpecId' => [ 'description' => '与交付组ID唯一对应的ID。', 'type' => 'string', 'example' => 'spec-8o18t8uc31qib0****', ], 'SessionTimeout' => [ 'description' => '会话断连保留时长，单位为分钟。终端用户会话断开连接后，会话将保留此处设置的时长，然后再注销。如果始终保留，则填写`-1`。取值范围：-1和3~300。默认值为`15`。', 'type' => 'string', 'example' => '15', ], 'AppInstanceGroupName' => [ 'description' => '交付组名称。', 'type' => 'string', 'example' => '办公应用', ], 'ExpiredTime' => [ 'description' => '交付组到期时间。', 'type' => 'string', 'example' => '2022-04-27T16:00:00.000+00:00', ], 'OtaInfo' => [ 'description' => 'OTA升级任务信息。', 'type' => 'object', 'properties' => [ 'OtaVersion' => [ 'title' => '当前ota版本', 'description' => '当前OTA版本。', 'type' => 'string', 'example' => '0.0.1-D-20220615.11****', ], 'NewOtaVersion' => [ 'title' => '新ota版本,为空表示没有新版本', 'description' => '新的OTA版本。为空表示没有新版本。', 'type' => 'string', 'example' => '0.0.1-D-20220630.11****', ], 'TaskId' => [ 'title' => '任务id', 'description' => 'OTA升级任务ID。', 'type' => 'string', 'example' => 'ota-e49929gv8acz5****', ], ], ], 'OsType' => [ 'title' => '系统类型', 'description' => '系统类型。', 'type' => 'string', 'enumValueTitles' => [ 'Windows' => 'Windows', ], 'example' => 'Windows', 'enum' => [ 'Windows', 'Linux', 'Android', ], ], 'ResourceStatus' => [ 'description' => '资源状态。', 'type' => 'string', 'enumValueTitles' => [ 'AVAILABLE' => '可用', 'RELEASED' => '已释放', 'EXPIRED_IN_7_DAYS' => '7天内过期', 'UNAVAILABLE' => '不可用', 'UPGRADING' => '更新中', 'CREATING' => '创建中', ], 'example' => 'AVAILABLE', ], 'AppPolicyId' => [ 'description' => '策略ID。', 'type' => 'string', 'example' => 'pg-g3k5wa2ms2****', ], 'ChargeResourceMode' => [ 'description' => '售卖模式。', 'type' => 'string', 'enumValueTitles' => [ 'AppInstance' => '按会话售卖', 'Node' => '按资源售卖', ], 'example' => 'Node', ], 'SkipUserAuthCheck' => [ 'description' => '是否跳过用户授权校验。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '不校验', 'false' => '校验 [默认值]', ], 'example' => 'false', ], 'OfficeSiteId' => [ 'description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-beijing+dir-172301****'."\n", ], 'AppPolicyVersion' => [ 'description' => '策略版本。', 'type' => 'string', 'enumValueTitles' => [ 'CENTER' => '统一策略[新策略]', 'DEFAULT' => '默认策略[旧策略]', ], 'example' => 'CENTER', ], 'AppPolicyImageCheck' => [ 'description' => '当前镜像是否支持统一策略。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '支持', 'false' => '不支持', ], 'example' => 'false', ], 'ResourceTags' => [ 'title' => '资源标签列表。请使用Tags字段。', 'description' => '资源标签列表。', 'type' => 'array', 'items' => [ 'title' => '资源标签。', 'description' => '资源标签。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'example' => 'department', ], 'Value' => [ 'title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'example' => 'design', ], 'Scope' => [ 'title' => '标签类型。取值范围：'."\n" .'Custom：自定义标签。'."\n" .'System：系统标签。', 'description' => '标签类型。', 'type' => 'string', 'enumValueTitles' => [ 'Custom' => '自定义标签', 'System' => '系统标签', ], 'example' => 'Custom', ], ], ], ], 'Tags' => [ 'title' => '资源标签列表。', 'description' => '资源标签列表。', 'type' => 'array', 'items' => [ 'title' => '资源标签。', 'description' => '资源标签。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'example' => 'department', ], 'Value' => [ 'title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'example' => 'design', ], 'Scope' => [ 'title' => '标签类型。取值范围：'."\n" .'Custom：自定义标签。'."\n" .'System：系统标签。', 'description' => '标签类型。', 'type' => 'string', 'enumValueTitles' => [ 'Custom' => '自定义标签', 'System' => '系统标签', ], 'example' => 'Custom', ], ], ], ], 'AuthMode' => [ 'title' => '授权模式。', 'description' => '授权模式。', 'type' => 'string', 'enumValueTitles' => [ 'App' => '应用授权', 'AppInstanceGroup' => '交付组授权', 'Session' => '会话授权', ], 'example' => 'App', 'default' => 'App', 'enum' => [ 'App', 'Session', 'AppInstanceGroup', ], ], 'AccessType' => [ 'title' => '接入类型。', 'description' => '接入类型。', 'type' => 'string', 'enumValueTitles' => [ 'INTERNET' => '互联网', 'VPC' => '企业专网（VPC）', 'ANY' => '互联网和企业专网（VPC）', ], 'example' => 'INTERNET', 'default' => 'INTERNET', 'enum' => [ 'INTERNET', 'VPC', 'ANY', ], ], 'SupportUserGroupMixedAuth' => [ 'title' => '是否支持用户和用户组混合授权。', 'description' => '是否支持用户和用户组混合授权。', 'type' => 'boolean', 'default' => 'true', ], 'UserGroupAuthMode' => [ 'title' => '用户和用户组授权模式。', 'description' => '用户和用户组授权模式。', 'type' => 'string', 'example' => 'Mixed', 'default' => 'Mixed', 'enum' => [ 'Mixed', 'User', 'UserGroup', ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"AppInstanceGroupModels\\": [\\n {\\n \\"Apps\\": [\\n {\\n \\"AppId\\": \\"ca-i87mycyn419nu****\\",\\n \\"AppName\\": \\"办公应用\\",\\n \\"AppVersion\\": \\"1.0.0\\",\\n \\"AppVersionName\\": \\"初始版本\\",\\n \\"AppIcon\\": \\"https://app-center-icon-****.png\\"\\n }\\n ],\\n \\"AppCenterImageId\\": \\"img-8z4nztpaqvay4****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ProductType\\": \\"CloudApp\\",\\n \\"AppInstanceType\\": \\"__dynamic__\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"Amount\\": 1,\\n \\"MinAmount\\": 1,\\n \\"MaxAmount\\": 10,\\n \\"ReserveAmountRatio\\": \\"20\\",\\n \\"ReserveMinAmount\\": 1,\\n \\"ReserveMaxAmount\\": 5,\\n \\"ScalingStep\\": 10,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"GmtCreate\\": \\"2022-04-26T15:06:16.000+00:00\\",\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"NodePool\\": [\\n {\\n \\"NodePoolId\\": \\"rg-g6922kced36hx****\\",\\n \\"NodeInstanceType\\": \\"appstreaming.vgpu.4c8g.2g\\",\\n \\"NodeAmount\\": 1,\\n \\"NodeUsed\\": 1,\\n \\"NodeCapacity\\": 2,\\n \\"ScalingNodeAmount\\": 8,\\n \\"ScalingNodeUsed\\": 4,\\n \\"StrategyType\\": \\"NODE_FIXED\\",\\n \\"Amount\\": 2,\\n \\"MaxScalingAmount\\": 8,\\n \\"MaxIdleAppInstanceAmount\\": 3,\\n \\"ScalingStep\\": 2,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"RecurrenceSchedules\\": [\\n {\\n \\"RecurrenceType\\": \\"Weekly\\",\\n \\"RecurrenceValues\\": [\\n 1\\n ],\\n \\"TimerPeriods\\": [\\n {\\n \\"Amount\\": 5,\\n \\"EndTime\\": \\"11:00\\",\\n \\"StartTime\\": \\"09:30\\"\\n }\\n ]\\n }\\n ],\\n \\"StrategyDisableDate\\": \\"2022-09-08\\",\\n \\"StrategyEnableDate\\": \\"2022-08-01\\",\\n \\"WarmUp\\": false,\\n \\"NodeTypeName\\": \\"无影-通用型_4核8G\\"\\n }\\n ],\\n \\"SpecId\\": \\"spec-8o18t8uc31qib0****\\",\\n \\"SessionTimeout\\": \\"15\\",\\n \\"AppInstanceGroupName\\": \\"办公应用\\",\\n \\"ExpiredTime\\": \\"2022-04-27T16:00:00.000+00:00\\",\\n \\"OtaInfo\\": {\\n \\"OtaVersion\\": \\"0.0.1-D-20220615.11****\\",\\n \\"NewOtaVersion\\": \\"0.0.1-D-20220630.11****\\",\\n \\"TaskId\\": \\"ota-e49929gv8acz5****\\"\\n },\\n \\"OsType\\": \\"Windows\\",\\n \\"ResourceStatus\\": \\"AVAILABLE\\",\\n \\"AppPolicyId\\": \\"pg-g3k5wa2ms2****\\",\\n \\"ChargeResourceMode\\": \\"Node\\",\\n \\"SkipUserAuthCheck\\": false,\\n \\"OfficeSiteId\\": \\"cn-beijing+dir-172301****\\\\n\\",\\n \\"AppPolicyVersion\\": \\"CENTER\\",\\n \\"AppPolicyImageCheck\\": false,\\n \\"ResourceTags\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"design\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"design\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"AuthMode\\": \\"App\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"SupportUserGroupMixedAuth\\": true,\\n \\"UserGroupAuthMode\\": \\"Mixed\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询多个交付组详细信息', ], 'PageListAppInstanceGroupUser' => [ 'summary' => '分页查询交付组中已添加的分配用户。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREappstreamingV87T4P', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'maxItems' => 100, ], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => '每页的查询结果数量，不可超过`100`。建议填写该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => '需展示的查询结果页码。建议填写该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], '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-67E1FC5F****', ], 'Users' => [ 'description' => '查询到的一组用户。', 'type' => 'array', 'items' => [ 'description' => '查询到的用户名。', 'type' => 'string', 'example' => 'username1', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Users\\": [\\n \\"username1\\"\\n ]\\n}","type":"json"}]', 'title' => '分页查询交付组的分配用户', ], 'RenewAppInstanceGroup' => [ 'summary' => '为交付组续费。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREappstreamingU1TTUH', ], ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'PromotionId', 'in' => 'query', 'schema' => [ 'description' => '优惠ID。可通过[GetResourcePrice](~~428503~~)接口获得。', 'type' => 'string', 'required' => false, 'example' => '17440009****', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => '是否自动付费。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '自动付费', 'false' => '手动付费 [默认值]', ], 'example' => 'false', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => '资源购买时长的数量部分，与`PeriodUnit`一起表示完整的购买时长。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ 'description' => '资源购买时长的单位部分，与`Period`一起表示完整的购买时长。可使用的`Period`与`PeriodUnit`的搭配如下：'."\n" ."\n" .'- 1 Week（1周）'."\n" .'- 1 Month（1个月）'."\n" .'- 2 Month（2个月）'."\n" .'- 3 Month（3个月）'."\n" .'- 6 Month（6个月）'."\n" .'- 1 Year（1年）'."\n" .'- 2 Year（2年）'."\n" .'- 3 Year（3年）'."\n" ."\n" .'> 该参数区分大小写。例如，`Week`是有效的，`week`是无效的。另外，如果请求参数不符合上述搭配，例如`2 Week`，虽然调用本接口会成功，但最终在下单阶段会出错。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Month' => '月', 'Year' => '年', 'Week' => '周', ], 'example' => 'Week', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'query', 'schema' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], [ 'name' => 'RenewMode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'RenewAmount', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, ], ], [ 'name' => 'RenewNodes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'required' => false, ], 'required' => false, ], ], ], '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-67E1FC5F****', ], 'Code' => [ 'description' => '出错时的错误码。', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', ], 'OrderId' => [ 'description' => '订单ID。', 'type' => 'string', 'example' => '123456****', ], 'Message' => [ 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"OrderId\\": \\"123456****\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n}","type":"json"}]', 'title' => '为交付组续费', 'description' => '请确保在使用该接口前，已充分了解无影云应用的[计费方式和价格](~~426039~~)。', ], 'UpdateAppInstanceGroupImage' => [ 'summary' => '更新交付组的镜像。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'query', 'schema' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], [ 'name' => 'AppCenterImageId', 'in' => 'query', 'schema' => [ 'description' => '应用镜像ID，可从无影云应用控制台的镜像管理页面获取。', 'type' => 'string', 'required' => true, 'example' => 'img-8z4nztpaqvay4****', ], ], [ 'name' => 'BizRegionId', 'in' => 'query', 'schema' => [ 'description' => '交付组所属的地域ID。关于支持的地域详情，请参见[使用限制](~~426036~~)。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'cn-shanghai' => '华东2（上海）', 'cn-hangzhou' => '华东1（杭州）', ], 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'Code' => [ 'description' => '出错时的错误码。', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', ], 'Message' => [ 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n}","type":"json"}]', 'title' => '更新交付组镜像', 'description' => '>开始更新镜像后，终端用户访问云应用的会话将会断开，请谨慎操作，以免造成终端用户的数据丢失。>'."\n" ."\n" .'> 更新发布成功后，一般需要等待2分钟左右，变更才会在终端生效。', ], 'ModifyAppInstanceGroupAttribute' => [ 'summary' => '修改交付组的通用策略，包括并发会话数、会话断连保留时长等。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '134213', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'query', 'schema' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], [ 'name' => 'AppInstanceGroupName', 'in' => 'query', 'schema' => [ 'description' => '交付组名称。', 'type' => 'string', 'required' => false, 'example' => '办公应用', ], ], [ 'name' => 'SessionTimeout', 'in' => 'query', 'schema' => [ 'description' => '会话断连保留时长，单位为分钟。终端用户会话断开连接后，会话将保留此处设置的时长，然后再注销。如果始终保留，则填写`-1`。取值范围：-1和3~300。默认值为`15`。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '300', 'example' => '15', ], ], [ 'name' => 'NodePool', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '资源组对象。', 'type' => 'object', 'properties' => [ 'NodePoolId' => [ 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-ew7va2g1wl3vm****', ], 'NodeCapacity' => [ 'description' => '并发会话数，即单个资源可同时连接的会话数。如果同时连接的会话数过多，可能导致应用的使用体验下降。取值范围因资源规格不同而不同。各资源规格对应的取值范围可通过ListNodeInstanceType接口获取。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], 'required' => false, ], ], [ 'name' => 'StoragePolicy', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '存储策略。', 'type' => 'object', 'properties' => [ 'StorageTypeList' => [ 'description' => '存储类型列表。', 'type' => 'array', 'items' => [ 'description' => '存储类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'OFF' => '关闭', 'PDS' => '网盘与相册服务（Drive and Photo Service）', ], 'example' => 'PDS', ], 'required' => false, ], 'UserProfileFollow' => [ 'type' => 'object', 'properties' => [ 'ProfileFollowSwitch' => [ 'type' => 'boolean', 'required' => false, ], 'FileSystemId' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], 'UserProfile' => [ 'description' => '用户数据漫游配置。', 'type' => 'object', 'properties' => [ 'UserProfileSwitch' => [ 'description' => '用户数据漫游开关。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '开启', 'false' => '关闭', ], 'example' => 'false', ], 'FileSystemId' => [ 'description' => '用户数据存储系统ID（NAS ID）。', 'type' => 'string', 'required' => false, 'example' => '06ae94****', ], ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'SecurityPolicy', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '安全策略。', 'type' => 'object', 'properties' => [ 'SkipUserAuthCheck' => [ 'description' => '是否跳过用户授权校验。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '不校验', 'false' => '校验 [默认值]', ], 'example' => 'false', ], 'ResetAfterUnbind' => [ 'description' => '解绑后是否重置。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '重置', 'false' => '不重置', ], 'example' => 'true', ], ], 'required' => false, ], ], [ 'name' => 'PreOpenMode', 'in' => 'formData', 'schema' => [ 'description' => '预开模式。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'SINGLE_APP' => '单应用预开', 'OFF' => '关闭预开[默认值]', ], 'example' => 'OFF', ], ], [ 'name' => 'PreOpenAppId', 'in' => 'formData', 'schema' => [ 'description' => '预开应用的AppId。如果`PreOpenMode`参数为`SINGLE_APP`，则`PreOpenAppId`不能为空字符串。', 'type' => 'string', 'required' => false, 'example' => 'ca-b2ronxxd****'."\n", ], ], [ 'name' => 'PerSessionPerApp', 'in' => 'formData', 'schema' => [ 'description' => '一个会话内只允许打开一个应用。'."\n" .'- 开启后，如果打开交付组内的多个应用，将会为每个应用分配一个会话，消耗更多的会话数量', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '开启', 'false' => '关闭', ], 'example' => 'false', ], ], [ 'name' => 'Network', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '网络配置。'."\n" ."\n" .'> 如需使用该参数，请提交工单。', 'type' => 'object', 'properties' => [ 'DomainRules' => [ 'description' => '域名规则配置。', 'type' => 'array', 'items' => [ 'description' => '域名规则。', 'type' => 'object', 'properties' => [ 'Domain' => [ 'description' => '域名。', 'type' => 'string', 'required' => false, 'example' => 'www.example.com', ], 'Policy' => [ 'description' => '策略值。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'allow' => '允许访问', 'block' => '禁止访问', ], 'example' => 'block', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], ], ], '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-67E1FC5F****', ], 'Code' => [ 'description' => '出错时的错误码。', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', ], 'Message' => [ 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n}","type":"json"}]', 'title' => '修改交付组通用策略', ], 'ModifyNodePoolAttribute' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'title' => '产品类型', 'description' => '产品类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'PoolId', 'in' => 'formData', 'schema' => [ 'title' => '资源组id', 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-ew7va2g1wl3vm****', ], ], [ 'name' => 'NodeCapacity', 'in' => 'formData', 'schema' => [ 'title' => '按资源售卖的，单个节点允许运行的应用实例数', 'description' => '并发会话数，即单个资源可同时连接的会话数。如果同时连接的会话数过多，可能导致应用的使用体验下降。取值范围因资源规格不同而不同。各资源规格对应的取值范围分别是：'."\n" ."\n" .'- appstreaming.general.4c8g：1\\~2；'."\n" .'- appstreaming.general.8c16g：1\\~4；'."\n" .'- appstreaming.vgpu.8c16g.4g：1\\~4；'."\n" .'- appstreaming.vgpu.8c31g.16g：1\\~4；'."\n" .'- appstreaming.vgpu.14c93g.12g：1\\~6；', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'NodePoolStrategy', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '节点池策略', 'description' => '交付组的自动扩缩容策略。', 'type' => 'object', 'properties' => [ 'StrategyType' => [ 'title' => '策略类型，默认为NODE_FIXED', 'description' => '弹性模式。'."\n" ."\n" .'> '."\n" .'- `NODE_FIXED`（固定数量）：适用于包年包月资源和按量付费资源。'."\n" .'- `NODE_SCALING_BY_USAGE`（自动扩缩容）：适用于包年包月资源和按量付费资源。'."\n" .'- `NODE_SCALING_BY_SCHEDULE`（定时扩缩容）：仅适用于按量付费资源。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'NODE_FIXED' => '固定数量（不使用弹性扩缩容）', 'NODE_SCALING_BY_SCHEDULE' => '定时扩缩容', 'NODE_SCALING_BY_USAGE' => '自动扩缩容', ], 'example' => 'NODE_FIXED', ], 'NodeAmount' => [ 'description' => '购买资源的数量。取值范围：1~100。'."\n" ."\n" .'> '."\n" .'- 若为包年包月资源，则该参数不可修改。'."\n" .'- 若为按量付费资源，则当弹性模式（`StrategyType`）为固定数量（`NODE_FIXED`）或自动扩缩容（`NODE_SCALING_BY_USAGE`）时该参数可修改。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'MaxScalingAmount' => [ 'title' => '最大弹性数量', 'description' => '扩容时最多创建资源的数量。`StrategyType`设为`NODE_SCALING_BY_USAGE`时，该字段必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], 'MaxIdleAppInstanceAmount' => [ 'description' => '空闲会话数上限。指定该值时，当会话使用率超过`ScalingUsageThreshold`且当前交付组空闲会话数小于`MaxIdleAppInstanceAmount`时，才会触发自动扩容，否则认为交付组空闲会话已足够使用，不自动扩容。该参数可用于灵活控制弹性扩容行为和降低使用成本。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], 'ScalingStep' => [ 'title' => '弹性扩容步长', 'description' => '扩容时每次创建资源的数量。取值范围：1~10。`StrategyType`设为`NODE_SCALING_BY_USAGE`时，该字段必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'ScalingUsageThreshold' => [ 'title' => '触发弹性扩容的会话百分比', 'description' => '会话使用率上限阈值（%）。当会话使用率超过该阈值时，将触发自动扩容。会话使用率的计算公式为`会话使用率=当前会话数÷(资源总数×资源并发会话数)×100%`。`StrategyType`设为`NODE_SCALING_BY_USAGE`时，该字段必填。取值范围：0\\~100。默认值：85。', 'type' => 'string', 'required' => false, 'example' => '85', ], 'ScalingDownAfterIdleMinutes' => [ 'title' => '资源回收时间', 'description' => '无会话连接的资源最多保留的时长（分钟）。当资源内无会话连接时，将按照此处设置的时长开始倒计时，倒计时结束时将完成缩容。取值范围：5~120。默认值：5。但有以下例外情况：'."\n" ."\n" .'- 若缩容后将导致重新触发自动扩容，则不会执行缩容，以免导致反复产生缩容、扩容。'."\n" .'- 若此时间段内，因会话数增加而触发自动扩容，则该资源不会按原计划缩容，倒计时也将重新开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], 'StrategyEnableDate' => [ 'description' => '策略生效日期。格式为：yyyy-MM-dd。该日期必须大于或等于当前日期。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => '2023-01-05', ], 'StrategyDisableDate' => [ 'description' => '策略失效日期。格式为：yyyy-MM-dd。失效日期与生效日期的间隔必须介于7天到1年之间（含7天和1年）。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。', 'type' => 'string', 'required' => false, 'example' => '2023-01-19', ], 'WarmUp' => [ 'description' => '是否开启资源预热策略。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'RecurrenceSchedules' => [ 'description' => '策略执行周期列表。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期。', 'type' => 'object', 'properties' => [ 'RecurrenceType' => [ 'description' => '策略执行周期的类型。必须同时指定`RecurrenceType`和`RecurrenceValues`。 ', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'weekly' => '周（每周指定几天重复执行一次定时任务）', ], 'example' => 'weekly', ], 'RecurrenceValues' => [ 'description' => '策略执行周期的数值列表。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期的数值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ 1 => '周一', '周二', '周三', '周四', '周五', '周六', '周日', ], 'example' => '1', ], 'required' => false, 'maxItems' => 7, ], 'TimerPeriods' => [ 'description' => '策略执行周期的时间段列表。时间段设置要求：'."\n" ."\n" .'- 最多可添加3个时间段。'."\n" .'- 时间段之间不重叠。'."\n" .'- 时间段之间的间隔大于或等于5分钟。'."\n" .'- 单个时间段的时长大于或等于15分钟。'."\n" .'- 所有时间段累计不跨天。', 'type' => 'array', 'items' => [ 'description' => '策略执行周期的时间段。', 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => '开始时间。格式为HH:mm。', 'type' => 'string', 'required' => false, 'example' => '12:00', ], 'EndTime' => [ 'description' => '结束时间。格式为HH:mm。', 'type' => 'string', 'required' => false, 'example' => '15:00', ], 'Amount' => [ 'description' => '资源数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 5, ], ], 'required' => false, ], 'required' => false, 'maxItems' => 7, ], ], 'required' => false, ], ], [ 'name' => 'BizRegionId', 'in' => 'formData', 'schema' => [ 'description' => '交付组所属的地域ID。关于支持的地域详情，请参见[使用限制](~~426036~~)。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'cn-shanghai' => '华东2（上海）', 'cn-hangzhou' => '华东1（杭州）', ], 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResult', 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'Code' => [ 'description' => '出错时的错误码。', 'type' => 'string', 'example' => 'InvalidParameter.PoolId', ], 'Message' => [ 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'The parameter PoolId is invalid.', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.PoolId\\",\\n \\"Message\\": \\"The parameter PoolId is invalid.\\"\\n}","type":"json"}]', 'title' => '修改交付组弹性模式', 'summary' => '修改交付组的弹性模式，包括固定数量（不使用弹性扩缩容）、定时扩缩容和自动扩缩容。', 'description' => '您可以设置无影云应用资源的弹性模式：'."\n" ."\n" .'- 固定数量：不使用弹性扩缩容。'."\n" .'- 自动扩缩容：根据连接会话的数量和无会话连接时长实现资源的自动扩缩容。'."\n" .'- 定时扩缩容：在指定日期的指定时间段执行资源的定时扩缩容。'."\n" ."\n" .'请确保在使用该接口前，已充分了解无影云应用的[计费方式和价格](~~426039~~)。', ], 'AuthorizeInstanceGroup' => [ 'summary' => '为交付组添加或移除分配用户。只有添加到分配用户的用户可访问云应用。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '83450', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '交付组ID。可调用[ListAppInstanceGroup](~~428506~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'maxItems' => 100, ], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AuthorizeUserIds', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => '要添加交付组授权的用户名列表。可设置1\\~100个。', 'type' => 'array', 'items' => [ 'description' => '要添加交付组授权的用户名。可调用[DescribeUsers](~~436936~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => 'alice', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'UnAuthorizeUserIds', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => '要移除交付组授权的用户名列表。可设置1\\~100个。', 'type' => 'array', 'items' => [ 'description' => '要移除交付组授权的用户名。可调用[DescribeUsers](~~436936~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => 'tom', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'UserMeta', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '用户信息。', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '用户类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'ad' => 'AD账号', 'simple' => '无影便捷账号', ], 'example' => 'simple', ], 'AdDomain' => [ 'description' => 'AD域名。', 'type' => 'string', 'required' => false, 'example' => 'example.com', ], ], 'required' => false, ], ], [ 'name' => 'AppInstancePersistentId', 'in' => 'formData', 'schema' => [ 'title' => '持久会话ID。', 'description' => '持久会话ID。', 'type' => 'string', 'required' => false, 'example' => 'p-0cc7s3mw2fg4j****', ], ], [ 'name' => 'AvatarId', 'in' => 'formData', 'schema' => [ 'title' => '用户分身ID。', 'description' => '用户分身ID。'."\n" ."\n" .'> 此参数不开放使用。', 'type' => 'string', 'required' => false, 'example' => 'default', 'default' => 'default', ], ], [ 'name' => 'AuthorizeUserGroupIds', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'title' => '授权用户组ID列表。', 'description' => '授权用户组ID列表。', 'type' => 'array', 'items' => [ 'title' => '授权用户组ID。', 'description' => '授权用户组ID。', 'type' => 'string', 'required' => false, 'example' => 'ug-00001', ], 'required' => false, 'maxItems' => 20, ], ], [ 'name' => 'UnAuthorizeUserGroupIds', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'title' => '取消授权用户组ID列表。', 'description' => '取消授权用户组ID列表。', 'type' => 'array', 'items' => [ 'title' => '取消授权用户组ID列表。', 'description' => '取消授权用户组ID列表。', 'type' => 'string', 'required' => false, 'example' => 'ug-00002', ], 'required' => false, 'maxItems' => 20, ], ], ], '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '为交付组添加或移除分配用户', 'description' => '> 变更分配用户后，选中的用户将收到相应的通知邮件。一般需要等待2分钟左右，变更才会在终端生效。'."\n", ], 'LogOffAllSessionsInAppInstanceGroup' => [ 'summary' => '注销已开启定时扩缩容策略的按量付费交付组下所有会话。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'title' => '产品类型', 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '实例组id', 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '出错时的错误码。', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', ], 'Message' => [ 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '注销交付组下所有会话', 'description' => '> 本接口仅适用于已启用定时扩缩容策略的按量付费资源交付组，且仅可在定时扩缩容策略中设置的扩缩容时间段以外的时间调用成功。', ], 'DeleteAppInstanceGroup' => [ 'summary' => '删除"资源型-按量付费"形式的交付组。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'maxItems' => 100, ], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ '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-67E1FC5F****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidAppInstanceGroupSpecItem.NotFound', 'errorMessage' => 'The app instance group spec item is not found.', ], [ 'errorCode' => 'InvalidBrowserInstanceGroup.NotFound', 'errorMessage' => 'The browser instance group is not found.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '删除按量付费交付组', 'description' => '> 本接口不支持删除使用包年包月资源的交付组。', ], 'ModifyAppPolicy' => [ 'summary' => '修改交付组显示策略，包括帧率、分辨率、协议类型等设置。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppPolicyId', 'in' => 'query', 'schema' => [ 'description' => '策略ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-ee2znjktwgxu2****', ], ], [ 'name' => 'VideoPolicy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '显示策略。', 'type' => 'object', 'properties' => [ 'FrameRate' => [ 'description' => '帧率（FPS）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [ 30 => '30 FPS', 60 => '60 FPS', ], 'example' => '60', ], 'TerminalResolutionAdaptive' => [ 'description' => '是否使用自适应分辨率。'."\n" ."\n" .'- `true`：会话分辨率跟随终端显示区域变化。此时`SessionResolutionWidth`和`SessionResolutionHeight`为分辨率变化的最大值。'."\n" ."\n" .'- `false`：会话分辨率不跟随终端显示区域变化。此时分辨率固定为`SessionResolutionWidth`和`SessionResolutionHeight`的值。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'SessionResolutionWidth' => [ 'description' => '分辨率的宽度，单位为像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1920', ], 'SessionResolutionHeight' => [ 'description' => '分辨率的高度，单位为像素。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1080', ], 'StreamingMode' => [ 'description' => '流模式。与`Webrtc`参数搭配表示协议类型。'."\n" ."\n" .'- `Webrtc`=`true`且`StreamingMode`=`video`，表示WebRTC流。'."\n" .'- `Webrtc`=`false`且`StreamingMode`=`video`，表示视频流。'."\n" .'- `Webrtc`=`false`且`StreamingMode`=`mix`，表示混合流。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'video' => '视频流', 'mix' => '混合流', ], 'example' => 'video', ], 'Webrtc' => [ 'description' => '是否开启WebRTC。与`StreamingMode`参数搭配表示协议类型。'."\n" ."\n" .'- `Webrtc`=`true`且`StreamingMode`=`video`，表示WebRTC流。'."\n" .'- `Webrtc`=`false`且`StreamingMode`=`video`，表示视频流。'."\n" .'- `Webrtc`=`false`且`StreamingMode`=`mix`，表示混合流。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'VisualQualityStrategy' => [ 'description' => '画质策略。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'adaptive' => '自适应', 'smooth' => '流畅优先', 'quality' => '画质优先', ], 'example' => 'smooth', ], ], 'required' => false, ], ], ], '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-67E1FC5F****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '修改交付组显示策略', ], 'ListAuthorizedUserGroups' => [ 'summary' => '通过交付组查询该交付组授权的用户组列表。', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREappstreamingD8SMIE', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'title' => '产品类型。', 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '每页最大返回的数量。', 'description' => '每页最大返回的数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'example' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'title' => '页码，从1开始。', 'description' => '页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '交付组ID。', 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], [ 'name' => 'GroupId', 'in' => 'formData', 'schema' => [ 'title' => '用户组ID，精确查询。', 'description' => '用户组ID，精确查询。', 'type' => 'string', 'required' => false, 'example' => 'ug-00001', ], ], [ 'name' => 'GroupName', 'in' => 'formData', 'schema' => [ 'title' => '用户组名称，模糊查询。', 'description' => '用户组名称，模糊查询。', 'type' => 'string', 'required' => false, 'example' => '用户组001', ], ], ], '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-67E1FC5F****', ], 'TotalCount' => [ 'title' => '总数。', 'description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'PageSize' => [ 'title' => '每页返回的最大数量。', 'description' => '每页返回的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'title' => '页码。', 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'UserGroups' => [ 'title' => '用户组信息列表。', 'description' => '用户组信息列表。', 'type' => 'array', 'items' => [ 'title' => '用户组信息。', 'description' => '用户组信息。', 'type' => 'object', 'properties' => [ 'GroupName' => [ 'title' => '用户组名称。', 'description' => '用户组名称。', 'type' => 'string', 'example' => '用户组001', ], 'AppInstanceGroupId' => [ 'title' => '交付组ID。', 'description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-9ciijz60n4xsv****', ], 'AuthMode' => [ 'title' => '授权模式。', 'description' => '授权模式。', 'type' => 'string', 'enumValueTitles' => [ 'App' => '应用授权', 'AppInstanceGroup' => '交付组授权', 'Session' => '会话授权', ], 'example' => 'App', 'default' => 'App', 'enum' => [ 'App', 'Session', 'AppInstanceGroup', ], ], 'GroupId' => [ 'title' => '用户组ID。', 'description' => '用户组ID。', 'type' => 'string', 'example' => 'ug-00001', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 6,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"UserGroups\\": [\\n {\\n \\"GroupName\\": \\"用户组001\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"AuthMode\\": \\"App\\",\\n \\"GroupId\\": \\"ug-00001\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询交付组授权的用户组列表', ], 'ListAppInstances' => [ 'summary' => '查询交付组内会话实例的详细信息，包括实例ID、实例状态、创建时间、更新时间、会话状态、主网卡公网IP等。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '170357', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'AppInstanceGroupId', 'in' => 'query', 'schema' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-4p5f8tj16yb8b****', ], ], [ 'name' => 'AppInstanceId', 'in' => 'query', 'schema' => [ 'description' => '应用实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ai-azn3kmwruh1vl****', ], ], [ 'name' => 'Status', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '应用实例状态列表。', 'type' => 'array', 'items' => [ 'description' => '应用实例状态。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'INIT' => '初始化', 'STARTING' => '应用启动中', 'CLOSING' => '应用停止中', 'CLOSED' => '应用已关闭', 'RUNNING' => '应用运行中', 'IDLE' => '空闲', 'BOUND' => '已绑定', 'UNAVAILABLE' => '不可用', ], 'example' => 'INIT', ], 'required' => false, 'maxItems' => 100, 'minItems' => 1, ], ], [ 'name' => 'AppInstanceIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '应用实例ID列表，最大长度为100。', 'type' => 'array', 'items' => [ 'description' => '应用实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ai-azn3kmwruh1vl****', ], 'required' => false, 'maxItems' => 100, 'minItems' => 1, ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页的查询结果数量，不可超过`100`。默认值为`20`。建议填写该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '需展示的查询结果页码。默认值为`1`。建议填写该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'IncludeDeleted', 'in' => 'query', 'schema' => [ 'description' => '是否查询已删除的实例信息。'."\n" .'该参数为true时AppInstanceIdList的字段必填，否则会报参数错误。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '查询', 'false' => '不查询[默认值]', ], 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'UserIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '用户ID列表，最大长度为100。', 'type' => 'array', 'items' => [ 'description' => '用户ID', 'type' => 'string', 'required' => false, 'example' => 'Alice', ], 'required' => false, 'maxItems' => 100, ], ], ], '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-67E1FC5F****', ], 'TotalCount' => [ 'description' => '查询结果的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '18', ], 'PageSize' => [ 'description' => '每页的查询结果数量，不可超过`100`。建议填写该参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'description' => '需展示的查询结果页码。建议填写该参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AppInstanceModels' => [ 'description' => '查询的应用实例列表。', 'type' => 'array', 'items' => [ 'description' => '查询的应用实例。', 'type' => 'object', 'properties' => [ 'AppInstanceId' => [ 'description' => '应用实例ID。', 'type' => 'string', 'example' => 'ai-8dl7dzchklmka****', ], 'AppInstanceGroupId' => [ 'description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-dk8p95irqfst9****', ], 'Status' => [ 'description' => '应用实例状态。', 'type' => 'string', 'example' => 'BOUND', ], 'MainEthPublicIp' => [ 'description' => '主网卡公网IP。交付组网络策略（`StrategyType`）为混合模式（`Mixed`）时才返回该值，否则为空。', 'type' => 'string', 'example' => '10.13.13.211', ], 'NetworkInterfaceIp' => [ 'type' => 'string', ], 'GmtCreate' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2023-03-07T20:29:19.000+08:00', ], 'GmtModified' => [ 'description' => '更新时间。', 'type' => 'string', 'example' => '2023-03-07T20:29:19.000+08:00', ], 'SessionStatus' => [ 'description' => '会话连接状态。实例状态为应用运行中（`RUNNING`）时才返回该值，否则为空。', 'type' => 'string', 'enumValueTitles' => [ 'disconnect' => '已关闭', 'connect' => '已连接', ], 'example' => 'connect', ], 'BindInfo' => [ 'description' => '实例与用户绑定相关信息。', 'type' => 'object', 'properties' => [ 'EndUserId' => [ 'description' => '实例绑定的最终用户ID。', 'type' => 'string', 'example' => 'app.test', ], 'UsageDuration' => [ 'description' => '实例使用时长。单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], ], ], 'NodeId' => [ 'description' => '运行实例的节点ID。'."\n" .'> 只有本实例所属交付组的售卖模式为按资源售卖（ChargeResourceMode=Node）时，才会返回本参数。', 'type' => 'string', 'example' => 'i-bp13********', ], 'ChargeType' => [ 'description' => '实例的付费类型，返回值：'."\n" .'- **PrePaid**：包年包月（预付费）。'."\n" .'- **PostPaid**：按量付费（后付费）。'."\n" .'> 只有本实例所属交付组的售卖模式为按资源售卖（ChargeResourceMode=Node）时，才会返回本参数。', 'type' => 'string', 'enumValueTitles' => [ 'PostPaid' => '按量付费（后付费）', 'PrePaid' => '包年包月（预付费）', ], 'example' => 'PostPaid', ], 'NetworkInterfaceId' => [ 'type' => 'string', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 18,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"AppInstanceModels\\": [\\n {\\n \\"AppInstanceId\\": \\"ai-8dl7dzchklmka****\\",\\n \\"AppInstanceGroupId\\": \\"aig-dk8p95irqfst9****\\",\\n \\"Status\\": \\"BOUND\\",\\n \\"MainEthPublicIp\\": \\"10.13.13.211\\",\\n \\"NetworkInterfaceIp\\": \\"\\",\\n \\"GmtCreate\\": \\"2023-03-07T20:29:19.000+08:00\\",\\n \\"GmtModified\\": \\"2023-03-07T20:29:19.000+08:00\\",\\n \\"SessionStatus\\": \\"connect\\",\\n \\"BindInfo\\": {\\n \\"EndUserId\\": \\"app.test\\",\\n \\"UsageDuration\\": 2000\\n },\\n \\"NodeId\\": \\"i-bp13********\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"NetworkInterfaceId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询交付组内实例详细信息', ], 'DeleteAppInstances' => [ 'summary' => '删除指定应用实例。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '交付组ID。可通过接口[ListAppInstanceGroup](~~428506~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], [ 'name' => 'AppInstanceIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '应用实例ID列表。', 'type' => 'array', 'items' => [ 'description' => '应用实例ID。'."\n" ."\n" .'> 仅特定客户可获取到该参数。', 'type' => 'string', 'required' => true, 'example' => 'ai-gbuea*****', ], 'required' => true, 'maxItems' => 100, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'DeleteAppInstanceModels' => [ 'description' => '实例删除结果列表。', 'type' => 'array', 'items' => [ 'description' => '实例删除结果。', 'type' => 'object', 'properties' => [ 'AppInstanceId' => [ 'description' => '应用实例ID。', 'type' => 'string', 'example' => 'ai-gbuea*****'."\n", ], 'Success' => [ 'description' => '是否成功触发删除。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '触发成功', 'false' => '触发失败', ], 'example' => 'true', ], 'Code' => [ 'description' => '出错时的错误码。', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', ], 'Message' => [ 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DeleteAppInstanceModels\\": [\\n {\\n \\"AppInstanceId\\": \\"ai-gbuea*****\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '删除指定应用实例', 'description' => '处于初始化状态或空闲状态的实例才能被删除。该接口仅向特定客户开放。', ], 'ListPersistentAppInstances' => [ 'summary' => '查询交付组内的持久会话应用实例列表。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '268317', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '云应用', 'CloudBrowser' => '云浏览器', 'AndroidCloud' => '云手机', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'query', 'schema' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-0bxls9m9arax6****', ], ], [ 'name' => 'AppInstancePersistentIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '持久会话ID列表。', 'type' => 'array', 'items' => [ 'description' => '持久会话ID。', 'type' => 'string', 'required' => true, 'example' => 'p-0cc7s3mw2fg4j****', ], 'required' => false, 'maxItems' => 100, 'minItems' => 1, ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页的查询结果数量，不可超过**100**，默认值为**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '需展示的查询结果页码，从**1**开始，默认为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], '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-67E1FC5F****', ], 'TotalCount' => [ 'description' => '查询结果的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'PageSize' => [ 'description' => '每页的查询结果数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'PageNumber' => [ 'description' => '当前展示的查询结果页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PersistentAppInstanceModels' => [ 'description' => '持久会话应用实例信息列表。', 'type' => 'array', 'items' => [ 'description' => '持久会话应用实例信息。', 'type' => 'object', 'properties' => [ 'AppInstancePersistentId' => [ 'description' => '持久会话ID。', 'type' => 'string', 'example' => 'p-0cc7s3mw2fg4j****', ], 'AppInstancePersistentName' => [ 'description' => '持久会话应用实例名称。', 'type' => 'string', 'example' => 'test-persistent-name', ], 'AppInstancePersistentStatus' => [ 'description' => '持久会话应用实例状态。', 'type' => 'string', 'enumValueTitles' => [ 'STARTING' => '启动中', 'RUNNING' => '运行中', 'STOPPED' => '已停止', 'UNAVAILABLE' => '不可用', 'DELETING' => '删除中', 'PENDING' => '创建中', 'STOPPING' => '停止中', 'DELETED' => '已删除', 'REBUILDING' => '重置中', ], 'example' => 'RUNNING', ], 'AppInstanceGroupId' => [ 'description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-0bxls9m9arax6****', ], 'AppInstanceId' => [ 'description' => '应用实例ID。', 'type' => 'string', 'example' => 'ai-azn3kmwruh1vl****', ], 'AppInstanceStatus' => [ 'description' => '应用实例状态。', 'type' => 'string', 'enumValueTitles' => [ 'INIT' => '初始化', 'STARTING' => '应用启动中', 'CLOSING' => '应用停止中', 'CLOSED' => '应用已关闭', 'RUNNING' => '应用运行中', 'IDLE' => '空闲', 'BOUND' => '已绑定', 'UNAVAILABLE' => '不可用', 'DELETED' => '已删除', ], 'example' => 'RUNNING', ], 'GmtCreate' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2025-03-13T03:22:18.000+00:00', ], 'AuthorizedUsers' => [ 'description' => '授权的用户名列表。', 'type' => 'array', 'items' => [ 'description' => '授权的用户名。', 'type' => 'string', 'example' => 'user-001', ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PersistentAppInstanceModels\\": [\\n {\\n \\"AppInstancePersistentId\\": \\"p-0cc7s3mw2fg4j****\\",\\n \\"AppInstancePersistentName\\": \\"test-persistent-name\\",\\n \\"AppInstancePersistentStatus\\": \\"RUNNING\\",\\n \\"AppInstanceGroupId\\": \\"aig-0bxls9m9arax6****\\",\\n \\"AppInstanceId\\": \\"ai-azn3kmwruh1vl****\\",\\n \\"AppInstanceStatus\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2025-03-13T03:22:18.000+00:00\\",\\n \\"AuthorizedUsers\\": [\\n \\"user-001\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询持久会话应用实例列表', ], 'GetConnectionTicket' => [ 'summary' => '获取云应用连接凭证。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '169756', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '云应用', 'AndroidCloud' => '安卓云', ], 'example' => 'CloudApp', ], ], [ 'name' => 'EndUserId', 'in' => 'formData', 'schema' => [ 'description' => '用户名称。', 'type' => 'string', 'required' => true, 'example' => 'alice', ], ], [ 'name' => 'BizRegionId', 'in' => 'formData', 'schema' => [ 'description' => '地域ID。'."\n" ."\n" .'> 当传入本参数时，仅会在参数指定地域的交付组中分配应用实例。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'cn-shenzhen' => 'cn-shenzhen', 'cn-beijing' => 'cn-beijing', 'cn-shanghai' => 'cn-shanghai', 'cn-zhangjiakou' => 'cn-zhangjiakou', 'cn-hangzhou' => 'cn-hangzhou', ], 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => [ 'description' => '任务ID。'."\n" ."\n" .'> 非首次调用时必填。使用本参数查询任务状态和连接凭证。', 'type' => 'string', 'required' => false, 'example' => '28778acb-a469-4bc0-8e0f****', ], ], [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'description' => '应用ID。'."\n" ."\n" .'> 首次调用时必填，后续调用时选填。', 'type' => 'string', 'required' => false, 'example' => 'ca-e4s0puhmwi7v****', ], ], [ 'name' => 'AppVersion', 'in' => 'formData', 'schema' => [ 'description' => '应用版本。传入本参数时，仅会打开参数所指定版本的应用。如果不传入本参数，则会打开已授权的任意版本的应用。', 'type' => 'string', 'required' => false, 'example' => '1.0.0', ], ], [ 'name' => 'AppStartParam', 'in' => 'formData', 'schema' => [ 'description' => '应用启动参数。关于启动参数的获取方法，请参见[如何获取应用安装参数与启动参数](~~426045~~)。', 'type' => 'string', 'required' => false, 'example' => '/q /n', ], ], [ 'name' => 'EnvironmentConfig', 'in' => 'formData', 'schema' => [ 'title' => '环境配置。', 'description' => '环境配置。', 'type' => 'string', 'required' => false, ], ], [ 'name' => 'AppInstanceGroupIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '交付组列表。'."\n" ."\n" .'> - 当传入本参数时，仅会在参数指定的且已授权的交付组中分配应用实例。'."\n" .'> - 当传入`AppInstanceId`或`AppInstancePersistentId `参数时，本参数必填。', 'type' => 'array', 'items' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => false, 'example' => 'aig-4xz0oy8x4ipyv****', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'AppInstancePersistentId', 'in' => 'formData', 'schema' => [ 'description' => '持久会话ID。', 'type' => 'string', 'required' => false, 'example' => 'p-0bxls9m3cl7s****', ], ], [ 'name' => 'AppInstanceId', 'in' => 'formData', 'schema' => [ 'description' => '应用实例ID。'."\n" ."\n" .'> '."\n" .'> - 当传入本参数时，仅会尝试分配参数所指定的应用实例。'."\n" .'> - 当传入本参数时，必须同时传入`AppInstanceGroupIdList`参数，且`AppInstanceGroupIdList`中交付组ID的数量为1。', 'type' => 'string', 'required' => false, 'example' => 'ai-1rznfnrvsa99d****', ], ], [ 'name' => 'AccessType', 'in' => 'formData', 'schema' => [ 'title' => '接入类型，不传表示两种都显示。'."\n" .'取值范围：'."\n" .'互联网：INTERNET'."\n" .'专线：VPC', 'description' => '接入类型，不传表示两种都显示。'."\n" .'取值范围：'."\n" .'互联网：INTERNET'."\n" .'专线：VPC', 'type' => 'string', 'required' => false, 'example' => 'INTERNET', 'maxLength' => 10, 'minLength' => 0, 'default' => 'INTERNET', 'enum' => [ 'INTERNET', 'VPC', ], ], ], [ 'name' => 'AppPolicyId', 'in' => 'formData', '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'TaskStatus' => [ 'description' => '任务状态。', 'type' => 'string', 'enumValueTitles' => [ 'Finished' => '已完成', 'Failed' => '已失败', 'Running' => '执行中', ], 'example' => 'Running', ], 'TaskId' => [ 'description' => '任务ID。', 'type' => 'string', 'example' => 'f3d1b31c-605e-4d04-a896****', ], 'BizRegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Ticket' => [ 'description' => '连接云应用的凭证。'."\n" .'> 非首次调用时显示此参数。', 'type' => 'string', 'example' => 'DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****', ], 'AppInstanceGroupId' => [ 'description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-53fvrq1oan****', ], 'AppInstancePersistentId' => [ 'description' => '持久会话ID。', 'type' => 'string', 'example' => 'p-0bxls9m3cl7s****', ], 'AppInstanceId' => [ 'description' => '应用实例ID。', 'type' => 'string', 'example' => 'ai-7ybdeiyoeh5e****', ], 'OsType' => [ 'description' => '操作系统类型。', 'type' => 'string', 'enumValueTitles' => [ 'Windows' => 'Windows操作系统', ], 'example' => 'Windows', ], 'TenantId' => [ 'description' => '租户ID（阿里云账号UID）。', 'type' => 'integer', 'format' => 'int64', 'example' => '148871678899****', ], 'AvatarId' => [ 'title' => '分身ID。', 'description' => '分身ID。', 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"Running\\",\\n \\"TaskId\\": \\"f3d1b31c-605e-4d04-a896****\\",\\n \\"BizRegionId\\": \\"cn-hangzhou\\",\\n \\"Ticket\\": \\"DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****\\",\\n \\"AppInstanceGroupId\\": \\"aig-53fvrq1oan****\\",\\n \\"AppInstancePersistentId\\": \\"p-0bxls9m3cl7s****\\",\\n \\"AppInstanceId\\": \\"ai-7ybdeiyoeh5e****\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"TenantId\\": 0,\\n \\"AvatarId\\": \\"\\"\\n}","type":"json"}]', 'title' => '获取云应用连接凭证', 'description' => '本接口需要多次调用（至少两次）才能最终获得连接凭证。'."\n" ."\n" .'第一次调用，会为指定的便捷账号分配应用实例，并启动应用。返回启动任务ID（`TaskID`）。'."\n" ."\n" .'后续调用，需要在请求参数中传入`TaskID`参数，查询任务是否结束，当返回的任务状态（`TaskStatus`）为已完成（`Finished`）时，会同时返回连接凭证（`Ticket`）。', ], 'Unbind' => [ 'summary' => '解绑用户和会话。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'EndUserId', 'in' => 'formData', 'schema' => [ 'description' => '用户名。', 'type' => 'string', 'required' => true, 'example' => 'alice', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '交付组ID。可调用[GetConnectionTicket](~~609336~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], [ 'name' => 'AppInstancePersistentId', 'in' => 'formData', 'schema' => [ 'description' => '持久会话ID。可调用[GetConnectionTicket](~~609336~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => 'p-0bxls9m3cl7s****', ], ], [ 'name' => 'AppInstanceId', 'in' => 'formData', 'schema' => [ 'description' => '会话ID。可调用[GetConnectionTicket](~~609336~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => 'ai-d297eyf83g5ni****', ], ], ], '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-67E1FC5F****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '解绑用户和会话', ], 'ListBindInfo' => [ 'summary' => '查询用户与资源之间的绑定信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '262111', 'abilityTreeNodes' => [ 'FEATUREappstreamingV87T4P', ], ], 'parameters' => [ [ 'name' => 'UserIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '用户ID列表。可以传入1\\~100个ID。'."\n" ."\n" .'> 当传入本参数时，仅会返回指定的用户的绑定信息。', 'type' => 'array', 'items' => [ 'description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'Alice', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'WyIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '无影用户ID列表。可以传入1\\~100个ID。'."\n" ."\n" .'> 当传入本参数时，仅会返回指定的无影用户的绑定信息。', 'type' => 'array', 'items' => [ 'description' => '无影用户ID。', 'type' => 'string', 'required' => false, 'example' => '2ca6f5a93536****', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'AppInstanceGroupIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '交付组ID列表。可以传入1\\~100个ID。'."\n" ."\n" .'> 当传入本参数时，仅会返回指定的交付组的绑定信息。', 'type' => 'array', 'items' => [ 'description' => '交付组ID。', 'type' => 'string', 'required' => false, 'example' => 'aig-4xz0oy8x4ipyv****', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'AppInstanceIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '应用实例ID列表。可以传入1\\~100个ID。'."\n" ."\n" .'> 当传入本参数时，仅会返回指定的应用实例的绑定信息。', 'type' => 'array', 'items' => [ 'description' => '应用实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ai-azn3kmwruh1vl****', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'AppIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '应用ID列表。可以传入1\\~100个ID。'."\n" ."\n" .'> 当传入本参数时，仅会返回指定的应用的绑定信息。', 'type' => 'array', 'items' => [ 'description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'ca-fq738or6vd854****', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => '每页的查询结果数量，不可超过`100`。默认值为`20`。建议填写该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '20', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => '需展示的查询结果页码。默认值为`1`。建议填写该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], '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' => 'AD2D0761-1FE5-549D-B169-D3F8D19C****', ], 'TotalCount' => [ 'description' => '查询结果的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'PageSize' => [ 'description' => '每页的查询结果数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'description' => '当前展示的查询结果页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'BindInfoModels' => [ 'description' => '返回的绑定信息列表。', 'type' => 'array', 'items' => [ 'description' => '返回的绑定信息。', 'type' => 'object', 'properties' => [ 'AppId' => [ 'description' => '应用ID。', 'type' => 'string', 'example' => 'ca-fq738or6vd854****', ], 'AppVersion' => [ 'description' => '应用版本号。', 'type' => 'string', 'example' => '1.0', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'UserId' => [ 'description' => '用户ID。', 'type' => 'string', 'example' => 'Alice', ], 'WyId' => [ 'description' => '无影用户ID。', 'type' => 'string', 'example' => '2ca6f5a93536****', ], 'AccountType' => [ 'description' => '账号类型。', 'type' => 'string', 'enumValueTitles' => [ 'ad' => 'AD域账号', 'simple' => '便捷账号', ], 'example' => 'simple', ], 'AppInstanceGroupId' => [ 'description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-0abxhr6ce35w8****', ], 'AppInstanceId' => [ 'description' => '应用实例ID。', 'type' => 'string', 'example' => 'ai-83oe276fre4l3****', ], 'ProductType' => [ 'description' => '产品类型。', 'type' => 'string', 'enumValueTitles' => [ 'CloudApp' => '云应用', 'CloudBrowser' => '云浏览器', 'AndroidCloud' => '云手机', ], 'example' => 'CloudApp', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169-D3F8D19C****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"BindInfoModels\\": [\\n {\\n \\"AppId\\": \\"ca-fq738or6vd854****\\",\\n \\"AppVersion\\": \\"1.0\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"UserId\\": \\"Alice\\",\\n \\"WyId\\": \\"2ca6f5a93536****\\",\\n \\"AccountType\\": \\"simple\\",\\n \\"AppInstanceGroupId\\": \\"aig-0abxhr6ce35w8****\\",\\n \\"AppInstanceId\\": \\"ai-83oe276fre4l3****\\",\\n \\"ProductType\\": \\"CloudApp\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询绑定信息', ], 'CreateImageFromAppInstanceGroup' => [ 'summary' => '通过调试交付组创建新镜像。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppCenterImageName', 'in' => 'formData', 'schema' => [ 'description' => '应用镜像名称。', 'type' => 'string', 'required' => true, 'example' => 'test_name', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '交付组ID。可调用[ListAppInstanceGroup](~~428506~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], ], '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-67E1FC5F****', ], 'ImageId' => [ 'description' => '镜像ID。', 'type' => 'string', 'example' => 'img-bp13mu****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"ImageId\\": \\"img-bp13mu****\\"\\n}","type":"json"}]', 'title' => '通过调试交付组创建新镜像', ], 'GetDebugAppInstance' => [ 'summary' => '获取调试应用实例信息。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CloudApp' => '无影云应用', ], 'example' => 'CloudApp', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '交付组ID。可通过`listAppInstanceGroup`接口获取。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], ], '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-67E1FC5F****', ], 'AppInstanceGroupId' => [ 'description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-9ciijz60n4xsv****', ], 'AppInstanceId' => [ 'description' => '应用实例ID。', 'type' => 'string', 'example' => 'ai-7ybdeiyoeh5e****', ], 'AppId' => [ 'description' => '应用ID。', 'type' => 'string', 'example' => '__DEBUG_APP', ], 'UserId' => [ 'description' => '用户ID。', 'type' => 'string', 'example' => '__debug__', ], 'AuthCode' => [ 'description' => '授权码。该授权码有效期为3分钟，且无论校验成功或失败，只能被使用一次。当为一个用户生成多个授权码时，只有最后一次生成的有效。', 'type' => 'string', 'example' => 'e4e169bea1cc48e8afac53**********', ], 'AppVersion' => [ 'description' => '应用版本ID。', 'type' => 'string', 'example' => '1.1', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"AppInstanceId\\": \\"ai-7ybdeiyoeh5e****\\",\\n \\"AppId\\": \\"__DEBUG_APP\\",\\n \\"UserId\\": \\"__debug__\\",\\n \\"AuthCode\\": \\"e4e169bea1cc48e8afac53**********\\",\\n \\"AppVersion\\": \\"1.1\\"\\n}","type":"json"}]', 'title' => '获取调试应用实例信息', 'responseParamsDescription' => '根据获得的返回参数，您可以拼接URL来获取建连信息。URL拼接示例：'."\n" ."\n" .'`?AppId=__DEBUG_APP&AppVersion=1.0&AppInstanceGroupId=aig-5wfetbb7aovy8****&Env=online&AppInstanceId=ai-c7ruhxqww38ws****&AuthCode=acv2j%2BqjU3GAIBVOz33KxdcVyHJ58Dc2N2GC3ZpWNu9Q3zX84cxbNJcPX5enF%2BPePBEgBHxvF28QQcUOjgMk5tHgQKbe%2FUXbIDfg83vN7C3XMzkXo8ByHepfSLQwFLdP4S83zA327ugaB1w1pNnDwhbSvkfRmTA3JOc%2FNEqNs6w%2FePg5NmS4bRhodpYkb4wL****`'."\n" ."\n" .'> ``需根据您的业务实际情况替换。', ], 'ListOtaTask' => [ 'summary' => '查询OTA升级历史记录。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '每页数量', 'description' => '每页的查询结果数量。取值范围：1~100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'title' => '页码', 'description' => '当前展示的查询结果页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '实例组id', 'description' => '交付组ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-53fvrq1oanz6c****', ], ], [ 'name' => 'OtaType', 'in' => 'formData', 'schema' => [ 'title' => 'ota类型,取值：'."\n" .'Fota ： agent组件更新'."\n" .'ImageUpdate ： 镜像更新'."\n" .'AppUpdate ： 应用更新', 'description' => 'OTA升级任务类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Fota' => '无影系统组件更新', ], 'example' => 'Fota', 'enum' => [ 'Fota', 'ImageUpdate', 'AppUpdate', ], ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'TotalCount' => [ 'description' => 'OTA升级任务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'PageSize' => [ 'title' => '每页数量', 'description' => '每页的查询结果数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'title' => '页码', 'description' => '当前展示的查询结果页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TaskList' => [ 'title' => 'AppInstanceGroupModels', 'description' => 'OTA升级任务列表。', 'type' => 'array', 'items' => [ 'description' => 'OTA升级任务。', 'type' => 'object', 'properties' => [ 'OtaVersion' => [ 'title' => 'ota版本，格式举例：0.0.1-R-20220708.110604', 'description' => 'OTA版本。', 'type' => 'string', 'example' => '0.0.1-R-20220708.110604', ], 'TaskDisplayStatus' => [ 'title' => '任务展示状态', 'description' => '任务状态。', 'type' => 'string', 'enumValueTitles' => [ 'FAILED' => '升级失败', 'RUNNING' => '升级中', 'TERMINATED' => '升级停止', 'PART_FINISHED' => '升级成功', 'STANDBY' => '等待升级', 'FINISHED' => '升级成功', ], 'example' => 'RUNNING', 'enum' => [ 'STANDBY', 'RUNNING', 'FAILED', 'TERMINATED', 'FINISHED', 'PART_FINISHED', ], ], 'TaskStartTime' => [ 'title' => '任务开始时间，ISO-8601格式', 'description' => '任务开始时间，ISO 8601格式。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2022-08-04T14:36:00+08:00', ], 'TaskId' => [ 'title' => '任务id', 'description' => '任务ID。', 'type' => 'string', 'example' => 'ota-be7jzm29wrrz5****', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 6,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TaskList\\": [\\n {\\n \\"OtaVersion\\": \\"0.0.1-R-20220708.110604\\",\\n \\"TaskDisplayStatus\\": \\"RUNNING\\",\\n \\"TaskStartTime\\": \\"2022-08-04T14:36:00+08:00\\",\\n \\"TaskId\\": \\"ota-be7jzm29wrrz5****\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询OTA升级历史记录', ], 'GetOtaTaskByTaskId' => [ 'summary' => '查询OTA升级任务明细，包括可升级版本、版本说明等。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => [ 'title' => 'ota任务id', 'description' => 'OTA升级任务ID。可调用[ListAppInstanceGroup](~~428506~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'ota-be7jzm29wrrz5****', ], ], ], '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-67E1FC5F****', ], 'Code' => [ 'title' => '错误码', 'description' => '出错时的错误码。', 'type' => 'string', 'example' => 'OtaTask.Running', ], 'Message' => [ 'title' => '提示', 'description' => '出错时的错误消息。', 'type' => 'string', 'example' => 'The task is running and cannot be sumitted.', ], 'ReleaseNote' => [ 'title' => '版本说明', 'description' => '版本说明，描述OTA升级的内容。', 'type' => 'string', 'example' => '测试升级', ], 'OtaVersion' => [ 'title' => '版本号', 'description' => 'OTA版本。', 'type' => 'string', 'example' => '0.0.1-R-20220708.110604', ], 'TaskStartTime' => [ 'title' => '任务执行时间，ISO-8601格式', 'description' => '任务执行时间，ISO 8601格式。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2022-08-04T14:36:00+08:00', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"OtaTask.Running\\",\\n \\"Message\\": \\"The task is running and cannot be sumitted.\\",\\n \\"ReleaseNote\\": \\"测试升级\\",\\n \\"OtaVersion\\": \\"0.0.1-R-20220708.110604\\",\\n \\"TaskStartTime\\": \\"2022-08-04T14:36:00+08:00\\"\\n}","type":"json"}]', 'title' => '查询OTA升级任务明细', ], 'ApproveOtaTask' => [ 'summary' => '设置OTA升级的执行时间。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '实例组id', 'description' => '交付组ID。可调用[ListAppInstanceGroup](~~ListAppInstanceGroup~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', ], ], [ 'name' => 'BizRegionId', 'in' => 'formData', 'schema' => [ 'title' => '请求发起者所在地域', 'description' => '交付组所属的地域ID。可以调用[ListRegions](~~ListRegions~~)查询无影云应用支持的地域列表。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => [ 'title' => 'ota任务id', 'description' => 'OTA升级任务ID。可调用[ListAppInstanceGroup](~~ListAppInstanceGroup~~)获取。'."\n" ."\n" .'> 每次调用`ApproveOtaTask`成功后，都会导致`TaskId`变更。因此，再次调用本接口之前，请重新调用`ListAppInstanceGroup`以获取最新的`TaskId`。', 'type' => 'string', 'required' => true, 'example' => 'ota-be7jzm29wrrz5****', ], ], [ 'name' => 'OtaType', 'in' => 'formData', 'schema' => [ 'title' => 'ota类型,取值：'."\n" .'Fota ： agent组件更新'."\n" .'ImageUpdate ： 镜像更新'."\n" .'AppUpdate ： 应用更新', 'description' => 'OTA升级任务类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Fota' => '无影系统组件更新', ], 'example' => 'Fota', 'enum' => [ 'Fota', 'ImageUpdate', 'AppUpdate', ], ], ], [ 'name' => 'StartTime', 'in' => 'formData', 'schema' => [ 'title' => '开始时间，iso8601格式', 'description' => 'OTA升级任务的开始时间。按照ISO 8601格式填写。', 'type' => 'string', 'format' => 'iso8601', 'required' => true, 'example' => '2022-08-04T14:36:00+08:00', ], ], ], '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-67E1FC5F****', ], 'Code' => [ 'description' => '执行结果。返回`success`表示成功，否则将返回错误信息。', 'type' => 'string', 'example' => 'OtaTask.Running', ], 'Message' => [ 'description' => '错误信息。当`Code`为`success`时，不返回该参数。', 'type' => 'string', 'example' => 'The task is running and cannot be sumitted.', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"OtaTask.Running\\",\\n \\"Message\\": \\"The task is running and cannot be sumitted.\\"\\n}","type":"json"}]', 'title' => '设置OTA升级执行时间', ], 'ListTenantConfig' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'PlainResult', 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'TenantConfigModel' => [ 'description' => '用户配置信息。', 'type' => 'object', 'properties' => [ 'AppInstanceGroupExpireRemind' => [ 'description' => '是否开启资源到期提醒。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '开启', 'false' => '不开启', ], 'example' => 'true', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TenantConfigModel\\": {\\n \\"AppInstanceGroupExpireRemind\\": true\\n }\\n}","type":"json"}]', 'title' => '查询管理员账号配置信息', 'summary' => '查询管理员账号配置信息，例如是否已开启资源到期提醒。', ], 'ModifyTenantConfig' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', 'http', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'AppInstanceGroupExpireRemind', 'in' => 'formData', 'schema' => [ 'description' => '是否开启资源到期提醒。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '开启', 'false' => '不开启', ], 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'BaseResult', 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '修改管理员账号配置信息', 'summary' => '修改管理员账号配置信息，例如是否开启资源到期提醒。', ], 'ListTagCloudResources' => [ 'summary' => '查询一个或多个指定云资源的标签列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266102', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ResourceType', 'in' => 'formData', 'schema' => [ 'title' => '资源类型。取值范围：'."\n" .'AliUid：租户 '."\n" .'AppId：应用ID'."\n" .'AppInstanceGroupId：交付组'."\n" .'WyId：用户', 'description' => '云资源类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'AppId' => '应用ID', 'WyId' => '无影用户唯一ID', 'AppInstanceGroupId' => '交付组ID', 'AliUid' => '租户ID', ], 'example' => 'AppInstanceGroupId', ], ], [ 'name' => 'ResourceIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '资源ID列表，最多支持50个。'."\n" .'资源类型为租户的时候不需要指定。', 'description' => '资源ID列表，最多支持50个。资源类型为租户ID时不需要指定。', 'type' => 'array', 'items' => [ 'title' => '资源ID。', 'description' => '资源ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-001', 'maxLength' => 64, 'minLength' => 1, ], 'required' => false, 'maxItems' => 50, 'minItems' => 0, ], ], [ 'name' => 'Scope', 'in' => 'formData', 'schema' => [ 'title' => '标签类型。取值范围：'."\n" .'Custom：自定义标签。'."\n" .'System：系统标签。'."\n" .'All：全部标签。'."\n" .'默认值：All。', 'description' => '标签类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'All' => '全部标签 [默认值]', 'Custom' => '自定义标签', 'System' => '系统标签', ], 'example' => 'Custom', 'maxLength' => 20, 'minLength' => 0, 'enum' => [ 'Custom', 'System', 'All', ], ], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => [ 'title' => '分页时每页显示的数据行数。'."\n" .'最大值：1000。默认值：50。', 'description' => '分页时每页显示的数据行数。'."\n" .'最大值：1000。默认值：50。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '50', 'default' => '50', ], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => [ 'title' => '下一个查询开始的 Token。', 'description' => '下一个查询开始的 Token。', 'type' => 'string', 'required' => false, 'example' => 'ptnJAAAAAAAxNzE5OTEwNQ==', ], ], ], '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'NextToken' => [ 'title' => '根据NextToken判断是否具备下一个查询开始的 Token。', 'description' => '根据NextToken判断是否具备下一个查询开始的 Token。', 'type' => 'string', 'example' => 'AAAAAYRHtOLVQzCYj17y+OP7LZRrUJaF4rnBGQkWwMiVHlLZBB1w3Us37CVvhvyM0TXavA==', ], 'TotalCount' => [ 'title' => '总数。', 'description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'ResourceTags' => [ 'title' => '资源绑定的标签信息列表。', 'description' => '资源绑定的标签信息列表。', 'type' => 'array', 'items' => [ 'title' => '资源绑定的标签信息。', 'description' => '资源绑定的标签信息。', 'type' => 'object', 'properties' => [ 'ResourceType' => [ 'title' => '资源类型。取值范围：'."\n" .'AliUid：租户 '."\n" .'AppId：应用ID'."\n" .'AppInstanceGroupId：交付组'."\n" .'WyId：用户', 'description' => '云资源类型。', 'type' => 'string', 'enumValueTitles' => [ 'AppId' => '应用ID', 'WyId' => '无影用户唯一ID', 'AppInstanceGroupId' => '交付组ID', 'AliUid' => '租户ID', ], 'example' => 'AppInstanceGroupId', ], 'ResourceId' => [ 'title' => '资源ID。', 'description' => '资源ID。', 'type' => 'string', 'example' => 'aig-0001', ], 'Tags' => [ 'title' => '标签信息列表。', 'description' => '标签信息列表。', 'type' => 'array', 'items' => [ 'title' => '标签信息。', 'description' => '标签信息。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键', 'description' => '标签键。', 'type' => 'string', 'example' => 'Resolution', ], 'Value' => [ 'title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'example' => '1080p', ], 'Scope' => [ 'title' => '标签类型。取值范围：'."\n" .'Custom：自定义标签。'."\n" .'System：系统标签。', 'description' => '标签类型。', 'type' => 'string', 'enumValueTitles' => [ 'Custom' => '自定义标签', 'System' => '系统标签', ], 'example' => 'Custom', ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'ServiceUnavailable', 'errorMessage' => 'Service unavailable. Please try again later.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"AAAAAYRHtOLVQzCYj17y+OP7LZRrUJaF4rnBGQkWwMiVHlLZBB1w3Us37CVvhvyM0TXavA==\\",\\n \\"TotalCount\\": 15,\\n \\"ResourceTags\\": [\\n {\\n \\"ResourceType\\": \\"AppInstanceGroupId\\",\\n \\"ResourceId\\": \\"aig-0001\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Resolution\\",\\n \\"Value\\": \\"1080p\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询云资源的标签列表', ], 'TagCloudResources' => [ 'summary' => '为云资源创建并绑定标签，对于资源已有的标签，则更新标签的值。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266104', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ResourceType', 'in' => 'formData', 'schema' => [ 'title' => '资源类型。取值范围：'."\n" .'AliUid：租户 '."\n" .'AppId：应用ID'."\n" .'AppInstanceGroupId：交付组'."\n" .'WyId：用户', 'description' => '云资源类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'CenterImageId' => '中心镜像ID', 'AppId' => '应用ID', 'WyId' => '无影用户唯一ID', 'AppInstanceGroupId' => '交付组ID', 'AliUid' => '租户ID', ], 'example' => 'AppInstanceGroupId', 'maxLength' => 30, 'minLength' => 1, 'enum' => [ 'AliUid', 'AppId', 'AppInstanceGroupId', 'WyId', 'CenterImageId', ], ], ], [ 'name' => 'ResourceIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '资源ID列表，最多支持50个'."\n" .'资源类型为租户的时候不需要指定。', 'description' => '资源ID列表，最多支持50个。资源类型为租户ID时不需要指定。', 'type' => 'array', 'items' => [ 'title' => '资源ID', 'description' => '资源ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-0002', 'maxLength' => 64, 'minLength' => 1, ], 'required' => false, 'maxItems' => 50, 'minItems' => 0, ], ], [ 'name' => 'Tags', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '自定义（Custom+指定范围的System）标签列表，最多支持10个'."\n" .'● 标签键长度范围：1~128 个字符。'."\n" .'● 标签值长度范围：1~128 个字符。'."\n" .'● 区分大小写。'."\n" .'● 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。', 'description' => '标签列表。支持系统标签和自定义标签。'."\n" ."\n" .'- 系统标签枚举值：'."\n" .' - `System/Scheduler/GRAYSCALE`：灰度标签'."\n" .' - `System/Scheduler/STOP_NEW_USER_CONNECTION`：阻止交付组新绑定用户建连的标签'."\n" ."\n" .'- 自定义标签：最多可创建20个。'."\n" ."\n" .'> 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。', 'type' => 'array', 'items' => [ 'title' => '标签信息。', 'description' => '标签信息。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键。', 'description' => '标签键。区分大小写。长度范围：1\\~128 个字符。', 'type' => 'string', 'required' => true, 'example' => 'Resolution', 'maxLength' => 128, 'minLength' => 1, ], 'Value' => [ 'title' => '标签值。', 'description' => '标签值。区分大小写。长度范围：1\\~128 个字符。', 'type' => 'string', 'required' => true, 'example' => '720p', 'maxLength' => 256, 'minLength' => 0, ], ], 'required' => true, ], 'required' => true, 'maxItems' => 20, 'minItems' => 1, ], ], ], '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'FailedResources' => [ 'title' => '失败的资源与标签信息列表。', 'description' => '失败的资源与标签信息列表。', 'type' => 'array', 'items' => [ 'title' => '失败的资源与标签信息。', 'description' => '失败的资源与标签信息。', 'type' => 'object', 'properties' => [ 'ResourceType' => [ 'title' => '资源类型。取值范围：'."\n" .'AliUid：租户 '."\n" .'AppId：应用ID'."\n" .'AppInstanceGroupId：交付组'."\n" .'WyId：用户', 'description' => '云资源类型。', 'type' => 'string', 'enumValueTitles' => [ 'CenterImageId' => '中心镜像ID', 'AppId' => '应用ID', 'WyId' => '无影用户唯一ID', 'AppInstanceGroupId' => '交付组ID', 'AliUid' => '租户ID', ], 'example' => 'AppInstanceGroupId', ], 'ResourceId' => [ 'title' => '资源ID。', 'description' => '资源ID。', 'type' => 'string', 'example' => 'aig-001', ], 'Tags' => [ 'title' => '失败的标签信息列表。', 'description' => '失败的标签信息列表。', 'type' => 'array', 'items' => [ 'title' => '失败的标签信息。', 'description' => '失败的标签信息。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'example' => 'System/Scheduler/STOP_NEW_USER_CONNECTION', ], 'Value' => [ 'title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'example' => 'true', ], 'Scope' => [ 'title' => '标签类型。取值范围：'."\n" .'Custom：自定义标签。'."\n" .'System：系统标签。', 'description' => '标签类型。', 'type' => 'string', 'enumValueTitles' => [ 'Custom' => '自定义标签', 'System' => '系统标签', ], 'example' => 'System', ], ], ], ], 'Code' => [ 'title' => '错误码。', 'description' => '错误码。', 'type' => 'string', 'example' => 'TAG_KEY_DUPLICATED', ], 'Message' => [ 'title' => '错误描述', 'description' => '错误描述。', 'type' => 'string', 'example' => 'Duplicate tag keys exist.', ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'ServiceUnavailable', 'errorMessage' => 'Service unavailable. Please try again later.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FailedResources\\": [\\n {\\n \\"ResourceType\\": \\"AppInstanceGroupId\\",\\n \\"ResourceId\\": \\"aig-001\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"System/Scheduler/STOP_NEW_USER_CONNECTION\\",\\n \\"Value\\": \\"true\\",\\n \\"Scope\\": \\"System\\"\\n }\\n ],\\n \\"Code\\": \\"TAG_KEY_DUPLICATED\\",\\n \\"Message\\": \\"Duplicate tag keys exist.\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '为云资源创建并绑定标签', ], 'UntagCloudResources' => [ 'summary' => '为云资源统一解绑标签。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266118', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ResourceType', 'in' => 'formData', 'schema' => [ 'title' => '资源类型。取值范围：'."\n" .'AliUid：租户 '."\n" .'AppId：应用ID'."\n" .'AppInstanceGroupId：交付组'."\n" .'WyId：用户', 'description' => '资源类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'AppId' => '应用ID', 'WyId' => '无影用户唯一ID', 'AppInstanceGroupId' => '交付组ID', 'AliUid' => '租户ID', ], 'example' => 'AppInstanceGroupId', ], ], [ 'name' => 'ResourceIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '资源ID列表，最多支持50个'."\n" .'资源类型为租户的时候不需要指定。', 'description' => '资源ID列表，最多支持50个。资源类型为租户ID时不需要指定。', 'type' => 'array', 'items' => [ 'title' => '资源ID', 'description' => '资源ID。', 'type' => 'string', 'required' => true, 'example' => 'aig-0009', 'maxLength' => 64, 'minLength' => 1, ], 'required' => false, 'maxItems' => 50, 'minItems' => 0, ], ], [ 'name' => 'TagKeys', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'title' => '自定义（Custom+指定范围的System）标签键列表，最多支持10个', 'description' => '标签列表。支持系统标签和自定义标签。最多可传入10个标签。'."\n" ."\n" .'系统标签枚举值：'."\n" .'- `System/Scheduler/GRAYSCALE`：灰度标签'."\n" .'- `System/Scheduler/STOP_NEW_USER_CONNECTION`：阻止交付组新绑定用户建连的标签', 'type' => 'array', 'items' => [ 'title' => '标签键', 'description' => '标签键。区分大小写。长度范围：1\\~128 个字符。', 'type' => 'string', 'required' => true, 'example' => 'System/Scheduler/GRAYSCALE', 'maxLength' => 128, 'minLength' => 1, ], 'required' => true, 'maxItems' => 20, 'minItems' => 1, ], ], ], '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' => 'E25FC620-6B6F-12D2-A992-AD8727DC****', ], 'FailedResources' => [ 'title' => '失败的资源与标签信息列表。', 'description' => '失败的资源与标签信息列表。', 'type' => 'array', 'items' => [ 'title' => '失败的资源与标签信息。', 'description' => '失败的资源与标签信息。', 'type' => 'object', 'properties' => [ 'ResourceType' => [ 'title' => '资源类型。'."\n" .'● 租户 AliUid'."\n" .'● 应用ID AppId'."\n" .'● 交付组 AppInstanceGroupId'."\n" .'● 用户 WyId', 'description' => '云资源类型。', 'type' => 'string', 'enumValueTitles' => [ 'AppId' => '应用ID', 'WyId' => '无影用户唯一ID', 'AppInstanceGroupId' => '交付组ID', 'AliUid' => '租户ID', ], 'example' => 'AppInstanceGroupId', ], 'ResourceId' => [ 'title' => '资源ID。', 'description' => '资源ID。', 'type' => 'string', 'example' => 'aig-00000001', ], 'Tags' => [ 'title' => '失败的标签信息列表。', 'description' => '失败的标签信息列表。', 'type' => 'array', 'items' => [ 'title' => '失败的标签信息。', 'description' => '失败的标签信息。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'example' => 'Resolution', ], 'Scope' => [ 'title' => '标签类型。取值范围：'."\n" .'Custom：自定义标签。'."\n" .'System：系统标签。', 'description' => '标签类型。', 'type' => 'string', 'enumValueTitles' => [ 'Custom' => '自定义标签', 'System' => '系统标签', ], 'example' => 'Custom', ], ], ], ], 'Code' => [ 'title' => '错误码。', 'description' => '错误码。', 'type' => 'string', 'example' => 'UNTAG_RESOURCE_FAILED', ], 'Message' => [ 'title' => '错误描述', 'description' => '错误描述。', 'type' => 'string', 'example' => 'Failed to untag resource.', ], ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'ServiceUnavailable', 'errorMessage' => 'Service unavailable. Please try again later.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25FC620-6B6F-12D2-A992-AD8727DC****\\",\\n \\"FailedResources\\": [\\n {\\n \\"ResourceType\\": \\"AppInstanceGroupId\\",\\n \\"ResourceId\\": \\"aig-00000001\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Resolution\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"Code\\": \\"UNTAG_RESOURCE_FAILED\\",\\n \\"Message\\": \\"Failed to untag resource.\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '解除云资源的标签', ], 'DescribeWuyingServerEipInfo' => [ 'summary' => '查询无影工作站EIP信息。', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], ], 'parameters' => [ [ 'name' => 'WuyingServerId', 'in' => 'formData', 'schema' => [ 'description' => '工作站ID。', 'type' => 'string', 'required' => true, 'example' => 'ws-0bw2f11****dial', ], ], [ 'name' => 'Isp', 'in' => 'formData', 'schema' => [ 'description' => '互联网服务运营商，取值范围： '."\n" .'- ChinaMobile：移动。'."\n" .'- ChinaTelecom：电信。'."\n" .'- ChinaUnicom：联通。', 'type' => 'string', 'required' => false, 'example' => 'ChinaTelecom', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], 'EipInfoModel' => [ 'description' => '弹性公网IP信息。', 'type' => 'object', 'properties' => [ 'NetworkInterfaceId' => [ 'description' => '网卡ID。', 'type' => 'string', 'example' => 'eni-bp174p2xxxxxbyh02ix', ], 'IpAddress' => [ 'description' => '公网 IP。', 'type' => 'string', 'example' => '171.xxx.xxx.221', ], 'ServerPortRange' => [ 'description' => '端口范围。', 'type' => 'string', 'example' => '6606/6607', ], 'EipId' => [ 'type' => 'string', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"EipInfoModel\\": {\\n \\"NetworkInterfaceId\\": \\"eni-bp174p2xxxxxbyh02ix\\",\\n \\"IpAddress\\": \\"171.xxx.xxx.221\\",\\n \\"ServerPortRange\\": \\"6606/6607\\",\\n \\"EipId\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '查询无影工作站EIP信息', ], 'CreateWuyingServer' => [ 'summary' => '创建一台或多台工作站。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREappstreamingU1TTUH', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'WuyingServerName', 'in' => 'formData', 'schema' => [ 'description' => '工作站名称，创建多台时自动增加数字后缀。', 'type' => 'string', 'required' => false, 'example' => 'exampleServerName', ], ], [ 'name' => 'Amount', 'in' => 'formData', 'schema' => [ 'description' => '数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ServerInstanceType', 'in' => 'formData', 'schema' => [ 'description' => '工作站规格。', 'type' => 'string', 'required' => false, 'example' => 'eds.proworkstation_flagship_elite_ne.96c384g.192g4x', ], ], [ 'name' => 'SystemDiskSize', 'in' => 'formData', 'schema' => [ 'description' => '系统盘大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'SystemDiskCategory', 'in' => 'formData', 'schema' => [ 'description' => '系统盘类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'cloud_auto' => 'cloud_auto', ], 'example' => 'cloud_auto', ], ], [ 'name' => 'SystemDiskPerformanceLevel', 'in' => 'formData', 'schema' => [ 'description' => '系统盘性能等级。', 'type' => 'string', 'required' => false, 'example' => 'PL0', ], ], [ 'name' => 'DataDisk', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => '数据盘列表。', 'type' => 'array', 'items' => [ 'description' => '数据盘信息。', 'type' => 'object', 'properties' => [ 'DataDiskSize' => [ 'description' => '数据盘大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], 'DataDiskCategory' => [ 'description' => '数据盘类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'cloud_auto' => 'cloud_auto', ], 'example' => 'cloud_auto', ], 'DataDiskPerformanceLevel' => [ 'description' => '数据盘性能等级。', 'type' => 'string', 'required' => false, 'example' => 'PL0', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'ImageId', 'in' => 'formData', 'schema' => [ 'description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'img-bp13mu****', ], ], [ 'name' => 'BizRegionId', 'in' => 'formData', 'schema' => [ 'description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'OfficeSiteId', 'in' => 'formData', 'schema' => [ 'description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-643067****', ], ], [ 'name' => 'Password', 'in' => 'formData', 'schema' => [ 'description' => '工作站登录密码。', 'type' => 'string', 'required' => false, 'example' => 'YourPassword123', ], ], [ 'name' => 'ChargeType', 'in' => 'formData', 'schema' => [ 'description' => '付费类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PrePaid' => '包年包月', ], 'example' => 'PrePaid', ], ], [ 'name' => 'Period', 'in' => 'formData', 'schema' => [ 'description' => '购买时长。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PeriodUnit', 'in' => 'formData', 'schema' => [ 'description' => '时间单位。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Month' => '月', 'Year' => '年', ], 'example' => 'Month', ], ], [ 'name' => 'AutoPay', 'in' => 'formData', 'schema' => [ 'description' => '自动支付。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AutoRenew', 'in' => 'formData', 'schema' => [ 'description' => '自动续费。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'PromotionId', 'in' => 'formData', 'schema' => [ 'description' => '折扣ID。'."\n" ."\n\n" .'> 如果设置了PromotionId，则会尝试应用相应的折扣优惠。', 'type' => 'string', 'required' => false, 'example' => '17440009****', ], ], [ 'name' => 'VSwitchIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '办公网络交换机列表。', 'type' => 'array', 'items' => [ 'description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-55vk6****5vatze7jg', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'VirtualNodePoolId', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => 'vnp-0b************gyw', ], ], [ 'name' => 'NetworkStrategyType', 'in' => 'formData', 'schema' => [ 'description' => '网络策略类型（邀测）。', 'type' => 'string', 'required' => false, 'example' => 'DirectIp', ], ], [ 'name' => 'Bandwidth', 'in' => 'formData', 'schema' => [ 'description' => '带宽值，NetworkStrategyType为DirectIp有效，单位：Mbps，范围2～100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '2', 'example' => '10', ], ], [ 'name' => 'IdempotenceToken', 'in' => 'formData', 'schema' => [ 'title' => '幂等性令牌，确保操作唯一性', 'description' => '幂等性令牌，确保操作唯一性', 'type' => 'string', 'required' => false, 'example' => '6a1b8c3d', ], ], [ 'name' => 'ServerPortRange', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'SavingPlanId', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'HostName', 'in' => 'formData', 'schema' => [ 'description' => '主机名称。限制说明如下：'."\n" ."\n" .'- 半角句号（.）和短划线（-）不能作为首尾字符，更不能连续使用。'."\n" ."\n" .'- windows工作站：字符长度为2~15，不支持半角句号（.），不能连续使用短划线，不能全是数字。允许包含大小写英文字母、数字和短划线（-）。'."\n" ."\n" .'- Linux工作站：'."\n" ."\n" .' - 字符长度为2~64，支持多个半角句号（.），点之间为一段，每段允许包含大小写英文字母、数字和短划线（-）。'."\n" ."\n" .' - 支持通过占位符`${instance_id}`将实例ID 写入HostName参数。例如：`HostName=k8s-${instance_id}`，并且创建的 ECS 实例 ID 为`i-123abc****`，则该实例的主机名为`k8s-i-123abc****`。'."\n" ."\n" .'- 一次创建多台工作站实例时，可以使用`name_prefix[begin_number,bits]name_suffix`的命名格式为多台工作站统一命名。例如，设置Hostname 的取值为`ecd-[1,4]-test`，则第一台工作站主机名称为`ecd-0001-test`，第二台工作站主机名称为`ecd-0002-test`，依次类推。'."\n" ."\n" .' - `name_prefix`：主机名称的前缀。'."\n" ."\n" .' - `[begin_number,bits]`：主机名称中的有序数字。'."\n" ."\n" .' - `begin_number`：起始数字，取值支持0~999999，默认值为 0，若取值非法也设置为0。'."\n" ."\n" .' - `bits`：数字位数，取值支持1~6，默认值为 6，若取值非法也设置为6。'."\n" ."\n" .' - `name_suffix`：主机名称的后缀。', 'type' => 'string', 'required' => false, 'example' => 'testhost', ], ], [ 'name' => 'SubPayType', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'MaxPrice', 'in' => 'formData', 'schema' => [ 'type' => 'number', 'format' => 'float', 'required' => false, ], ], ], '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-67E1FC5F****', ], 'Data' => [ 'description' => '响应数据。', 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => '订单ID。', 'type' => 'string', 'example' => '23429322113****', ], 'WuyingServerIdList' => [ 'description' => '工作站ID列表。', 'type' => 'array', 'items' => [ 'description' => '工作站ID。', 'type' => 'string', 'example' => 'ws-0byd****2lwi', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"23429322113****\\",\\n \\"WuyingServerIdList\\": [\\n \\"ws-0byd****2lwi\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => '创建工作站', 'description' => '1. 项目相当于云Flow控制台的资源配置模块'."\n" .'2. 当入参ContentId背后有多个版本的时候，当前api会使用默认的那个版本 同时进行绑定'."\n" .'3. 只有Content的默认版本是可用状态，调用当前接口才可以成功', ], 'ListWuyingServer' => [ 'summary' => '查询工作站列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'title' => '分页大小', 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '100', 'default' => '20', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'title' => '页码', 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'BizType', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, ], ], [ 'name' => 'WuyingServerNameOrId', 'in' => 'formData', 'schema' => [ 'title' => '研发主机名称', 'description' => '工作站名称或工作站ID。', 'type' => 'string', 'required' => false, 'example' => 'exampleServerName', ], ], [ 'name' => 'WuyingServerIdList', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => '工作站ID列表。', 'type' => 'array', 'items' => [ 'description' => '工作站ID。', 'type' => 'string', 'required' => false, 'example' => 'ws-0bydg****2lwi', ], 'required' => false, ], ], [ 'name' => 'ServerInstanceType', 'in' => 'formData', 'schema' => [ 'title' => '规格', 'description' => '工作站规格。', 'type' => 'string', 'required' => false, 'example' => 'eds.proworkstation_flagship_elite.32c64g.48g1x', ], ], [ 'name' => 'ImageId', 'in' => 'formData', 'schema' => [ 'title' => '镜像ID', 'description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'img-bp13mu****', ], ], [ 'name' => 'BizRegionId', 'in' => 'formData', 'schema' => [ 'title' => '地域', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'OfficeSiteId', 'in' => 'formData', 'schema' => [ 'title' => '工作区ID', 'description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-172301****', ], ], [ 'name' => 'ChargeType', 'in' => 'formData', 'schema' => [ 'title' => '付费类型', 'description' => '付费类型。', 'type' => 'string', 'required' => false, 'example' => 'PrePaid', ], ], [ 'name' => 'VirtualNodePoolId', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'AddVirtualNodePoolStatusList', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'required' => false, ], 'required' => false, ], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => [ 'title' => '状态', 'description' => '工作站状态。', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', ], ], [ 'name' => 'Users', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'required' => false, ], 'required' => false, ], ], ], '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-67E1FC5F****', ], 'TotalCount' => [ 'title' => '总量', 'description' => '总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'PageSize' => [ 'title' => '分页大小', 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'title' => '页码', 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'WuyingServerList' => [ 'description' => '工作站信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AliUid' => [ 'type' => 'integer', 'format' => 'int64', ], 'WuyingServerId' => [ 'description' => '工作站ID。', 'type' => 'string', 'example' => 'ws-0byd****8wn2lwi', ], 'WuyingServerName' => [ 'description' => '工作站名称。', 'type' => 'string', 'example' => 'exampleServerName', ], 'Status' => [ 'description' => '工作站状态。', 'type' => 'string', 'example' => 'RUNNING', ], 'ServerInstanceTypeInfo' => [ 'description' => '规格信息。', 'type' => 'object', 'properties' => [ 'ServerInstanceType' => [ 'description' => '工作站规格。', 'type' => 'string', 'example' => 'eds.proworkstation_flagship_elite_ne.96c384g.192g4x', ], 'Cpu' => [ 'description' => 'vCPU数量。', 'type' => 'string', 'example' => '96', ], 'Memory' => [ 'description' => '内存大小，单位为MB。', 'type' => 'integer', 'format' => 'int32', 'example' => '393,216', ], 'Gpu' => [ 'description' => 'GPU数量。', 'type' => 'string', 'example' => '4', ], 'GpuMemory' => [ 'description' => '显存大小，单位为MB。', 'type' => 'integer', 'format' => 'int32', 'example' => '196,608', ], 'GpuSpec' => [ 'type' => 'string', ], ], ], 'SystemDiskSize' => [ 'description' => '系统盘大小，单位为GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'SystemDiskCategory' => [ 'description' => '系统盘类型。', 'type' => 'string', 'example' => 'cloud_auto', ], 'SystemDiskPerformanceLevel' => [ 'description' => '系统盘性能等级。', 'type' => 'string', 'example' => 'PL0', ], 'DataDisk' => [ 'description' => '数据盘列表。', 'type' => 'array', 'items' => [ 'description' => '数据盘信息。', 'type' => 'object', 'properties' => [ 'DataDiskSize' => [ 'description' => '数据盘大小，单位为GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'DataDiskCategory' => [ 'description' => '数据盘类型。', 'type' => 'string', 'example' => 'cloud_auto', ], 'DataDiskPerformanceLevel' => [ 'description' => '数据盘性能等级。', 'type' => 'string', 'example' => 'PL0', ], 'DataDiskId' => [ 'type' => 'string', ], 'DataDiskNo' => [ 'type' => 'string', ], ], ], ], 'ImageId' => [ 'description' => '镜像ID。', 'type' => 'string', 'example' => 'imgc-06****oagaev', ], 'ImageName' => [ 'description' => '镜像名称。', 'type' => 'string', 'example' => 'Alibaba Cloud Linux 3.2104 LTS 64位', ], 'OsType' => [ 'description' => '操作系统类型。', 'type' => 'string', 'example' => 'Linux', ], 'BizRegionId' => [ 'description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'OfficeSiteId' => [ 'description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-1b****ayv2', ], 'OfficeSiteName' => [ 'description' => '办公网络名称。', 'type' => 'string', 'example' => 'exampleOfficeSite', ], 'OfficeSiteType' => [ 'description' => '办公网络类型。', 'type' => 'string', 'example' => 'SIMPLE', ], 'NetworkInterfaceIp' => [ 'description' => '内网IP。', 'type' => 'string', 'example' => '10.80.21.149', ], 'ChargeType' => [ 'description' => '付费方式。', 'type' => 'string', 'example' => 'PrePaid', ], 'CreateTime' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2025-08-02T16:52:11.000+00:00', ], 'ExpiredTime' => [ 'description' => '到期时间。', 'type' => 'string', 'example' => '2025-09-03T16:00:00.000+00:00', ], 'VirtualNodePoolId' => [ 'type' => 'string', ], 'AddVirtualNodePoolStatus' => [ 'type' => 'string', ], 'SubPayType' => [ 'type' => 'string', ], 'MaxPrice' => [ 'type' => 'number', 'format' => 'float', ], 'VirtualKubeletIp' => [ 'type' => 'string', ], 'ResourceSessionStatus' => [ 'type' => 'string', ], 'Bandwidth' => [ 'type' => 'integer', 'format' => 'int32', ], 'FotaVersion' => [ 'type' => 'string', ], 'TimerGroupId' => [ 'title' => '定时任务ID。', 'description' => '定时任务ID。', 'type' => 'string', ], 'SystemDiskId' => [ 'type' => 'string', ], 'InstanceInfoList' => [ 'description' => '工作站实例信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'p-0ceitx****c5', ], 'NetworkInterfaceId' => [ 'description' => '网卡ID。', 'type' => 'string', 'example' => 'eni-uf65b****dfnt3wb', ], ], ], ], 'SecurityGroupIds' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'Users' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'Sessions' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceSessionStartTime' => [ 'type' => 'string', ], 'UserId' => [ 'type' => 'string', ], ], ], ], 'PolicyGroupIdList' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"WuyingServerList\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"WuyingServerId\\": \\"ws-0byd****8wn2lwi\\",\\n \\"WuyingServerName\\": \\"exampleServerName\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ServerInstanceTypeInfo\\": {\\n \\"ServerInstanceType\\": \\"eds.proworkstation_flagship_elite_ne.96c384g.192g4x\\",\\n \\"Cpu\\": \\"96\\",\\n \\"Memory\\": 0,\\n \\"Gpu\\": \\"4\\",\\n \\"GpuMemory\\": 0,\\n \\"GpuSpec\\": \\"\\"\\n },\\n \\"SystemDiskSize\\": 100,\\n \\"SystemDiskCategory\\": \\"cloud_auto\\",\\n \\"SystemDiskPerformanceLevel\\": \\"PL0\\",\\n \\"DataDisk\\": [\\n {\\n \\"DataDiskSize\\": 200,\\n \\"DataDiskCategory\\": \\"cloud_auto\\",\\n \\"DataDiskPerformanceLevel\\": \\"PL0\\",\\n \\"DataDiskId\\": \\"\\",\\n \\"DataDiskNo\\": \\"\\"\\n }\\n ],\\n \\"ImageId\\": \\"imgc-06****oagaev\\",\\n \\"ImageName\\": \\"Alibaba Cloud Linux 3.2104 LTS 64位\\",\\n \\"OsType\\": \\"Linux\\",\\n \\"BizRegionId\\": \\"cn-hangzhou\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-1b****ayv2\\",\\n \\"OfficeSiteName\\": \\"exampleOfficeSite\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"NetworkInterfaceIp\\": \\"10.80.21.149\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"CreateTime\\": \\"2025-08-02T16:52:11.000+00:00\\",\\n \\"ExpiredTime\\": \\"2025-09-03T16:00:00.000+00:00\\",\\n \\"VirtualNodePoolId\\": \\"\\",\\n \\"AddVirtualNodePoolStatus\\": \\"\\",\\n \\"SubPayType\\": \\"\\",\\n \\"MaxPrice\\": 0,\\n \\"VirtualKubeletIp\\": \\"\\",\\n \\"ResourceSessionStatus\\": \\"\\",\\n \\"Bandwidth\\": 0,\\n \\"FotaVersion\\": \\"\\",\\n \\"TimerGroupId\\": \\"\\",\\n \\"SystemDiskId\\": \\"\\",\\n \\"InstanceInfoList\\": [\\n {\\n \\"InstanceId\\": \\"p-0ceitx****c5\\",\\n \\"NetworkInterfaceId\\": \\"eni-uf65b****dfnt3wb\\"\\n }\\n ],\\n \\"SecurityGroupIds\\": [\\n \\"\\"\\n ],\\n \\"Users\\": [\\n \\"\\"\\n ],\\n \\"Sessions\\": [\\n {\\n \\"ResourceSessionStartTime\\": \\"\\",\\n \\"UserId\\": \\"\\"\\n }\\n ],\\n \\"PolicyGroupIdList\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询工作站', ], 'StartWuyingServer' => [ 'summary' => '启动工作站。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREappstreamingEP3FXS', ], ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'WuyingServerIdList', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => '工作站ID列表。', 'type' => 'array', 'items' => [ 'description' => '工作站ID。', 'type' => 'string', 'required' => false, 'example' => 'ws-0bydg****2lwi', ], 'required' => false, ], ], ], '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-67E1FC5F****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '启动工作站', ], 'StopWuyingServer' => [ 'summary' => '停止工作站。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREappstreamingEP3FXS', ], ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'WuyingServerIdList', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => '工作站ID列表。', 'type' => 'array', 'items' => [ 'description' => '工作站ID。', 'type' => 'string', 'required' => false, 'example' => 'ws-0byd****wn2lwi', ], 'required' => false, ], ], [ 'name' => 'Force', 'in' => 'formData', 'schema' => [ 'title' => '强制重启', 'description' => '强制重启。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'True' => '强制', 'False' => '不强制', ], 'example' => 'True', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '请求响应。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AD2D0761-1FE5-549D-B169******', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\"\\n}","type":"json"}]', 'title' => '停止工作站', ], 'RestartWuyingServer' => [ 'summary' => '重启工作站。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREappstreamingEP3FXS', ], ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'WuyingServerIdList', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => '工作站ID列表。', 'type' => 'array', 'items' => [ 'description' => '工作站ID。', 'type' => 'string', 'required' => false, 'example' => 'ws-0byd****n2lwi', ], 'required' => false, ], ], ], '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-67E1FC5F****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '重启工作站', ], 'ModifyWuyingServerAttribute' => [ 'summary' => '修改工作站属性。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREappstreamingBC1NTD', ], ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'WuyingServerId', 'in' => 'formData', 'schema' => [ 'description' => '工作站ID。', 'type' => 'string', 'required' => false, 'example' => 'ws-0bw2f11****dial', ], ], [ 'name' => 'WuyingServerName', 'in' => 'formData', 'schema' => [ 'description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'exampleServerName', ], ], [ 'name' => 'Password', 'in' => 'formData', 'schema' => [ 'description' => '工作站登录密码。', 'type' => 'string', 'required' => false, 'example' => 'yourPassword', ], ], ], '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-67E1FC5F****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '修改工作站属性', ], 'UpdateWuyingServerImage' => [ 'summary' => '更新工作站镜像。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREappstreamingDG81PX', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ 'description' => '产品类型。需填写固定值WuyingServer。', 'type' => 'string', 'required' => false, 'example' => 'WuyingServer', ], ], [ 'name' => 'WuyingServerId', 'in' => 'formData', 'schema' => [ 'description' => '工作站ID。', 'type' => 'string', 'required' => false, 'example' => 'ws-0bw2f11****dial', ], ], [ 'name' => 'ImageId', 'in' => 'formData', 'schema' => [ 'description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'imgc-0aae4rgk9****6e8p', ], ], ], '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-67E1FC5F****', ], 'TaskId' => [ 'description' => '更新任务ID。', 'type' => 'string', 'example' => 'ota-be7jzm29wrrz5****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskId\\": \\"ota-be7jzm29wrrz5****\\"\\n}","type":"json"}]', 'title' => '更新工作站镜像', ], 'RenewWuyingServer' => [ 'summary' => '为一台工作站续费。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'WuyingServerId', 'in' => 'formData', 'schema' => [ 'description' => '工作站ID。', 'type' => 'string', 'required' => false, 'example' => 'ws-0bw2f11****dial', ], ], [ 'name' => 'Period', 'in' => 'formData', 'schema' => [ 'description' => '续费时长。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PeriodUnit', 'in' => 'formData', 'schema' => [ 'description' => '续费时间单位。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Month' => '月', 'Year' => '年', ], 'example' => 'Month'."\n", ], ], [ 'name' => 'AutoPay', 'in' => 'formData', 'schema' => [ 'description' => '自动支付。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'PromotionId', 'in' => 'formData', 'schema' => [ 'description' => '折扣ID。', 'type' => 'string', 'required' => false, 'example' => '17440009****', ], ], ], '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-67E1FC5F****', ], 'OrderId' => [ 'description' => '订单ID。', 'type' => 'string', 'example' => '23977848****97', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OrderId\\": \\"23977848****97\\"\\n}","type":"json"}]', 'title' => '续费工作站', ], 'DeleteWuyingServer' => [ 'summary' => '删除工作站', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREappstreamingKER98U', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'WuyingServerId', 'in' => 'formData', 'schema' => [ 'description' => '工作站ID。', 'type' => 'string', 'required' => true, 'example' => 'ws-0bw2f11****dial', 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '删除工作站', 'description' => '删除工作站。', ], 'ModifyBrowserInstanceGroup' => [ 'summary' => '修改无影云浏览器属性。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '219753', 'abilityTreeNodes' => [ 'FEATUREappstreaming4BR4QS', 'FEATUREappstreamingKE839Q', 'FEATUREappstreaming50MBS2', ], ], 'parameters' => [ [ 'name' => 'BrowserInstanceGroupId', 'in' => 'query', 'schema' => [ 'description' => '需要修改的云浏览器ID。', 'type' => 'string', 'required' => true, 'example' => 'big-0bz55ixxxxx9xi9w9', ], ], [ 'name' => 'CloudBrowserName', 'in' => 'formData', 'schema' => [ 'description' => '云浏览器名称。', 'type' => 'string', 'required' => false, 'example' => 'BrowserTest', ], ], [ 'name' => 'Network', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '网络配置。', 'type' => 'object', 'properties' => [ 'AccessRestriction' => [ 'description' => '访问限制类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'ALLOW_LIST' => '白名单模式', ], 'example' => 'ALLOW_LIST', ], 'RestrictedURLs' => [ 'description' => '限制域名配置。', 'type' => 'array', 'items' => [ 'description' => '关联的域名限制。', 'type' => 'object', 'properties' => [ 'URL' => [ 'description' => '域名。', 'type' => 'string', 'required' => false, 'example' => 'aliyun.com', ], 'RestrictedURLId' => [ 'description' => '域名配置ID，仅修改需要传入。', 'type' => 'string', 'required' => false, 'example' => 'ru-12345', ], ], 'required' => false, ], 'required' => false, ], 'RemoveRestrictedURLIds' => [ 'description' => '需要移除的域名列表。', 'type' => 'array', 'items' => [ 'description' => '域名配置ID。', 'type' => 'string', 'required' => false, 'example' => 'ru-12345', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'Policy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '访问策略。', 'type' => 'object', 'properties' => [ 'ClipboardPolicy' => [ 'description' => '剪切板相关策略。', 'type' => 'object', 'properties' => [ 'Clipboard' => [ 'description' => '剪切板策略。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'read' => '允许本地往云浏览器复制粘贴', 'readwrite' => '双向允许', 'write' => '允许云浏览器往本地复制粘贴', 'off' => '双向禁止', ], 'example' => 'off', ], 'ClipboardScope' => [ 'description' => '剪切板管控范围。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'grained' => '精细化管控', 'global' => '全局管控', ], 'example' => 'global', ], 'TextClipboard' => [ 'description' => '文本剪切板策略。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'read' => '允许本地往云浏览器复制粘贴', 'readwrite' => '双向允许', 'write' => '允许云浏览器往本地复制粘贴', 'off' => '双向禁止', ], 'example' => 'off', ], 'RichTextClipboard' => [ 'description' => '富文本剪切板策略。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'read' => '允许本地往云浏览器复制粘贴', 'readwrite' => '双向允许', 'write' => '允许云浏览器往本地复制粘贴', 'off' => '双向禁止', ], 'example' => 'off', ], 'FileClipboard' => [ 'description' => '文件剪切板策略。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'read' => '允许本地往云浏览器复制粘贴', 'readwrite' => '双向允许', 'write' => '允许云浏览器往本地复制粘贴', 'off' => '双向禁止', ], 'example' => 'off', ], 'ClipboardReadLimit' => [ 'description' => '剪切板读取长度限制。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], 'ClipboardWriteLimit' => [ 'description' => '剪切板写入长度限制。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], 'ClipboardSizeUnit' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], 'VideoPolicy' => [ 'description' => '画面策略。', 'type' => 'object', 'properties' => [ 'FrameRate' => [ 'description' => '帧率。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', ], ], 'required' => false, ], 'WatermarkPolicy' => [ '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' => [ 'EndUserId' => '便捷账号ID', 'ClientTime' => '系统时间', 'InstanceGroup' => '浏览器组ID', ], 'example' => 'EndUserId', ], 'required' => false, ], ], 'required' => false, ], 'PolicyId' => [ 'description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-12345', ], 'PolicyVersion' => [ 'description' => '策略版本。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Center' => '中心策略', ], 'example' => 'Center', ], 'DisconnectKeepSession' => [ 'description' => '断连保留策略。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'customTime' => '自定义时间', 'persistent' => '用不释放', ], 'example' => 'customTime', ], 'DisconnectKeepSessionTime' => [ 'description' => '会话断连保留时长。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15', ], 'Html5FileTransfer' => [ 'description' => 'Web客户端文件传输策略。', 'type' => 'string', 'required' => false, 'example' => 'off', ], 'NoOperationDisconnect' => [ 'type' => 'string', 'required' => false, ], 'NoOperationDisconnectTime' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'Timers', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '定时器。', 'type' => 'array', 'items' => [ 'description' => '关联的定时任务。', 'type' => 'object', 'properties' => [ 'TimerType' => [ 'description' => '定时器类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'SESSION_TIMEOUT' => '连接断开会话释放超时时间。', ], 'example' => 'SESSION_TIMEOUT', ], 'Interval' => [ 'description' => '间隔。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'BrowserConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '浏览器配置。', 'type' => 'object', 'properties' => [ 'Homepage' => [ 'description' => '主页。', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', ], 'BrowserParam' => [ 'description' => '启动参数。', 'type' => 'string', 'required' => false, 'example' => '--incognito', ], 'Bookmarks' => [ 'description' => '书签。', 'type' => 'array', 'items' => [ 'description' => '关联的书签说明。', 'type' => 'object', 'properties' => [ 'BookmarkId' => [ 'description' => '书签ID，仅修改场景需要传递。', 'type' => 'string', 'required' => false, 'example' => 'bm-12345', ], 'BookmarkName' => [ 'description' => '书签名。', 'type' => 'string', 'required' => true, 'example' => 'test', ], 'BookmarkURL' => [ 'description' => '书签地址。', 'type' => 'string', 'required' => true, 'example' => 'https://www.aliyun.com', ], 'BookmarkFolder' => [ 'description' => '书签所属文件夹。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, ], 'RemoveBookmarks' => [ 'description' => '移除的书签列表。', 'type' => 'array', 'items' => [ 'description' => '移除的书签ID。', 'type' => 'string', 'required' => false, 'example' => 'bm-12345', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => '修改云浏览器', 'description' => '修改无影云浏览器属性。', ], ], 'endpoints' => [ [ 'regionId' => 'cn-shanghai', 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com', ], ], ];