summaryrefslogtreecommitdiff
path: root/data/en_us/wss/2021-12-21
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/en_us/wss/2021-12-21
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/wss/2021-12-21')
-rw-r--r--data/en_us/wss/2021-12-21/api-docs.php2119
1 files changed, 1338 insertions, 781 deletions
diff --git a/data/en_us/wss/2021-12-21/api-docs.php b/data/en_us/wss/2021-12-21/api-docs.php
index 0f288cb..fa4b03c 100644
--- a/data/en_us/wss/2021-12-21/api-docs.php
+++ b/data/en_us/wss/2021-12-21/api-docs.php
@@ -1,43 +1,26 @@
<?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' => null,
+ 'children' => ['CreateMultiOrder'],
'type' => 'directory',
- 'children' => [
- 'CreateMultiOrder',
- ],
+ 'title' => 'Order',
],
[
- 'id' => 202515,
- 'title' => null,
+ 'children' => ['DescribePackageDeductions', 'ModifyInstanceProperties'],
'type' => 'directory',
- 'children' => [
- 'DescribePackageDeductions',
- 'ModifyInstanceProperties',
- ],
+ 'title' => 'Duration plans & core-hour plans',
],
[
- 'id' => 196356,
- 'title' => null,
+ 'children' => ['DescribeDeliveryAddress'],
'type' => 'directory',
- 'children' => [
- 'DescribeDeliveryAddress',
- ],
+ 'title' => 'Hardware',
],
[
- 'id' => 0,
- 'title' => '其它',
+ 'children' => ['DescribeMultiPrice', 'DescribeDeductionStatistic', 'SetAgentCreditQuota', 'DescribeCreditUsageInfo', 'DescribeCreditPackageAgents'],
'type' => 'directory',
- 'children' => [
- 'DescribeMultiPrice',
- ],
+ 'title' => 'Other',
],
],
'components' => [
@@ -45,14 +28,9 @@
],
'apis' => [
'CreateMultiOrder' => [
- 'summary' => '多商品组合下单',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Use this API to order, renew, and modify specific products, such as monthly resource plans for Elastic Desktop Service (EDS) Enterprise Edition.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -64,9 +42,7 @@
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeCode' => '244439',
- 'abilityTreeNodes' => [
- 'FEATUREgwsQ7ENW2',
- ],
+ 'abilityTreeNodes' => ['FEATUREgwsQ7ENW2'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
@@ -75,145 +51,166 @@
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The items in the order.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'A single item in the order.',
'type' => 'object',
'properties' => [
- 'Amount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'Amount' => ['description' => 'The number of resources to purchase.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'ResourceType' => [
- 'description' => '',
+ 'description' => 'The type of the resource.'."\n"
+ ."\n"
+ .'> This parameter is case-sensitive.',
+ 'enumValueTitles' => ['DurationPackage' => 'A monthly duration package for the Enterprise Edition.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'DurationPackage' => '',
- ],
'example' => 'DurationPackage',
+ 'title' => '',
],
'AutoPay' => [
- 'description' => '',
+ 'description' => 'Specifies whether to enable automatic payment.',
+ 'enumValueTitles' => ['true' => 'Enables automatic payment.', 'false' => 'Disables automatic payment.'],
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
'example' => 'true',
+ 'title' => '',
],
'AutoRenew' => [
- 'description' => '',
+ 'description' => 'Specifies whether to enable auto-renewal.',
+ 'enumValueTitles' => ['true' => 'Enables auto-renewal.', 'false' => 'Disables auto-renewal.'],
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
'example' => 'false',
+ 'title' => '',
],
'PeriodUnit' => [
- 'description' => '',
+ 'description' => 'The time unit of the subscription duration.'."\n"
+ ."\n"
+ .'> This parameter is required for prepaid instances and is case-sensitive.',
+ 'enumValueTitles' => ['Month' => 'Month', 'Year' => 'Year'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'Month' => '',
- 'Year' => '',
- ],
'example' => 'Year',
+ 'title' => '',
],
'Components' => [
- 'description' => '',
+ 'description' => 'The components that define the resource.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'A single component that defines the resource.',
'type' => 'object',
'properties' => [
'Key' => [
- 'description' => '',
+ 'description' => 'The key of the component.',
+ 'enumValueTitles' => ['DurationType' => 'The duration of the computing plan in hours. Required for a purchase or configuration change.', 'RootDiskSize' => 'The size of the system disk. Required.', 'OsType' => 'The type of the operating system. Required for a purchase or configuration change.', 'RootDiskCategory' => 'The type of the system disk. Required.', 'RootPerformanceLevel' => 'The performance level of the system disk. This is required when `RootDiskCategory` is set to `cloud_essd`.', 'DataPerformanceLevel' => 'Optional. The performance level of the data disk. The valid values are the same as those for `RootPerformanceLevel`.', 'RegionId' => 'The region of the instance. Required.', 'DataDiskSize' => 'Optional. The size of the data disk. The valid values are the same as those for `RootDiskSize`.', 'InstanceType' => 'The instance type. Required for a purchase or configuration change.', 'DataDiskCategory' => 'Optional. The type of the data disk. The valid values are the same as those for `RootDiskCategory`.'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'DurationType' => '',
- 'RootDiskSize' => '',
- 'OsType' => '',
- 'RootDiskCategory' => '',
- 'RootPerformanceLevel' => '',
- 'DataPerformanceLevel' => '',
- 'RegionId' => '',
- 'DataDiskSize' => '',
- 'InstanceType' => '',
- 'DataDiskCategory' => '',
- ],
'example' => 'RegionId',
+ 'title' => '',
],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'Value' => ['description' => 'The value of the component.'."\n"
+ ."\n"
+ .'Example and valid values for the keys of a monthly duration package (Enterprise Edition):'."\n"
+ ."\n"
+ .'- RegionId: cn-shanghai'."\n"
+ ."\n"
+ .'- InstanceType: eds.enterprise\\_office.4c8g'."\n"
+ ."\n"
+ .'- DurationType (in hours): Valid values:'."\n"
+ ."\n"
+ .' - 120'."\n"
+ ."\n"
+ .' - 250'."\n"
+ ."\n"
+ .'- OsType: Valid values:'."\n"
+ ."\n"
+ .' - Windows'."\n"
+ ."\n"
+ .' - Linux'."\n"
+ ."\n"
+ .'- RootDiskSize (in GiB): 80'."\n"
+ ."\n"
+ .'- RootDiskCategory: Valid values:'."\n"
+ ."\n"
+ .' - cloud\\_efficiency (Ultra Disk)'."\n"
+ ."\n"
+ .' - cloud\\_auto (ESSD AutoPL Disk)'."\n"
+ ."\n"
+ .' - `cloud_essd` (Enhanced SSD). This value is supported only by specific instance types.'."\n"
+ ."\n"
+ .'- RootPerformanceLevel: Valid values:'."\n"
+ ."\n"
+ .' - PL0'."\n"
+ ."\n"
+ .' - PL1'."\n"
+ ."\n"
+ .' - PL2'."\n"
+ ."\n"
+ .' - PL3'."\n"
+ ."\n"
+ .'- DataDiskSize (in GiB): Same as `RootDiskSize`.'."\n"
+ ."\n"
+ .'- DataDiskCategory: Same as `RootDiskCategory`.'."\n"
+ ."\n"
+ .'- DataPerformanceLevel: Same as `RootPerformanceLevel`.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
- 'PromotionId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'youhuiquan_promotion_option_id_for_blank',
- ],
- 'Period' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'PromotionId' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''],
+ 'Period' => ['description' => 'The subscription period. Valid values:'."\n"
+ ."\n"
+ .'- If `PeriodUnit` is set to `Year`, the valid values are 1, 2, 3, and 5.'."\n"
+ ."\n"
+ .'- If `PeriodUnit` is set to `Month`, the valid values are 1, 2, 3, and 6.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'ResourceIds' => [
- 'description' => '',
+ 'description' => 'A list of resource IDs.'."\n"
+ ."\n"
+ .'> For a monthly duration package, this parameter specifies the IDs of the cloud desktops. This parameter is required unless the `OrderType` is `create`.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecd-7ywwjrhpy9fec****',
- ],
+ 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-7ywwjrhpy9fec****', 'title' => ''],
'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
- 'BuyChange' => [
- 'type' => 'boolean',
+ 'BuyChange' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ 'InstanceIds' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'maxItems' => 100,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 20,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The order type.',
+ 'enumValueTitles' => ['modify' => 'Changes the configuration.', 'create' => 'Purchases a new resource.', 'renew' => 'Renews a resource.', 'convert' => 'Converts the order type.', 'refund' => 'Requests a refund for a resource.'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'modify' => '',
- 'create' => '',
- 'renew' => '',
- 'convert' => '',
- 'refund' => '',
- ],
'example' => 'create',
+ 'title' => '',
],
],
[
@@ -221,424 +218,421 @@
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The extended properties.',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"PackageUsedUpStrategyKey":"Postpaid"}',
- 'description' => '',
- ],
+ 'additionalProperties' => ['description' => 'The extended properties, in JSON format.'."\n"
+ ."\n"
+ .'Example: `{"PackageUsedUpStrategyKey":"Postpaid"}` specifies that the Pay-As-You-Go billing method is used after the monthly duration package is exhausted.', 'type' => 'string', 'example' => '{"PackageUsedUpStrategyKey":"Postpaid"}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'ChannelCookie',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970'],
'OrderIds' => [
- 'description' => '',
+ 'description' => 'A list of order IDs.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '23171351342****',
- ],
+ 'items' => ['description' => 'An order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '23171351342****', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\",\\n \\"OrderIds\\": [\\n 0\\n ]\\n}","type":"json"}]',
- ],
- 'DescribePackageDeductions' => [
- 'summary' => '查询核时包抵扣明细',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Place Combined Orders',
+ 'description' => '<props="china">'."\n"
+ ."\n"
+ .'Before calling this API, make sure you understand how Wuying Workspace is billed and its [pricing](https://www.aliyun.com/price/product?#/gws/detail/gws).'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\n"
+ ."\n"
+ .'Before calling this API, make sure you understand how Wuying Workspace is billed and its [pricing](https://www.alibabacloud.com/zh/product/cloud-desktop?#J_8623712560).'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'If you do not specify automatic payment, this API does not handle the payment. You must use the returned order ID to construct a payment URL. The order becomes active and the resource is provisioned only after the payment is complete.',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-22T07:32:22.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-02-25T13:01:43.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateMultiOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\",\\n \\"OrderIds\\": [\\n 0\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeCreditPackageAgents' => [
+ 'summary' => 'Queries a list of agents and their usage information.',
+ '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' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'enumValueTitles' => [
- 'CorePackage' => '',
- ],
- 'example' => 'CorePackage',
- 'title' => '资源类型,核时包:CorePackage',
- ],
+ 'schema' => ['description' => 'The business type.', 'type' => 'string', 'required' => false, 'example' => 'BUSINESS', 'title' => ''],
],
[
- 'name' => 'PackageIds',
+ 'name' => 'AgentType',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'chp-0bf5d9fdjr8vz****',
- 'title' => '',
- ],
- 'required' => false,
- 'docRequired' => false,
- 'maxItems' => 100,
- 'title' => '核时包id列表',
- ],
+ 'schema' => ['description' => 'The agent type. Valid values: `CREDIT_PACKAGE`, `JVS_CLAW`, `OPEN_CLAW`, and `JVS_COPILOT`.', 'type' => 'string', 'required' => false, 'example' => 'JVS_COPILOT', 'title' => ''],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'AgentIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecd-6wye9optu0kag****',
- ],
- 'required' => false,
- 'docRequired' => false,
+ 'items' => ['description' => 'An agent ID.', 'type' => 'string', 'required' => false, 'example' => 'jvs-xxxx', 'title' => ''],
'maxItems' => 100,
- 'title' => '抵扣实例列表,企业版核时包对应桌面id',
+ 'minItems' => 0,
+ 'description' => 'An array of agent IDs to query. Example: `["agent-1","agent-2"]`.',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PageNum',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'enumValueTitles' => [],
- 'example' => '1',
- 'title' => '页码,默认1',
- ],
+ 'schema' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'NextToken',
'in' => 'query',
+ 'schema' => ['description' => 'The token to retrieve the next page of results. Obtain this value from the `NextToken` parameter of the previous response. For the first request, set this parameter to an empty string.', 'type' => 'string', 'required' => false, 'example' => 'eyJvZmZzZXQiOjIwfQ==', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '100',
- 'title' => '每页最大数量,最大不超过100,默认100',
- 'maximum' => '100',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID. Provide this ID when contacting support.', 'type' => 'string', 'title' => '', 'example' => 'xxxx-xxxx-xxxx'],
+ 'Agents' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AgentId' => ['description' => 'The ID of the agent.', 'type' => 'string', 'example' => 'agent-abc', 'title' => ''],
+ 'InstanceType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'jvs-copilot.standard', 'title' => ''],
+ 'CreatedTime' => ['description' => '**The creation time of the instance.**', 'type' => 'string', 'example' => '2026-04-01 10:00:00', 'title' => ''],
+ 'ExpiredTime' => ['description' => '**The expiration time of the instance.**', 'type' => 'string', 'example' => '2026-10-01 10:00:00', 'title' => ''],
+ 'UsedCredit' => ['description' => '**The amount of credit used.**', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'TotalCredit' => ['description' => '**The total credit.**', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', 'title' => ''],
+ 'CreditPackageId' => ['description' => '**The ID of the active credit package instance.**', 'type' => 'string', 'example' => 'cp-inst-001', 'title' => ''],
+ 'WarnPercent' => ['description' => '**The alarm threshold, specified as a percentage. Valid values: 0 to 100.**', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of agents.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'MaxResults' => ['description' => 'The number of results returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'NextToken' => ['description' => 'The token to retrieve the next page of results. If this value is empty, all results have been returned.', 'type' => 'string', 'example' => 'eyJvZmZzZXQiOjIwfQ==', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DescribeCreditPackageAgents',
+ 'description' => '## Usage notes'."\n"
+ ."\n"
+ .'- **Pagination**: This operation supports pagination by using the `NextToken` and `MaxResults` parameters. For the first request, set `NextToken` to an empty string.'."\n"
+ ."\n"
+ .'- **Filtering**: Use the `AgentType` and `AgentIds` parameters to filter the results.'."\n"
+ ."\n"
+ .'- **Status filtering**: Use the `Status` parameter to filter agents by status. Valid values are 0 (deleted) and 1 (active).'."\n"
+ ."\n"
+ .'- **Sorting**: By default, the results are sorted by `id` in ascending order.'."\n"
+ ."\n"
+ .'- **Additional parameter for anonymous edition**: The `FillInstance` parameter automatically populates the ID of the JVS\\_COPILOT agent that is associated with the current user.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '起始时间,时间戳格式,long型',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeCreditPackageAgents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', '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型',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'schema' => ['description' => 'The business type.', 'type' => 'string', 'required' => false, 'example' => 'BUSINESS', 'title' => ''],
],
[
- 'name' => 'ResourceTypes',
+ 'name' => 'UsageType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The usage type. Valid values:'."\n"
+ .'* User: Returns the usage, remaining credits, and consumption trends of the active credit packages for the current user.'."\n"
+ .'* CreditPackage: Requires a CreditPackageId. Returns the total and remaining credits of the specified credit package.'."\n"
+ .'* Agent: Requires an AgentId. Returns the cumulative credit usage, cumulative allocated quota, and the percentages of both.', 'type' => 'string', 'required' => false, 'example' => 'User', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
+ 'description' => 'The JSON string of instance IDs. This parameter can be omitted when `UsageType=User`. Set this parameter to the credit package instance ID when `UsageType=CreditPackage`, or to the `AgentId` when `UsageType=Agent`.',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'cp-0bszoespx7o1ehjxs', 'title' => ''],
+ 'required' => false,
'maxItems' => 100,
+ 'minItems' => 0,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The return type: `ListResult<CreditUsageInfoModel>`.',
'type' => 'object',
'properties' => [
- 'PageNum' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Deductions' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '68BD3312-53D8-123E-BB32-1A9F25E07A03'],
+ 'UsageInfoList' => [
+ 'description' => 'The array of usage data.',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'DesktopName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DemoComputer',
- 'title' => '',
- ],
- 'DesktopId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ecd-6wye9optu0kag****',
- ],
- 'RegionId' => [
- 'description' => '',
- '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' => 'The usage primary key. When `UsageType=User`, this is the `aliUid`. When `UsageType=CreditPackage`, this is the credit package instance ID. When `UsageType=Agent`, this is the `AgentId`.', 'type' => 'string', 'example' => 'agent-abc', 'title' => ''],
+ 'UsageInfo' => [
+ 'description' => 'The usage data details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DayUsedCredit' => ['description' => 'The credit usage in the last 1 day.', 'type' => 'integer', 'format' => 'int64', 'example' => '最近一天消耗积分', 'title' => ''],
+ 'WeekUsedCredit' => ['description' => 'The credit usage in the last 1 week.', 'type' => 'integer', 'format' => 'int64', 'example' => '最近一周消耗积分', 'title' => ''],
+ 'TotalUsedCredit' => ['description' => 'The cumulative credit usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '共计消耗积分', 'title' => ''],
+ 'TotalCredit' => ['description' => 'The cumulative total credits.', 'type' => 'integer', 'format' => 'int64', 'example' => '积分配额', 'title' => ''],
+ 'RemainCredit' => ['description' => 'The cumulative remaining credits.', 'type' => 'integer', 'format' => 'int64', 'example' => '积分余量', 'title' => ''],
+ 'CurrentTotalCredit' => ['description' => 'The total credits of the current active credit package.', 'type' => 'integer', 'format' => 'int64', 'example' => '当前周期积分配额', 'title' => ''],
+ 'CurrentRemainCredit' => ['description' => 'The remaining credits of the current active credit package.', 'type' => 'integer', 'format' => 'int64', 'example' => '当前周期积分余量', 'title' => ''],
+ 'CurrentUsedCredit' => ['description' => 'The used credits of the current active credit package.', 'type' => 'integer', 'format' => 'int64', 'example' => '当前周期积分消耗', 'title' => ''],
+ 'CurrentInstanceId' => ['description' => 'The instance ID of the current active credit package.', 'type' => 'string', 'example' => 'cp-inst-001', 'title' => ''],
+ 'CreditTrendList' => [
+ 'description' => 'The hourly consumption samples of the current credit package.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TimePoint' => ['description' => 'The time point in the format of `yyyy-MM-dd HH` (accurate to the hour).', 'type' => 'string', 'example' => '2026-05-02 10', 'title' => ''],
+ 'UsedCredit' => ['description' => 'The number of credits consumed during the hour.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'WarnPercent' => ['description' => 'The alert threshold percentage (0–100).', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''],
+ 'PeriodUsedCredit' => ['description' => 'The shared credit usage in the current active period.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''],
+ 'PeriodTotalCredit' => ['description' => 'The shared credit quota in the current active period.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''],
+ 'TodayUsed' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TotalUsed' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
- 'example' => 'Windows',
- ],
- 'StaTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-07-31T02:00Z',
- ],
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-07-31T03:00Z',
- ],
- 'ResourceType' => [
- 'type' => 'string',
- ],
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8192',
- ],
- 'Cpu' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'SessionId' => [
- 'type' => 'string',
- ],
- 'InstanceId' => [
- 'type' => 'string',
- ],
- 'InstanceType' => [
- 'type' => 'string',
- ],
- 'UsedTimeWithScale' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'GroupResourceType' => [
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '抵扣详情',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
'title' => '',
- ],
- 'TotalUsedTime' => [
- 'title' => '总使用时长。',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'TotalUsedCoreTime' => [
- 'title' => '总抵扣核时。',
- 'type' => 'number',
- 'format' => 'float',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'ModifyInstanceProperties' => [
- 'summary' => '更新实例属性',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query credit usage details',
+ 'summary' => 'Queries credit usage by a specified dimension such as user, credit package, or agent.',
+ 'description' => '## Operation description'."\n"
+ ."\n"
+ .'This API operation queries credit usage details based on the dimension specified by `UsageType` (User, CreditPackage, or Agent). The response includes the total, remaining, and used credits of the current credit package, hourly consumption samples, alert thresholds, period quotas, and other information.'."\n"
+ ."\n"
+ .'- **User**: User dimension. Returns the aggregated usage and remaining credits across all active credit packages for the current user.'."\n"
+ .'- **CreditPackage**: Credit package dimension. Returns the total, remaining, and consumption samples for a specified credit package instance.'."\n"
+ .'- **Agent**: Agent dimension. Returns the cumulative usage, current period usage, quota, alert, and other information for a specified agent.'."\n"
+ ."\n"
+ .'**Notes**:'."\n"
+ .'- The `InstanceIds` parameter can be omitted when `UsageType=User`. Set this parameter to the credit package instance ID when `UsageType=CreditPackage`, or to the AgentId when `UsageType=Agent`.'."\n"
+ .'- Anonymous requests support the `FillInstance` parameter. If `InstanceIds` is not explicitly specified and `FillInstance=true`, the server automatically populates the bound `JVS_COPILOT` AgentId based on the current logon `wyId`.'."\n"
+ .'- Time window constants: The `dayUsedCredit` statistics window is `now - ONE_DAY_MILLIS`, and the `weekUsedCredit` statistics window is `now - ONE_WEEK_MILLIS`.'."\n"
+ .'- The consumption samples in `currentCreditConsumeList` are aggregated by hour and may have an asynchronous synchronization delay of up to 5 minutes.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeCreditUsageInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => false,
- 'enumValueTitles' => [
- '企业版按月时长包' => 'DurationPackage',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PeriodUnit' => ['description' => 'The period unit. For valid values, see the `PeriodUnit` enumeration.', 'type' => 'string', 'required' => false, 'example' => 'Year', 'title' => ''],
+ 'BaseTime' => ['description' => 'The base time.', 'type' => 'string', 'required' => false, 'example' => '2024-01-01', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'example' => 'DurationPackage',
+ 'maxItems' => 100,
+ 'description' => 'The list of periods, formatted as a JSON array of `PeriodParam` objects.',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ResourceTypes',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['description' => 'The list of resource types. You can specify a maximum of 50 resource types.'."\n"
+ ."\n"
+ .'> Setting `ResourceTypes` overrides the individual `Service` and `ResourceType` request parameters.', 'type' => 'string', 'required' => false, 'example' => 'Desktop', 'title' => ''],
+ 'maxItems' => 100,
+ 'description' => 'The list of resource types, specified as a JSON array.',
'required' => false,
- 'docRequired' => true,
- 'example' => 'mdp-0c62ayep0nk4v****',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Key',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'enumValueTitles' => [
- 'PackageUsedUpStrategy' => '',
- ],
- 'example' => 'PackageUsedUpStrategy',
- ],
+ 'schema' => ['description' => 'The start time, specified as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2026-03-20T16:00:00Z', 'title' => ''],
],
[
- 'name' => 'Value',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'Postpaid',
- ],
+ 'schema' => ['description' => 'The end time, specified as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2025-06-06T02:14:00Z', 'title' => ''],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mdp-0bwu3if0u9wwj****',
- ],
+ 'items' => ['description' => 'An instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ak-7yz7llzomgh2g64gc', 'title' => ''],
+ 'maxItems' => 100,
+ 'description' => 'The list of instance IDs, specified as a JSON array.',
'required' => false,
- 'maxItems' => 200,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -647,555 +641,1118 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A1B2C3D4-xxxx-xxxx-xxxx-xxxxxxxxxxxx'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Deductions' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DeductionDate' => ['description' => 'The deduction date.', 'type' => 'string', 'example' => '2024-01-01', 'title' => ''],
+ 'ConsumeSecond' => ['description' => 'The consumption duration in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '7000', 'title' => ''],
+ 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'CloudDesktop', 'title' => ''],
+ ],
+ 'description' => 'Details of a single deduction.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The deduction details.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Usages' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Period' => ['description' => '**The time period.**', 'type' => 'string', 'example' => '2024-01-01', 'title' => ''],
+ 'ConsumeSecond' => ['description' => '**The consumption duration in seconds.**', 'type' => 'integer', 'format' => 'int64', 'example' => '6000', 'title' => ''],
+ 'ResourceType' => ['description' => '**The resource type.**', 'type' => 'string', 'example' => 'CloudDesktop', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '**The usage details.**',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AvailableCorePackages' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupId' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'g-xxxxx', 'title' => ''],
+ 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1568857911493620', 'title' => ''],
+ 'GroupResourceType' => ['description' => 'The group resource type.', 'type' => 'string', 'example' => 'CoreHour', 'title' => ''],
+ 'UsedTime' => ['description' => 'The used duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '40000', 'title' => ''],
+ 'TotalTime' => ['description' => 'The total duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000', 'title' => ''],
+ 'ResourceType' => ['description' => 'The group resource type.', 'type' => 'string', 'example' => 'CoreHour', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''],
+ 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-12-31 23:59:59', 'title' => ''],
+ 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Active', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2024-12-31 23:59:59', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''],
+ 'NoLx' => ['description' => 'Indicates whether the resource is a No-Lx resource.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'NoLxSource' => ['description' => 'The source of the No-Lx resource.', 'type' => 'string', 'example' => '无凌霄来源示例值', 'title' => ''],
+ 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'res-xxxxx', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '**The available core-hour packages.**',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The deduction data.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The response data.',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\"\\n}","type":"json"}]',
- ],
- 'DescribeDeliveryAddress' => [
- 'summary' => '查询物流地址',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DescribeDeductionStatistic',
+ 'summary' => 'Retrieves resource deduction and usage statistics based on specified criteria.',
+ 'description' => '## Request'."\n"
+ ."\n"
+ .'- This API supports GET and POST methods.'."\n"
+ ."\n"
+ .'- The `periods` parameter is a JSON array of `PeriodParam` objects, each containing the `periodUnit` and `baseTime` fields.'."\n"
+ ."\n"
+ .'- The `resourceTypes` parameter is a JSON array of resource type strings.'."\n"
+ ."\n"
+ .'- The `startTime` and `endTime` parameters are timestamps that define the query\'s time range.'."\n"
+ ."\n"
+ .'- The `nextToken`, `maxResults`, `pageNo`, and `pageSize` parameters control pagination and the number of results to return.'."\n"
+ ."\n"
+ .'- The API throws a `SalesClientException` if the `resourceTypes` parameter contains an invalid value or if the `periods` parameter fails JSON parsing.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeDeductionStatistic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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\\": false,\\n \\"NoLxSource\\": \\"无凌霄来源示例值\\",\\n \\"ResourceId\\": \\"res-xxxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeDeliveryAddress' => [
+ 'summary' => 'Retrieves information about delivery addresses.',
+ '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' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '72481C12-69AB-5CE1-8A35-A8EFA921****',
- ],
+ 'TotalCount' => ['description' => 'The total count of addresses.'."\n"
+ ."\n"
+ .'> Up to 20 addresses are supported.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates this unique identifier for each request.', 'type' => 'string', 'example' => '72481C12-69AB-5CE1-8A35-A8EFA921****', 'title' => ''],
'Addresses' => [
- 'description' => '',
+ 'description' => 'The address list.',
'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' => 'The postal code.', 'type' => 'string', 'example' => '03****', 'title' => ''],
+ 'Contacts' => ['description' => 'The contact name.', 'type' => 'string', 'example' => 'Alice', 'title' => ''],
+ 'Mobile' => ['description' => 'The mobile number.', 'type' => 'string', 'example' => '1381111****', 'title' => ''],
'DefaultAddress' => [
- 'description' => '',
+ 'description' => 'Indicates whether this is the default address.',
+ 'enumValueTitles' => ['true' => 'This is the default address.', 'false' => 'This is not the default address.'],
'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
'example' => 'true',
+ 'title' => '',
],
- 'Detail' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'Detail' => ['description' => 'The detailed address, which should include the street name and house number.', 'type' => 'string', 'example' => '灯彩街1008号云园区2号楼测试中心'."\n", 'title' => ''],
'Province' => [
- 'description' => '',
+ 'description' => 'The province.',
'type' => 'object',
'properties' => [
- 'ProvinceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '330000',
- ],
- 'ProvinceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'ProvinceId' => ['description' => 'The province ID. For more information, see [China regions, countries and territories codes](~~167926~~).'."\n"
+ ."\n"
+ .'For example, **110000** represents Beijing and **120000** represents Tianjin.', 'type' => 'integer', 'format' => 'int64', 'example' => '330000', 'title' => ''],
+ 'ProvinceName' => ['description' => 'The province name.', 'type' => 'string', 'example' => '浙江省', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'City' => [
- 'description' => '',
+ 'description' => 'The city.',
'type' => 'object',
'properties' => [
- 'CityId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '33****',
- ],
- 'CityName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'CityId' => ['description' => 'The city ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '33****', 'title' => ''],
+ 'CityName' => ['description' => 'The city name.', 'type' => 'string', 'example' => '杭州市', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'Area' => [
- 'description' => '',
+ 'description' => 'The area.',
'type' => 'object',
'properties' => [
- 'AreaName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'AreaId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '33****',
- ],
+ 'AreaName' => ['description' => 'The area name.', 'type' => 'string', 'example' => '西湖区', 'title' => ''],
+ 'AreaId' => ['description' => 'The area ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '33****', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'Town' => [
- 'description' => '',
+ 'description' => 'The town.',
'type' => 'object',
'properties' => [
- 'TownName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TownId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3001****',
- ],
+ 'TownName' => ['description' => 'The town name.', 'type' => 'string', 'example' => '三墩镇', 'title' => ''],
+ 'TownId' => ['description' => 'The town ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3001****', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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"}]',
- ],
- 'DescribeMultiPrice' => [
- 'summary' => '批量询价',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '查询物流地址',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeDeliveryAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeMultiPrice' => [
+ 'summary' => 'Queries prices for Elastic Desktop Service products, covering order types such as purchase, renewal, configuration change, and cancellation.',
+ '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',
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DurationPackage',
- ],
- 'PeriodUnit' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Year',
- ],
+ 'Amount' => ['description' => 'The quantity to purchase.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ 'ResourceType' => ['description' => 'The resource type.'."\n"
+ ."\n"
+ .'> The value is case-sensitive.', 'type' => 'string', 'required' => false, 'example' => 'DurationPackage', 'title' => ''],
+ 'PeriodUnit' => ['description' => 'The unit of the subscription period.', 'type' => 'string', 'required' => false, 'example' => 'Year', 'title' => ''],
'Components' => [
- 'description' => '',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RegionId',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'Key' => ['description' => 'The key of the component.', 'type' => 'string', 'required' => false, 'example' => 'RegionId', 'title' => ''],
+ 'Value' => ['description' => 'The value of the component.'."\n"
+ ."\n"
+ .'The following are the keys and their sample or enumerated values for a monthly duration package of the enterprise edition:'."\n"
+ ."\n"
+ .'- `RegionId`: cn-shanghai'."\n"
+ ."\n"
+ .'- `InstanceType`: eds.enterprise\\_office.4c8g'."\n"
+ ."\n"
+ .'- `DurationType` (in hours): \\[enum]'."\n"
+ ."\n"
+ .' - 120'."\n"
+ ."\n"
+ .' - 250'."\n"
+ ."\n"
+ .'- `OsType`: \\[enum]'."\n"
+ ."\n"
+ .' - Windows'."\n"
+ ."\n"
+ .' - Linux'."\n"
+ ."\n"
+ .'- `RootDiskSize` (in GiB): 80'."\n"
+ ."\n"
+ .'- `RootDiskCategory`: \\[enum]'."\n"
+ ."\n"
+ .' - `cloud_efficiency` (Ultra Cloud Disk)'."\n"
+ ."\n"
+ .' - `cloud_auto` (AutoPL Cloud Disk)'."\n"
+ ."\n"
+ .' - `cloud_essd` (Enhanced SSD (ESSD), available only for specific instance types)'."\n"
+ ."\n"
+ .'- `RootPerformanceLevel`: \\[enum]'."\n"
+ ."\n"
+ .' - PL0'."\n"
+ ."\n"
+ .' - PL1'."\n"
+ ."\n"
+ .' - PL2'."\n"
+ ."\n"
+ .' - PL3'."\n"
+ ."\n"
+ .'- `DataDiskSize` (in GiB): Same as `RootDiskSize`.'."\n"
+ ."\n"
+ .'- `DataDiskCategory`: Same as `RootDiskCategory`.'."\n"
+ ."\n"
+ .'- `DataPerformanceLevel`: Same as `RootPerformanceLevel`.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''],
],
'required' => false,
+ 'description' => 'A component.',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
+ 'description' => 'A list of components.',
+ 'title' => '',
+ 'example' => '',
],
- 'PromotionId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'youhuiquan_promotion_option_id_for_blank',
- ],
- 'Period' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'PromotionId' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''],
+ 'Period' => ['description' => 'The subscription period. Valid values:'."\n"
+ ."\n"
+ .'- If `PeriodUnit` is `Year`, the valid values are 1, 2, and 3.'."\n"
+ ."\n"
+ .'- If `PeriodUnit` is `Month`, the valid values are 1, 2, 3, and 6.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'InstanceIds' => [
- 'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mdp-erdb15ubox6sx****',
- ],
+ 'items' => ['description' => 'An instance ID.', 'type' => 'string', 'required' => false, 'example' => 'mdp-erdb15ubox6sx****', 'title' => ''],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
+ 'description' => 'A list of instance IDs.',
+ 'title' => '',
+ 'example' => '',
],
'ResourceIds' => [
- 'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecd-7ywwjrhpy9fec****',
- ],
+ 'items' => ['description' => 'A resource ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-7ywwjrhpy9fec****', 'title' => ''],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
+ 'description' => 'A list of resource IDs.',
+ 'title' => '',
+ 'example' => '',
],
- 'SavingPlanPeriod' => [
- 'type' => 'string',
- ],
+ 'SavingPlanPeriod' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'required' => false,
+ 'description' => 'An order item.',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 20,
+ 'description' => 'The order items.',
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'OrderType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'create',
- ],
+ 'schema' => ['description' => 'The order type.', 'type' => 'string', 'required' => false, 'example' => 'create', 'title' => ''],
],
[
'name' => 'PackageCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pacakge',
- ],
+ 'schema' => ['description' => 'The package code. This parameter is not required for non-package types.', 'type' => 'string', 'required' => false, 'example' => 'pacakge', 'title' => ''],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '182864463481****',
- ],
+ 'schema' => ['description' => 'The ID of the user who owns the resource in the reseller model. This parameter is not required in non-reseller mode.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '182864463481****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970', 'title' => ''],
'PriceInfo' => [
- 'description' => '',
'type' => 'object',
'properties' => [
'Rules' => [
- 'description' => '',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'accounts_suspect_users',
- ],
- 'RuleId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'hrzdvc',
- ],
+ 'Description' => ['description' => 'The promotion rule description.', 'type' => 'string', 'example' => 'accounts_suspect_users', 'title' => ''],
+ 'RuleId' => ['description' => 'The promotion rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'hrzdvc', 'title' => ''],
],
+ 'description' => 'A promotion rule.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'A list of promotion rules.',
+ 'title' => '',
+ 'example' => '',
],
'Price' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'OriginalPrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '6800',
- ],
- 'DiscountPrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '534.6',
- ],
- 'Currency' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'TradePrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '82.6',
- ],
+ 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '6800', 'title' => ''],
+ 'DiscountPrice' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '534.6', 'title' => ''],
+ 'Currency' => ['description' => 'The currency.'."\n"
+ ."\n"
+ .'China site: CNY.'."\n"
+ ."\n"
+ .'International site: USD.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'TradePrice' => ['description' => 'The trade price, which is the original price minus the discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '82.6', 'title' => ''],
'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' => '',
- 'type' => 'string',
- 'example' => 'youhuiquan_promotion_option_id_for_blank',
- ],
- 'PromotionName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'PromotionDesc' => ['description' => 'The promotion description.', 'type' => 'string', 'example' => '促销', 'title' => ''],
+ 'OptionCode' => ['description' => 'The option code.', 'type' => 'string', 'example' => 'new', 'title' => ''],
+ 'Selected' => ['description' => 'Indicates whether the promotion is selected.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'PromotionId' => ['description' => 'The promotion ID.', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''],
+ 'PromotionName' => ['description' => 'The promotion name.', 'type' => 'string', 'example' => '优惠活动名称', 'title' => ''],
],
+ 'description' => 'A promotion.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'A list of promotions.',
+ 'title' => '',
+ 'example' => '',
],
'PriceDetails' => [
- 'description' => '',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'OrderItem' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'OrderItem' => ['description' => 'The sort order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'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' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '100.00', 'title' => ''],
+ 'DiscountPrice' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '20.00', 'title' => ''],
+ 'TradePrice' => ['description' => 'The trade price, which is the original price minus the discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '80.00', 'title' => ''],
+ 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'DurationPackage', 'title' => ''],
+ 'SavingPlanRecommendPrice' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => 'A breakdown of the price.',
+ 'title' => '',
+ 'example' => '',
],
'ModuleDetails' => [
- 'description' => '',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'ModuleCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DesktopType',
- ],
- 'ModuleValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'eds.enterprise_office.8c32g',
- ],
- 'ModuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- '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' => 'The module code.', 'type' => 'string', 'example' => 'DesktopType', 'title' => ''],
+ 'ModuleValue' => ['description' => 'The module value.', 'type' => 'string', 'example' => 'eds.enterprise_office.8c32g', 'title' => ''],
+ 'ModuleName' => ['description' => 'The module name.', 'type' => 'string', 'example' => '企业办公型-8C32G', 'title' => ''],
+ 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '10900', 'title' => ''],
+ 'DiscountPrice' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '734.65', 'title' => ''],
+ 'TradePrice' => ['description' => 'The trade price, which is the original price minus the discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '292.2', 'title' => ''],
+ 'SavingPlanDiscountPrice' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => 'The details of a pricing module.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'A list of pricing module details.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'A price detail.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'A list of price details.',
+ 'title' => '',
+ 'example' => '',
],
- 'RefundPrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '60.00',
- ],
+ 'RefundPrice' => ['description' => 'The refund amount.', 'type' => 'number', 'format' => 'float', 'example' => '60.00', 'title' => ''],
'RefundInstanceIdPriceMap' => [
- 'description' => '',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'number',
- 'format' => 'float',
- 'description' => '',
- 'example' => '100',
- ],
+ 'additionalProperties' => ['description' => 'The refund amount.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''],
+ 'description' => 'A map of instance IDs to their corresponding refund amounts.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'The price information.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'The detailed price information.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'The pricing result.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'title' => 'DescribeMultiPrice',
+ 'description' => '<props="china">'."\n"
+ ."\n"
+ .'Before using this interface, ensure you understand the billing methods and [pricing](https://www.aliyun.com/price/product?#/gws/detail/gws) for Wuying Workspace.'."\n"
+ ."\n"
+ .'</props>',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-17T09:56:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeMultiPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', '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' => 'The resource type.',
+ 'enumValueTitles' => ['CorePackage' => 'A billing unit for Elastic Desktop Service.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Desktop',
+ ],
+ ],
+ [
+ 'name' => 'PackageIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'An array of package IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The package ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'chp-0bf5d9fdjr8vz****'],
+ 'required' => false,
+ 'docRequired' => false,
+ 'maxItems' => 100,
+ 'title' => '核时包id列表',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'An array of instance IDs. If you specify this parameter, the `PackageIds` parameter is required.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-6wye9optu0kag****', 'title' => ''],
+ 'required' => false,
+ 'docRequired' => false,
+ 'maxItems' => 100,
+ 'title' => '抵扣实例列表,企业版核时包对应桌面id',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '页码,默认1',
+ 'description' => 'The page number. Default value: 1.',
+ 'enumValueTitles' => [],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页最大数量,最大不超过100,默认100', 'description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'example' => '100'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '起始时间,时间戳格式,long型', 'description' => 'The start time, in Unix timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1709117383000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '起始时间,时间戳格式,long型', 'description' => 'The end time, in Unix timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1709117383000'],
+ ],
+ [
+ 'name' => 'ResourceTypes',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
+ 'maxItems' => 100,
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNum' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'Deductions' => [
+ 'description' => 'The deduction details.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A deduction detail.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DesktopName' => ['description' => 'The cloud computer name.', 'type' => 'string', 'title' => '', 'example' => 'DemoComputer'],
+ 'DesktopId' => ['description' => 'The cloud computer ID.', 'type' => 'string', 'example' => 'ecd-6wye9optu0kag****', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'DesktopType' => ['description' => 'The desktop type.', 'type' => 'string', 'example' => 'eds.enterprise_office.4c8g', 'title' => ''],
+ 'OsType' => [
+ 'description' => 'The OS of the cloud computer.',
+ 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
+ 'type' => 'string',
+ 'example' => 'Windows',
+ 'title' => '',
+ ],
+ 'StaTime' => ['description' => 'The billing cycle start time.', 'type' => 'string', 'example' => '2024-07-31T02:00Z', 'title' => ''],
+ 'EndTime' => ['description' => 'The billing cycle end time.', 'type' => 'string', 'example' => '2024-07-31T03:00Z', 'title' => ''],
+ 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'Desktop', 'title' => ''],
+ 'UsedTime' => ['description' => 'The usage duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', 'title' => ''],
+ 'UsedCoreTime' => ['description' => 'The deducted core-hours.', 'type' => 'number', 'format' => 'float', 'example' => '4.0', 'title' => ''],
+ 'InstanceState' => ['description' => 'The core-hour package state.', 'type' => 'string', 'example' => 'Deleted', 'title' => ''],
+ 'Memory' => ['description' => 'The memory size, in MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '8192', 'title' => ''],
+ 'Cpu' => ['description' => 'The number of vCPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'SessionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'UsedTimeWithScale' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'GroupResourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'UsedTimeDecimal' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '抵扣详情',
+ 'example' => '',
+ ],
+ 'TotalCount' => ['description' => 'The total number of matching entries.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '100'],
+ 'TotalUsedTime' => ['title' => '总使用时长。', 'description' => 'The total usage duration of all matching entries, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'],
+ 'TotalUsedCoreTime' => ['title' => '总抵扣核时。', 'description' => 'The total core-hours deducted for all matching entries.', 'type' => 'number', 'format' => 'float', 'example' => '10.1'],
+ 'TotalUsedTimeDecimal' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'title' => '查询核时包抵扣明细',
+ 'summary' => 'Query deduction details for time-based packages.',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-08T03:32:49.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-06-23T10:46:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2025-02-07T02:55:58.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-11-12T03:41:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-09-25T07:45:37.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribePackageDeductions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', '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' => 'Modifies the attributes of an instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The resource type.'."\n"
+ .'> This parameter is case-sensitive. Ensure that the value is spelled correctly.',
+ 'enumValueTitles' => ['企业版按月时长包' => 'DurationPackage'],
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'DurationPackage',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mdp-0c62ayep0nk4v****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Key',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of the attribute.',
+ 'enumValueTitles' => ['PackageUsedUpStrategy' => 'Strategy when the package duration is used up.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'PackageUsedUpStrategy',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'Value',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The value of the attribute.'."\n"
+ ."\n"
+ .'- PackageUsedUpStrategy: Valid values:'."\n"
+ .' - Postpaid: Enters the pay-as-you-go phase.'."\n"
+ .' - Shutdown: Hibernation.'."\n"
+ .' - Maintenance: Shuts down and enters O&M mode. Client connections are not allowed.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Postpaid', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The instance ID.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'mdp-0bwu3if0u9wwj****', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 200,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '833C4D2C-09C7-5CE6-8159-06758B964970', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"833C4D2C-09C7-5CE6-8159-06758B964970\\"\\n}","type":"json"}]',
+ 'title' => 'Modify instance attributes',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ModifyInstanceProperties',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'SetAgentCreditQuota' => [
+ 'summary' => 'Sets the credit quota for specified Agents.',
+ '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' => 'The business type.', 'type' => 'string', 'required' => false, 'example' => 'BUSINESS', 'title' => ''],
+ ],
+ [
+ 'name' => 'AgentType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Agent type.', 'type' => 'string', 'required' => false, 'example' => 'JVSClaw', 'title' => ''],
+ ],
+ [
+ 'name' => 'AgentIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'An Agent ID.', 'type' => 'string', 'required' => false, 'example' => 'jvs-0bwu3iffqhduyz3kq', 'title' => ''],
+ 'maxItems' => 100,
+ 'description' => 'A list of Agent IDs.',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'CreditQuota',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The credit quota.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '9B353D6D-53C9-1C24-95D5-2D24596DBCF1'],
+ ],
+ 'title' => '',
+ 'description' => 'The schema of the response.',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'SetAgentCreditQuota',
+ 'description' => '## Description'."\n"
+ ."\n"
+ .'This operation sets the credit quota for one or more Agents of a specific type.'."\n"
+ ."\n"
+ .'### Usage notes'."\n"
+ ."\n"
+ .'- The `AgentType` parameter specifies the type of Agent to which the quota applies, such as `JVSClaw` or `OpenClaw`.'."\n"
+ ."\n"
+ .'- The `AgentIds` parameter is an array of up to 100 Agent IDs.'."\n"
+ ."\n"
+ .'- The `CreditQuota` parameter specifies the credit quota for each Agent.'."\n"
+ ."\n"
+ .'### Examples',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:SetAgentCreditQuota',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B353D6D-53C9-1C24-95D5-2D24596DBCF1\\"\\n}","type":"json"}]',
+ ],
],
'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Currently selected hardware is out of stock, please reduce purchase quantity or try again later'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeMultiPrice'],
+ ],
+ 'createdAt' => '2025-11-17T09:56:44.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateMultiOrder'],
+ ],
+ 'createdAt' => '2025-02-25T13:01:51.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'DescribePackageDeductions'],
+ ],
+ 'createdAt' => '2025-02-07T02:56:05.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribePackageDeductions'],
+ ],
+ 'createdAt' => '2024-11-12T03:41:27.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'wss.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'DescribePackageDeductions'],
+ ],
+ 'createdAt' => '2024-09-25T07:45:46.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'wss.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'DescribePrice'],
+ ],
+ 'createdAt' => '2024-04-29T12:21:38.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeBillings'],
+ ['description' => 'Request parameters changed', 'api' => 'DescribePrice'],
+ ],
+ 'createdAt' => '2022-03-08T01:54:17.000Z',
+ 'description' => '调整询价接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateOrder'],
+ ['description' => 'OpenAPI offline', 'api' => 'DescribePrice'],
+ ['description' => 'OpenAPI offline', 'api' => 'StartBilling'],
+ ['description' => 'OpenAPI offline', 'api' => 'StopBilling'],
+ ],
+ 'createdAt' => '2022-02-16T01:32:40.000Z',
+ 'description' => '无影售卖中台API首次发布',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'ECD',
+ 'productName' => 'Elastic Desktop Service',
+ 'ramCodes' => ['ecd', 'eds-user', 'gws', 'wss'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DescribeCreditPackageAgents',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeCreditPackageAgents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribePackageDeductions',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribePackageDeductions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateMultiOrder',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateMultiOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDeliveryAddress',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeDeliveryAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCreditUsageInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeCreditUsageInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyInstanceProperties',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ModifyInstanceProperties',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeMultiPrice',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeMultiPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetAgentCreditQuota',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:SetAgentCreditQuota',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDeductionStatistic',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeDeductionStatistic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];