summaryrefslogtreecommitdiff
path: root/data/zh_cn/wss/2021-12-21/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/wss/2021-12-21/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
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.php1880
1 files changed, 1051 insertions, 829 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
index 52e0afa..14f750f 100644
--- a/data/zh_cn/wss/2021-12-21/api-docs.php
+++ b/data/zh_cn/wss/2021-12-21/api-docs.php
@@ -1,43 +1,30 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'wss',
- 'version' => '2021-12-21',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'wss', 'version' => '2021-12-21'],
'directories' => [
[
- 'id' => 202525,
- 'title' => '订单',
+ 'children' => ['CreateMultiOrder'],
'type' => 'directory',
- 'children' => [
- 'CreateMultiOrder',
- ],
+ 'title' => '订单',
+ 'id' => 451817,
],
[
- 'id' => 202515,
- 'title' => '时长包&核时包',
+ 'children' => ['DescribePackageDeductions', 'ModifyInstanceProperties'],
'type' => 'directory',
- 'children' => [
- 'DescribePackageDeductions',
- 'ModifyInstanceProperties',
- ],
+ 'title' => '时长包&核时包',
+ 'id' => 451818,
],
[
- 'id' => 196356,
- 'title' => '硬件',
+ 'children' => ['DescribeDeliveryAddress'],
'type' => 'directory',
- 'children' => [
- 'DescribeDeliveryAddress',
- ],
+ 'title' => '硬件',
+ 'id' => 451819,
],
[
- 'id' => 0,
- 'title' => '其它',
+ 'children' => ['DescribeMultiPrice', 'DescribeDeductionStatistic', 'SetAgentCreditQuota', 'DescribeCreditUsageInfo', 'DescribeCreditPackageAgents'],
'type' => 'directory',
- 'children' => [
- 'DescribeMultiPrice',
- ],
+ 'title' => '其他',
+ 'id' => 451820,
],
],
'components' => [
@@ -46,13 +33,8 @@
'apis' => [
'CreateMultiOrder' => [
'summary' => '本接口为无影云电脑企业版按月时长包等部分商品的下单、续费、变配接口。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -64,9 +46,7 @@
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeCode' => '244439',
- 'abilityTreeNodes' => [
- 'FEATUREgwsQ7ENW2',
- ],
+ 'abilityTreeNodes' => ['FEATUREgwsQ7ENW2'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
@@ -81,41 +61,27 @@
'description' => '商品信息。',
'type' => 'object',
'properties' => [
- 'Amount' => [
- 'description' => '购买数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'Amount' => ['description' => '购买数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'ResourceType' => [
'description' => '资源类型。'."\n"
.'> 该参数区分大小写,请确保拼写正确。',
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'DurationPackage' => '企业版按月时长包',
- ],
+ 'enumValueTitles' => ['DurationPackage' => '企业版按月时长包'],
'example' => 'DurationPackage',
],
'AutoPay' => [
'description' => '是否自动支付。',
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '自动支付',
- 'false' => '不自动支付',
- ],
+ 'enumValueTitles' => ['true' => '自动支付', 'false' => '不自动支付'],
'example' => 'true',
],
'AutoRenew' => [
'description' => '是否自动续费。',
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '自动续费',
- 'false' => '不自动续费',
- ],
+ 'enumValueTitles' => ['true' => '自动续费', 'false' => '不自动续费'],
'example' => 'false',
],
'PeriodUnit' => [
@@ -124,10 +90,7 @@
.'> 仅当实例的付费类型为预付费时,需要填写此参数。该参数区分大小写,请确保拼写正确。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'Month' => '月',
- 'Year' => '年',
- ],
+ 'enumValueTitles' => ['Month' => '月', 'Year' => '年'],
'example' => 'Year',
],
'Components' => [
@@ -141,89 +104,59 @@
'description' => '模块的键(key)。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'DurationType' => '计算套餐 [新购和变配必填]',
- 'RootDiskSize' => '系统盘大小 [必填]',
- 'OsType' => '操作系统类型 [新购和变配必填]',
- 'RootDiskCategory' => '系统盘类型 [必填]',
- 'RootPerformanceLevel' => '系统盘性能等级 [在RootDiskCategory指定cloud_essd时必填]',
- 'DataPerformanceLevel' => '数据盘性能等级 [非必填,取值同RootPerformanceLevel]',
- 'RegionId' => '实例所属地域 [必填]',
- 'DataDiskSize' => '数据盘大小 [非必填,取值同RootDiskSize]',
- 'InstanceType' => '实例规格 [新购和变配必填]',
- 'DataDiskCategory' => '数据盘类型 [非必填,取值同RootDiskCategory]',
- ],
+ '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',
- ],
+ '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',
- ],
+ '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****',
- ],
+ 'items' => ['description' => '资源ID列表。', 'type' => 'string', 'required' => false, 'example' => 'ecd-7ywwjrhpy9fec****'],
'required' => false,
'maxItems' => 100,
],
- 'BuyChange' => [
- 'type' => 'boolean',
- 'required' => false,
+ 'BuyChange' => ['type' => 'boolean', 'required' => false, 'description' => ''],
+ 'InstanceIds' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ 'maxItems' => 100,
],
],
'required' => false,
@@ -239,13 +172,7 @@
'description' => '订单类型。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'modify' => '变配',
- 'create' => '新购',
- 'renew' => '续费',
- 'convert' => '订单类型转换',
- 'refund' => '退款',
- ],
+ 'enumValueTitles' => ['modify' => '变配', 'create' => '新购', 'renew' => '续费', 'convert' => '订单类型转换', 'refund' => '退款'],
'example' => 'create',
],
],
@@ -257,23 +184,20 @@
'description' => '扩展属性。',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"PackageUsedUpStrategyKey":"Postpaid"}',
- 'description' => '扩展属性。JSON格式。'."\n"
- ."\n"
- .'示例:通过`{"PackageUsedUpStrategyKey":"Postpaid"}`指定月度时长使用完毕后的策略为按需付费。',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => '{"PackageUsedUpStrategyKey":"Postpaid"}', 'description' => '扩展属性。JSON格式。'."\n"
+ ."\n"
+ .'示例:通过`{"PackageUsedUpStrategyKey":"Postpaid"}`指定月度时长使用完毕后的策略为按需付费。'],
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'ChannelCookie',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -283,621 +207,549 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970',
- ],
+ '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****',
- ],
+ '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',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-22T07:32:22.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-25T13:01:43.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateMultiOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\",\\n \\"OrderIds\\": [\\n 0\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeCreditPackageAgents' => [
+ 'summary' => '查询当前用户名下的Agent列表及用量汇总信息。',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '228937',
- 'abilityTreeNodes' => [
- 'FEATUREgwsENR35V',
- ],
- ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'BizType',
'in' => 'query',
- 'schema' => [
- 'title' => '资源类型,核时包:CorePackage',
- 'description' => '资源类型。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'enumValueTitles' => [
- 'Desktop' => '企业版核时包',
- ],
- 'example' => 'Desktop',
- ],
+ 'schema' => ['description' => '业务类型', 'type' => 'string', 'required' => false, 'example' => 'BUSINESS'],
],
[
- 'name' => 'PackageIds',
+ 'name' => 'AgentType',
'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,
- ],
+ 'schema' => ['description' => 'Agent 类型:`CREDIT_PACKAGE` / `JVS_CLAW` / `OPEN_CLAW` / `JVS_COPILOT`'."\n", 'type' => 'string', 'required' => false, 'example' => 'JVS_COPILOT'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'AgentIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '抵扣实例列表,企业版核时包对应桌面id',
- 'description' => '云电脑ID列表。此字段有值时,`PackageIds`字段必填。',
+ 'description' => 'AgentId 列表的 JSON 字符串,例:`["agent-1","agent-2"]`'."\n",
'type' => 'array',
- 'items' => [
- 'description' => '云电脑ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecd-6wye9optu0kag****',
- ],
+ 'items' => ['description' => 'AgentId列表', 'type' => 'string', 'required' => false, 'example' => 'jvs-xxxx'],
'required' => false,
- 'docRequired' => false,
'maxItems' => 100,
+ 'minItems' => 0,
],
],
[
- 'name' => 'PageNum',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '页码,默认1',
- 'description' => '当前页码。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'enumValueTitles' => [],
- 'example' => '1',
- ],
+ 'schema' => ['description' => '每页数量'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'NextToken',
'in' => 'query',
+ 'schema' => ['description' => '分页 Token;首次请求传空,后续取上一次响应的 `nextToken`'."\n", 'type' => 'string', 'required' => false, 'example' => 'eyJvZmZzZXQiOjIwfQ=='],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '每页最大数量,最大不超过100,默认100',
- 'description' => '分页查询时设置的每页行数。最大值:100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '100',
- 'example' => '100',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求追踪 ID,用于问题排查'."\n", 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx'],
+ 'Agents' => [
+ 'description' => 'Agent列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AgentId' => ['description' => 'Agent ID'."\n", 'type' => 'string', 'example' => 'agent-abc'],
+ 'InstanceType' => ['description' => '实例规格'."\n", 'type' => 'string', 'example' => 'jvs-copilot.standard'],
+ 'CreatedTime' => ['description' => '**实例创建时间**'."\n", 'type' => 'string', 'example' => '2026-04-01 10:00:00'],
+ 'ExpiredTime' => ['description' => '**实例到期时间**'."\n", 'type' => 'string', 'example' => '2026-10-01 10:00:00'],
+ 'UsedCredit' => ['description' => '**已使用积分量**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'TotalCredit' => ['description' => '**积分总量**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
+ 'CreditPackageId' => ['description' => '**当前生效积分包实例 ID**'."\n", 'type' => 'string', 'example' => 'cp-inst-001'],
+ 'WarnPercent' => ['description' => '**告警阈值百分比(0–100)**'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'MaxResults' => ['description' => '每页数量'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'NextToken' => ['description' => '分页 Token;首次请求传空,后续取上一次响应的 `nextToken`'."\n", 'type' => 'string', 'example' => 'eyJvZmZzZXQiOjIwfQ=='],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询积分包Agent列表',
+ 'description' => '## 请求说明'."\n"
+ ."\n"
+ .'- **分页支持**:通过 `NextToken` 和 `MaxResults` 参数实现分页,首次请求时 `NextToken` 应为空字符串。'."\n"
+ .'- **过滤条件**:可以使用 `AgentType` 和 `AgentIds` 参数来过滤返回的 Agent 列表。'."\n"
+ .'- **状态过滤**:通过 `Status` 参数(0-已删除,1-生效中)来过滤 Agent 的状态。'."\n"
+ .'- **排序规则**:默认按 `id` 升序排列。'."\n"
+ .'- **匿名版额外参数**:`FillInstance` 参数用于自动填充当前登录用户的已绑定 JVS_COPILOT AgentId。'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '起始时间,时间戳格式,long型',
- 'description' => '起始时间,Unix时间戳格式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1709117383000',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeCreditPackageAgents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx-xxxx\\",\\n \\"Agents\\": [\\n {\\n \\"AgentId\\": \\"agent-abc\\",\\n \\"InstanceType\\": \\"jvs-copilot.standard\\",\\n \\"CreatedTime\\": \\"2026-04-01 10:00:00\\",\\n \\"ExpiredTime\\": \\"2026-10-01 10:00:00\\",\\n \\"UsedCredit\\": 100,\\n \\"TotalCredit\\": 2000,\\n \\"CreditPackageId\\": \\"cp-inst-001\\",\\n \\"WarnPercent\\": 80\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"eyJvZmZzZXQiOjIwfQ==\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeCreditUsageInfo' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'EndTime',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true],
+ 'parameters' => [
+ [
+ 'name' => 'BizType',
'in' => 'query',
- 'schema' => [
- 'title' => '起始时间,时间戳格式,long型',
- 'description' => '结束时间,Unix时间戳格式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1709117383000',
- ],
+ 'schema' => ['description' => '业务类型', 'type' => 'string', 'required' => false, 'example' => 'BUSINESS'],
],
[
- 'name' => 'ResourceTypes',
+ 'name' => 'UsageType',
+ 'in' => 'query',
+ 'schema' => ['description' => '用量类型(UseageType):User、CreditPackage、Agent'."\n"
+ .'* User:返回用户当前生效积分包的用量、余量及消耗趋势'."\n"
+ .'* CreditPackage:需要传入CreditPackageId,返回指定积分包的总量、余量'."\n"
+ .'* Agent:需要传入AgentId,返回累计积分用量、累计分配额度及两者百分比'."\n", 'type' => 'string', 'required' => false, 'example' => 'User'],
+ ],
+ [
+ 'name' => 'InstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
+ 'description' => '实例 ID 列表 JSON 字符串;`UsageType=User` 时可省略,`CreditPackage` 时传积分包实例 ID,`Agent` 时传 `AgentId`'."\n",
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cp-0bszoespx7o1ehjxs'],
'required' => false,
'maxItems' => 100,
+ 'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回类型:`ListResult<CreditUsageInfoModel>`'."\n",
'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' => '抵扣明细列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '68BD3312-53D8-123E-BB32-1A9F25E07A03'],
+ 'UsageInfoList' => [
+ 'description' => '业务数据数组'."\n",
'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',
+ 'UsageInfoKey' => ['description' => '用量主键:`UsageType=User` 时为 `aliUid`;`CreditPackage` 时为积分包实例 ID;`Agent` 时为 `AgentId`'."\n", 'type' => 'string', 'example' => 'agent-abc'],
+ 'UsageInfo' => [
+ 'description' => '用量数据详情'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DayUsedCredit' => ['description' => '最近 1 天积分用量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '最近一天消耗积分'],
+ 'WeekUsedCredit' => ['description' => '最近 1 周积分用量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '最近一周消耗积分'],
+ 'TotalUsedCredit' => ['description' => '累计积分用量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '共计消耗积分'],
+ 'TotalCredit' => ['description' => '累计积分总量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '积分配额'],
+ 'RemainCredit' => ['description' => '累计计费余量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '积分余量'],
+ 'CurrentTotalCredit' => ['description' => '当前生效积分包总量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '当前周期积分配额'],
+ 'CurrentRemainCredit' => ['description' => '当前生效积分包余量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '当前周期积分余量'],
+ 'CurrentUsedCredit' => ['description' => '当前生效积分包用量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '当前周期积分消耗'],
+ 'CurrentInstanceId' => ['description' => '当前生效积分包实例 ID'."\n", 'type' => 'string', 'example' => 'cp-inst-001'],
+ 'CreditTrendList' => [
+ 'description' => '当前积分包按小时消耗采样(见下)'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TimePoint' => ['description' => '时间点,格式 `yyyy-MM-dd HH`(精确到小时)'."\n", 'type' => 'string', 'example' => '2026-05-02 10'],
+ 'UsedCredit' => ['description' => '该小时消耗积分数'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'WarnPercent' => ['description' => '告警阈值百分比(0–100)'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
+ 'PeriodUsedCredit' => ['description' => '当前生效周期的共享积分用量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
+ 'PeriodTotalCredit' => ['description' => '当前生效周期的共享积分配额'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300'],
+ 'TodayUsed' => ['type' => 'string'],
+ 'TotalUsed' => ['type' => 'string'],
],
- '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',
],
],
+ 'description' => '',
],
],
- '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询积分用量详情',
+ 'summary' => '按指定维度查询用户、积分包或Agent的积分使用情况。',
+ 'description' => '## 请求说明'."\n"
+ ."\n"
+ .'该API用于根据`UsageType`指定的维度(User / CreditPackage / Agent)查询积分用量详情。返回内容包括当前积分包总量/余量/用量、按小时消耗采样、告警阈值、周期配额等信息。'."\n"
+ ."\n"
+ .'- **User**:用户维度,返回当前用户全部生效积分包的合计用量、余量。'."\n"
+ .'- **CreditPackage**:积分包维度,返回指定积分包实例的总量、余量、消耗采样。'."\n"
+ .'- **Agent**:Agent维度,返回指定Agent的累计用量、当前周期用量、配额、告警等信息。'."\n"
+ ."\n"
+ .'**注意**:'."\n"
+ .'- `InstanceIds`参数在`UsageType=User`时可省略,在`CreditPackage`时传积分包实例ID,在`Agent`时传AgentId。'."\n"
+ .'- 匿名版请求支持`FillInstance`参数,当未显式传入`InstanceIds`且`FillInstance=true`时,服务端依据当前登录`wyId`自动填充已绑定的`JVS_COPILOT`AgentId。'."\n"
+ .'- 时间窗口常量:`dayUsedCredit`统计窗口为`now - ONE_DAY_MILLIS`,`weekUsedCredit`统计窗口为`now - ONE_WEEK_MILLIS`。'."\n"
+ .'- 消耗采样`currentCreditConsumeList`按小时聚合,可能存在≤5分钟的异步同步延迟。'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeCreditUsageInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68BD3312-53D8-123E-BB32-1A9F25E07A03\\",\\n \\"UsageInfoList\\": [\\n {\\n \\"UsageInfoKey\\": \\"agent-abc\\",\\n \\"UsageInfo\\": {\\n \\"DayUsedCredit\\": 0,\\n \\"WeekUsedCredit\\": 0,\\n \\"TotalUsedCredit\\": 0,\\n \\"TotalCredit\\": 0,\\n \\"RemainCredit\\": 0,\\n \\"CurrentTotalCredit\\": 0,\\n \\"CurrentRemainCredit\\": 0,\\n \\"CurrentUsedCredit\\": 0,\\n \\"CurrentInstanceId\\": \\"cp-inst-001\\",\\n \\"CreditTrendList\\": [\\n {\\n \\"TimePoint\\": \\"2026-05-02 10\\",\\n \\"UsedCredit\\": 12\\n }\\n ],\\n \\"WarnPercent\\": 80,\\n \\"PeriodUsedCredit\\": 120,\\n \\"PeriodTotalCredit\\": 300,\\n \\"TodayUsed\\": \\"\\",\\n \\"TotalUsed\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeDeductionStatistic' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'Periods',
'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '资源类型。'."\n"
- .'> 该参数区分大小写,请确保拼写正确。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => false,
- 'enumValueTitles' => [
- '企业版按月时长包' => 'DurationPackage',
+ 'description' => '时间周期列表,JSON 数组格式,元素为 `PeriodParam` 对象'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PeriodUnit' => ['description' => '时间周期单位(参考 `PeriodUnit` 枚举)'."\n", 'type' => 'string', 'required' => false, 'example' => 'Year'],
+ 'BaseTime' => ['description' => '基准时间'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-01-01'],
+ ],
+ 'required' => false,
+ 'description' => '',
],
- 'example' => 'DurationPackage',
+ 'required' => false,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ResourceTypes',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '实例的ID。',
- 'type' => 'string',
+ 'description' => '资源类型列表,JSON 数组格式'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => '资源类型列表。最多支持50组。'."\n"
+ ."\n"
+ .'> 如果您设置了`ResourceTypes`,则请求参数中单独设置的`Service`和`ResourceType`将不生效。', 'type' => 'string', 'required' => false, 'example' => 'Desktop'],
'required' => false,
- 'docRequired' => true,
- 'example' => 'mdp-0c62ayep0nk4v****',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'Key',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '属性的键(key)。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'enumValueTitles' => [
- 'PackageUsedUpStrategy' => '包内时长用尽策略',
- ],
- 'example' => 'PackageUsedUpStrategy',
- ],
+ 'schema' => ['description' => '开始时间(时间戳)'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2026-03-20T16:00:00Z'],
],
[
- 'name' => 'Value',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '属性的值(value)。'."\n"
- ."\n"
- .'- PackageUsedUpStrategy:[枚举]'."\n"
- .' - Postpaid(进入按需付费阶段)'."\n"
- .' - Shutdown(休眠/关机)'."\n"
- .' - Maintenance(停机并进入运维模式,不允许客户端连接)',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'Postpaid',
- ],
+ 'schema' => ['description' => '结束时间(时间戳)'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2025-06-06T02:14:00Z'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例ID。',
+ 'description' => '实例 ID 列表(JSON 数组)'."\n",
'type' => 'array',
- 'items' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mdp-0bwu3if0u9wwj****',
- ],
+ 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ak-7yz7llzomgh2g64gc'],
'required' => false,
- 'maxItems' => 200,
+ 'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID'."\n", 'type' => 'string', 'example' => 'A1B2C3D4-xxxx-xxxx-xxxx-xxxxxxxxxxxx'],
+ 'Data' => [
+ 'description' => '抵扣数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Deductions' => [
+ 'description' => '抵扣数据详情',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '抵扣数据详情',
+ 'type' => 'object',
+ 'properties' => [
+ 'DeductionDate' => ['description' => '抵扣日期'."\n", 'type' => 'string', 'example' => '2024-01-01'],
+ 'ConsumeSecond' => ['description' => '消费时长(秒)'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '7000'],
+ 'ResourceType' => ['description' => '资源类型'."\n", 'type' => 'string', 'example' => 'CloudDesktop'],
+ ],
+ ],
+ ],
+ 'Usages' => [
+ 'description' => '**使用量列表**'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Period' => ['description' => '**时间周期**'."\n", 'type' => 'string', 'example' => '2024-01-01'],
+ 'ConsumeSecond' => ['description' => '**消费时长(秒)**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6000'],
+ 'ResourceType' => ['description' => '**资源类型**'."\n", 'type' => 'string', 'example' => 'CloudDesktop'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'AvailableCorePackages' => [
+ 'description' => '**可用的核时包资源列表**'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupId' => ['description' => '组 ID'."\n", 'type' => 'string', 'example' => 'g-xxxxx'],
+ 'AliUid' => ['description' => '阿里云 UID'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1568857911493620'],
+ 'GroupResourceType' => ['description' => '组资源类型'."\n", 'type' => 'string', 'example' => 'CoreHour'],
+ 'UsedTime' => ['description' => '已使用时长'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '40000'],
+ 'TotalTime' => ['description' => '总时长'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000000'],
+ 'ResourceType' => ['description' => '组资源类型'."\n", 'type' => 'string', 'example' => 'CoreHour'],
+ 'StartTime' => ['description' => '开始时间'."\n", 'type' => 'string', 'example' => '2024-01-01 00:00:00'],
+ 'EndTime' => ['description' => '结束时间'."\n", 'type' => 'string', 'example' => '2024-12-31 23:59:59'],
+ 'Status' => ['description' => '状态'."\n", 'type' => 'string', 'example' => 'Active'],
+ 'ExpiredTime' => ['description' => '过期时间'."\n", 'type' => 'string', 'example' => '2024-12-31 23:59:59'],
+ 'CreateTime' => ['description' => '创建时间'."\n", 'type' => 'string', 'example' => '2024-01-01 00:00:00'],
+ 'NoLx' => ['description' => '是否无凌霄'."\n", 'type' => 'boolean'],
+ 'NoLxSource' => ['description' => '无凌霄来源'."\n", 'type' => 'string', 'example' => '无凌霄来源示例值'],
+ 'ResourceId' => ['description' => '资源 ID'."\n", 'type' => 'string', 'example' => 'res-xxxxx'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\"\\n}","type":"json"}]',
- 'title' => '修改实例属性',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询抵扣详情',
+ 'summary' => '获取指定条件下的资源抵扣和使用情况统计。',
+ 'description' => '## 请求说明'."\n"
+ ."\n"
+ .'- 该接口支持 GET 和 POST 方法。'."\n"
+ .'- `periods` 参数为 JSON 数组格式,每个元素为一个 `PeriodParam` 对象,包含 `periodUnit` 和 `baseTime` 字段。'."\n"
+ .'- `resourceTypes` 参数为 JSON 数组格式,包含多个资源类型字符串。'."\n"
+ .'- `startTime` 和 `endTime` 参数为时间戳格式,表示查询的时间范围。'."\n"
+ .'- 分页参数包括 `nextToken`、`maxResults`、`pageNo` 和 `pageSize`,用于控制返回结果的数量和分页。'."\n"
+ .'- 当 `resourceTypes` 参数包含无效值或 `periods` 参数 JSON 解析失败时,会抛出 `SalesClientException` 异常。'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1B2C3D4-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\",\\n \\"Data\\": {\\n \\"Deductions\\": [\\n {\\n \\"DeductionDate\\": \\"2024-01-01\\",\\n \\"ConsumeSecond\\": 7000,\\n \\"ResourceType\\": \\"CloudDesktop\\"\\n }\\n ],\\n \\"Usages\\": [\\n {\\n \\"Period\\": \\"2024-01-01\\",\\n \\"ConsumeSecond\\": 6000,\\n \\"ResourceType\\": \\"CloudDesktop\\"\\n }\\n ],\\n \\"AvailableCorePackages\\": [\\n {\\n \\"GroupId\\": \\"g-xxxxx\\",\\n \\"AliUid\\": 1568857911493620,\\n \\"GroupResourceType\\": \\"CoreHour\\",\\n \\"UsedTime\\": 40000,\\n \\"TotalTime\\": 1000000,\\n \\"ResourceType\\": \\"CoreHour\\",\\n \\"StartTime\\": \\"2024-01-01 00:00:00\\",\\n \\"EndTime\\": \\"2024-12-31 23:59:59\\",\\n \\"Status\\": \\"Active\\",\\n \\"ExpiredTime\\": \\"2024-12-31 23:59:59\\",\\n \\"CreateTime\\": \\"2024-01-01 00:00:00\\",\\n \\"NoLx\\": true,\\n \\"NoLxSource\\": \\"无凌霄来源示例值\\",\\n \\"ResourceId\\": \\"res-xxxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeDeliveryAddress' => [
'summary' => '查询物流地址信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ '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****',
- ],
+ '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****',
- ],
+ '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' => '否',
- ],
+ 'enumValueTitles' => ['true' => '是', 'false' => '否'],
'example' => 'true',
],
- 'Detail' => [
- 'description' => '需精确到街道和门牌号的详细地址。',
- 'type' => 'string',
- 'example' => '灯彩街1008号云园区2号楼测试中心'."\n",
- ],
+ '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' => '浙江省',
- ],
+ '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' => '杭州市',
- ],
+ '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****',
- ],
+ '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****',
- ],
+ 'TownName' => ['description' => '城镇名称。', 'type' => 'string', 'example' => '三墩镇'],
+ 'TownId' => ['description' => '城镇ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3001****'],
],
],
],
+ 'description' => '',
],
],
],
+ 'description' => '',
],
],
],
'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' => '查询物流地址',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeDeliveryAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeMultiPrice' => [
'summary' => '查询无影商品的价格,包括新购、续费、变配及退订等订单类型',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OrderItems',
@@ -910,26 +762,10 @@
'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',
- ],
+ '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',
@@ -937,74 +773,48 @@
'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',
- ],
+ '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',
- ],
+ '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****',
- ],
+ 'items' => ['description' => '实例ID列表。', 'type' => 'string', 'required' => false, 'example' => 'mdp-erdb15ubox6sx****'],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
@@ -1012,20 +822,13 @@
'ResourceIds' => [
'description' => '资源ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '资源ID列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecd-7ywwjrhpy9fec****',
- ],
+ 'items' => ['description' => '资源ID列表。', 'type' => 'string', 'required' => false, 'example' => 'ecd-7ywwjrhpy9fec****'],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
- 'SavingPlanPeriod' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'SavingPlanPeriod' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'Data' => ['type' => 'string'],
],
'required' => false,
],
@@ -1036,33 +839,17 @@
[
'name' => 'OrderType',
'in' => 'query',
- 'schema' => [
- 'description' => '订单类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'create',
- ],
+ 'schema' => ['description' => '订单类型。', 'type' => 'string', 'required' => false, 'example' => 'create'],
],
[
'name' => 'PackageCode',
'in' => 'query',
- 'schema' => [
- 'description' => '套餐Code,非套餐类型无需填写该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pacakge',
- ],
+ 'schema' => ['description' => '套餐Code,非套餐类型无需填写该参数。', 'type' => 'string', 'required' => false, 'example' => 'pacakge'],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
- 'schema' => [
- 'description' => '转售模式的资源归属用户ID,非转售模式无需填写该参数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '182864463481****',
- ],
+ 'schema' => ['description' => '转售模式的资源归属用户ID,非转售模式无需填写该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '182864463481****'],
],
],
'responses' => [
@@ -1071,11 +858,7 @@
'description' => '询价结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970'],
'PriceInfo' => [
'description' => '价格详细信息。',
'type' => 'object',
@@ -1087,17 +870,8 @@
'description' => '活动规则信息。',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'description' => '活动规则描述。',
- 'type' => 'string',
- 'example' => 'accounts_suspect_users',
- ],
- 'RuleId' => [
- 'description' => '活动规则ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'hrzdvc',
- ],
+ 'Description' => ['description' => '活动规则描述。', 'type' => 'string', 'example' => 'accounts_suspect_users'],
+ 'RuleId' => ['description' => '活动规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'hrzdvc'],
],
],
],
@@ -1105,33 +879,14 @@
'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',
- ],
+ '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',
@@ -1139,31 +894,11 @@
'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' => '优惠活动名称',
- ],
+ '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' => '优惠活动名称'],
],
],
],
@@ -1174,43 +909,16 @@
'description' => '价格详情。',
'type' => 'object',
'properties' => [
- 'OrderItem' => [
- 'description' => '排序属性。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ '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',
- ],
+ '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', 'description' => ''],
],
],
'ModuleDetails' => [
@@ -1220,64 +928,24 @@
'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',
- ],
+ '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', 'description' => ''],
],
],
],
],
],
],
- 'RefundPrice' => [
- 'description' => '退订价格。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '60.00',
- ],
+ 'RefundPrice' => ['description' => '退订价格。', 'type' => 'number', 'format' => 'float', 'example' => '60.00'],
'RefundInstanceIdPriceMap' => [
'description' => '退订实例和定价详情。',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'number',
- 'format' => 'float',
- 'description' => '退订金额。',
- 'example' => '100',
- ],
+ 'additionalProperties' => ['type' => 'number', 'format' => 'float', 'description' => '退订金额。', 'example' => '100'],
],
],
],
@@ -1287,19 +955,573 @@
],
],
],
- '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>',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-17T09:56:35.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeMultiPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
+ ],
+ 'DescribePackageDeductions' => [
+ '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, 'description' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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', 'description' => ''],
+ 'InstanceId' => ['type' => 'string', 'description' => ''],
+ 'InstanceType' => ['type' => 'string', 'description' => ''],
+ 'UsedTimeWithScale' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
+ 'GroupResourceType' => ['type' => 'string', 'description' => ''],
+ 'UsedTimeDecimal' => ['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'],
+ 'TotalUsedTimeDecimal' => ['type' => 'string'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '查询核时包抵扣明细',
+ 'summary' => '查询核时包抵扣明细。',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-08T03:32:49.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-06-23T10:46:35.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-02-07T02:55:58.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-12T03:41:18.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-09-25T07:45:37.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribePackageDeductions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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 \\"UsedTimeDecimal\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"TotalUsedTime\\": 100000,\\n \\"TotalUsedCoreTime\\": 10.1,\\n \\"TotalUsedTimeDecimal\\": \\"\\"\\n}","type":"json"}]',
+ ],
+ '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'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\"\\n}","type":"json"}]',
+ 'title' => '修改实例属性',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ ],
+ 'SetAgentCreditQuota' => [
+ 'summary' => '用于为指定的Agent设置积分使用额度。',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'BizType',
+ 'in' => 'query',
+ 'schema' => ['description' => '业务类型', 'type' => 'string', 'required' => false, 'example' => 'BUSINESS'],
+ ],
+ [
+ 'name' => 'AgentType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Agent类型'."\n", 'type' => 'string', 'required' => false, 'example' => 'JVSClaw'],
+ ],
+ [
+ 'name' => 'AgentIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'Agent ID列表'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'AgentId列表', 'type' => 'string', 'required' => false, 'example' => 'jvs-0bwu3iffqhduyz3kq'],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'CreditQuota',
+ 'in' => 'query',
+ 'schema' => ['description' => '积分配额'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '9B353D6D-53C9-1C24-95D5-2D24596DBCF1'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '设置积分配额',
+ 'description' => '## 请求说明'."\n"
+ .'通过此API,您可以为特定类型的Agent设置积分使用额度。支持批量设置多个Agent的额度。'."\n"
+ ."\n"
+ .'### 注意事项'."\n"
+ .'- `AgentType` 参数指定了要设置额度的Agent类型,例如 `JVSClaw` 或 `OpenClaw`。'."\n"
+ .'- `AgentIds` 参数是一个数组,可以包含最多100个Agent ID。'."\n"
+ .'- `CreditQuota` 参数指定了每个Agent的积分使用额度。'."\n"
+ ."\n"
+ .'### 示例'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:SetAgentCreditQuota',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B353D6D-53C9-1C24-95D5-2D24596DBCF1\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'wss.ap-southeast-1.aliyuncs.com', 'endpoint' => 'wss.ap-southeast-1.aliyuncs.com', 'vpc' => 'wss-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'wss.cn-shanghai.aliyuncs.com', 'endpoint' => 'wss.cn-shanghai.aliyuncs.com', 'vpc' => 'wss.vpc-proxy.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'OperationDenied.NoStock', 'message' => 'The resource is out of usage.', 'http_code' => 400, 'description' => '当前所选硬件库存不足,请减少购买数量、或稍后重试'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'wss.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeMultiPrice'],
+ ],
+ 'createdAt' => '2025-11-17T09:56:44.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'wss.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateMultiOrder'],
+ ],
+ 'createdAt' => '2025-02-25T13:01:51.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribePackageDeductions'],
+ ],
+ 'createdAt' => '2025-02-07T02:56:05.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribePackageDeductions'],
+ ],
+ 'createdAt' => '2024-11-12T03:41:27.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribePackageDeductions'],
+ ],
+ 'createdAt' => '2024-09-25T07:45:46.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribePrice'],
+ ],
+ 'createdAt' => '2024-04-29T12:21:38.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'DescribeBillings'],
+ ['description' => '请求参数发生变更', 'api' => 'DescribePrice'],
+ ],
+ 'createdAt' => '2022-03-08T01:54:17.000Z',
+ 'description' => '调整询价接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateOrder'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DescribePrice'],
+ ['description' => 'OpenAPI 下线', 'api' => 'StartBilling'],
+ ['description' => 'OpenAPI 下线', 'api' => 'StopBilling'],
+ ],
+ 'createdAt' => '2022-02-16T01:32:40.000Z',
+ 'description' => '无影售卖中台API首次发布',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'ECD',
+ 'productName' => '无影云电脑',
+ 'ramCodes' => ['ecd', 'eds-user', 'gws', 'wss'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DescribeCreditPackageAgents',
+ 'description' => '查询积分包Agent列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeCreditPackageAgents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribePackageDeductions',
+ 'description' => '查询核时包抵扣明细',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribePackageDeductions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateMultiOrder',
+ 'description' => '组合下单',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateMultiOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDeliveryAddress',
+ 'description' => '查询物流地址',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeDeliveryAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCreditUsageInfo',
+ 'description' => '查询积分用量详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeCreditUsageInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyInstanceProperties',
+ 'description' => '修改实例属性',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ModifyInstanceProperties',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeMultiPrice',
+ 'description' => '查询新购、续费变配及退订的价格',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeMultiPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetAgentCreditQuota',
+ 'description' => '设置积分配额',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:SetAgentCreditQuota',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDeductionStatistic',
+ 'description' => '查询抵扣详情',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeDeductionStatistic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];