diff options
Diffstat (limited to 'data/zh_cn/wss/2021-12-21/api-docs.php')
| -rw-r--r-- | data/zh_cn/wss/2021-12-21/api-docs.php | 1305 |
1 files changed, 1305 insertions, 0 deletions
diff --git a/data/zh_cn/wss/2021-12-21/api-docs.php b/data/zh_cn/wss/2021-12-21/api-docs.php new file mode 100644 index 0000000..52e0afa --- /dev/null +++ b/data/zh_cn/wss/2021-12-21/api-docs.php @@ -0,0 +1,1305 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'wss', + 'version' => '2021-12-21', + ], + 'directories' => [ + [ + 'id' => 202525, + 'title' => '订单', + 'type' => 'directory', + 'children' => [ + 'CreateMultiOrder', + ], + ], + [ + 'id' => 202515, + 'title' => '时长包&核时包', + 'type' => 'directory', + 'children' => [ + 'DescribePackageDeductions', + 'ModifyInstanceProperties', + ], + ], + [ + 'id' => 196356, + 'title' => '硬件', + 'type' => 'directory', + 'children' => [ + 'DescribeDeliveryAddress', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DescribeMultiPrice', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateMultiOrder' => [ + 'summary' => '本接口为无影云电脑企业版按月时长包等部分商品的下单、续费、变配接口。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '244439', + 'abilityTreeNodes' => [ + 'FEATUREgwsQ7ENW2', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OrderItems', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '商品信息。', + 'type' => 'array', + 'items' => [ + 'description' => '商品信息。', + 'type' => 'object', + 'properties' => [ + 'Amount' => [ + 'description' => '购买数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ResourceType' => [ + 'description' => '资源类型。'."\n" + .'> 该参数区分大小写，请确保拼写正确。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'DurationPackage' => '企业版按月时长包', + ], + 'example' => 'DurationPackage', + ], + 'AutoPay' => [ + 'description' => '是否自动支付。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '自动支付', + 'false' => '不自动支付', + ], + 'example' => 'true', + ], + 'AutoRenew' => [ + 'description' => '是否自动续费。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '自动续费', + 'false' => '不自动续费', + ], + 'example' => 'false', + ], + 'PeriodUnit' => [ + 'description' => '包年包月实例的购买时长单位。'."\n" + ."\n" + .'> 仅当实例的付费类型为预付费时，需要填写此参数。该参数区分大小写，请确保拼写正确。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Month' => '月', + 'Year' => '年', + ], + 'example' => 'Year', + ], + 'Components' => [ + 'description' => '商品模块。', + 'type' => 'array', + 'items' => [ + 'description' => '商品模块。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '模块的键（key）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DurationType' => '计算套餐 [新购和变配必填]', + 'RootDiskSize' => '系统盘大小 [必填]', + 'OsType' => '操作系统类型 [新购和变配必填]', + 'RootDiskCategory' => '系统盘类型 [必填]', + 'RootPerformanceLevel' => '系统盘性能等级 [在RootDiskCategory指定cloud_essd时必填]', + 'DataPerformanceLevel' => '数据盘性能等级 [非必填，取值同RootPerformanceLevel]', + 'RegionId' => '实例所属地域 [必填]', + 'DataDiskSize' => '数据盘大小 [非必填，取值同RootDiskSize]', + 'InstanceType' => '实例规格 [新购和变配必填]', + 'DataDiskCategory' => '数据盘类型 [非必填，取值同RootDiskCategory]', + ], + 'example' => 'RegionId', + ], + 'Value' => [ + 'description' => '模块的值（value）。'."\n" + ."\n" + .'企业版按月时长包各个键的示例值/枚举值如下：'."\n" + ."\n" + .'- RegionId：cn-shanghai'."\n" + .'- InstanceType：eds.enterprise_office.4c8g'."\n" + .'- DurationType（小时）：[枚举] '."\n" + .' - 120'."\n" + .' - 250'."\n" + .'- OsType：[枚举] '."\n" + .' - Windows'."\n" + .' - Linux'."\n" + .'- RootDiskSize（GiB）：80'."\n" + .'- RootDiskCategory：[枚举] '."\n" + .' - cloud_efficiency（高效云盘）'."\n" + .' - cloud_auto（极速云盘）'."\n" + .' - cloud_essd（增强型SSD云盘，仅部分规格支持）'."\n" + .'- RootPerformanceLevel：[枚举] '."\n" + .' - PL0'."\n" + .' - PL1'."\n" + .' - PL2'."\n" + .' - PL3'."\n" + .'- DataDiskSize（GiB）：取值同RootDiskSize'."\n" + .'- DataDiskCategory：取值同RootDiskCategory'."\n" + .'- DataPerformanceLevel：取值同RootPerformanceLevel', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'PromotionId' => [ + 'description' => '优惠ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + 'Period' => [ + 'description' => '购买周期。取值范围：'."\n" + ."\n" + .'- 当`PeriodUnit`为`Year`时，取值范围：1、2、3、5。'."\n" + ."\n" + .'- 当`PeriodUnit`为`Month`时，取值范围：1、2、3、6。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ResourceIds' => [ + 'description' => '资源ID列表。'."\n" + .'> 对于按月时长包，该参数对应云电脑ID，OrderType非`create`时必填。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-7ywwjrhpy9fec****', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'BuyChange' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'modify' => '变配', + 'create' => '新购', + 'renew' => '续费', + 'convert' => '订单类型转换', + 'refund' => '退款', + ], + 'example' => 'create', + ], + ], + [ + 'name' => 'Properties', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '扩展属性。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"PackageUsedUpStrategyKey":"Postpaid"}', + 'description' => '扩展属性。JSON格式。'."\n" + ."\n" + .'示例：通过`{"PackageUsedUpStrategyKey":"Postpaid"}`指定月度时长使用完毕后的策略为按需付费。', + ], + ], + ], + [ + 'name' => 'ResellerOwnerUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + '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' => '833C4D2C-09C7-5CE6-8159-06758B964970', + ], + 'OrderIds' => [ + 'description' => '订单ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23171351342****', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\",\\n \\"OrderIds\\": [\\n 0\\n ]\\n}","type":"json"}]', + 'title' => '组合下单', + 'description' => '<props="china">请确保在使用该接口前，已充分了解无影的收费方式和[价格](https://www.aliyun.com/price/product?#/gws/detail/gws)。</props>'."\n" + ."\n" + .'<props="intl">请确保在使用该接口前，已充分了解无影的收费方式和[价格](https://www.alibabacloud.com/zh/product/cloud-desktop?#J_8623712560)。</props>'."\n" + ."\n" + .'如果未指定自动支付，则当前接口不负责支付，需要通过本接口返回的订单ID拼接支付跳转链接进行支付后订单才会生效，资源才会生产。', + ], + 'DescribePackageDeductions' => [ + 'summary' => '查询核时包抵扣明细。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228937', + 'abilityTreeNodes' => [ + 'FEATUREgwsENR35V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型，核时包：CorePackage', + 'description' => '资源类型。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'Desktop' => '企业版核时包', + ], + 'example' => 'Desktop', + ], + ], + [ + 'name' => 'PackageIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '核时包id列表', + 'description' => '核时包ID列表，JSON格式。', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '核时包ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'chp-0bf5d9fdjr8vz****', + ], + 'required' => false, + 'docRequired' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '抵扣实例列表，企业版核时包对应桌面id', + 'description' => '云电脑ID列表。此字段有值时，`PackageIds`字段必填。', + 'type' => 'array', + 'items' => [ + 'description' => '云电脑ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-6wye9optu0kag****', + ], + 'required' => false, + 'docRequired' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '页码，默认1', + 'description' => '当前页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页最大数量，最大不超过100，默认100', + 'description' => '分页查询时设置的每页行数。最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'example' => '100', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '起始时间，时间戳格式，long型', + 'description' => '起始时间，Unix时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1709117383000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '起始时间，时间戳格式，long型', + 'description' => '结束时间，Unix时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1709117383000', + ], + ], + [ + 'name' => 'ResourceTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970', + ], + 'PageSize' => [ + 'description' => '分页查询时设置的每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Deductions' => [ + 'title' => '抵扣详情', + 'description' => '抵扣明细列表。', + 'type' => 'array', + 'items' => [ + 'description' => '抵扣明细。', + 'type' => 'object', + 'properties' => [ + 'DesktopName' => [ + 'title' => '', + 'description' => '云电脑名称。', + 'type' => 'string', + 'example' => 'DemoComputer', + ], + 'DesktopId' => [ + 'description' => '云电脑ID。', + 'type' => 'string', + 'example' => 'ecd-6wye9optu0kag****', + ], + 'RegionId' => [ + 'description' => '云电脑所属地域的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DesktopType' => [ + 'description' => '云电脑规格。', + 'type' => 'string', + 'example' => 'eds.enterprise_office.4c8g', + ], + 'OsType' => [ + 'description' => '云电脑操作系统类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Linux' => 'Linux', + 'Windows' => 'Windows', + ], + 'example' => 'Windows', + ], + 'StaTime' => [ + 'description' => '周期开始时间。', + 'type' => 'string', + 'example' => '2024-07-31T02:00Z', + ], + 'EndTime' => [ + 'description' => '周期结束时间。', + 'type' => 'string', + 'example' => '2024-07-31T03:00Z', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'Desktop', + ], + 'UsedTime' => [ + 'description' => '使用时长。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'UsedCoreTime' => [ + 'description' => '本次抵扣核数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.0', + ], + 'InstanceState' => [ + 'description' => '核时包状态。', + 'type' => 'string', + 'example' => 'Deleted', + ], + 'Memory' => [ + 'description' => '内存。单位：MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8192', + ], + 'Cpu' => [ + 'description' => 'vCPU数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'SessionId' => [ + 'type' => 'string', + ], + 'InstanceId' => [ + 'type' => 'string', + ], + 'InstanceType' => [ + 'type' => 'string', + ], + 'UsedTimeWithScale' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GroupResourceType' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '', + 'description' => '核时包抵扣明细查询结果总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'TotalUsedTime' => [ + 'title' => '总使用时长。', + 'description' => '总使用时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'TotalUsedCoreTime' => [ + 'title' => '总抵扣核时。', + 'description' => '总抵扣核时。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10.1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\",\\n \\"PageSize\\": 100,\\n \\"Deductions\\": [\\n {\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"DesktopId\\": \\"ecd-6wye9optu0kag****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DesktopType\\": \\"eds.enterprise_office.4c8g\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"StaTime\\": \\"2024-07-31T02:00Z\\",\\n \\"EndTime\\": \\"2024-07-31T03:00Z\\",\\n \\"ResourceType\\": \\"Desktop\\",\\n \\"UsedTime\\": 3600,\\n \\"UsedCoreTime\\": 4,\\n \\"InstanceState\\": \\"Deleted\\",\\n \\"Memory\\": 8192,\\n \\"Cpu\\": 4,\\n \\"SessionId\\": \\"\\",\\n \\"InstanceId\\": \\"\\",\\n \\"InstanceType\\": \\"\\",\\n \\"UsedTimeWithScale\\": 0,\\n \\"GroupResourceType\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"TotalUsedTime\\": 100000,\\n \\"TotalUsedCoreTime\\": 10.1\\n}","type":"json"}]', + 'title' => '查询核时包抵扣明细', + ], + 'ModifyInstanceProperties' => [ + 'summary' => '修改实例属性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。'."\n" + .'> 该参数区分大小写，请确保拼写正确。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'enumValueTitles' => [ + '企业版按月时长包' => 'DurationPackage', + ], + 'example' => 'DurationPackage', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mdp-0c62ayep0nk4v****', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '属性的键（key）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'PackageUsedUpStrategy' => '包内时长用尽策略', + ], + 'example' => 'PackageUsedUpStrategy', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '属性的值（value）。'."\n" + ."\n" + .'- PackageUsedUpStrategy：[枚举]'."\n" + .' - Postpaid（进入按需付费阶段）'."\n" + .' - Shutdown（休眠/关机）'."\n" + .' - Maintenance（停机并进入运维模式，不允许客户端连接）', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'mdp-0bwu3if0u9wwj****', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\"\\n}","type":"json"}]', + 'title' => '修改实例属性', + ], + 'DescribeDeliveryAddress' => [ + 'summary' => '查询物流地址信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '地址总数量。'."\n" + .'> 最多支持20个地址。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'RequestId' => [ + 'description' => '请求ID，阿里云为该请求生成的标识符。', + 'type' => 'string', + 'example' => '72481C12-69AB-5CE1-8A35-A8EFA921****', + ], + 'Addresses' => [ + 'description' => '地址列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PostalCode' => [ + 'description' => '邮政编码。', + 'type' => 'string', + 'example' => '03****', + ], + 'Contacts' => [ + 'description' => '联系人。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'Mobile' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'example' => '1381111****', + ], + 'DefaultAddress' => [ + 'description' => '是否为默认地址。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + 'Detail' => [ + 'description' => '需精确到街道和门牌号的详细地址。', + 'type' => 'string', + 'example' => '灯彩街1008号云园区2号楼测试中心'."\n", + ], + 'Province' => [ + 'description' => '省份。', + 'type' => 'object', + 'properties' => [ + 'ProvinceId' => [ + 'description' => '省份ID，具体请参见[中国地区、国家和地域代码](~~167926~~)。'."\n" + ."\n" + .'例如，**110000**表示北京市，**120000**表示天津市。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '330000', + ], + 'ProvinceName' => [ + 'description' => '省份名称。', + 'type' => 'string', + 'example' => '浙江省', + ], + ], + ], + 'City' => [ + 'description' => '城市。', + 'type' => 'object', + 'properties' => [ + 'CityId' => [ + 'description' => '城市ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33****', + ], + 'CityName' => [ + 'description' => '城市名称。', + 'type' => 'string', + 'example' => '杭州市', + ], + ], + ], + 'Area' => [ + 'description' => '区县。', + 'type' => 'object', + 'properties' => [ + 'AreaName' => [ + 'description' => '区县名称。', + 'type' => 'string', + 'example' => '西湖区', + ], + 'AreaId' => [ + 'description' => '区县ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33****', + ], + ], + ], + 'Town' => [ + 'description' => '城镇。', + 'type' => 'object', + 'properties' => [ + 'TownName' => [ + 'description' => '城镇名称。', + 'type' => 'string', + 'example' => '三墩镇', + ], + 'TownId' => [ + 'description' => '城镇ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3001****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 6,\\n \\"RequestId\\": \\"72481C12-69AB-5CE1-8A35-A8EFA921****\\",\\n \\"Addresses\\": [\\n {\\n \\"PostalCode\\": \\"03****\\",\\n \\"Contacts\\": \\"Alice\\",\\n \\"Mobile\\": \\"1381111****\\",\\n \\"DefaultAddress\\": true,\\n \\"Detail\\": \\"灯彩街1008号云园区2号楼测试中心\\\\n\\",\\n \\"Province\\": {\\n \\"ProvinceId\\": 330000,\\n \\"ProvinceName\\": \\"浙江省\\"\\n },\\n \\"City\\": {\\n \\"CityId\\": 0,\\n \\"CityName\\": \\"杭州市\\"\\n },\\n \\"Area\\": {\\n \\"AreaName\\": \\"西湖区\\",\\n \\"AreaId\\": 0\\n },\\n \\"Town\\": {\\n \\"TownName\\": \\"三墩镇\\",\\n \\"TownId\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询物流地址', + ], + 'DescribeMultiPrice' => [ + 'summary' => '查询无影商品的价格，包括新购、续费、变配及退订等订单类型', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OrderItems', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '商品信息。', + 'type' => 'array', + 'items' => [ + 'description' => '商品信息。', + 'type' => 'object', + 'properties' => [ + 'Amount' => [ + 'description' => '购买数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ResourceType' => [ + 'description' => '资源类型。'."\n" + .'> 该参数区分大小写，请确保拼写正确。', + 'type' => 'string', + 'required' => false, + 'example' => 'DurationPackage', + ], + 'PeriodUnit' => [ + 'description' => '购买时长单位。', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + 'Components' => [ + 'description' => '商品模块列表。', + 'type' => 'array', + 'items' => [ + 'description' => '商品模块。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '模块的键（Key）。', + 'type' => 'string', + 'required' => false, + 'example' => 'RegionId', + ], + 'Value' => [ + 'description' => '模块的值（Value）。'."\n" + ."\n" + .'企业版按月时长包各个键的示例值/枚举值如下：'."\n" + ."\n" + .'- RegionId：cn-shanghai'."\n" + .'- InstanceType：eds.enterprise_office.4c8g'."\n" + .'- DurationType（小时）：[枚举] '."\n" + .' - 120'."\n" + .' - 250'."\n" + .'- OsType：[枚举] '."\n" + .' - Windows'."\n" + .' - Linux'."\n" + .'- RootDiskSize（GiB）：80'."\n" + .'- RootDiskCategory：[枚举] '."\n" + .' - cloud_efficiency（高效云盘）'."\n" + .' - cloud_auto（极速云盘）'."\n" + .' - cloud_essd（增强型SSD云盘，仅部分规格支持）'."\n" + .'- RootPerformanceLevel：[枚举] '."\n" + .' - PL0'."\n" + .' - PL1'."\n" + .' - PL2'."\n" + .' - PL3'."\n" + .'- DataDiskSize（GiB）：取值同RootDiskSize'."\n" + .'- DataDiskCategory：取值同RootDiskCategory'."\n" + .'- DataPerformanceLevel：取值同RootPerformanceLevel', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'PromotionId' => [ + 'description' => '优惠ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + 'Period' => [ + 'description' => '购买周期。取值范围：'."\n" + ."\n" + .'- 当`PeriodUnit`为`Year`时，取值范围：1、2、3。'."\n" + ."\n" + .'- 当`PeriodUnit`为`Month`时，取值范围：1、2、3、6。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'InstanceIds' => [ + 'description' => '实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'mdp-erdb15ubox6sx****', + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 0, + ], + 'ResourceIds' => [ + 'description' => '资源ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-7ywwjrhpy9fec****', + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 0, + ], + 'SavingPlanPeriod' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'create', + ], + ], + [ + 'name' => 'PackageCode', + 'in' => 'query', + 'schema' => [ + 'description' => '套餐Code，非套餐类型无需填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'pacakge', + ], + ], + [ + 'name' => 'ResellerOwnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '转售模式的资源归属用户ID，非转售模式无需填写该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '182864463481****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '询价结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970', + ], + 'PriceInfo' => [ + 'description' => '价格详细信息。', + 'type' => 'object', + 'properties' => [ + 'Rules' => [ + 'description' => '活动规则信息。', + 'type' => 'array', + 'items' => [ + 'description' => '活动规则信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '活动规则描述。', + 'type' => 'string', + 'example' => 'accounts_suspect_users', + ], + 'RuleId' => [ + 'description' => '活动规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'hrzdvc', + ], + ], + ], + ], + 'Price' => [ + 'description' => '价格信息。', + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '6800', + ], + 'DiscountPrice' => [ + 'description' => '折扣价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '534.6', + ], + 'Currency' => [ + 'description' => '货币单位。'."\n" + ."\n" + .'中国站：CNY。'."\n" + ."\n" + .'国际站：USD。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'TradePrice' => [ + 'description' => '实际付款价格。取值为原价减去折减的价格。', + 'type' => 'number', + 'format' => 'float', + 'example' => '82.6', + ], + 'Promotions' => [ + 'description' => '促销活动信息。', + 'type' => 'array', + 'items' => [ + 'description' => '促销活动信息。', + 'type' => 'object', + 'properties' => [ + 'PromotionDesc' => [ + 'description' => '促销信息描述。', + 'type' => 'string', + 'example' => '促销', + ], + 'OptionCode' => [ + 'description' => '促销活动规则描述。', + 'type' => 'string', + 'example' => 'new', + ], + 'Selected' => [ + 'description' => '是否被选中。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PromotionId' => [ + 'description' => '促销活动ID。', + 'type' => 'string', + 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + 'PromotionName' => [ + 'description' => '促销活动名称。', + 'type' => 'string', + 'example' => '优惠活动名称', + ], + ], + ], + ], + 'PriceDetails' => [ + 'description' => '价格详情。', + 'type' => 'array', + 'items' => [ + 'description' => '价格详情。', + 'type' => 'object', + 'properties' => [ + 'OrderItem' => [ + 'description' => '排序属性。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PriceDetail' => [ + 'description' => '价格详情。', + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100.00', + ], + 'DiscountPrice' => [ + 'description' => '折扣价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '20.00', + ], + 'TradePrice' => [ + 'description' => '实际付款价格。取值为原价减去折减的价格。', + 'type' => 'number', + 'format' => 'float', + 'example' => '80.00', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'DurationPackage', + ], + 'SavingPlanRecommendPrice' => [ + 'type' => 'number', + 'format' => 'float', + ], + ], + ], + 'ModuleDetails' => [ + 'description' => '计价模块价格详情。', + 'type' => 'array', + 'items' => [ + 'description' => '计价模块价格详情。', + 'type' => 'object', + 'properties' => [ + 'ModuleCode' => [ + 'description' => '模块code。', + 'type' => 'string', + 'example' => 'DesktopType', + ], + 'ModuleValue' => [ + 'description' => '模块值。', + 'type' => 'string', + 'example' => 'eds.enterprise_office.8c32g', + ], + 'ModuleName' => [ + 'description' => '模块名称。', + 'type' => 'string', + 'example' => '企业办公型-8C32G', + ], + 'OriginalPrice' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10900', + ], + 'DiscountPrice' => [ + 'description' => '折扣价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '734.65', + ], + 'TradePrice' => [ + 'description' => '实际付款价格。取值为原价减去折减的价格。', + 'type' => 'number', + 'format' => 'float', + 'example' => '292.2', + ], + 'SavingPlanDiscountPrice' => [ + 'type' => 'number', + 'format' => 'float', + ], + ], + ], + ], + ], + ], + ], + 'RefundPrice' => [ + 'description' => '退订价格。', + 'type' => 'number', + 'format' => 'float', + 'example' => '60.00', + ], + 'RefundInstanceIdPriceMap' => [ + 'description' => '退订实例和定价详情。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'number', + 'format' => 'float', + 'description' => '退订金额。', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\",\\n \\"PriceInfo\\": {\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"accounts_suspect_users\\",\\n \\"RuleId\\": 0\\n }\\n ],\\n \\"Price\\": {\\n \\"OriginalPrice\\": 6800,\\n \\"DiscountPrice\\": 534.6,\\n \\"Currency\\": \\"CNY\\",\\n \\"TradePrice\\": 82.6,\\n \\"Promotions\\": [\\n {\\n \\"PromotionDesc\\": \\"促销\\",\\n \\"OptionCode\\": \\"new\\",\\n \\"Selected\\": true,\\n \\"PromotionId\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionName\\": \\"优惠活动名称\\"\\n }\\n ],\\n \\"PriceDetails\\": [\\n {\\n \\"OrderItem\\": 1,\\n \\"PriceDetail\\": {\\n \\"OriginalPrice\\": 100,\\n \\"DiscountPrice\\": 20,\\n \\"TradePrice\\": 80,\\n \\"ResourceType\\": \\"DurationPackage\\",\\n \\"SavingPlanRecommendPrice\\": 0\\n },\\n \\"ModuleDetails\\": [\\n {\\n \\"ModuleCode\\": \\"DesktopType\\",\\n \\"ModuleValue\\": \\"eds.enterprise_office.8c32g\\",\\n \\"ModuleName\\": \\"企业办公型-8C32G\\",\\n \\"OriginalPrice\\": 10900,\\n \\"DiscountPrice\\": 734.65,\\n \\"TradePrice\\": 292.2,\\n \\"SavingPlanDiscountPrice\\": 0\\n }\\n ]\\n }\\n ],\\n \\"RefundPrice\\": 60,\\n \\"RefundInstanceIdPriceMap\\": {\\n \\"key\\": 100\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询新购、续费变配及退订的价格', + 'description' => '<props="china">请确保在使用该接口前，已充分了解无影的收费方式和[价格](https://www.aliyun.com/price/product?#/gws/detail/gws)。</props>', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'wss.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'wss.ap-southeast-1.aliyuncs.com', + ], + ], +]; |