summaryrefslogtreecommitdiff
path: root/data/en_us/gws/2019-06-18
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/gws/2019-06-18
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/gws/2019-06-18')
-rw-r--r--data/en_us/gws/2019-06-18/api-docs.php3059
1 files changed, 1138 insertions, 1921 deletions
diff --git a/data/en_us/gws/2019-06-18/api-docs.php b/data/en_us/gws/2019-06-18/api-docs.php
index cfabda4..7a601da 100644
--- a/data/en_us/gws/2019-06-18/api-docs.php
+++ b/data/en_us/gws/2019-06-18/api-docs.php
@@ -1,156 +1,62 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'gws',
- 'version' => '2019-06-18',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'gws', 'version' => '2019-06-18'],
'directories' => [
[
- 'id' => 64023,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'CreateServiceLinkedRole',
- ],
- ],
- [
- 'id' => 64025,
- 'title' => null,
+ 'children' => ['SetInstanceName', 'SetInstancePolicy', 'SetInstanceUser', 'DescribeInstancePolicy', 'GetConnectTicket'],
'type' => 'directory',
- 'children' => [
- 'DescribeClusterADDomain',
- 'IsUserAdmin',
- ],
+ 'title' => 'Instances',
],
[
- 'id' => 64028,
- 'title' => null,
+ 'children' => ['SetImageName'],
'type' => 'directory',
- 'children' => [
- 'CreateInstance',
- 'DeleteInstance',
- 'SetInstanceName',
- 'SetInstancePolicy',
- 'SetInstanceUser',
- 'StartInstance',
- 'StopInstance',
- 'DescribeInstancePolicy',
- 'DescribeInstances',
- 'GetConnectTicket',
- 'RestartInstance',
- ],
+ 'title' => 'Images',
],
[
- 'id' => 64040,
- 'title' => null,
+ 'children' => ['SetClusterDnat', 'SetClusterName', 'SetClusterADDomain', 'SetClusterPolicy', 'DescribeClusterConnections', 'DescribeClusterPolicy'],
'type' => 'directory',
- 'children' => [
- 'CreateImage',
- 'DeleteImage',
- 'SetImageName',
- 'DescribeImages',
- ],
+ 'title' => 'Clusters',
],
[
- 'id' => 64045,
- 'title' => null,
+ 'children' => ['CreateCluster', 'CreateImage', 'CreateInstance', 'CreateServiceLinkedRole', 'DeleteCluster', 'DeleteImage', 'DeleteInstance', 'DescribeAvailableResource', 'DescribeClusterADDomain', 'DescribeClusters', 'DescribeImages', 'DescribeInstances', 'IsUserAdmin', 'RestartInstance', 'StartInstance', 'StopInstance'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'CreateCluster',
- 'DeleteCluster',
- 'SetClusterDnat',
- 'SetClusterName',
- 'SetClusterADDomain',
- 'SetClusterPolicy',
- 'DescribeClusterConnections',
- 'DescribeClusterPolicy',
- 'DescribeClusters',
- 'DescribeAvailableResource',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateServiceLinkedRole' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateCluster' => [
+ 'summary' => 'Creates a cluster.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'create',
- ],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'AlreadyExists' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"AlreadyExists\\": true,\\n \\"RequestId\\": \\"XXX-XXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXX-XXX</RequestId>\\n<AlreadyExists>true</AlreadyExists>","errorExample":""}]',
- 'title' => 'CreateServiceLinkedRole',
- ],
- 'DescribeClusterADDomain' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
[
- 'AK' => [],
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-xxx', 'title' => ''],
],
- ],
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'ClusterType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gws-rhzlyl5zx3ua**** ',
- ],
+ 'schema' => ['description' => 'The cluster type. Valid values:'."\n"
+ .'* gws.s1.standard.', 'type' => 'string', 'required' => true, 'example' => 'gws.s1.standard', 'title' => ''],
],
[
- 'name' => 'TaskId',
+ 'name' => 'VSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 't-xxx',
- ],
+ 'schema' => ['description' => 'The vSwitch ID used to create cluster servers. If this parameter is not specified, the system automatically finds the latest active zone with inventory based on the current cluster specifications (for example, China North 2 Zone H). If the zone:'."\n"
+ .'* already has a vSwitch, the existing vSwitch is used.'."\n"
+ .'* does not have a vSwitch, the system attempts automatic creation.', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxx', 'title' => ''],
],
],
'responses' => [
@@ -158,104 +64,76 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A',
- ],
- 'IsSupported' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TaskFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DomainDnsIp' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '192.168.XX.XX',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-xxx',
- ],
- 'DomainName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'example.com',
- ],
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'gws-xxx', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A\\",\\n \\"IsSupported\\": true,\\n \\"TaskFinished\\": true,\\n \\"DomainDnsIp\\": \\"192.168.XX.XX\\",\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"DomainName\\": \\"example.com\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterADDomainResponse>\\n <TaskId>t-xxx</TaskId>\\n <RequestId>7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A</RequestId>\\n <DomainName>example.com</DomainName>\\n <TaskFinished>true</TaskFinished>\\n <IsSupported>true</IsSupported>\\n <DomainDnsIp>192.168.XX.XX</DomainDnsIp>\\n</DescribeClusterADDomainResponse>","errorExample":""}]',
- 'title' => 'DescribeClusterADDomain',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ClusterId\\": \\"gws-xxx\\",\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Create a cluster',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'IsUserAdmin' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'CreateImage' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'get',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The image name.', 'type' => 'string', 'required' => false, 'example' => 'image-xxx', 'title' => ''],
+ ],
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'IsAllow' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'IsAdmin' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
+ 'ImageId' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'm-xxx', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsAllow\\": false,\\n \\"IsAdmin\\": true,\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<IsAdmin>true</IsAdmin>\\n<IsAllow>true</IsAllow>\\n<RequestId>C8760FD7-61AD-47EA-AAC3-F4E6A973DF51</RequestId>","errorExample":""}]',
- 'title' => 'IsUserAdmin',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageId\\": \\"m-xxx\\",\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Create an image',
+ 'summary' => 'Creates an image.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'CreateInstance' => [
- 'summary' => '创建实例',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Creates an instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -263,220 +141,155 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gws-xxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'gws-xxx', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-xxx',
- ],
+ 'schema' => ['description' => 'The vSwitch ID.'."\n"
+ .'* If specified, the instance is created in this vSwitch. Specify this parameter when you create an instance to define the CIDR block and zone of the instance.'."\n"
+ .'* If not specified, the system automatically selects the latest active zone with available inventory based on the current instance type (for example, China (Beijing) Zone G).'."\n"
+ .' * If a vSwitch already exists in the zone, the system uses the existing vSwitch.'."\n"
+ .' * If no vSwitch exists in the zone, the system attempts automatic creation.', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxx', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'desktop-xxx',
- ],
+ 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'desktop-xxx', 'title' => ''],
],
[
'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-xxx',
- ],
+ 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'm-xxx', 'title' => ''],
],
[
'name' => 'SystemDiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '500',
- 'minimum' => '20',
- 'example' => '100',
- ],
+ 'schema' => ['description' => 'The system cloud disk size. Unit: GB.'."\n"
+ .'* Valid values: 20 to 500.'."\n"
+ .'* When you select an image, the system cloud disk size must be greater than or equal to the image size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '500', 'minimum' => '20', 'example' => '100', 'title' => ''],
],
[
'name' => 'SystemDiskCategory',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cloud_ssd',
- ],
+ 'schema' => ['description' => 'The category of the system cloud disk. Valid values:'."\n"
+ .'* cloud_efficiency: ultra cloud disk.'."\n"
+ .'* cloud_ssd: standard SSD.'."\n"
+ .'* cloud_essd: Enterprise SSD (ESSD). Only instances of newer instance families, such as ecs.g6, support ESSDs.', 'type' => 'string', 'required' => true, 'example' => 'cloud_ssd', 'title' => ''],
],
[
'name' => 'AllocatePublicAddress',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to assign a public IP address. Valid values:'."\n"
+ .'* True'."\n"
+ .'* False.', 'type' => 'string', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''],
],
[
'name' => 'InternetChargeType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PayByBandwidth',
- 'default' => 'PayByTraffic',
- ],
+ 'schema' => ['description' => '> This parameter takes effect only when AllocatePublicAddress is set to true.'."\n"
+ ."\n"
+ .'The billing method for network usage. Valid values:'."\n"
+ ."\n"
+ .'- PayByTraffic (default): pay-by-traffic.'."\n"
+ .'- PayByBandwidth: pay-by-bandwidth.', 'type' => 'string', 'required' => false, 'default' => 'PayByTraffic', 'example' => 'PayByBandwidth', 'title' => ''],
],
[
'name' => 'InternetMaxBandwidthIn',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '4',
- ],
+ 'schema' => ['description' => '> This parameter takes effect only when AllocatePublicAddress is set to true.'."\n"
+ ."\n"
+ .'The maximum inbound public bandwidth. Unit: Mbit/s.'."\n"
+ .'* Valid values: 1 to 100.'."\n"
+ .'* Default value: 4.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '4', 'title' => ''],
],
[
'name' => 'InternetMaxBandwidthOut',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '4',
- 'default' => '4',
- ],
+ 'schema' => ['description' => '> This parameter takes effect only when AllocatePublicAddress is set to true.'."\n"
+ ."\n"
+ .'The maximum outbound public bandwidth. Unit: Mbit/s.'."\n"
+ .'* Valid values: 1 to 100.'."\n"
+ .'* Default value: 4.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'default' => '4', 'example' => '4', 'title' => ''],
],
[
'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecs.g6.large',
- ],
+ 'schema' => ['description' => 'The instance type. For more information, see [Instance families](https://help.aliyun.com/document_detail/25378.html) or call [DescribeInstanceTypes](https://help.aliyun.com/document_detail/25620.html) to query available instance types.', 'type' => 'string', 'required' => true, 'example' => 'ecs.g6.large', 'title' => ''],
],
[
'name' => 'InstanceChargeType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PostPaid',
- 'default' => 'PostPaid',
- ],
+ 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
+ .'* PostPaid (default): pay-as-you-go.'."\n"
+ .'* PrePaid: subscription.', 'type' => 'string', 'required' => false, 'default' => 'PostPaid', 'example' => 'PostPaid', 'title' => ''],
],
[
'name' => 'AutoRenew',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'True',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n"
+ .'* False (default)'."\n"
+ .'* True.', 'type' => 'string', 'required' => false, 'default' => 'false', 'example' => 'True', 'title' => ''],
],
[
'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '> This parameter takes effect only when InstanceChargeType is set to PrePaid (subscription).'."\n"
+ ."\n"
+ .'The subscription duration.'."\n"
+ .'* If PeriodUnit is set to Week, valid values are 1 to 4.'."\n"
+ .'* If PeriodUnit is set to Month, valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Week',
- ],
+ 'schema' => ['description' => '> This parameter takes effect only when InstanceChargeType is set to PrePaid (subscription).'."\n"
+ ."\n"
+ .'The unit of the subscription duration. Valid values:'."\n"
+ .'* Week'."\n"
+ .'* Month.', 'type' => 'string', 'required' => false, 'example' => 'Week', 'title' => ''],
],
[
'name' => 'WorkMode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Desktop',
- ],
+ 'schema' => ['description' => 'The work mode. Valid values:'."\n"
+ .'* Desktop: desktop mode.'."\n"
+ .'* Application: application mode.', 'type' => 'string', 'required' => true, 'example' => 'Desktop', 'title' => ''],
],
[
'name' => 'AppList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The application list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'AppName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'notepad',
- ],
- 'AppPath' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'C:\\Windows\\System32\\notepad.exe',
- ],
- 'AppArgs' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c:/temp.txt',
- ],
+ 'AppName' => ['description' => '> This parameter takes effect only when WorkMode is set to Application.'."\n"
+ ."\n"
+ .'The application name. Valid values of N in AppList.N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'notepad', 'title' => ''],
+ 'AppPath' => ['description' => '> This parameter takes effect only when WorkMode is set to Application.'."\n"
+ ."\n"
+ .'The execution path of the application. Valid values of N in AppList.N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'C:\\Windows\\System32\\notepad.exe', 'title' => ''],
+ 'AppArgs' => ['description' => '> This parameter takes effect only when WorkMode is set to Application.'."\n"
+ ."\n"
+ .'The runtime parameters of the application. Valid values of N in AppList.N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'c:/temp.txt', 'title' => ''],
],
'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 10,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -485,54 +298,73 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'i-xxx',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
- ],
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-xxx', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceId\\": \\"i-xxx\\",\\n \\"RequestId\\": \\"XXX-XXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXX-XXX</RequestId>\\n<InstanceId>i-xxx</InstanceId>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"i-xxx\\",\\n \\"RequestId\\": \\"XXX-XXX\\"\\n}","type":"json"}]',
'title' => 'CreateInstance',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
- 'DeleteInstance' => [
- 'methods' => [
- 'post',
- 'get',
+ 'CreateServiceLinkedRole' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AlreadyExists' => ['description' => '* true: The service-linked role **has already been** created for the current account.'."\n"
+ .'* false: The service-linked role **has not been** created for the current account.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlreadyExists\\": true,\\n \\"RequestId\\": \\"XXX-XXX\\"\\n}","type":"json"}]',
+ 'title' => 'Create a service-linked role for WUYING workspace',
+ 'summary' => 'Creates a service-linked role for WUYING Workspace.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DeleteCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-xxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'gws-xxx', 'title' => ''],
],
],
'responses' => [
@@ -540,150 +372,242 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXX-XXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXX-XXX</RequestId>","errorExample":""}]',
- 'title' => 'DeleteInstance',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a cluster',
+ 'summary' => 'Deletes a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SetInstanceName' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DeleteImage' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'ImageId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the image.', 'type' => 'string', 'required' => true, 'example' => 'm-xxx', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-xxx',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Delete an image',
+ 'summary' => 'Deletes an image.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'DeleteInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
[
- 'name' => 'Name',
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'desktop-xxx',
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXX-XXX\\"\\n}","type":"json"}]',
+ 'title' => 'Delete an instance',
+ 'summary' => 'Deletes an instance.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'DescribeAvailableResource' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
+ 'RequestId' => ['description' => 'Request id。', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
+ 'AvailableResources' => [
+ 'description' => 'AvailableResources',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ClusterType' => ['description' => 'The cluster type.', 'type' => 'string', 'example' => 'gws.s1.stardard', 'title' => ''],
+ 'Zone' => ['description' => 'The zone.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'SetInstanceName',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"AvailableResources\\": [\\n {\\n \\"ClusterType\\": \\"gws.s1.stardard\\",\\n \\"Zone\\": \\"cn-hangzhou-i\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query specifications and zones of Cloud desktop clusters',
+ 'summary' => 'Queries the specifications and zone list of Cloud Desktop clusters.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SetInstancePolicy' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeClusterADDomain' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-xxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'gws-rhzlyl5zx3ua**** ', 'title' => ''],
],
[
- 'name' => 'VisualLossless',
+ 'name' => 'TaskId',
'in' => 'query',
+ 'schema' => ['description' => 'The task ID obtained by calling SetClusterADDomain.', 'type' => 'string', 'required' => false, 'example' => 't-xxx', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'on',
- 'default' => 'off',
- 'enum' => [
- 'on',
- 'off',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A', 'title' => ''],
+ 'IsSupported' => ['description' => 'Indicates whether the cluster supports AD domain association. Valid values:'."\n"
+ .'* true: Supported.'."\n"
+ .'* false: Not supported.'."\n"
+ ."\n"
+ .'> Only gws.s1.advanced clusters support AD domain association.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'TaskFinished' => ['description' => 'The running status of the current query command. Valid values:'."\n"
+ .'* false: Not completed.'."\n"
+ .'* true: Completed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'DomainDnsIp' => ['description' => 'The DNS IP address of the AD domain.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-xxx', 'title' => ''],
+ 'DomainName' => ['description' => 'The domain name of the AD domain.', 'type' => 'string', 'example' => 'example.com', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A\\",\\n \\"IsSupported\\": true,\\n \\"TaskFinished\\": true,\\n \\"DomainDnsIp\\": \\"192.168.XX.XX\\",\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"DomainName\\": \\"example.com\\"\\n}","type":"json"}]',
+ 'title' => 'Query user-associated AD information',
+ 'summary' => 'Queries the information about the Active Directory (AD) associated with a Cloud Desktop cluster.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'DescribeClusterConnections' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'OptimizeFor3d',
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'on',
- 'default' => 'off',
- 'enum' => [
- 'on',
- 'off',
- ],
- ],
+ 'schema' => ['description' => 'The cloud desktop cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'gws-xxx', 'title' => ''],
],
[
- 'name' => 'AsyncMode',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'The start date of the query interval.', 'type' => 'string', 'required' => true, 'example' => '2020-09-07', 'title' => ''],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end date of the query interval.', 'type' => 'string', 'required' => true, 'example' => '2020-09-01', 'title' => ''],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The task ID for asynchronous queries.', 'type' => 'string', 'required' => false, 'example' => 't-xxx', 'title' => ''],
],
],
'responses' => [
@@ -691,75 +615,83 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-xxx',
- ],
- 'RequestId' => [
- 'description' => 'Request id。',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
+ 'TaskFinished' => ['description' => '* true: The current task has been completed.'."\n"
+ .'* false: The current task is still running.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'TotalCount' => ['description' => 'The length of the Connections array.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TaskId' => ['description' => '* If the TaskId input parameter is empty when calling, the caller needs to use the TaskId in the return value to continue calling this API to obtain the query result.'."\n"
+ .'* If the TaskId input parameter is not empty when calling, the return value will query the running status of this TaskId.', 'type' => 'string', 'example' => 't-xxx', 'title' => ''],
+ 'Connections' => [
+ 'description' => 'An array describing connection session information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'LogoffStatus' => ['description' => '* 0: The session has exited normally.'."\n"
+ .'* Empty value: The session has not exited yet.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'LogonTime' => ['description' => 'The logon time of this session.', 'type' => 'string', 'example' => '2020-09-01T01:02:03.456Z', 'title' => ''],
+ 'HostName' => ['description' => 'The host name.', 'type' => 'string', 'example' => 'hostname', 'title' => ''],
+ 'LogoffTime' => ['description' => 'The logoff time of this session.'."\n"
+ .'When this value is empty, it indicates that the session has not exited yet.', 'type' => 'string', 'example' => '2020-09-03T01:02:03.456Z', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-xxx', 'title' => ''],
+ 'ClientName' => ['description' => 'The host name of the client.', 'type' => 'string', 'example' => 'client-xxx', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"RequestId\\": \\"XXX-XXX\\"\\n}","errorExample":""},{"type":"xml","example":"<TaskId>t-xxx</TaskId>\\n<RequestId>XXX-XXX</RequestId>","errorExample":""}]',
- 'title' => 'SetInstancePolicy',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"TaskFinished\\": true,\\n \\"TotalCount\\": 1,\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"Connections\\": [\\n {\\n \\"LogoffStatus\\": \\"0\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"LogonTime\\": \\"2020-09-01T01:02:03.456Z\\",\\n \\"HostName\\": \\"hostname\\",\\n \\"LogoffTime\\": \\"2020-09-03T01:02:03.456Z\\",\\n \\"InstanceId\\": \\"i-xxx\\",\\n \\"ClientName\\": \\"client-xxx\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query session connection information for a cluster',
+ 'summary' => 'Query session connection information for a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SetInstanceUser' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeClusterPolicy' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-xxx',
- ],
+ 'schema' => ['description' => '> This value is only valid when `AsyncMode` is `true`'."\n"
+ ."\n"
+ .'When not empty, used to obtain the execution status of a previously submitted query command.'."\n", 'type' => 'string', 'required' => false, 'example' => 't-xxx', 'title' => ''],
],
[
- 'name' => 'UserUid',
+ 'name' => 'AsyncMode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1234',
- ],
+ 'schema' => ['description' => 'Asynchronous mode invocation:'."\n"
+ .'* false (default): The API returns only after the command execution is complete.'."\n"
+ .'* true: The API returns **immediately**.'."\n"
+ .' * When `TaskId` is empty: The query command is executed asynchronously in the background. The caller needs to use the TaskId from the **return value** to continue calling this API to obtain the query command result.'."\n"
+ .' * When `TaskId` is not empty: Obtain the result of the query command.'."\n", 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'UserName',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'user_xxx',
- ],
+ 'schema' => ['description' => 'Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'gws-xxx', 'title' => ''],
],
],
'responses' => [
@@ -767,49 +699,86 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
+ 'UdpPort' => ['description' => 'UDP port:'."\n"
+ .'* on: Enabled'."\n"
+ .'* off: Disabled', 'type' => 'string', 'example' => 'on', 'title' => ''],
+ 'TaskFinished' => ['description' => '> This value is only valid when `AsyncMode` is `true`'."\n"
+ ."\n"
+ .'The execution status of the current query command:'."\n"
+ .'* false: Not yet completed.'."\n"
+ .'* true: Completed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'Request Id', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
+ 'UsbRedirect' => ['description' => 'USB redirection:'."\n"
+ .'* off'."\n"
+ .'* on'."\n", 'type' => 'string', 'example' => 'off', 'title' => ''],
+ 'Clipboard' => ['description' => 'Local clipboard access in the cloud desktop:'."\n"
+ .'* off: Disabled'."\n"
+ .'* read: Read-only'."\n"
+ .'* write: Write-only'."\n"
+ .'* readwrite: Read & Write'."\n"
+ ."\n", 'type' => 'string', 'example' => 'readwrite', 'title' => ''],
+ 'Watermark' => ['description' => 'Watermark:'."\n"
+ .'* off'."\n"
+ .'* on', 'type' => 'string', 'example' => 'off', 'title' => ''],
+ 'TaskId' => ['description' => '> This value is only valid when `AsyncMode` is `true`'."\n"
+ ."\n"
+ .'The task ID of the current query command.', 'type' => 'string', 'example' => 't-xxx', 'title' => ''],
+ 'DomainList' => ['description' => 'Domain name whitelist:'."\n"
+ .'* When the whitelist is empty, access to all domain names is allowed.'."\n"
+ .'* When the whitelist is not empty, only the domain names in the list are allowed.'."\n"
+ .'* Wildcard `*` is supported.'."\n"
+ .'* Multiple domain name rules are separated by commas.'."\n", 'type' => 'string', 'example' => '*.abc.com,*.xyz.com', 'title' => ''],
+ 'Audio' => ['description' => 'Audio:'."\n"
+ .'* on: Enabled'."\n"
+ .'* off: Disabled', 'type' => 'string', 'example' => 'on', 'title' => ''],
+ 'LocalDrive' => ['description' => 'Mapped drive for local disk in the cloud desktop:'."\n"
+ .'* off: Disabled'."\n"
+ .'* read: Read-only'."\n"
+ .'* readwrite: Read & Write'."\n", 'type' => 'string', 'example' => 'readwrite', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'SetInstanceUser',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UdpPort\\": \\"on\\",\\n \\"TaskFinished\\": true,\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"UsbRedirect\\": \\"off\\",\\n \\"Clipboard\\": \\"readwrite\\",\\n \\"Watermark\\": \\"off\\",\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"DomainList\\": \\"*.abc.com,*.xyz.com\\",\\n \\"Audio\\": \\"on\\",\\n \\"LocalDrive\\": \\"readwrite\\"\\n}","type":"json"}]',
+ 'title' => 'Get Cluster Policy',
+ 'summary' => 'Get cluster policy.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'StartInstance' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeClusters' => [
+ 'summary' => 'Calls DescribeClusters to query cluster information.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'operationType' => 'read',
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-xxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'gws-rhzlyl5zx3ua****', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of rows per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -817,46 +786,73 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
+ 'PageSize' => ['description' => 'The number of rows per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of clusters.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Clusters' => [
+ 'description' => 'The list of cluster information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1vi54o1on2sijpm****', 'title' => ''],
+ 'Status' => ['description' => 'The cluster status. Valid values:'."\n"
+ .'* creating'."\n"
+ .'* starting'."\n"
+ .'* running'."\n"
+ .'* deleted'."\n"
+ .'* indebt.', 'type' => 'string', 'example' => 'running', 'title' => ''],
+ 'NatId' => ['description' => 'The ID of the NAT gateway associated with the cluster.'."\n"
+ .'> This value is empty if the cluster is not associated with a NAT gateway.', 'type' => 'string', 'example' => 'ngw-uf63l0kkf73ieyf9k****', 'title' => ''],
+ 'InstanceCount' => ['description' => 'The number of instances in the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-09-17T02:02:25Z', 'title' => ''],
+ 'NatEip' => ['description' => 'The elastic IP address used by the NAT gateway associated with the cluster.'."\n"
+ .'> This value is empty if the cluster is not associated with a NAT gateway.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''],
+ 'SecurityGroup' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-bp18ny7dvho4g0s7****', 'title' => ''],
+ 'Name' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'cluster-xxx', 'title' => ''],
+ 'DomainName' => ['description' => '* gws.s1.standard cluster: An empty value is returned.'."\n"
+ .'* gws.s1.advanced cluster: After the user AD domain is associated, this value corresponds to the associated user AD domain, such as example.com. This value is empty after the association is removed.', 'type' => 'string', 'example' => 'example.com', 'title' => ''],
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'gws-rhzlyl5zx3ua****', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'StartInstance',
- ],
- 'StopInstance' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Clusters\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1vi54o1on2sijpm****\\",\\n \\"Status\\": \\"running\\",\\n \\"NatId\\": \\"ngw-uf63l0kkf73ieyf9k****\\",\\n \\"InstanceCount\\": 1,\\n \\"CreateTime\\": \\"2020-09-17T02:02:25Z\\",\\n \\"NatEip\\": \\"192.168.XX.XX\\",\\n \\"SecurityGroup\\": \\"sg-bp18ny7dvho4g0s7****\\",\\n \\"Name\\": \\"cluster-xxx\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"ClusterId\\": \\"gws-rhzlyl5zx3ua****\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query cluster information',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeImages' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-xxx',
- ],
+ 'schema' => ['description' => 'Instance type.', 'type' => 'string', 'required' => false, 'example' => 'ecs.g6.large', 'title' => ''],
],
],
'responses' => [
@@ -864,69 +860,88 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
+ 'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'XXXX-XXXX', 'title' => ''],
+ 'PageNumber' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of image resources.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Images' => [
+ 'description' => 'A collection of image information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'Image status:'."\n"
+ .'* Missing'."\n"
+ .'* Available'."\n"
+ .'* Creating'."\n"
+ .'* UnAvailable'."\n"
+ .'* CreateFailed'."\n", 'type' => 'string', 'example' => 'Available', 'title' => ''],
+ 'ImageType' => ['description' => 'Image type:'."\n"
+ .'* system'."\n"
+ .'* custom', 'type' => 'string', 'example' => 'system', 'title' => ''],
+ 'Progress' => ['description' => 'The progress of the image creation, in percentage.', 'type' => 'string', 'example' => '100%', 'title' => ''],
+ 'Size' => ['description' => 'Image size, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time of the image.', 'type' => 'string', 'example' => 'Mon May 27 13:33:42 CST 2019', 'title' => ''],
+ 'Name' => ['description' => 'Image name.', 'type' => 'string', 'example' => 'windows 2016 标准版 citrix 1903', 'title' => ''],
+ 'ImageId' => ['description' => 'Image ID.', 'type' => 'string', 'example' => 'm-bp125mb261tmk6tqvoni', 'title' => ''],
+ 'ProductCode' => ['description' => 'Product code.'."\n"
+ .'If this parameter is returned, it indicates that the image was created based on an image from the image marketplace.', 'type' => 'string', 'example' => 'cmjj00042097', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'StopInstance',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"XXXX-XXXX\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Images\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"ImageType\\": \\"system\\",\\n \\"Progress\\": \\"100%\\",\\n \\"Size\\": 40,\\n \\"CreateTime\\": \\"Mon May 27 13:33:42 CST 2019\\",\\n \\"Name\\": \\"windows 2016 标准版 citrix 1903\\",\\n \\"ImageId\\": \\"m-bp125mb261tmk6tqvoni\\",\\n \\"ProductCode\\": \\"cmjj00042097\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Get image information list',
+ 'summary' => 'Describes images.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'DescribeInstancePolicy' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-xxx',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 't-xxx',
- ],
+ 'schema' => ['description' => '> This value is valid only when `AsyncMode` is set to `true`.'."\n"
+ ."\n"
+ .'If this parameter is not empty, it is used to retrieve the execution status of a previous query command.', 'type' => 'string', 'required' => false, 'example' => 't-xxx', 'title' => ''],
],
[
'name' => 'AsyncMode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to use asynchronous mode:'."\n"
+ .'* false (default): The API returns only after the command execution is complete.'."\n"
+ .'* true: The API returns **immediately**.'."\n"
+ .' * If `TaskId` is empty: The query command is executed asynchronously in the background. Use the TaskId in the **response** to call this API again to retrieve the result of the query command.'."\n"
+ .' * If `TaskId` is not empty: Retrieves the result of the query command.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''],
],
],
'responses' => [
@@ -934,123 +949,80 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'OptimizeFor3d' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'on',
- ],
- 'TaskFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'VisualLossless' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'off',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-xxx',
- ],
+ 'OptimizeFor3d' => ['description' => 'The GPU 3D acceleration status. Valid values:'."\n"
+ .'* off: Disabled.'."\n"
+ .'* on: Enabled.'."\n"
+ .'* N/A: Not applicable, for example, for non-GPU instances.', 'type' => 'string', 'example' => 'on', 'title' => ''],
+ 'TaskFinished' => ['description' => 'The execution status of the current query command. Valid values:'."\n"
+ .'* false: Not completed.'."\n"
+ .'* true: Completed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'VisualLossless' => ['description' => 'The visual lossless mode status. Valid values:'."\n"
+ .'* off: Disabled.'."\n"
+ .'* on: Enabled.'."\n"
+ .'* N/A: Not applicable, for example, for non-GPU instances.', 'type' => 'string', 'example' => 'off', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID of the current query command.', 'type' => 'string', 'example' => 't-xxx', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OptimizeFor3d\\": \\"on\\",\\n \\"TaskFinished\\": true,\\n \\"VisualLossless\\": \\"off\\",\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"TaskId\\": \\"t-xxx\\"\\n}","errorExample":""},{"type":"xml","example":"<TaskId>t-xxx</TaskId>\\n<RequestId>XXX-XXX</RequestId>\\n<VisualLossless>off</VisualLossless>\\n<TaskFinished>true</TaskFinished>\\n<OptimizeFor3d>on</OptimizeFor3d>","errorExample":""}]',
- 'title' => 'DescribeInstancePolicy',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OptimizeFor3d\\": \\"on\\",\\n \\"TaskFinished\\": true,\\n \\"VisualLossless\\": \\"off\\",\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"TaskId\\": \\"t-xxx\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve instance policy configuration status',
+ 'summary' => 'Retrieves the policy configuration status of an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'DescribeInstances' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- 'default' => '20',
- ],
+ 'schema' => ['description' => 'The number of instances per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '20', 'example' => '10', 'title' => ''],
],
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gws-xxx',
- ],
+ 'schema' => ['description' => 'Lists all instances in the specified cluster ID.'."\n"
+ .'> If this parameter is not specified, instances in all clusters are listed.', 'type' => 'string', 'required' => false, 'example' => 'gws-xxx', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'i-xxx',
- ],
+ 'schema' => ['description' => 'Lists the information of the specified instance ID.'."\n"
+ .'> If this parameter is not specified, all instances are listed.', 'type' => 'string', 'required' => false, 'example' => 'i-xxx', 'title' => ''],
],
[
'name' => 'UserUid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12345',
- ],
+ 'schema' => ['description' => 'Lists all instances assigned to the specified user ID.'."\n"
+ .'> If this parameter is not specified, instances of all users are listed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''],
],
[
'name' => 'UserName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user01',
- ],
+ 'schema' => ['description' => 'Lists all instances assigned to the specified user.'."\n"
+ .'> If this parameter is not specified, instances of all users are listed.', 'type' => 'string', 'required' => false, 'example' => 'user01', 'title' => ''],
],
],
'responses' => [
@@ -1058,254 +1030,165 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'PageSize' => ['description' => 'The number of rows per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'Instances' => [
- 'description' => '',
+ 'description' => 'The list of instance information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Stopped',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2099-12-31T15:59Z',
- ],
- 'WorkMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Application',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-12T07:35Z',
- ],
- 'StoppedMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'UserUid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234',
- ],
- 'HostName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'c0-i01-xx-t6',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'i-xxx',
- ],
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ecs.g6.large',
- ],
- 'DomainName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'abc.com',
- ],
- 'InstanceChargeType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PostPaid',
- ],
- 'MaxBandwidthIn' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'IsBoundUser' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MaxBandwidthOut' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'c0-i01-xx-t6-2c8g',
- ],
- 'UserName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'user-xxx',
- ],
- 'ImageId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'm-xxx',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gws-xxx',
- ],
+ 'Status' => ['description' => 'The instance status. Valid values:'."\n"
+ .'* Creating: being created'."\n"
+ .'* Starting: being started'."\n"
+ .'* Stopping: being stopped'."\n"
+ .'* Stopped: stopped'."\n"
+ .'* Initializing: being initialized'."\n"
+ .'* Unregistered: unregistered'."\n"
+ .'* Registered: registered'."\n"
+ .'* InUse: in use'."\n"
+ .'* Missing: missing'."\n"
+ .'* Cloning: image being created.', 'type' => 'string', 'example' => 'Stopped', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2099-12-31T15:59Z', 'title' => ''],
+ 'WorkMode' => ['description' => 'The work mode. Valid values:'."\n"
+ .'* Desktop: desktop mode'."\n"
+ .'* Application: application mode.', 'type' => 'string', 'example' => 'Application', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2019-10-12T07:35Z', 'title' => ''],
+ 'StoppedMode' => ['description' => 'The billing status when the instance is stopped. Valid values:'."\n"
+ .'* KeepCharging: Billing continues. For example, the user shuts down the instance from within Windows.'."\n"
+ .'* StopCharging: Billing stops.'."\n"
+ .'* Not-applicable: Not applicable. For example, subscription instances.', 'type' => 'string', 'example' => '停止', 'title' => ''],
+ 'UserUid' => ['description' => 'The assigned user ID.'."\n"
+ ."\n"
+ .'> This value is empty when the instance is not assigned to a specified user.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''],
+ 'HostName' => ['description' => 'The hostname, which is automatically generated when the instance is created. Do not change it. Otherwise, the instance status becomes "Unregistered".', 'type' => 'string', 'example' => 'c0-i01-xx-t6', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-xxx', 'title' => ''],
+ 'InstanceType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'ecs.g6.large', 'title' => ''],
+ 'DomainName' => ['description' => 'The user Active Directory (AD) associated with the cluster to which the instance belongs. This value is empty when the cluster is not associated with an AD or the cluster does not support AD association.', 'type' => 'string', 'example' => 'abc.com', 'title' => ''],
+ 'InstanceChargeType' => ['description' => 'The billing method. Valid values:'."\n"
+ .'* PrePaid: subscription'."\n"
+ .'* PostPaid: pay-as-you-go.', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''],
+ 'MaxBandwidthIn' => ['description' => 'The maximum inbound Internet bandwidth, in Mbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'IsBoundUser' => ['description' => 'Indicates whether the current caller is assigned to the current instance. Valid values:'."\n"
+ .'* true: Yes.'."\n"
+ .'* false: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'MaxBandwidthOut' => ['description' => 'The maximum outbound Internet bandwidth, in Mbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'Name' => ['description' => 'The instance name, which can be set by the user.', 'type' => 'string', 'example' => 'c0-i01-xx-t6-2c8g', 'title' => ''],
+ 'UserName' => ['description' => 'The assigned username.'."\n"
+ ."\n"
+ .'> This value is empty when the instance is not assigned to a specified user.', 'type' => 'string', 'example' => 'user-xxx', 'title' => ''],
+ 'ImageId' => ['description' => 'The image ID used when the instance was created.', 'type' => 'string', 'example' => 'm-xxx', 'title' => ''],
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'gws-xxx', 'title' => ''],
'AppList' => [
- 'description' => '',
+ 'description' => 'The application list.'."\n"
+ ."\n"
+ .'> This list is empty when the work mode is `Desktop`.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'AppName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'notepad',
- ],
- 'AppArgs' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'c:\\temp.txt',
- ],
- 'AppPath' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'c:\\windows\\system32\\nodepad.exe',
- ],
+ 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'notepad', 'title' => ''],
+ 'AppArgs' => ['description' => 'The runtime parameters of the application.', 'type' => 'string', 'example' => 'c:\\temp.txt', 'title' => ''],
+ 'AppPath' => ['description' => 'The runtime path of the application.', 'type' => 'string', 'example' => 'c:\\windows\\system32\\nodepad.exe', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"Stopped\\",\\n \\"ExpireTime\\": \\"2099-12-31T15:59Z\\",\\n \\"WorkMode\\": \\"Application\\",\\n \\"CreateTime\\": \\"2019-10-12T07:35Z\\",\\n \\"StoppedMode\\": \\"停止\\",\\n \\"UserUid\\": 1234,\\n \\"HostName\\": \\"c0-i01-xx-t6\\",\\n \\"InstanceId\\": \\"i-xxx\\",\\n \\"InstanceType\\": \\"ecs.g6.large\\",\\n \\"DomainName\\": \\"abc.com\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"MaxBandwidthIn\\": 100,\\n \\"IsBoundUser\\": true,\\n \\"MaxBandwidthOut\\": 100,\\n \\"Name\\": \\"c0-i01-xx-t6-2c8g\\",\\n \\"UserName\\": \\"user-xxx\\",\\n \\"ImageId\\": \\"m-xxx\\",\\n \\"ClusterId\\": \\"gws-xxx\\",\\n \\"AppList\\": [\\n {\\n \\"AppName\\": \\"notepad\\",\\n \\"AppArgs\\": \\"c:\\\\\\\\temp.txt\\",\\n \\"AppPath\\": \\"c:\\\\\\\\windows\\\\\\\\system32\\\\\\\\nodepad.exe\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<Instances>\\n <Status>Stopped</Status>\\n <MaxBandwidthOut>100</MaxBandwidthOut>\\n <MaxBandwidthIn>100</MaxBandwidthIn>\\n <UserName>user-xxx</UserName>\\n <DomainName>abc.com</DomainName>\\n <ClusterId>gws-xxx</ClusterId>\\n <InstanceId>i-xxx</InstanceId>\\n <InstanceChargeType>PostPaid</InstanceChargeType>\\n <StoppedMode>停止</StoppedMode>\\n <CreateTime>2019-10-12T07:35Z</CreateTime>\\n <IsBoundUser>true</IsBoundUser>\\n <Name>c0-i01-xx-t6-2c8g</Name>\\n <UserUid>1234</UserUid>\\n <ImageId>m-xxx</ImageId>\\n <ExpireTime>2099-12-31T15:59Z</ExpireTime>\\n <InstanceType>ecs.g6.large</InstanceType>\\n <WorkMode>Application</WorkMode>\\n <HostName>c0-i01-xx-t6</HostName>\\n <AppList>\\n <AppArgs>c:\\\\temp.txt</AppArgs>\\n <AppPath>c:\\\\windows\\\\system32\\\\nodepad.exe</AppPath>\\n <AppName>notepad</AppName>\\n </AppList>\\n</Instances>\\n<TotalCount>1</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>XXX-XXX</RequestId>\\n<PageNumber>1</PageNumber>","errorExample":""}]',
- 'title' => 'DescribeInstances',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"Stopped\\",\\n \\"ExpireTime\\": \\"2099-12-31T15:59Z\\",\\n \\"WorkMode\\": \\"Application\\",\\n \\"CreateTime\\": \\"2019-10-12T07:35Z\\",\\n \\"StoppedMode\\": \\"停止\\",\\n \\"UserUid\\": 1234,\\n \\"HostName\\": \\"c0-i01-xx-t6\\",\\n \\"InstanceId\\": \\"i-xxx\\",\\n \\"InstanceType\\": \\"ecs.g6.large\\",\\n \\"DomainName\\": \\"abc.com\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"MaxBandwidthIn\\": 100,\\n \\"IsBoundUser\\": true,\\n \\"MaxBandwidthOut\\": 100,\\n \\"Name\\": \\"c0-i01-xx-t6-2c8g\\",\\n \\"UserName\\": \\"user-xxx\\",\\n \\"ImageId\\": \\"m-xxx\\",\\n \\"ClusterId\\": \\"gws-xxx\\",\\n \\"AppList\\": [\\n {\\n \\"AppName\\": \\"notepad\\",\\n \\"AppArgs\\": \\"c:\\\\\\\\temp.txt\\",\\n \\"AppPath\\": \\"c:\\\\\\\\windows\\\\\\\\system32\\\\\\\\nodepad.exe\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve instance information',
+ 'summary' => 'Describes instance information.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'GetConnectTicket' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-xxx',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx', 'title' => ''],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'app-xxx',
- ],
+ 'schema' => ['description' => '> Do not specify this parameter when `WorkMode` is set to `Desktop` (desktop mode).'."\n"
+ .'> This parameter is required when `WorkMode` is set to `Application` (application mode).'."\n"
+ ."\n"
+ .'The application name.', 'type' => 'string', 'required' => false, 'example' => 'app-xxx', 'title' => ''],
],
[
'name' => 'UserName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user01',
- ],
+ 'schema' => ['description' => '> This parameter is required when the DomainName field returned by DescribeInstances is not empty and the caller is an assigned user of the instance.'."\n"
+ ."\n"
+ .'The domain username.', 'type' => 'string', 'required' => false, 'example' => 'user01', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
+ 'schema' => ['description' => '> This parameter is required when the DomainName field returned by DescribeInstances is not empty and the caller is an assigned user of the instance.'."\n"
+ ."\n"
+ .'The password of the domain username.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 't-xxx',
- ],
+ 'schema' => ['description' => '> This parameter takes effect only when `AsyncMode` is set to `true`.'."\n"
+ ."\n"
+ .'If this parameter is not empty, it is used to retrieve the execution status of a previous call.', 'type' => 'string', 'required' => false, 'example' => 't-xxx', 'title' => ''],
],
[
'name' => 'AsyncMode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to use asynchronous mode.'."\n"
+ .'* false (default): The API returns a response only after the command is executed.'."\n"
+ .'* true: The API returns a response **immediately**.'."\n"
+ .' * If `TaskId` is empty: The query command is executed asynchronously in the background. Use the TaskId in the **response** to call this API again to retrieve the result of the query command.'."\n"
+ .' * If `TaskId` is not empty: Retrieves the result of the query command.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''],
],
[
'name' => 'UsePrivateIp',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to use an internal IP address to connect to the Cloud Desktop:'."\n"
+ .'* false (default): When retrieving the connection token, the system selects the connection method in the following order from highest to lowest priority:'."\n"
+ .' * The elastic IP address (EIP) of the instance'."\n"
+ .' * The public IP address of the instance'."\n"
+ .' * The EIP used when the cluster is associated with a NAT gateway'."\n"
+ .' * The internal IP address of the instance'."\n"
+ .'* true: When retrieving the connection token, the system uses the internal IP address of the instance to connect to the Cloud Desktop.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''],
],
],
'responses' => [
@@ -1313,124 +1196,97 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
- ],
- 'Ticket' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXXXXXXX',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-xxx',
- ],
+ 'TaskFinished' => ['description' => 'The execution status of the current call.'."\n"
+ .'* false: Not completed.'."\n"
+ .'* true: Completed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
+ 'Ticket' => ['description' => 'The ticket used to connect to the user instance. Before using the ticket, Base64-decode its content, save it as an xxx.ica file, and then open the file. The following Python code provides an example:'."\n"
+ ."\n"
+ .'```'."\n"
+ .'import base64'."\n"
+ .'response = {'."\n"
+ .' "Ticket": "XXXX",'."\n"
+ .' "RequestId": "XXX-XXX",'."\n"
+ .'}'."\n"
+ .'f = open (\'xxx.ica\', \'w\')'."\n"
+ .'out = base64.b64decode(response[\'Ticket\'])'."\n"
+ .'f.write(out)'."\n"
+ .'f.close()'."\n"
+ .'```.', 'type' => 'string', 'example' => 'XXXXXXXXX', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID of the current call. You can use this value to call this API again to retrieve the execution result.', 'type' => 'string', 'example' => 't-xxx', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskFinished\\": true,\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"Ticket\\": \\"XXXXXXXXX\\",\\n \\"TaskId\\": \\"t-xxx\\"\\n}","errorExample":""},{"type":"xml","example":"<Ticket>XXXXXXXXX</Ticket>\\n<TaskId>t-xxx</TaskId>\\n<RequestId>XXX-XXX</RequestId>\\n<TaskFinished>true</TaskFinished>","errorExample":""}]',
- 'title' => 'GetConnectTicket',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskFinished\\": true,\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"Ticket\\": \\"XXXXXXXXX\\",\\n \\"TaskId\\": \\"t-xxx\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve the token required to connect to an instance',
+ 'summary' => 'Retrieves the token required to connect to an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'RestartInstance' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'IsUserAdmin' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
- 'parameters' => [
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-xxx',
- ],
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
+ 'IsAllow' => ['description' => 'Indicates whether the user can use the cloud graphics workstation service. Valid values:'."\n"
+ .'* true'."\n"
+ .'* false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'IsAdmin' => ['description' => 'Indicates whether the user is an admin user. Valid values:'."\n"
+ .'* true'."\n"
+ .'* false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>908AB064-2453-49E9-B062-9B6CC09FA25C</RequestId>","errorExample":""}]',
- 'title' => 'RestartInstance',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IsAllow\\": false,\\n \\"IsAdmin\\": true,\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Query permissions of the current user',
+ 'summary' => 'Queries the permissions of the current user.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateImage' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'RestartInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-xxx',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'image-xxx',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx', 'title' => ''],
],
],
'responses' => [
@@ -1438,305 +1294,72 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'ImageId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'm-xxx',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"ImageId\\": \\"m-xxx\\",\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<ImageId>m-xxx</ImageId>\\n<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'CreateImage',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteImage' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
- [
- 'name' => 'ImageId',
- 'in' => 'query',
- 'schema' => [
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-xxx',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'DeleteImage',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Restart an instance',
+ 'summary' => 'Restarts an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SetImageName' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'SetClusterADDomain' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ImageId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-xxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'gws-rhzlyl5zx3ua****', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'DomainDnsIp',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'image-xxx',
- ],
+ 'schema' => ['description' => 'The DNS IP address of the AD domain.', 'type' => 'string', 'required' => true, 'example' => '192.168.XX.XX', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'SetImageName',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeImages' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'InstanceType',
+ 'name' => 'DomainName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs.g6.large',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX-XXXX',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Images' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'ImageType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'system',
- ],
- 'Progress' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100%',
- ],
- 'Size' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '40',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Mon May 27 13:33:42 CST 2019',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ImageId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'm-bp125mb261tmk6tqvoni',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cmjj00042097',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'schema' => ['description' => 'The domain name of the AD domain.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"XXXX-XXXX\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Images\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"ImageType\\": \\"system\\",\\n \\"Progress\\": \\"100%\\",\\n \\"Size\\": 40,\\n \\"CreateTime\\": \\"Mon May 27 13:33:42 CST 2019\\",\\n \\"Name\\": \\"windows 2016 标准版 citrix 1903\\",\\n \\"ImageId\\": \\"m-bp125mb261tmk6tqvoni\\",\\n \\"ProductCode\\": \\"cmjj00042097\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>1</TotalCount>\\n<PageSize>20</PageSize>\\n<RequestId>XXXX-XXXX</RequestId>\\n<PageNumber>1</PageNumber>\\n<Images>\\n <Status>Available</Status>\\n <Progress>100%</Progress>\\n <ProductCode>cmjj00042097</ProductCode>\\n <Size>40</Size>\\n <CreateTime>Mon May 27 13:33:42 CST 2019</CreateTime>\\n <ImageId>m-bp125mb261tmk6tqvoni</ImageId>\\n <ImageType>system</ImageType>\\n <Name>windows 2016 标准版 citrix 1903</Name>\\n</Images>","errorExample":""}]',
- 'title' => 'DescribeImages',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CreateCluster' => [
- 'summary' => '创建集群',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
- 'parameters' => [
- [
- 'name' => 'VpcId',
+ 'name' => 'DomainPassword',
'in' => 'query',
- 'schema' => [
- 'description' => 'VPC id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc-xxx',
- ],
+ 'schema' => ['description' => 'The administrator password of the AD domain.', 'type' => 'string', 'required' => true, 'example' => 'password***', 'title' => ''],
],
[
- 'name' => 'ClusterType',
+ 'name' => 'DomainAdmin',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gws.s1.standard',
- ],
+ 'schema' => ['description' => 'The administrator password of the AD domain.', 'type' => 'string', 'required' => false, 'default' => 'administrator', 'example' => 'administrator', 'title' => ''],
],
[
- 'name' => 'VSwitchId',
+ 'name' => 'DomainDelete',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-xxx',
- ],
+ 'schema' => ['description' => 'Specifies whether to associate the cluster with the AD domain. Valid values:'."\n"
+ ."\n"
+ .'* false: Associates the cluster with the AD domain.'."\n"
+ .'* true: Dissociates the cluster from the AD domain.'."\n"
+ ."\n"
+ .'Default value: false.'."\n"
+ ."\n"
+ .'> Before you associate the cluster with the AD domain, make sure that the network between the AD domain and the Cloud Desktop VPC is connected by using Smart Access Gateway, Express Connect, or other methods.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''],
],
],
'responses' => [
@@ -1744,124 +1367,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gws-xxx',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
+ 'TaskId' => ['description' => 'The task ID. You can use this ID to query the execution status of the SetClusterADDomain operation.', 'type' => 'string', 'example' => 't-xxx', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A', 'title' => ''],
],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClusterId\\": \\"gws-xxx\\",\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<ClusterId>gws-xxx</ClusterId>\\n<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'CreateCluster',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteCluster' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
- [
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gws-xxx',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
- ],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'DeleteCluster',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"RequestId\\": \\"7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A\\"\\n}","type":"json"}]',
+ 'title' => 'Associate a Cloud desktop cluster with an AD domain',
+ 'summary' => 'Associates or dissociates a Cloud Desktop cluster with an Active Directory (AD) domain by calling SetClusterADDomain.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'SetClusterDnat' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gws-xxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'gws-xxx', 'title' => ''],
],
[
'name' => 'NatId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ngw-xxx',
- ],
+ 'schema' => ['description' => 'The NAT gateway ID.'."\n"
+ .'* If this parameter is set to a non-empty value, the specified NAT gateway is associated with the cluster. The NAT gateway and the Cloud Desktop cluster must be in the same VPC.'."\n"
+ .'* If this parameter is left empty and the cluster is already associated with a NAT gateway, the cluster is dissociated from the NAT gateway.', 'type' => 'string', 'required' => true, 'example' => 'ngw-xxx', 'title' => ''],
],
[
'name' => 'NatEip',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.2.3.4',
- ],
+ 'schema' => ['description' => '* If NatId is set to a non-empty value:'."\n"
+ .' * If this parameter is set to a non-empty value, the specified EIP is used for the association with the cluster.'."\n"
+ .' * If this parameter is left empty, an EIP whose status is Idle or UsedByForwardTable is automatically selected from the NAT gateway.'."\n"
+ .'* If NatId is left empty, this parameter does not take effect.', 'type' => 'string', 'required' => false, 'example' => '1.2.3.4', 'title' => ''],
],
],
'responses' => [
@@ -1869,59 +1424,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXX-XXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXX-XXX</RequestId>","errorExample":""}]',
- 'title' => 'SetClusterDnat',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXX-XXX\\"\\n}","type":"json"}]',
+ 'title' => 'Associate a cluster with a NAT gateway',
+ 'summary' => 'Associates a cluster with a NAT gateway. After the association, desktops are connected through DNAT and EIP.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'SetClusterName' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gws-xxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'gws-xxx', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cluster-xxx',
- ],
+ 'schema' => ['description' => 'The cluster name to set.', 'type' => 'string', 'required' => true, 'example' => 'cluster-xxx', 'title' => ''],
],
],
'responses' => [
@@ -1929,266 +1470,148 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'SetClusterName',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'SetClusterADDomain' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
- [
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gws-rhzlyl5zx3ua****',
- ],
- ],
- [
- 'name' => 'DomainDnsIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '192.168.XX.XX',
- ],
- ],
- [
- 'name' => 'DomainName',
- 'in' => 'query',
- 'schema' => [
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'example.com',
- ],
- ],
- [
- 'name' => 'DomainPassword',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'password***',
- ],
- ],
- [
- 'name' => 'DomainAdmin',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'administrator',
- 'default' => 'administrator',
- ],
- ],
- [
- 'name' => 'DomainDelete',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-xxx',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"RequestId\\": \\"7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A\\"\\n}","errorExample":""},{"type":"xml","example":"<SetClusterADDomainResponse>\\n <TaskId>t-xxx</TaskId>\\n <RequestId>7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A</RequestId>\\n</SetClusterADDomainResponse>","errorExample":""}]',
- 'title' => 'SetClusterADDomain',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Set cluster name',
+ 'summary' => 'Sets the name of a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'SetClusterPolicy' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gws-xxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'gws-xxx', 'title' => ''],
],
[
'name' => 'UsbRedirect',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The USB redirection policy. Valid values:'."\n"
+ .'* off: disabled.'."\n"
+ .'* on: enabled.',
'type' => 'string',
'required' => true,
+ 'enum' => ['off', 'on'],
'example' => 'on',
- 'enum' => [
- 'off',
- 'on',
- ],
+ 'title' => '',
],
],
[
'name' => 'Watermark',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The watermark policy. Valid values:'."\n"
+ .'* off: disabled.'."\n"
+ .'* on: enabled. The watermark consists of two lines of semi-transparent text in a star pattern that covers the screen. The text displays cluster information and host information in the following format:'."\n"
+ .' * gws-xxx@gws'."\n"
+ .' * c0-i00-xx-t6.',
'type' => 'string',
'required' => true,
+ 'enum' => ['off', 'on'],
'example' => 'off',
- 'enum' => [
- 'off',
- 'on',
- ],
+ 'title' => '',
],
],
[
'name' => 'LocalDrive',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The local drive mapping policy. Valid values:'."\n"
+ .'* off: disabled.'."\n"
+ .'* read: read-only.'."\n"
+ .'* readwrite: read and write.',
'type' => 'string',
'required' => true,
+ 'enum' => ['off', 'read', 'readwrite'],
'example' => 'readwrite',
- 'enum' => [
- 'off',
- 'read',
- 'readwrite',
- ],
+ 'title' => '',
],
],
[
'name' => 'Clipboard',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The clipboard policy. Valid values:'."\n"
+ .'* off: disabled.'."\n"
+ .'* read: read-only.'."\n"
+ .'* write: write-only.'."\n"
+ .'* readwrite: read and write.',
'type' => 'string',
'required' => true,
+ 'enum' => ['off', 'read', 'readwrite', 'write'],
'example' => 'read',
- 'enum' => [
- 'off',
- 'read',
- 'readwrite',
- 'write',
- ],
+ 'title' => '',
],
],
[
'name' => 'UdpPort',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The UDP port policy. Valid values:'."\n"
+ .'* on (default): enabled. We recommend that you set this parameter to on for better bandwidth usage and network stability.'."\n"
+ .'* off: disabled. To troubleshoot UDP-related network issues, set this parameter to off. After this parameter is set to off, the inbound security group rules for ports 1494 and 2598 are removed.',
'type' => 'string',
'required' => false,
- 'example' => 'off',
'default' => 'on',
- 'enum' => [
- 'off',
- 'on',
- ],
+ 'enum' => ['off', 'on'],
+ 'example' => 'off',
+ 'title' => '',
],
],
[
'name' => 'Audio',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The audio policy. Valid values:'."\n"
+ .'* on (default): enabled. The client can hear audio from the Cloud Desktop.'."\n"
+ .'* off: disabled. The client cannot hear audio from the Cloud Desktop.',
'type' => 'string',
'required' => false,
- 'example' => 'on',
'default' => 'on',
- 'enum' => [
- 'off',
- 'on',
- ],
+ 'enum' => ['off', 'on'],
+ 'example' => 'on',
+ 'title' => '',
],
],
[
'name' => 'DomainList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '*.abc.com,*.xyz.com',
- ],
+ 'schema' => ['description' => 'The domain name whitelist.'."\n"
+ .'* If the whitelist is empty, access to all domain names is allowed.'."\n"
+ .'* If the whitelist is not empty, only domain names in the list are accessible.'."\n"
+ .'* The `*` wildcard is supported.'."\n"
+ .'* Separate multiple domain name rules with commas (,).'."\n"
+ .'* The settings take effect immediately on all instances in the current cluster.', 'type' => 'string', 'required' => false, 'example' => '*.abc.com,*.xyz.com', 'title' => ''],
],
[
'name' => 'AsyncMode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to use asynchronous mode. Valid values:'."\n"
+ .'* false (default): The API returns a response only after the command is executed.'."\n"
+ .'* true: The command is executed in the background, and the API returns a response immediately. Record the TaskId from the response, and then call DescribeClusterPolicy to query the execution status of the command.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''],
],
],
'responses' => [
@@ -2196,83 +1619,94 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-xxx',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
+ 'TaskId' => ['description' => '> This value is valid only when `AsyncMode` is set to `true`.'."\n"
+ ."\n"
+ .'You can use this value to call DescribeClusterPolicy to query the execution status of the command.', 'type' => 'string', 'example' => 't-xxx', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"RequestId\\": \\"XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<TaskId>t-xxx</TaskId>\\n<RequestId>XXXX</RequestId>","errorExample":""}]',
- 'title' => 'SetClusterPolicy',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Set cluster policy',
+ 'summary' => 'Sets the policy for a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeClusterConnections' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'SetImageName' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gws-xxx',
- ],
+ 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'm-xxx', 'title' => ''],
],
[
- 'name' => 'StartTime',
+ 'name' => 'Name',
'in' => 'query',
+ 'schema' => ['description' => 'The image name.', 'type' => 'string', 'required' => true, 'example' => 'image-xxx', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2020-09-07',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Set image name',
+ 'summary' => 'Sets the name of an image.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'SetInstanceName' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
[
- 'name' => 'EndTime',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2020-09-01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx', 'title' => ''],
],
[
- 'name' => 'TaskId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 't-xxx',
- ],
+ 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'desktop-xxx', 'title' => ''],
],
],
'responses' => [
@@ -2280,129 +1714,83 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
- ],
- 'TaskFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-xxx',
- ],
- 'Connections' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'LogoffStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'InstanceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'LogonTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-09-01T01:02:03.456Z',
- ],
- 'HostName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hostname',
- ],
- 'LogoffTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-09-03T01:02:03.456Z',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'i-xxx',
- ],
- 'ClientName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'client-xxx',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"TaskFinished\\": true,\\n \\"TotalCount\\": 1,\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"Connections\\": [\\n {\\n \\"LogoffStatus\\": \\"0\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"LogonTime\\": \\"2020-09-01T01:02:03.456Z\\",\\n \\"HostName\\": \\"hostname\\",\\n \\"LogoffTime\\": \\"2020-09-03T01:02:03.456Z\\",\\n \\"InstanceId\\": \\"i-xxx\\",\\n \\"ClientName\\": \\"client-xxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<Connections>\\n <LogoffStatus>0</LogoffStatus>\\n <LogoffTime>2020-09-03T01:02:03.456Z</LogoffTime>\\n <ClientName>client-xxx</ClientName>\\n <LogonTime>2020-09-01T01:02:03.456Z</LogonTime>\\n <InstanceId>i-xxx</InstanceId>\\n</Connections>\\n<TotalCount>1</TotalCount>\\n<TaskId>t-xxx</TaskId>\\n<RequestId>XXX-XXX</RequestId>\\n<TaskFinished>true</TaskFinished>","errorExample":""}]',
- 'title' => 'DescribeClusterConnections',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Set instance name',
+ 'summary' => 'Sets the name of an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeClusterPolicy' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'SetInstancePolicy' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'TaskId',
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'VisualLossless',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => '> Valid only for GPU instances. Enable this option to obtain better image quality.'."\n"
+ ."\n"
+ .'The visual lossless mode. Valid values:'."\n"
+ .'* off (default): Disabled.'."\n"
+ .'* on: Enabled.',
'type' => 'string',
'required' => false,
- 'example' => 't-xxx',
+ 'default' => 'off',
+ 'enum' => ['on', 'off'],
+ 'example' => 'on',
+ 'title' => '',
],
],
[
- 'name' => 'AsyncMode',
+ 'name' => 'OptimizeFor3d',
'in' => 'query',
'schema' => [
- 'description' => '',
- 'type' => 'boolean',
+ 'description' => '> Valid only for GPU instances. Enable this option to obtain lower desktop latency.'."\n"
+ ."\n"
+ .'GPU acceleration. Valid values:'."\n"
+ .'* off (default): Disabled.'."\n"
+ .'* on: Enabled.',
+ 'type' => 'string',
'required' => false,
- 'example' => 'true',
- 'default' => 'false',
+ 'default' => 'off',
+ 'enum' => ['on', 'off'],
+ 'example' => 'on',
+ 'title' => '',
],
],
[
- 'name' => 'ClusterId',
+ 'name' => 'AsyncMode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gws-xxx',
- ],
+ 'schema' => ['description' => 'Specifies whether to use asynchronous mode. Valid values:'."\n"
+ .'* false (default): The API returns only after the setting is complete.'."\n"
+ .'* true: The API returns **immediately**.'."\n"
+ .' * If `TaskId` is empty, the setting action is executed asynchronously in the background. Use the TaskId in the **response** to call DescribeInstancePolicy to obtain the result of the setting action.'."\n"
+ .' * If `TaskId` is not empty, the result of the setting action is returned.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''],
],
],
'responses' => [
@@ -2410,119 +1798,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'UdpPort' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'on',
- ],
- 'TaskFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => 'Request Id',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
- ],
- 'UsbRedirect' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'off',
- ],
- 'Clipboard' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'readwrite',
- ],
- 'Watermark' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'off',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-xxx',
- ],
- 'DomainList' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '*.abc.com,*.xyz.com',
- ],
- 'Audio' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'on',
- ],
- 'LocalDrive' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'readwrite',
- ],
+ 'TaskId' => ['description' => '> This value is valid only when `AsyncMode` is set to `true`.'."\n"
+ ."\n"
+ .'Use this value to call DescribeInstancePolicy to query the execution status of the setting action.', 'type' => 'string', 'example' => 't-xxx', 'title' => ''],
+ 'RequestId' => ['description' => 'Request id。', 'type' => 'string', 'example' => 'XXX-XXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"UdpPort\\": \\"on\\",\\n \\"TaskFinished\\": true,\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"UsbRedirect\\": \\"off\\",\\n \\"Clipboard\\": \\"readwrite\\",\\n \\"Watermark\\": \\"off\\",\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"DomainList\\": \\"*.abc.com,*.xyz.com\\",\\n \\"Audio\\": \\"on\\",\\n \\"LocalDrive\\": \\"readwrite\\"\\n}","errorExample":""},{"type":"xml","example":"<TaskId>t-xxx</TaskId>\\n<UdpPort>on</UdpPort>\\n<RequestId>XXX-XXX</RequestId>\\n<LocalDrive>readwrite</LocalDrive>\\n<UsbRedirect>off</UsbRedirect>\\n<TaskFinished>true</TaskFinished>\\n<DomainList>*.abc.com,*.xyz.com</DomainList>\\n<Clipboard>readwrite</Clipboard>\\n<Audio>on</Audio>\\n<Watermark>off</Watermark>","errorExample":""}]',
- 'title' => 'DescribeClusterPolicy',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-xxx\\",\\n \\"RequestId\\": \\"XXX-XXX\\"\\n}","type":"json"}]',
+ 'title' => 'Set instance policy status',
+ 'summary' => 'Sets the policy status of an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeClusters' => [
- 'summary' => '查询gws集群列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'SetInstanceUser' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gws-rhzlyl5zx3ua****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'UserUid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'UserName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => true, 'example' => 'user_xxx', 'title' => ''],
],
],
'responses' => [
@@ -2530,237 +1852,132 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Clusters' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'VpcId' => [
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-bp1vi54o1on2sijpm****',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'running',
- ],
- 'NatId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ngw-uf63l0kkf73ieyf9k****',
- ],
- 'InstanceCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-09-17T02:02:25Z',
- ],
- 'NatEip' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '192.168.XX.XX',
- ],
- 'SecurityGroup' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sg-bp18ny7dvho4g0s7****',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cluster-xxx',
- ],
- 'DomainName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'example.com',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gws-rhzlyl5zx3ua****',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Clusters\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1vi54o1on2sijpm****\\",\\n \\"Status\\": \\"running\\",\\n \\"NatId\\": \\"ngw-uf63l0kkf73ieyf9k****\\",\\n \\"InstanceCount\\": 1,\\n \\"CreateTime\\": \\"2020-09-17T02:02:25Z\\",\\n \\"NatEip\\": \\"192.168.XX.XX\\",\\n \\"SecurityGroup\\": \\"sg-bp18ny7dvho4g0s7****\\",\\n \\"Name\\": \\"cluster-xxx\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"ClusterId\\": \\"gws-rhzlyl5zx3ua****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeClustersResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A</RequestId>\\n <PageNumber>1</PageNumber>\\n <Clusters>\\n <Status>running</Status>\\n <InstanceCount>1</InstanceCount>\\n <NatId>ngw-uf63l0kkf73ieyf9k****</NatId>\\n <VpcId>vpc-bp1vi54o1on2sijpm****</VpcId>\\n <DomainName>example.com</DomainName>\\n <ClusterId>gws-rhzlyl5zx3ua****</ClusterId>\\n <CreateTime>2020-09-17T02:02:25Z</CreateTime>\\n <SecurityGroup>sg-bp18ny7dvho4g0s7****</SecurityGroup>\\n <NatEip>192.168.XX.XX</NatEip>\\n <Name>cluster-xxx</Name>\\n </Clusters>\\n</DescribeClustersResponse>","errorExample":""}]',
- 'title' => 'DescribeClusters',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Assign a user to an instance',
+ 'summary' => 'Assigns a user to an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
- 'DescribeAvailableResource' => [
- 'methods' => [
- 'post',
- 'get',
+ 'StartInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Start an instance',
+ 'summary' => 'Starts an instance.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'StopInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'get',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-xxx', 'title' => ''],
+ ],
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'Request id。',
- 'type' => 'string',
- 'example' => 'XXX-XXX',
- ],
- 'AvailableResources' => [
- 'description' => 'AvailableResources',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ClusterType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gws.s1.stardard',
- ],
- 'Zone' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-i',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"XXX-XXX\\",\\n \\"AvailableResources\\": [\\n {\\n \\"ClusterType\\": \\"gws.s1.stardard\\",\\n \\"Zone\\": \\"cn-hangzhou-i\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>XXX-XXX</RequestId>\\n<AvailableResources>\\n <Zone>cn-hangzhou-i</Zone>\\n <ClusterType>gws.s1.stardard</ClusterType>\\n</AvailableResources>","errorExample":""}]',
- 'title' => 'DescribeAvailableResource',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXXX\\"\\n}","type":"json"}]',
+ 'title' => 'Stop an instance',
+ 'summary' => 'Stops an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
],
'endpoints' => [
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'gws.ap-northeast-3.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'ecd.cn-hangzhou-finance.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'gws.cn-qingdao.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'gws.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'gws.cn-chengdu.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'gws.cn-zhangjiakou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'gws.cn-huhehaote.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'gws.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'gws.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'gws.cn-shenzhen.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'gws.cn-hongkong.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'gws.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'gws.ap-southeast-2.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'gws.ap-southeast-5.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'gws.ap-northeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'gws.us-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'gws.us-east-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'gws.eu-central-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'gws.ap-south-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'gws.eu-west-1.aliyuncs.com',
- ],
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.ap-northeast-1.aliyuncs.com', 'endpoint' => 'gws.ap-northeast-1.aliyuncs.com', 'vpc' => 'gws-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.ap-southeast-1.aliyuncs.com', 'endpoint' => 'gws.ap-southeast-1.aliyuncs.com', 'vpc' => 'gws-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.ap-southeast-2.aliyuncs.com', 'endpoint' => 'gws.ap-southeast-2.aliyuncs.com', 'vpc' => 'gws-vpc.ap-southeast-2.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.ap-northeast-3.aliyuncs.com', 'endpoint' => 'gws.ap-northeast-3.aliyuncs.com', 'vpc' => 'gws-vpc.ap-southeast-3.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.ap-southeast-5.aliyuncs.com', 'endpoint' => 'gws.ap-southeast-5.aliyuncs.com', 'vpc' => 'gws-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.cn-beijing.aliyuncs.com', 'endpoint' => 'gws.cn-beijing.aliyuncs.com', 'vpc' => 'gws-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.cn-chengdu.aliyuncs.com', 'endpoint' => 'gws.cn-chengdu.aliyuncs.com', 'vpc' => 'gws-vpc.cn-chengdu.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.cn-hangzhou.aliyuncs.com', 'endpoint' => 'gws.cn-hangzhou.aliyuncs.com', 'vpc' => 'gws-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.cn-hongkong.aliyuncs.com', 'endpoint' => 'gws.cn-hongkong.aliyuncs.com', 'vpc' => 'gws-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.cn-huhehaote.aliyuncs.com', 'endpoint' => 'gws.cn-huhehaote.aliyuncs.com', 'vpc' => 'gws-vpc.cn-huhehaote.aliyuncs.com'],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.cn-qingdao.aliyuncs.com', 'endpoint' => 'gws.cn-qingdao.aliyuncs.com', 'vpc' => 'gws-vpc.cn-qingdao.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.cn-shanghai.aliyuncs.com', 'endpoint' => 'gws.cn-shanghai.aliyuncs.com', 'vpc' => 'gws-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.cn-shenzhen.aliyuncs.com', 'endpoint' => 'gws.cn-shenzhen.aliyuncs.com', 'vpc' => 'gws-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gws.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'gws.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'gws-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'gws.us-west-1.aliyuncs.com', 'endpoint' => 'gws.us-west-1.aliyuncs.com', 'vpc' => 'gws-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'gws.us-east-1.aliyuncs.com', 'endpoint' => 'gws.us-east-1.aliyuncs.com', 'vpc' => 'gws-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'gws.eu-west-1.aliyuncs.com', 'endpoint' => 'gws.eu-west-1.aliyuncs.com', 'vpc' => 'gws-vpc.eu-west-1.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'gws.eu-central-1.aliyuncs.com', 'endpoint' => 'gws.eu-central-1.aliyuncs.com', 'vpc' => 'gws-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'gws.ap-south-1.aliyuncs.com', 'endpoint' => 'gws.ap-south-1.aliyuncs.com', 'vpc' => 'gws-vpc.ap-south-1.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'ecd.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'ecd.cn-hangzhou-finance.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'EntityNotExist.Role', 'message' => 'The service linked role AliyunServiceRoleForGws is missing. Please contact the primary account owner or RAM user that has been authorized AliyunGwsFullAccess. They can automatically create the role in the console.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 18:42:22 +0000