summaryrefslogtreecommitdiff
path: root/data/en_us/appstream-center
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/appstream-center
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/appstream-center')
-rw-r--r--data/en_us/appstream-center/2021-02-18/api-docs.php566
-rw-r--r--data/en_us/appstream-center/2021-02-20/api-docs.php1644
-rw-r--r--data/en_us/appstream-center/2021-09-01/api-docs.php19377
-rw-r--r--data/en_us/appstream-center/2021-09-03/api-docs.php2311
4 files changed, 11966 insertions, 11932 deletions
diff --git a/data/en_us/appstream-center/2021-02-18/api-docs.php b/data/en_us/appstream-center/2021-02-18/api-docs.php
index 4b300f4..8c68354 100644
--- a/data/en_us/appstream-center/2021-02-18/api-docs.php
+++ b/data/en_us/appstream-center/2021-02-18/api-docs.php
@@ -1,36 +1,21 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'appstream-center',
- 'version' => '2021-02-18',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'appstream-center', 'version' => '2021-02-18'],
'directories' => [
'GetAuthCode',
[
- 'id' => 354391,
- 'title' => null,
+ 'children' => ['ExpireLoginToken', 'GetStsToken'],
'type' => 'directory',
- 'children' => [
- 'ExpireLoginToken',
- 'GetStsToken',
- ],
+ 'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetAuthCode' => [
- 'summary' => 'Obtains an authorization code that includes the identity and permission information of a user. You can use the code to launch cloud apps in integration scenarios.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ExpireLoginToken' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -40,179 +25,191 @@
'systemTags' => [],
'parameters' => [
[
- 'name' => 'ExternalUserId',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alice',
- ],
+ 'schema' => ['description' => 'The ID of the logon session.', 'type' => 'string', 'required' => true, 'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae9****', 'title' => ''],
],
[
- 'name' => 'EndUserId',
+ 'name' => 'LoginToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alice',
- ],
+ 'schema' => ['description' => 'The logon token.', 'type' => 'string', 'required' => true, 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****', 'title' => ''],
],
[
- 'name' => 'Policy',
+ 'name' => 'EndUserId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "Version": "1",'."\n"
- .' "Resource": {'."\n"
- .' "Type": "AppInstanceGroup",'."\n"
- .' "Id": "aig-9ciijz60n4xsv****"'."\n"
- .' }'."\n"
- .'}',
- ],
+ 'schema' => ['description' => 'The logon username.', 'type' => 'string', 'required' => true, 'example' => 'testuser', 'title' => ''],
],
[
- 'name' => 'AutoCreateUser',
+ 'name' => 'OfficeSiteId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'boolean',
- ],
+ 'schema' => ['description' => 'The ID of the workspace. This parameter is required if you log on using a workspace ID. You can leave this parameter empty if you log on using an organization ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing+dir-172301****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'The response elements.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'AuthModel' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'AuthCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********',
- ],
- 'EndUserId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alice',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2015-01-23T12:33:18Z',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AuthModel\\": {\\n \\"AuthCode\\": \\"acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"ExpireTime\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}","type":"json"}]',
- 'title' => 'GetAuthCode',
- ],
- 'ExpireLoginToken' => [
- 'summary' => 'Manually invalidates a logon token.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ExpireLoginToken',
+ 'summary' => 'Manually expires a logon token before its automatic expiration.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExpireLoginToken'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'GetAuthCode' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingV87T4P'],
+ ],
'parameters' => [
[
- 'name' => 'SessionId',
+ 'name' => 'ExternalUserId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae9****',
- ],
+ 'schema' => ['description' => 'The external user ID. This ID is defined by the caller and must be unique within an Alibaba Cloud account. This parameter and EndUserId cannot both be empty.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''],
],
[
- 'name' => 'LoginToken',
+ 'name' => 'EndUserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The username of the China Desktop Service (China Desktop Service) convenience account. The username must be unique within an Alibaba Cloud account. This parameter and ExternalUserId cannot both be empty.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''],
+ ],
+ [
+ 'name' => 'Policy',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The access policy that restricts the access permissions of the authorization code. If this parameter is left empty, no restrictions are applied.'."\n"
+ ."\n"
+ .'Syntax:'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "Version": "1",'."\n"
+ .' "Resource": {'."\n"
+ .' "Type": "<Resource type>",'."\n"
+ .' "Id": "<Resource ID>"'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'Valid values of <Resource type>:'."\n"
+ ."\n"
+ .'- AppInstanceGroup: delivery group. You can call the ListAppInstanceGroup operation to obtain the ID.'."\n"
+ .'- AppInstance: application instance (dedicated field).'."\n"
+ .'- App: application. You can call the ListAppInstanceGroup operation to obtain the ID.', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "Version": "1",'."\n"
+ .' "Resource": {'."\n"
+ .' "Type": "AppInstanceGroup",'."\n"
+ .' "Id": "aig-9ciijz60n4xsv****"'."\n"
+ .' }'."\n"
+ .'}', 'title' => ''],
+ ],
+ [
+ 'name' => 'AutoCreateUser',
'in' => 'formData',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****',
+ 'description' => 'Specifies whether to synchronously create an EndUserId based on ExternalUserId. This parameter takes effect only when EndUserId is empty.',
+ 'enumValueTitles' => ['true' => 'synchronously create.', 'false' => 'do not synchronously create (default)'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
],
],
[
- 'name' => 'EndUserId',
- 'in' => 'formData',
+ 'name' => 'TokenType',
+ 'in' => 'query',
'schema' => [
- 'description' => '',
'type' => 'string',
- 'required' => true,
- 'example' => 'testuser',
+ 'default' => 'StsToken',
+ 'enum' => ['LoginToken', 'StsToken'],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'OfficeSiteId',
+ 'name' => 'AccountType',
'in' => 'formData',
'schema' => [
- 'description' => '',
'type' => 'string',
- 'required' => false,
- 'example' => 'cn-beijing+dir-172301****',
+ 'enum' => ['ad', 'simple'],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'AdDomain',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'AdPassword',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'AuthModel' => [
+ 'description' => 'The authorization code information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthCode' => ['description' => 'The authorization code. The authorization code is valid for 3 minutes and can be used only once regardless of whether the verification succeeds or fails. If multiple authorization codes are generated for a user, only the last generated authorization code is valid.', 'type' => 'string', 'example' => 'acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********', 'title' => ''],
+ 'EndUserId' => ['description' => 'The username of the China Desktop Service convenience account.', 'type' => 'string', 'example' => 'alice', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The expiration time of the authorization code in UTC, following the ISO 8601 standard.', 'type' => 'string', 'example' => '2015-01-23T12:33:18Z', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'ExpireLoginToken',
+ 'title' => 'Obtain an authorization code',
+ 'summary' => 'Obtains an authorization code that contains user identity and permission information. The authorization code can be used to launch a cloud application in integration scenarios.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAuthCode'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AuthModel\\": {\\n \\"AuthCode\\": \\"acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"ExpireTime\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}","type":"json"}]',
],
'GetStsToken' => [
- 'summary' => '获取stsToken',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Gets a Security Token Service (STS) token.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -224,102 +221,283 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingV87T4P',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '参数无阿里云资源id',
+ 'abilityTreeNodes' => ['FEATUREappstreamingV87T4P'],
+ 'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ExternalId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Alex',
- ],
+ 'schema' => ['description' => 'The ID of the external user.', 'type' => 'string', 'required' => false, 'example' => 'Alex', 'title' => ''],
],
[
'name' => 'EndUserId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Alex',
- ],
+ 'schema' => ['description' => 'The Elastic Desktop Service (EDS) username.'."\n"
+ ."\n"
+ .'> Either EndUserId or ExternalId is required.', 'type' => 'string', 'required' => false, 'example' => 'Alex', 'title' => ''],
],
[
'name' => 'Expiration',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '600',
- ],
+ 'schema' => ['description' => 'The validity period of the token, in seconds. The maximum period is two days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '600', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CCF92035-6231-5ABB-930E-1E003C32****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CCF92035-6231-5ABB-930E-1E003C32****'],
'StsTokenModel' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'SessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'be4be09e-cd00-4b4c-add7-11b4d8****',
- ],
- 'StsToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sts****',
- ],
- 'AliUid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '105552640689****',
- ],
- 'TenantId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '105552640689****',
- ],
+ 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'be4be09e-cd00-4b4c-add7-11b4d8****', 'title' => ''],
+ 'StsToken' => ['description' => 'The temporary credentials.', 'type' => 'string', 'example' => 'sts****', 'title' => ''],
+ 'AliUid' => ['description' => 'The tenant ID, which is the UID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'example' => '105552640689****', 'title' => ''],
+ 'TenantId' => ['description' => 'The tenant ID, which is the UID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'example' => '105552640689****', 'title' => ''],
],
+ 'description' => 'The details of the token.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The response elements.',
+ 'example' => '',
],
],
],
+ 'title' => 'GetStsToken',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CCF92035-6231-5ABB-930E-1E003C32****\\",\\n \\"StsTokenModel\\": {\\n \\"SessionId\\": \\"be4be09e-cd00-4b4c-add7-11b4d8****\\",\\n \\"StsToken\\": \\"sts****\\",\\n \\"AliUid\\": 0,\\n \\"TenantId\\": 0\\n }\\n}","type":"json"}]',
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com',
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'appstream-center.cn-shanghai.aliyuncs.com', 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com', 'vpc' => 'appstream-center-intl.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'appstream-center.ap-southeast-1.aliyuncs.com', 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com', 'vpc' => 'appstream-center-intl.vpc-proxy.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AddRemoveAccountIsSame', 'message' => 'The same account is to be added and to be removed at the same time.', 'http_code' => 400, 'description' => 'The same account is to be added and to be removed at the same time.'],
+ ['code' => 'AppCenterImageId.Missing', 'message' => 'The AppCenter ImageId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppCenterImageInfo.NotFound', 'message' => 'The AppCenter ImageInfo is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppDeploymentInfo.NotFound', 'message' => 'The AppDeploymentInfo is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstallation.StartFailed', 'message' => 'Start app installation failed.', 'http_code' => 400, 'description' => 'Failed to start the app installation.'],
+ ['code' => 'AppInstallationStatus.IsFailed', 'message' => 'App installation failed.', 'http_code' => 400, 'description' => 'The app installation status is failed.'],
+ ['code' => 'AppInstanceGroupAttributeModify.Failed', 'message' => 'Failed to modify the delivery group attribute.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupIdIsNull', 'message' => 'The AppInstanceGroupId is null.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupImageCreate.Failed', 'message' => 'Failed to create an image from the debugging app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupNotFound', 'message' => 'The AppInstanceGroup is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupNotFound', 'message' => 'The specified AppInstanceGroup not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppType.ValueNotSupported', 'message' => 'The category of the app is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AuthorizeFailed', 'message' => 'Authorize failed, please check your EndUserId and Password.', 'http_code' => 400, 'description' => 'Invalid username or password.'],
+ ['code' => 'BillingItem.InsertFailure', 'message' => 'Failed to insert the billing item.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'BizTypeNotMatch', 'message' => 'The bizType and image do not match.', 'http_code' => 400, 'description' => 'The bizType and image do not match.'],
+ ['code' => 'BuilderImage.StartTaskFailed', 'message' => 'Failed to start the builder image task.', 'http_code' => 400, 'description' => 'Failed to start the builder image task.'],
+ ['code' => 'CallBack.PayOrderCallbackFailed', 'message' => 'Failed to lock the order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CashBookInsufficient', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CheckStock.Failed', 'message' => 'Failed to check the stock.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ConnectLdapServer.Failed', 'message' => 'Failed to connect to the LDAP server. Please check the configuration.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CreateAppInstanceGroup.Failed', 'message' => 'Failed to create the app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CreateDesktopImageRecord.Failed', 'message' => 'Create cloud computer image failed.', 'http_code' => 400, 'description' => 'Failed to create the cloud computer image.'],
+ ['code' => 'DeleteTemplate.Failed', 'message' => 'Delete template failed.', 'http_code' => 400, 'description' => 'Failed to delete the template.'],
+ ['code' => 'DesktopInstance.NotFound', 'message' => 'The cloud computer instance does not exist.', 'http_code' => 400, 'description' => 'The cloud computer instance does not exist.'],
+ ['code' => 'ExceedAddAccountQuota', 'message' => 'The maximum number of account addition is reached.', 'http_code' => 400, 'description' => 'The maximum number of account addition is reached.'],
+ ['code' => 'ExceedAppAuthUserQuota', 'message' => 'The authorized user quota of the app is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedAppInstanceGroupQuota', 'message' => 'The app instance group quota is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedBuilderQuota', 'message' => 'The maximum number of builders is reached.', 'http_code' => 400, 'description' => 'The maximum number of builders is reached.'],
+ ['code' => 'ExceedImageQuota', 'message' => 'The maximum number of images is reached.', 'http_code' => 400, 'description' => 'The maximum number of images is reached.'],
+ ['code' => 'ExceedPoolNodeAmountQuota', 'message' => 'The pool node amount quota is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedRemoveAccountQuota', 'message' => 'The maximum number of account removal is reached.', 'http_code' => 400, 'description' => 'The maximum number of account removal is reached.'],
+ ['code' => 'Forbidden.NoPermission', 'message' => 'You are not authorized to access this page.', 'http_code' => 403, 'description' => 'You are not authorized to access this page.'],
+ ['code' => 'ForbiddenNoRealNameAuthentication', 'message' => 'Operation failed. The user has not completed the real-name authentication.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ForbiddenNoRealNameAuthentication', 'message' => 'Forbidden by user real name authentication status.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'GetLoginTokenError', 'message' => 'Failed to get the login token.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Image.CreateModeInvalid', 'message' => 'The creation mode of this task is invalid.', 'http_code' => 400, 'description' => 'The creation mode of this task is invalid.'],
+ ['code' => 'Image.NotExist', 'message' => 'The image does not exist.', 'http_code' => 400, 'description' => 'The image does not exist.'],
+ ['code' => 'ImageCreateByInstance.TaskExist', 'message' => 'The image task of instance creation already exists.', 'http_code' => 400, 'description' => 'The image task of instance creation already exists.'],
+ ['code' => 'ImageDeleteFailed.HasSharedImage', 'message' => 'The shared image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllow', 'message' => 'The image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllowCommunityParent', 'message' => 'The parent image of a community image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The parent image of a community image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllowSharedImage', 'message' => 'The shared image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be deleted.'],
+ ['code' => 'ImageDistribute.ImageNotSupport', 'message' => 'The image does not support region distribution.', 'http_code' => 400, 'description' => 'The image does not support region distribution. E.g. encrypted images.'],
+ ['code' => 'ImageDistribute.RepeatedDistribution', 'message' => 'This image has been distributed to this region.', 'http_code' => 400, 'description' => 'This image has been distributed to this region.'],
+ ['code' => 'ImageDistribute.TargetDistributeRegionListEmpty', 'message' => 'The target distribution region list is empty.', 'http_code' => 400, 'description' => 'The target distribution region list is empty.'],
+ ['code' => 'ImageDistribute.Undistributed', 'message' => 'The image has not been distributed to any region.', 'http_code' => 400, 'description' => 'The image has not been distributed to any region.'],
+ ['code' => 'ImageIsNull', 'message' => 'The image does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ImageNotAllowDelete', 'message' => 'The image cannot be deleted, because shared cloud computers already exist.', 'http_code' => 400, 'description' => 'The image cannot be deleted, because shared cloud computers already exist.'],
+ ['code' => 'ImageRegion.NotConfigured', 'message' => 'The image does not have any region configuration.', 'http_code' => 400, 'description' => 'The image does not have any region configuration.'],
+ ['code' => 'ImageRegionDistribute.NotAllow', 'message' => 'This image cannot be distributed.', 'http_code' => 400, 'description' => 'This image cannot be distributed.'],
+ ['code' => 'ImageStatus.Error', 'message' => 'The image status is error.', 'http_code' => 400, 'description' => 'The image status is error.'],
+ ['code' => 'ImageStatus.ValueNotSupported', 'message' => 'The image status is not supported for creating a delivery group.', 'http_code' => 400, 'description' => 'You cannot create a delivery group in the current image status.'],
+ ['code' => 'ImageTask.Failed', 'message' => 'Start image task failed.', 'http_code' => 400, 'description' => 'Failed to start the image task.'],
+ ['code' => 'ImageUpdateFailed.NotAllow', 'message' => 'The image is not allowed to be modified.', 'http_code' => 400, 'description' => 'The image is not allowed to be modified.'],
+ ['code' => 'ImageUpdateSharedImageFailed.NotAllow', 'message' => 'The shared image is not allowed to be modified.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be modified.'],
+ ['code' => 'Instance.ImageUnsupported', 'message' => 'A non-centralized image does not support this type of operation.', 'http_code' => 400, 'description' => 'A non-centralized image does not support this type of operation.'],
+ ['code' => 'Instance.NotFound', 'message' => 'The instance is not found.', 'http_code' => 400, 'description' => 'The instance is not found.'],
+ ['code' => 'Instance.PhysicalNodeNotExist', 'message' => 'The instance physical node does not exist.', 'http_code' => 400, 'description' => 'The physical node of this instance does not exist.'],
+ ['code' => 'InternalError', 'message' => 'Internal error.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InternalError.TicketGenInternalError', 'message' => 'An error occurred while generating a ticket.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAliUid.Missing', 'message' => 'The AliUid is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAliUid.Missing', 'message' => 'The specified parameter AliUid is missing.', 'http_code' => 400, 'description' => 'The specified parameter AliUid is missing.'],
+ ['code' => 'InvalidAliUid.NotFound', 'message' => 'The AliUid is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAmount.Invalid', 'message' => 'The Amount is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.Missing', 'message' => 'The AppId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.NotFound', 'message' => 'The AppId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotContainThisAPP', 'message' => 'The app instance group does not contain this app.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotFound', 'message' => 'The app instance group is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotFound', 'message' => 'The AppInstanceGroupId %s is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NullAppInstanceGroup', 'message' => 'The app instance group is null.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NullOrNotPublishedStatus', 'message' => 'The app instance group does not exist or is not published.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.StatusInvalid', 'message' => 'The app instance group status is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.Unauthorized', 'message' => 'Unauthorized to use this app.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupAction.IllegalAction', 'message' => 'The action against the app instance group is not allowed.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupId.Missing', 'message' => 'The AppInstanceGroupId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupName.Missing', 'message' => 'The AppInstanceGroupName is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupSpecItem.NotFound', 'message' => 'The app instance group spec item is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceId.NotFound', 'message' => 'The AppInstanceId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceState', 'message' => 'The app instance state is invalid.', 'http_code' => 200, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.Invalid', 'message' => 'The AppInstanceType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.Missing', 'message' => 'The AppInstanceType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.NotFound', 'message' => 'The app instance type is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppVersion.Missing', 'message' => 'The AppVersion is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBaseImage.InvalidStatus', 'message' => 'Invalid base image status.', 'http_code' => 400, 'description' => 'The status of the base image is invalid.'],
+ ['code' => 'InvalidBaseImage.NotConfigured', 'message' => 'Configuration required for Vhd/Container images.', 'http_code' => 400, 'description' => 'Configuration required for Vhd/Container images.'],
+ ['code' => 'InvalidBaseImage.NotFound', 'message' => 'Base image not found.', 'http_code' => 400, 'description' => 'The base image is not found.'],
+ ['code' => 'InvalidBaseImage.NotSystemImage', 'message' => 'Base image is not system image.', 'http_code' => 400, 'description' => 'The base image is not a system image.'],
+ ['code' => 'InvalidBaseImageVersion.NotOnline', 'message' => 'Base image version is not online.', 'http_code' => 400, 'description' => 'The base image is not of an available online version.'],
+ ['code' => 'InvalidBindRelationship.NotFound', 'message' => 'The bind relationship is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBindStage.Missing', 'message' => 'The BindStage is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBindStrategy.NotFound', 'message' => 'The bind strategy is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBizType', 'message' => 'The bizType parameter is invalid.', 'http_code' => 400, 'description' => 'The bizType parameter is invalid.'],
+ ['code' => 'InvalidBrowserInstanceGroup.NotFound', 'message' => 'The browser instance group is not found.', 'http_code' => 400, 'description' => 'The cloud browser does not exist, please confirm and try again'],
+ ['code' => 'InvalidBundle.NotFound', 'message' => 'The request bundle does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidChargeType.Missing', 'message' => 'The ChargeType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidChargeType.ValueNotSupported', 'message' => 'The ChargeType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDataDiskSize.SmallerThanParent', 'message' => 'Sub-image data disk size is smaller than the parent image.', 'http_code' => 400, 'description' => 'Sub-image data disk size is smaller than the parent image.'],
+ ['code' => 'InvalidDomainId.NotFound', 'message' => 'The DomainId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDriveId.NotFound', 'message' => 'The DriveId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidEndUserId.Missing', 'message' => 'The EndUserId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidEndUserIds.ValueNotSupported', 'message' => 'The EndUserIds is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidExternalFileId.NotFound', 'message' => 'The ExternalFileId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwAddress.NotFound', 'message' => 'The gateway address is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwParam.NotFound', 'message' => 'A parameter error occurred while generating the gateway token.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwToken.ValueTooLong', 'message' => 'The GWToken is too long.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidImageConfig.RegionInvalid', 'message' => 'The region configuration of this image is invalid.', 'http_code' => 400, 'description' => 'The region configuration of this image is invalid.'],
+ ['code' => 'InvalidImageId.Invalid', 'message' => 'The specified parameter imageId is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidImageOperation.Failed', 'message' => 'Invalid image operation.', 'http_code' => 400, 'description' => 'Image operation failed.'],
+ ['code' => 'InvalidImageOperation.ImageIsCreating', 'message' => 'Failed to operation the image, it is creating.', 'http_code' => 400, 'description' => 'Failed to operation the image, it is creating.'],
+ ['code' => 'InvalidImagePackageType.Unsupported', 'message' => 'Unsupported image package type.', 'http_code' => 400, 'description' => 'This package type is not supported.'],
+ ['code' => 'InvalidInstanceId.Missing', 'message' => 'The InstanceId is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidLoginToken.Missing', 'message' => 'The LoginToken is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNextToken', 'message' => 'The NextToken is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNodeInstanceType.NotFound', 'message' => 'The node instance type is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNodeInstanceType.NotSupportOsType', 'message' => 'The node instance type does not support images with this OS type.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrder.CommodityCodeNotMatch', 'message' => 'No CommodityCode matches this order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrder.CommodityCodeNotMatch', 'message' => 'No commodityCode matched for this order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrderId.NotFound', 'message' => 'The order is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrderId.NotFound', 'message' => 'The specified order is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOsType.ValueNotSupported', 'message' => 'The operation system type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.%s', 'message' => 'The parameter %s is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.AddAccount/RemoveAccount', 'message' => 'The tenant ID to be added or removed is invalid.', 'http_code' => 400, 'description' => 'The tenant ID to be added or removed is invalid.'],
+ ['code' => 'InvalidParameter.ImageId', 'message' => 'The image ID is invalid.', 'http_code' => 400, 'description' => 'The image ID is invalid.'],
+ ['code' => 'InvalidParameter.SystemDiskSize', 'message' => 'The system disk size is invalid.', 'http_code' => 400, 'description' => 'The system disk size is invalid.'],
+ ['code' => 'InvalidParentImage.AlreadyHasCommunityImage', 'message' => 'The parent image already has a community image.', 'http_code' => 400, 'description' => 'This image cannot be published to the community because it is already published.'],
+ ['code' => 'InvalidParentImage.ImageTypeIsNotUserImage', 'message' => 'Invalid operation. The parent image is not a user image.', 'http_code' => 400, 'description' => 'Invalid operation. The parent image is not a user image.'],
+ ['code' => 'InvalidParentImage.InvalidStatus', 'message' => 'Invalid parent image status.', 'http_code' => 400, 'description' => 'The status of the parent image is invalid.'],
+ ['code' => 'InvalidParentImage.NotFound', 'message' => 'Parent image not found.', 'http_code' => 400, 'description' => 'The parent image is not found.'],
+ ['code' => 'InvalidPeriod.Invalid', 'message' => 'The Period is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriod.Missing', 'message' => 'The Period is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriodUnit.Missing', 'message' => 'The PeriodUnit is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriodUnit.ValueNotSupported', 'message' => 'The PeriodUnit is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.Invalid', 'message' => 'The ProductType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.Missing', 'message' => 'The ProductType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.ValueNotSupported', 'message' => 'The ProductType is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.ConfigError', 'message' => 'The region configuration is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.Missing', 'message' => 'The Region is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.NotFound', 'message' => 'The region is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.NotMatch', 'message' => 'The region does not match the current environment.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegionBind.NotFound', 'message' => 'The AppRegionBind is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegionId.NotFound', 'message' => 'The RegionId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidResourcePool.NotFound', 'message' => 'The resource pool is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidResponse.Missing', 'message' => 'The response body is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSessionId.Missing', 'message' => 'The SessionId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSourceImage.ImageTypeCannotBeShared', 'message' => 'Source image cannot be shared.', 'http_code' => 400, 'description' => 'This type of source image cannot be shared.'],
+ ['code' => 'InvalidSourceImage.StatusNotAvailable', 'message' => 'Invalid source image status.', 'http_code' => 400, 'description' => 'The status of the source image is invalid.'],
+ ['code' => 'InvalidSpecId.Missing', 'message' => 'The SpecId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStorageType.NotFound', 'message' => 'The StorageType is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.ChargeTypeNotSupported', 'message' => 'The charge type is not supported for the given strategy.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Invalid', 'message' => 'The StrategyConfig is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Invalid', 'message' => 'The policy configuration is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Missing', 'message' => 'The StrategyConfig is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.NotFound', 'message' => 'The StrategyConfig is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyParam.Invalid', 'message' => 'The StrategyParam is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyType.ValueNotSupported', 'message' => 'The strategy type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyType.ValueNotSupported', 'message' => 'The policy type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSubAppType.ValueNotSupported', 'message' => 'The sub-category of the app is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSystemDiskSize.SmallerThanParent', 'message' => 'Sub-image system disk size is smaller than the parent image.', 'http_code' => 400, 'description' => 'Sub-image system disk size is smaller than the parent image.'],
+ ['code' => 'InvalidTargetAliUid.TargetShareImageAlreadyExist', 'message' => 'Target shared image already exists.', 'http_code' => 400, 'description' => 'The target shared image already exists.'],
+ ['code' => 'InvalidTaskId.NotFound', 'message' => 'The TaskId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidTemplate.NotFound', 'message' => 'Template not found.', 'http_code' => 400, 'description' => 'The template is not found.'],
+ ['code' => 'InvalidUserId.NotFound', 'message' => 'The UserId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'LogOffAllSession.Failed', 'message' => 'Failed to log off all sessions in the delivery group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter', 'message' => 'There is a missing parameter.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter.AppIdAndAppVersion', 'message' => 'The AppId and AppVersion are missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter.RegionId', 'message' => 'The RegionId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'nvalidStrategyConfig.NotFound', 'message' => 'The policy configuration is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OperationDenied.NoStock', 'message' => 'The operation is denied, because the instance stock is unavailable.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.Canceled', 'message' => 'The task has been cancelled.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.NotFound', 'message' => 'The ota task is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.Running', 'message' => 'The task is running and cannot be sumitted.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTaskNotifyRegion.Error', 'message' => 'The unit manager failed to receive the OTA upgrade job.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParentImage.NotExist', 'message' => 'The parent image does not exist.', 'http_code' => 400, 'description' => 'The parent image does not exist.'],
+ ['code' => 'ParentImageRegionDistribute.NotExist', 'message' => 'The target distribution region of the parent image does not exist.', 'http_code' => 400, 'description' => 'The target distribution region of the parent image does not exist.'],
+ ['code' => 'ProductTypeInvalid', 'message' => 'The ProductType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ProductTypeNotMatch', 'message' => 'The productType and image do not match.', 'http_code' => 400, 'description' => 'The productType and image do not match.'],
+ ['code' => 'QueryTemplate.Failed', 'message' => 'Query template failed.', 'http_code' => 400, 'description' => 'Failed to query the template.'],
+ ['code' => 'RegionUnBind.Fail', 'message' => 'Failed to unbind.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ServiceUnavailable', 'message' => 'Service unavailable. Please try again later.', 'http_code' => 500, 'description' => 'Service unavailable. Please try again later.'],
+ ['code' => 'StockError.InvalidResourceRequest', 'message' => 'Your request cannot be processed currently due to an error. Please try again later.', 'http_code' => 500, 'description' => 'The inventory check failed and the system is temporarily unable to process your request. Please try again later.'],
+ ['code' => 'StockError.NoStock', 'message' => 'The selected specification is out of stock. Please try again later or select other specifications.', 'http_code' => 400, 'description' => 'The selected specification is out of stock. Please try again later or select other specifications.'],
+ ['code' => 'StorageLock.Exist', 'message' => 'The storage lock exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLock.NotFound', 'message' => 'The storage lock is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockProperties.NotMatch', 'message' => 'The storage lock properties do not match.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockUnitResponse.Empty', 'message' => 'The storage lock unit is found empty.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockUnlockLevel.Error', 'message' => 'An unlock level error occurred while unlocking the storage lock.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Task.ResourceReleased', 'message' => 'Cannot retry because task resource is released.', 'http_code' => 400, 'description' => 'Cannot retry because the resource for builder task is released.'],
+ ['code' => 'TaskType.Invalid', 'message' => 'Invalid task type.', 'http_code' => 400, 'description' => 'Invalid task type.'],
+ ['code' => 'TryBind.AppRegionBindLockFailed', 'message' => 'Failed to lock the app and region bind.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoBindContext', 'message' => 'Failed to bind, because there is no bind context.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoCandidateAppInstanceGroup', 'message' => 'Failed to bind, because there is no candidate app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoSupportedApp', 'message' => 'Failed to bind, because there is no supported app for this file extension.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.BindExistingAppInstanceFail', 'message' => 'Failed to bind existing app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.NoCandidateAppInstance', 'message' => 'Failed to bind, because there is no candidate app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.NoIdleAppInstance', 'message' => 'Failed to bind, because there is no idle app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.TicketIsNull', 'message' => 'Failed to bind, because a null ticket is returned.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'UpdateImage.Failed', 'message' => 'Failed to update the image.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'UpdateRegion.NotSupport', 'message' => 'The distributed regions of vhd or container images cannot be modified.', 'http_code' => 400, 'description' => 'The distributed regions of vhd or container images cannot be modified.'],
+ ['code' => 'UserIdentifier.NotFound', 'message' => 'This username does not exist. Please check if it is correct.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAuthCode'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExpireLoginToken'],
],
],
+ 'ram' => [
+ 'productCode' => 'AppStreaming',
+ 'productName' => 'App Streaming',
+ 'ramCodes' => ['appstreaming', 'ecd'],
+ 'ramLevel' => 'SERVICE',
+ 'ramConditions' => [],
+ 'ramActions' => [],
+ 'resourceTypes' => [],
+ ],
];
diff --git a/data/en_us/appstream-center/2021-02-20/api-docs.php b/data/en_us/appstream-center/2021-02-20/api-docs.php
index fa51258..06c5ba2 100644
--- a/data/en_us/appstream-center/2021-02-20/api-docs.php
+++ b/data/en_us/appstream-center/2021-02-20/api-docs.php
@@ -1,22 +1,11 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'appstream-center',
- 'version' => '2021-02-20',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'appstream-center', 'version' => '2021-02-20'],
'directories' => [
[
- 'id' => 349018,
- 'title' => null,
+ 'children' => ['ClientUserLogout', 'GetLoginToken', 'RefreshLoginToken', 'GetStsToken', 'FindIdpListByLoginIdentifier'],
'type' => 'directory',
- 'children' => [
- 'ClientUserLogout',
- 'GetLoginToken',
- 'RefreshLoginToken',
- 'GetStsToken',
- 'FindIdpListByLoginIdentifier',
- ],
+ 'title' => 'Client logon authentication',
],
],
'components' => [
@@ -24,109 +13,279 @@
],
'apis' => [
'ClientUserLogout' => [
- 'summary' => '终端用户登出',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'LoginToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v22369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70****',
- ],
+ 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => false, 'example' => 'v22369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70****', 'title' => ''],
],
[
'name' => 'SessionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '597e869d-ea14-4b83-9490-714f68****',
- ],
+ 'schema' => ['description' => 'Session ID for the login.', 'type' => 'string', 'required' => false, 'example' => '597e869d-ea14-4b83-9490-714f68****', 'title' => ''],
],
[
'name' => 'ClientId',
'in' => 'query',
+ 'schema' => ['description' => 'Client ID.', 'type' => 'string', 'required' => false, 'example' => 'eac19bef-1e45-4190-a03a-4ea74b****', 'title' => ''],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Office network ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong+dir-643067****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ProfileRegion',
+ 'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Site to which the account belongs.',
+ 'enumValueTitles' => ['ap_southeast_1' => 'Alibaba Cloud International Website (www\\.alibabacloud.com)', 'cn_hangzhou' => 'China site'],
'type' => 'string',
'required' => false,
- 'example' => 'eac19bef-1e45-4190-a03a-4ea74b****',
+ 'example' => 'cn_hangzhou',
+ 'title' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Response data structure.',
+ 'title' => 'Schema of Response ',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request ', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Client logoff ',
+ 'summary' => 'Log out the client and destroy the login credentials.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'FindIdpListByLoginIdentifier' => [
+ 'summary' => 'Allows a client to query login configuration for an office network or an enterprise identifier.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'OfficeSiteId',
- 'in' => 'query',
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '140090',
+ 'abilityTreeNodes' => ['FEATUREappstreamingV87T4P'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClientId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The unique ID of the client.', 'type' => 'string', 'required' => false, 'example' => '370b56f8-2812-4b6c-bfa6-2560791c****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientOS',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The client operating system.', 'type' => 'string', 'required' => false, 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientVersion',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The version of the client application.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-D-20211008.101607', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientChannel',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A custom identifier that distinguishes different client applications.', 'type' => 'string', 'required' => false, 'example' => 'pc', 'title' => ''],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The unique identifier of the client. For the Wuying Client, find this parameter in the About dialog box on the login screen.', 'type' => 'string', 'required' => false, 'example' => '2943802884B27030B6759F9132B2****', 'title' => ''],
+ ],
+ [
+ 'name' => 'LoginIdentifier',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The enterprise identifier.', 'type' => 'string', 'required' => true, 'example' => 'Aliyun123***', 'title' => ''],
+ ],
+ [
+ 'name' => 'SupportTypes',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The supported login types.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The supported login type.',
+ 'enumValueTitles' => ['ad' => 'AD domain account', 'simple' => 'simple account'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ad',
+ 'title' => '',
+ ],
'required' => false,
- 'example' => 'cn-hongkong+dir-643067****',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ProfileRegion',
+ 'name' => 'AvailableFeatures',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ap_southeast_1' => '',
- 'cn_hangzhou' => '',
+ 'description' => 'The features supported by the client.',
+ 'additionalProperties' => [
+ 'description' => 'The feature supported by the client.',
+ 'enumValueTitles' => ['Business' => 'Support for the Business Edition'],
+ 'type' => 'string',
+ 'example' => '{\\"Business\\":\\"1\\"}',
+ 'title' => '',
],
- 'example' => 'cn_hangzhou',
+ 'type' => 'object',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'ClientIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client IP address.', 'type' => 'string', 'required' => false, 'example' => '22.21.XX.XX', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response body.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'AD2D0761-1FE5-549D-B169-D3F8D19C****'],
+ 'IdpInfos' => [
+ 'description' => 'The identity provider (IdP) details.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'IdpId' => ['description' => 'The ID of the identity provider (IdP) configuration.', 'type' => 'string', 'example' => 'idp-hlyexfvwert9m8****', 'title' => ''],
+ 'IdpName' => ['description' => 'The name of the identity provider.', 'type' => 'string', 'example' => 'DingTalk', 'title' => ''],
+ 'SsoProtocol' => [
+ 'description' => 'The SSO protocol.',
+ 'enumValueTitles' => ['OAuth2' => 'The OAuth2 protocol.', 'SAML' => 'The SAML protocol.', 'OIDC' => 'The OIDC protocol.'],
+ 'type' => 'string',
+ 'example' => 'SAML',
+ 'title' => '',
+ ],
+ 'IdpProvider' => ['description' => 'The type or service of the identity provider.', 'type' => 'string', 'example' => 'DingTalk', 'title' => ''],
+ 'SsoServiceUrl' => ['description' => 'The SSO service URL.', 'type' => 'string', 'example' => 'https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso', 'title' => ''],
+ 'Cookies' => ['description' => 'For cookie-based single sign-on (SSO), specifies the cookies that the client must set.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'AccountType' => [
+ 'description' => 'The account type.',
+ 'enumValueTitles' => ['ad' => 'AD domain account', 'simple' => 'simple account'],
+ 'type' => 'string',
+ 'example' => 'simple',
+ 'title' => '',
+ ],
+ 'JumpSwitch' => ['description' => 'Indicates whether to redirect to a browser for sign-in.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'IdpNameEN' => ['description' => 'The English name of the identity provider (IdP).', 'type' => 'string', 'example' => 'wy-simple', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OfficeSiteInfo' => [
+ 'description' => 'The office site details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OfficeSiteId' => ['description' => 'The office site ID.', 'type' => 'string', 'example' => 'cn-shanghai+dir-448204****', 'title' => ''],
+ 'SsoServiceUrl' => ['description' => 'The SSO service URL.', 'type' => 'string', 'example' => 'https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'AccessType' => [
+ 'description' => 'The allowed client network connection types.',
+ 'enumValueTitles' => ['INTERNET' => 'internet access', 'VPC' => 'VPC access', 'ANY' => 'Both internet access and VPC access are allowed.'],
+ 'type' => 'string',
+ 'example' => 'INTERNET',
+ 'title' => '',
+ ],
+ 'ProviderId' => ['description' => 'The business ID (BID) of the account.', 'type' => 'string', 'example' => '26842', 'title' => ''],
+ 'PreferVpcAccess' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'VpcAccessAddress' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TenantAliasInfo' => [
+ 'description' => 'The tenant alias details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TenantAlias' => ['description' => 'The tenant alias.', 'type' => 'string', 'example' => 'Or09****', 'title' => ''],
+ 'AccessType' => [
+ 'description' => 'The allowed client network connection types.',
+ 'enumValueTitles' => ['INTERNET' => 'internet access', 'VPC' => 'VPC access', 'ANY' => 'Both internet access and VPC access are allowed.'],
+ 'type' => 'string',
+ 'example' => 'INTERNET',
+ 'title' => '',
+ ],
+ 'PreferVpcAccess' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'VpcAccessAddress' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'IsLoginByCipherParam' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ProfileRegion' => [
+ 'description' => 'The site where the account is located.',
+ 'enumValueTitles' => ['ap_southeast_1' => 'international site', 'cn_hangzhou' => 'china site'],
'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'example' => 'cn_hangzhou',
+ 'title' => '',
+ ],
+ 'PopRegionConfig' => [
+ 'description' => 'The central service endpoint, used for high availability.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The login service URL for the specified region.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ 'title' => 'Query logon configuration',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169-D3F8D19C****\\",\\n \\"IdpInfos\\": [\\n {\\n \\"IdpId\\": \\"idp-hlyexfvwert9m8****\\",\\n \\"IdpName\\": \\"DingTalk\\",\\n \\"SsoProtocol\\": \\"SAML\\",\\n \\"IdpProvider\\": \\"DingTalk\\",\\n \\"SsoServiceUrl\\": \\"https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso\\",\\n \\"Cookies\\": \\"null\\",\\n \\"AccountType\\": \\"simple\\",\\n \\"JumpSwitch\\": \\"true\\",\\n \\"IdpNameEN\\": \\"wy-simple\\"\\n }\\n ],\\n \\"OfficeSiteInfo\\": {\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-448204****\\",\\n \\"SsoServiceUrl\\": \\"https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"ProviderId\\": \\"26842\\",\\n \\"PreferVpcAccess\\": false,\\n \\"VpcAccessAddress\\": \\"\\"\\n },\\n \\"TenantAliasInfo\\": {\\n \\"TenantAlias\\": \\"Or09****\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"PreferVpcAccess\\": false,\\n \\"VpcAccessAddress\\": \\"\\",\\n \\"IsLoginByCipherParam\\": \\"\\"\\n },\\n \\"ProfileRegion\\": \\"cn_hangzhou\\",\\n \\"PopRegionConfig\\": {\\n \\"key\\": \\"cn-shanghai\\"\\n }\\n}","type":"json"}]',
],
'GetLoginToken' => [
- 'summary' => 'Queries a logon token using an enterprise identifier.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
@@ -139,1198 +298,835 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '125244',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingV87T4P',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingV87T4P'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''],
],
[
'name' => 'ClientId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '05967f80-6f51-46cb-a27c-****',
- ],
+ 'schema' => ['description' => 'A unique identifier generated by the client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '05967f80-6f51-46cb-a27c-****', 'title' => ''],
],
[
'name' => 'DirectoryId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'cn-beijing+dir-j9dd****',
- ],
+ 'schema' => ['description' => 'The ID of the office network. This parameter has the same meaning as `OfficeSiteId`. We recommend that you use `OfficeSiteId` instead of `DirectoryId`. You can specify `DirectoryId` or `OfficeSiteId`, but not both.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-beijing+dir-j9dd****', 'title' => ''],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'cn-beijing+dir-j9dd****',
- ],
+ 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-beijing+dir-j9dd****', 'title' => ''],
],
[
'name' => 'SessionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'c6f3cd91-65fc-4c7b-b189-2a73da0****',
- ],
+ 'schema' => ['description' => 'The login session ID.'."\n"
+ ."\n"
+ .'This parameter is not required if a virtual MFA device is not bound or secondary client authentication is disabled. If a virtual MFA device is bound or secondary client authentication is enabled, you must specify this parameter in authentication stages that occur after the `ADPassword` stage. You can obtain the session ID from the response returned for convenience account verification (that is, when the `GetLoginToken` request is in the `ADPassword` stage).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'c6f3cd91-65fc-4c7b-b189-2a73da0****', 'title' => ''],
],
[
'name' => 'CurrentStage',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'SsoTokenLogin',
- ],
+ 'schema' => ['description' => 'The current stage of the login authentication process. The following stages are available in sequence:'."\n"
+ ."\n"
+ .'1. `ADPassword`: Verifies user information. Specify this value for password-based authentication by using a convenience account or an AD account.'."\n"
+ ."\n"
+ .'2. `MFABind`: Binds a virtual MFA device.'."\n"
+ ."\n"
+ .'3. `MFAVerify`: Verifies the security code generated by the virtual MFA device.'."\n"
+ ."\n"
+ .'4. `TokenVerify`: Performs secondary client authentication.'."\n"
+ ."\n"
+ .'5. `ChangePassword`: Changes the user password.'."\n"
+ ."\n"
+ .'6. `KeepAliveVerify`: Exchanges a valid `KeepAliveToken` for a new login token.'."\n"
+ ."\n"
+ .'7. `PhoneVerifyTenantSelect`: Selects a corporate identifier to log in with during phone-based authentication.'."\n"
+ ."\n"
+ .'8. `VerifyForRisk`: Performs identity verification after a login risk is detected.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'SsoTokenLogin', 'title' => ''],
],
[
'name' => 'EndUserId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'user01',
- ],
+ 'schema' => ['description' => 'The username of the convenience account or AD account. This parameter is required if `CurrentStage` is set to `ADPassword`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'user01', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'Admin@1234****',
- 'maxLength' => 500,
- 'minLength' => 1,
- ],
+ 'schema' => ['description' => 'The password for the convenience account or AD account. This parameter is required if `CurrentStage` is set to `ADPassword`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maxLength' => 500, 'minLength' => 1, 'example' => 'Admin@1234****', 'title' => ''],
],
[
'name' => 'EncryptedPassword',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '04d7****8e90bb0484fc;gJ1GLca1vQRRqQbRvByU0A==;5kOWZE7AtbQhki+4LAo69A==',
- ],
+ 'schema' => ['description' => 'The encrypted password.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '04d7****8e90bb0484fc;gJ1GLca1vQRRqQbRvByU0A==;5kOWZE7AtbQhki+4LAo69A==', 'title' => ''],
],
[
'name' => 'OldPassword',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'Admin@1234****'."\n",
- ],
+ 'schema' => ['description' => 'The old password. This parameter is required if `CurrentStage` is set to `ChangePassword`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Admin@1234****'."\n", 'title' => ''],
],
[
'name' => 'NewPassword',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'Admin@1234****'."\n",
- ],
+ 'schema' => ['description' => 'The new password. This parameter is required if `CurrentStage` is set to `ChangePassword`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Admin@1234****'."\n", 'title' => ''],
],
[
'name' => 'AuthenticationCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '182901',
- ],
+ 'schema' => ['description' => 'The security code generated by the virtual MFA device. This parameter is required if `CurrentStage` is set to `MFAVerify`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '182901', 'title' => ''],
],
[
'name' => 'SsoSessionToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '04d707a6-fb23-44a7-aae7-8e90****',
- ],
+ 'schema' => ['description' => 'The token used for SSO authentication.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '04d707a6-fb23-44a7-aae7-8e90****', 'title' => ''],
],
[
'name' => 'ClientOS',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 22631)',
- ],
+ 'schema' => ['description' => 'The client operating system.', 'type' => 'string', 'required' => false, 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 22631)', 'title' => ''],
],
[
'name' => 'ClientVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7.3.0-20240619.143924',
- ],
+ 'schema' => ['description' => 'The client version.', 'type' => 'string', 'required' => false, 'example' => '7.3.0-20240619.143924', 'title' => ''],
],
[
'name' => 'TokenCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '1234***',
- ],
+ 'schema' => ['description' => 'If secondary client authentication is enabled in the Elastic Desktop Service Enterprise Edition console and a login risk is detected for the user, the system sends a secondary authentication verification code to the user\'s email. This parameter is required if `CurrentStage` is set to `TokenVerify`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1234***', 'title' => ''],
],
[
'name' => 'UmidToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '04d707a6-fb23-44a7-aae7-8e90bb04****',
- ],
+ 'schema' => ['description' => 'A token that you provide to ensure the request is idempotent.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '04d707a6-fb23-44a7-aae7-8e90bb04****', 'title' => ''],
],
[
'name' => 'FingerPrintData',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => 'The fingerprint information. This parameter is not currently supported.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
[
'name' => 'KeepAlive',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to stay logged in.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'KeepAliveToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '00ugamMAoO1+u1MlhmgCeZJ75q094x3H/4kg7ZaTI3f/joVTVPIpJgfv9JFkPLNxnQjblrvsByNas08mc6FtVWvQPOE68fqmt6QMM4UbRtahm8luxEXvicF58qSPXW1hxOtV/Ev6d92VBz2Bck/N4CYyjD0iLocfN8jkBnt231****',
- ],
+ 'schema' => ['description' => 'The token used to stay logged in. If a user successfully logs on and chooses to stay logged in, the API returns a `KeepAliveToken`. While this token is valid, you can call the `GetLoginToken` operation and set `CurrentStage` to `KeepAliveVerify` to obtain a new login token (`LoginToken`). This parameter is required if `CurrentStage` is set to `KeepAliveVerify`.', 'type' => 'string', 'required' => false, 'example' => '00ugamMAoO1+u1MlhmgCeZJ75q094x3H/4kg7ZaTI3f/joVTVPIpJgfv9JFkPLNxnQjblrvsByNas08mc6FtVWvQPOE68fqmt6QMM4UbRtahm8luxEXvicF58qSPXW1hxOtV/Ev6d92VBz2Bck/N4CYyjD0iLocfN8jkBnt231****', 'title' => ''],
],
[
'name' => 'Uuid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'C50973691A6D2BE23F2CDD73B85B****',
- ],
+ 'schema' => ['description' => 'A unique identifier for the client. If you use the Elastic Desktop Service client, you can find this value in the About dialog box on the logon screen.', 'type' => 'string', 'required' => false, 'example' => 'C50973691A6D2BE23F2CDD73B85B****', 'title' => ''],
],
[
'name' => 'ImageUrl',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => 'The image URL.'."\n"
+ ."\n"
+ .'> This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
[
'name' => 'EncryptedFingerPrintData',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => 'The fingerprint information.'."\n"
+ ."\n"
+ .'> This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
[
'name' => 'EncryptedKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4d7****8e90bb0484fc',
- ],
+ 'schema' => ['description' => 'The encrypted key ID.', 'type' => 'string', 'required' => false, 'example' => '4d7****8e90bb0484fc', 'title' => ''],
],
[
'name' => 'ClientType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows',
- ],
+ 'schema' => ['description' => 'The client type.', 'type' => 'string', 'required' => false, 'example' => 'windows', 'title' => ''],
],
[
'name' => 'SsoExtendsCookies',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => 'The cookie for SSO sign-in, used to enable password-free sign-in within applications.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
[
'name' => 'LoginName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
[
'name' => 'LoginIdentifier',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Fe04****',
- ],
+ 'schema' => ['description' => 'The corporate identifier.', 'type' => 'string', 'required' => false, 'example' => 'Fe04****', 'title' => ''],
],
[
'name' => 'IdpId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'idp-iwntrlbb98q7v****',
- ],
+ 'schema' => ['description' => 'The logon authentication service ID. You can obtain this ID by calling the [`FindIdpListByLoginIdentifier`](~~FindIdpListByLoginIdentifier~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'idp-iwntrlbb98q7v****', 'title' => ''],
],
[
'name' => 'NetworkType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The network connection type of the client.',
+ 'enumValueTitles' => ['INTERNET' => 'Internet', 'VPC' => 'VPC'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'INTERNET' => '',
- 'VPC' => '',
- ],
'example' => 'INTERNET',
+ 'title' => '',
],
],
[
'name' => 'Phone',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1822727****',
- ],
+ 'schema' => ['description' => 'The phone number. This parameter is used for phone-based logins.'."\n"
+ ."\n"
+ .'> This feature is not available for accounts on the International site.', 'type' => 'string', 'required' => false, 'example' => '1822727****', 'title' => ''],
],
[
'name' => 'PhoneVerifyCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '321123',
- ],
+ 'schema' => ['description' => 'The phone verification code. This parameter is used for phone-based logins.'."\n"
+ ."\n"
+ .'> This feature is not available for accounts on the International site.', 'type' => 'string', 'required' => false, 'example' => '321123', 'title' => ''],
],
[
'name' => 'AvailableFeatures',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'type' => 'object',
+ 'description' => 'The features supported by the client.',
'additionalProperties' => [
+ 'description' => 'The features supported by the client.',
+ 'enumValueTitles' => ['Business' => 'Supports the Business Edition.'],
'type' => 'string',
+ 'example' => '{\\"Business\\":\\"1\\"}',
+ 'title' => '',
],
+ 'type' => 'object',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'MfaType',
'in' => 'query',
'schema' => [
+ 'description' => 'The MFA verification type.',
+ 'enumValueTitles' => ['TOTP' => 'Authenticator app code', 'PHONE' => 'Phone verification code', 'EMAIL' => 'Email verification code'],
'type' => 'string',
+ 'required' => false,
+ 'example' => 'TOTP',
+ 'title' => '',
],
],
[
'name' => 'ClientName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The client name.', 'type' => 'string', 'required' => false, 'example' => 'HONOR-BRN-HXXB', 'title' => ''],
],
[
'name' => 'ProfileRegion',
'in' => 'query',
'schema' => [
+ 'description' => 'The site to which the tenant belongs.',
+ 'enumValueTitles' => ['ap_southeast_1' => 'International site', 'cn_hangzhou' => 'China site'],
'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn_hangzhou',
+ 'title' => '',
],
],
[
'name' => 'Channel',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'AreaSite',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'CipherEndUserId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'CipherPassword',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'Email' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alice***@aliyun.com',
- ],
- 'Secret' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4JZNSDHDM3T6AZ4G2O5OWXBLLE4P****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EEA72491-B731-53D6-83ED-209769D6****',
- ],
- 'EndUserId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alice',
- ],
- 'LoginToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****',
- ],
- 'NextStage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MFABind',
- ],
- 'QrCodePng' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5OCLLKKOJU5HPBX66H3QCTWY******'."\n",
- ],
- 'Label' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test:wuying'."\n",
- ],
- 'SessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc15c91c-821b-4edd-9af2-6df66cc****',
- ],
- 'Phone' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1826717****',
- ],
- 'TenantId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13747924304****',
- ],
- 'KeepAliveToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIp***',
- ],
- 'Industry' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'edu',
- ],
+ 'Email' => ['description' => 'The user\'s email address. This parameter is returned with the `LoginToken` after a successful sign-in.'."\n"
+ ."\n"
+ .'- For a convenience account, this is the email address specified when the account was created.'."\n"
+ ."\n"
+ .'- For an AD domain account, the email address uses the format `username@<AD domain>`.', 'type' => 'string', 'example' => 'alice***@example.com', 'title' => ''],
+ 'Secret' => ['description' => 'The secret key for binding a virtual MFA device. This parameter is used in the `MFABind` stage.'."\n"
+ ."\n"
+ .'> For details about authentication stages, see the description of the `CurrentStage` request parameter.', 'type' => 'string', 'example' => '4JZNSDHDM3T6AZ4G2O5OWXBLLE4P****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEA72491-B731-53D6-83ED-209769D6****', 'title' => ''],
+ 'EndUserId' => ['description' => 'The username of the convenience account or AD domain account.', 'type' => 'string', 'example' => 'alice', 'title' => ''],
+ 'LoginToken' => ['description' => 'The login token.', 'type' => 'string', 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****', 'title' => ''],
+ 'NextStage' => ['description' => 'The expected next authentication stage. For example, if an administrator enables multi-factor authentication (MFA) in the Elastic Desktop Service Enterprise Edition console, this parameter returns `MFAVerify` after the username and password authentication is successful (that is, after the `ADPassword` stage). This indicates that MFA is required.'."\n"
+ ."\n"
+ .'> For details about authentication stages, see the description of the `CurrentStage` request parameter.', 'type' => 'string', 'example' => 'MFABind', 'title' => ''],
+ 'QrCodePng' => ['description' => 'The Base64-encoded QR code of the secret key used to bind a virtual MFA device. This parameter is returned during the `MFABind` stage and may be empty.'."\n"
+ ."\n"
+ .'> For details about authentication stages, see the description of the `CurrentStage` request parameter.', 'type' => 'string', 'example' => '5OCLLKKOJU5HPBX66H3QCTWY******'."\n", 'title' => ''],
+ 'Label' => ['description' => 'The convenience account attributes. For an AD domain account, this parameter is empty.', 'type' => 'string', 'example' => 'test:wuying'."\n", 'title' => ''],
+ 'SessionId' => ['description' => 'The session ID. This parameter is returned only on the first call to `GetLoginToken` in the same session. If multiple authentication steps are required, you must pass this parameter in subsequent requests.', 'type' => 'string', 'example' => 'cc15c91c-821b-4edd-9af2-6df66cc****', 'title' => ''],
+ 'Phone' => ['description' => 'The phone number of the convenience account. For an AD domain account, this parameter is empty.', 'type' => 'string', 'example' => '1826717****', 'title' => ''],
+ 'TenantId' => ['description' => 'The Alibaba Cloud account ID, used for hardware terminal identification.', 'type' => 'integer', 'format' => 'int64', 'example' => '13747924304****', 'title' => ''],
+ 'KeepAliveToken' => ['description' => 'The token used to keep the user signed in. If a user successfully signs in and enables the \'keep me signed in\' option, the operation returns a `KeepAliveToken`. If this option is not enabled, this parameter is empty.', 'type' => 'string', 'example' => '006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIp***', 'title' => ''],
+ 'Industry' => ['description' => '> This parameter is not available for public use.', 'type' => 'string', 'example' => 'edu', 'title' => ''],
'Props' => [
- 'description' => '',
+ 'description' => '> This parameter is not available for public use.',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '',
- 'example' => '{\'environment\': \'online\', \'sourceClientType\': \'WINDOWS',
- ],
- ],
- 'WyId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0aba1403b337a***',
- ],
- 'VpcRegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-beijing',
- ],
- 'WindowDisplayMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Windowed',
- ],
- 'AccountType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ad',
+ 'additionalProperties' => ['description' => '> This parameter is not available for public use.', 'type' => 'string', 'example' => '{\'environment\': \'online\', \'sourceClientType\': \'WINDOWS', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'WyId' => ['description' => 'The globally unique ID for the user.', 'type' => 'string', 'example' => '0aba1403b337a***', 'title' => ''],
+ 'VpcRegionId' => ['description' => 'The ID of the Virtual Private Cloud (VPC) region. This parameter is used when signing in over a VPC.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
+ 'WindowDisplayMode' => ['description' => '> This parameter is not available for public use.', 'type' => 'string', 'example' => 'Windowed', 'title' => ''],
+ 'AccountType' => ['description' => 'The account type, which can be a convenience account or an AD domain account.', 'type' => 'string', 'example' => 'ad', 'title' => ''],
'TenantInfos' => [
- 'description' => '',
+ 'description' => 'The tenant ID information. When signing in with a phone number, the number may be associated with multiple tenant IDs. In this case, you must set the `CurrentStage` parameter to `PhoneVerifyTenantSelect` and specify a tenant ID to sign in.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The tenant ID information.',
'type' => 'object',
'properties' => [
- 'TenantAlias' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Up830***',
- ],
+ 'TenantAlias' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => 'Up830***', 'title' => ''],
'AccessType' => [
- 'description' => '',
+ 'description' => 'The client\'s network connection type.',
+ 'enumValueTitles' => ['INTERNET' => 'Internet', 'VPC' => 'Virtual Private Cloud (VPC)', 'ANY' => 'All connection types are allowed.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'INTERNET' => '',
- 'VPC' => '',
- 'ANY' => '',
- ],
'example' => 'INTERNET',
+ 'title' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'TenantAlias' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Rq201***',
- ],
- 'AccessType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'INTERNET',
- ],
+ 'TenantAlias' => ['description' => 'The tenant identifier used for sign-in.', 'type' => 'string', 'example' => 'Rq201***', 'title' => ''],
+ 'AccessType' => ['description' => 'The client\'s network connection type.', 'type' => 'string', 'example' => 'INTERNET', 'title' => ''],
'OfficeSites' => [
- 'description' => '',
+ 'description' => 'The office network information for the AD domain, returned after a successful sign-in.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[\'cn-beijing+dir-096920***\', \'cn-shenzhen+dir-2546908***\']',
- ],
- ],
- 'IdpId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'idp-7ttvs4ove8bo5***',
- ],
- 'AdDomain' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easthp***.com',
+ 'items' => ['description' => 'An office network ID associated with the AD domain.', 'type' => 'string', 'example' => '[\'cn-beijing+dir-096920***\', \'cn-shenzhen+dir-2546908***\']', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'IdpId' => ['description' => 'The ID of the identity provider (IdP) configuration associated with the user.', 'type' => 'string', 'example' => 'idp-7ttvs4ove8bo5***', 'title' => ''],
+ 'AdDomain' => ['description' => 'The domain name of the AD-integrated office network.', 'type' => 'string', 'example' => 'easthp***.com', 'title' => ''],
'RiskVerifyInfo' => [
- 'description' => '',
+ 'description' => 'Contains details for login risk detection. If a risk is detected, you must verify the user\'s identity using the returned email address or phone number.'."\n"
+ .'To do this, call the `SendVerifyCode` operation to send a verification code to the provided contact information. Then, call the `GetLoginToken` operation and set the `CurrentStage` parameter to `VerifyForRisk` to complete the identity verification.',
'type' => 'object',
'properties' => [
- 'Email' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ppas***@aliyun.com',
- ],
- 'LastLockDuration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12000',
- ],
- 'Locked' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Phone' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1826717****',
- ],
+ 'Email' => ['description' => 'The email address used for identity verification.', 'type' => 'string', 'example' => 'ppas***@aliyun.com', 'title' => ''],
+ 'LastLockDuration' => ['description' => 'The lockout duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '12000', 'title' => ''],
+ 'Locked' => ['description' => 'Indicates whether the user is locked.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Phone' => ['description' => 'The phone number used for identity verification.', 'type' => 'string', 'example' => '138****1111', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'PasswordStrategy' => [
- 'description' => '',
+ 'description' => 'The password policy.',
'type' => 'object',
'properties' => [
- 'TenantPasswordLength' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
+ 'TenantPasswordLength' => ['description' => 'The required password length.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
'TenantAlternativeChars' => [
- 'description' => '',
+ 'description' => 'The required character types for the password.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The required character types for the password.',
+ 'enumValueTitles' => ['NUMBER' => 'Digits', 'SPECIAL_CHAR' => 'Special characters', 'LOWER_LETTER' => 'Lowercase letters', 'UPPER_LETTER' => 'Uppercase letters'],
'type' => 'string',
- 'enumValueTitles' => [
- 'NUMBER' => '',
- 'SPECIAL_CHAR' => '',
- 'LOWER_LETTER' => '',
- 'UPPER_LETTER' => '',
- ],
'example' => 'UPPER_LETTER',
+ 'title' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'Reason' => [
- 'description' => '',
+ 'description' => 'The reason the sign-in failed.',
+ 'enumValueTitles' => ['ResetPassword' => 'The password has been reset.', 'PasswordExpired' => 'The password has expired and must be changed.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'ResetPassword' => '',
- 'PasswordExpired' => '',
- ],
'example' => 'PasswordExpired',
+ 'title' => '',
],
'MfaTypeList' => [
+ 'description' => 'The available MFA verification types when MFA is triggered.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
+ 'description' => 'The MFA verification type.',
+ 'enumValueTitles' => ['TOTP' => 'TOTP', 'PHONE' => 'phone verification code', 'EMAIL' => 'Email verification code'],
'type' => 'string',
+ 'example' => 'PHONE',
+ 'title' => '',
],
'Stage' => [
+ 'description' => 'The value to use for the `CurrentStage` parameter after you select an MFA type.',
+ 'enumValueTitles' => ['MFAVerifyV1' => 'Perform MFA verification', 'MFABindV1' => 'Bind an MFA device'],
'type' => 'string',
+ 'example' => 'MFABindV1',
+ 'title' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'NickName' => [
- 'type' => 'string',
- ],
+ 'NickName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'title' => 'Obtain Login Credential ',
+ 'summary' => 'Retrieve login credentials using an enterprise identifier.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Email\\": \\"alice***@example.com\\",\\n \\"Secret\\": \\"4JZNSDHDM3T6AZ4G2O5OWXBLLE4P****\\",\\n \\"RequestId\\": \\"EEA72491-B731-53D6-83ED-209769D6****\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"LoginToken\\": \\"v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****\\",\\n \\"NextStage\\": \\"MFABind\\",\\n \\"QrCodePng\\": \\"5OCLLKKOJU5HPBX66H3QCTWY******\\\\n\\",\\n \\"Label\\": \\"test:wuying\\\\n\\",\\n \\"SessionId\\": \\"cc15c91c-821b-4edd-9af2-6df66cc****\\",\\n \\"Phone\\": \\"1826717****\\",\\n \\"TenantId\\": 0,\\n \\"KeepAliveToken\\": \\"006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIp***\\",\\n \\"Industry\\": \\"edu\\",\\n \\"Props\\": {\\n \\"key\\": \\"{\'environment\': \'online\', \'sourceClientType\': \'WINDOWS\\"\\n },\\n \\"WyId\\": \\"0aba1403b337a***\\",\\n \\"VpcRegionId\\": \\"cn-beijing\\",\\n \\"WindowDisplayMode\\": \\"Windowed\\",\\n \\"AccountType\\": \\"ad\\",\\n \\"TenantInfos\\": [\\n {\\n \\"TenantAlias\\": \\"Up830***\\",\\n \\"AccessType\\": \\"INTERNET\\"\\n }\\n ],\\n \\"TenantAlias\\": \\"Rq201***\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"OfficeSites\\": [\\n \\"[\'cn-beijing+dir-096920***\', \'cn-shenzhen+dir-2546908***\']\\"\\n ],\\n \\"IdpId\\": \\"idp-7ttvs4ove8bo5***\\",\\n \\"AdDomain\\": \\"easthp***.com\\",\\n \\"RiskVerifyInfo\\": {\\n \\"Email\\": \\"ppas***@aliyun.com\\",\\n \\"LastLockDuration\\": 12000,\\n \\"Locked\\": true,\\n \\"Phone\\": \\"138****1111\\"\\n },\\n \\"PasswordStrategy\\": {\\n \\"TenantPasswordLength\\": 12,\\n \\"TenantAlternativeChars\\": [\\n \\"UPPER_LETTER\\"\\n ]\\n },\\n \\"Reason\\": \\"PasswordExpired\\",\\n \\"MfaTypeList\\": [\\n {\\n \\"Name\\": \\"PHONE\\",\\n \\"Stage\\": \\"MFABindV1\\"\\n }\\n ],\\n \\"NickName\\": \\"\\"\\n}","type":"json"}]',
- 'title' => 'GetLoginToken',
],
- 'RefreshLoginToken' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetStsToken' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
],
],
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'abilityTreeCode' => '128463',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingV87T4P',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'ClientId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'."\n",
- ],
- ],
- [
- 'name' => 'SessionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => false,
- 'example' => '6442b2fd-ed3e-423a-8e6e-352d26a4****',
- ],
- ],
- [
- 'name' => 'EndUserId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'alice',
- ],
- ],
- [
- 'name' => 'LoginToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'v1046341d8d4e2f05c4aa168196009613594aaf451499bfc75e54699efa7230bc968e1debb1fa4063b01e5d327b467****',
- ],
- ],
- [
- 'name' => 'OfficeSiteId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shenzhen+dir-436909****',
- ],
- ],
- [
- 'name' => 'LoginIdentifier',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Alibaba****',
- ],
- ],
- [
- 'name' => 'ClientType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'html5' => '',
- 'android' => '',
- 'windows' => '',
- 'ios' => '',
- 'macos' => '',
- ],
- 'example' => 'windows',
- ],
- ],
- [
- 'name' => 'Uuid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2943802884B27030B6759F9132B2****',
- ],
- ],
- [
- 'name' => 'ProfileRegion',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '419F31B9-1FDF-5644-ABA3-D00026FA****',
- ],
- 'LoginToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'v12369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70****',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"419F31B9-1FDF-5644-ABA3-D00026FA****\\",\\n \\"LoginToken\\": \\"v12369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70****\\"\\n}","type":"json"}]',
- 'title' => 'RefreshLoginToken',
- 'summary' => 'Refreshes a logon token.',
- ],
- 'GetStsToken' => [
- 'summary' => 'Obtains an STS token.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'Anonymous' => [],
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingV87T4P'],
+ 'autoTest' => false,
+ 'tenantRelevance' => 'publicInformation',
],
- 'deprecated' => false,
- 'systemTags' => [],
'parameters' => [
[
'name' => 'ClientId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eac19bef-1e45-4190-a03a-4ea74b69****',
- ],
+ 'schema' => ['description' => 'The unique ID generated by the client.', 'type' => 'string', 'required' => false, 'example' => 'eac19bef-1e45-4190-a03a-4ea74b69****', 'title' => ''],
],
[
'name' => 'ClientOS',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)',
- ],
+ 'schema' => ['description' => 'The client operating system.', 'type' => 'string', 'required' => false, 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)', 'title' => ''],
],
[
'name' => 'ClientVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6.3.0-R-20231106.210000',
- ],
+ 'schema' => ['description' => 'The client version.', 'type' => 'string', 'required' => false, 'example' => '6.3.0-R-20231106.210000', 'title' => ''],
],
[
'name' => 'ClientIp',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '22.21.2.**',
- ],
+ 'schema' => ['description' => 'The client IP address.', 'type' => 'string', 'required' => false, 'example' => '22.21.2.**', 'title' => ''],
],
[
'name' => 'Uuid',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2943802884B27030B6759F9132B2****',
- ],
+ 'schema' => ['description' => 'The device UUID.', 'type' => 'string', 'required' => false, 'example' => '2943802884B27030B6759F9132B2****', 'title' => ''],
],
[
'name' => 'AuthCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e4e169bea1cc48e8afac53**********',
- ],
+ 'schema' => ['description' => 'The authorization code. This code is valid for 3 minutes and can be used only once, regardless of whether the validation succeeds or fails. If a user generates multiple authorization codes, only the latest one is valid.', 'type' => 'string', 'required' => true, 'example' => 'e4e169bea1cc48e8afac53**********', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CCF92035-6231-5ABB-930E-1E003C32****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CCF92035-6231-5ABB-930E-1E003C32****'],
'StsTokenModel' => [
- 'description' => '',
+ 'description' => 'The temporary security credential details.',
'type' => 'object',
'properties' => [
- 'SessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'be4be09e-cd00-4b4c-add7-11b4d8****',
- ],
- 'StsToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sts****',
- ],
- 'TenantId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '105552640689****',
- ],
+ 'SessionId' => ['description' => 'The login session ID.', 'type' => 'string', 'example' => 'be4be09e-cd00-4b4c-add7-11b4d8****', 'title' => ''],
+ 'StsToken' => ['description' => 'The STS token.', 'type' => 'string', 'example' => 'sts****', 'title' => ''],
+ 'TenantId' => ['description' => 'The tenant ID (Alibaba Cloud account ID).', 'type' => 'integer', 'format' => 'int64', 'example' => '105552640689****', 'title' => ''],
+ 'LoginToken' => ['description' => 'The login token.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'EndUserId' => ['description' => 'The end-user ID.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ProfileRegion' => ['description' => 'The region where the user profile is stored.', 'type' => 'string', 'title' => '', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CCF92035-6231-5ABB-930E-1E003C32****\\",\\n \\"StsTokenModel\\": {\\n \\"SessionId\\": \\"be4be09e-cd00-4b4c-add7-11b4d8****\\",\\n \\"StsToken\\": \\"sts****\\",\\n \\"TenantId\\": 0\\n }\\n}","type":"json"}]',
- 'title' => 'GetStsToken',
- ],
- 'FindIdpListByLoginIdentifier' => [
- 'summary' => 'Queries the information about identity providers by logon identifier.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Obtain temporary identity credentials',
+ 'summary' => 'Gets an STS token (temporary security credential) for Wuying Workspace.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CCF92035-6231-5ABB-930E-1E003C32****\\",\\n \\"StsTokenModel\\": {\\n \\"SessionId\\": \\"be4be09e-cd00-4b4c-add7-11b4d8****\\",\\n \\"StsToken\\": \\"sts****\\",\\n \\"TenantId\\": 0,\\n \\"LoginToken\\": \\"\\",\\n \\"EndUserId\\": \\"\\",\\n \\"ProfileRegion\\": \\"\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'RefreshLoginToken' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
],
],
- 'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'abilityTreeCode' => '140090',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingV87T4P',
- ],
+ 'abilityTreeCode' => '128463',
+ 'abilityTreeNodes' => ['FEATUREappstreamingV87T4P'],
],
'parameters' => [
[
'name' => 'ClientId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '370b56f8-2812-4b6c-bfa6-2560791c****',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unique ID generated by the client. See `UUID`. This parameter is not sensitive and does not require encryption.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'."\n", 'title' => ''],
],
[
- 'name' => 'ClientOS',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)',
- ],
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The login session ID.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '6442b2fd-ed3e-423a-8e6e-352d26a4****', 'title' => ''],
],
[
- 'name' => 'ClientVersion',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2.0.1-D-20211008.101607',
- ],
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'alice', 'title' => ''],
],
[
- 'name' => 'ClientChannel',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pc',
- ],
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The login token.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1046341d8d4e2f05c4aa168196009613594aaf451499bfc75e54699efa7230bc968e1debb1fa4063b01e5d327b467****', 'title' => ''],
],
[
- 'name' => 'Uuid',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2943802884B27030B6759F9132B2****',
- ],
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the office network. Leave this parameter empty if you are not logging in from an office network.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen+dir-436909****', 'title' => ''],
],
[
'name' => 'LoginIdentifier',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Aliyun123***',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => 'The enterprise identifier.', 'type' => 'string', 'required' => false, 'example' => 'Alibaba****', 'title' => ''],
],
[
- 'name' => 'SupportTypes',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'ClientType',
+ 'in' => 'query',
'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ad' => '',
- 'simple' => '',
- ],
- 'example' => 'ad',
- ],
+ 'description' => 'The client type.',
+ 'enumValueTitles' => ['html5' => 'Web client', 'android' => 'Android client', 'windows' => 'Windows client', 'ios' => 'iOS client', 'macos' => 'macOS client'],
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 100,
+ 'example' => 'windows',
+ 'title' => '',
],
],
[
- 'name' => 'AvailableFeatures',
+ 'name' => 'Uuid',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
+ 'schema' => ['description' => 'The UUID of the device used for login.', 'type' => 'string', 'required' => false, 'example' => '2943802884B27030B6759F9132B2****', 'title' => ''],
],
[
- 'name' => 'ClientIp',
+ 'name' => 'ProfileRegion',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The site to which the account belongs.',
+ 'enumValueTitles' => ['ap_southeast_1' => 'Alibaba Cloud International Website (www\\.alibabacloud.com)', 'cn_hangzhou' => 'Alibaba Cloud China Website (www\\.aliyun.com)'],
'type' => 'string',
'required' => false,
- 'example' => '22.21.XX.XX',
+ 'example' => 'cn_hangzhou',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AD2D0761-1FE5-549D-B169-D3F8D19C****',
- ],
- 'IdpInfos' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'IdpId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'idp-hlyexfvwert9m8****',
- ],
- 'IdpName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SsoProtocol' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'OAuth2' => '',
- 'SAML' => '',
- 'OIDC' => '',
- ],
- 'example' => 'SAML',
- ],
- 'IdpProvider' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SsoServiceUrl' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso',
- ],
- 'Cookies' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'AccountType' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'ad' => '',
- 'simple' => '',
- ],
- 'example' => 'simple',
- ],
- 'JumpSwitch' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'IdpNameEN' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'OfficeSiteInfo' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OfficeSiteId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shanghai+dir-448204****',
- ],
- 'SsoServiceUrl' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'AccessType' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'INTERNET' => '',
- 'VPC' => '',
- 'ANY' => '',
- ],
- 'example' => 'INTERNET',
- ],
- 'ProviderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '26842',
- ],
- ],
- ],
- 'TenantAliasInfo' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TenantAlias' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Or09****',
- ],
- 'AccessType' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'INTERNET' => '',
- 'VPC' => '',
- 'ANY' => '',
- ],
- 'example' => 'INTERNET',
- ],
- ],
- ],
- 'ProfileRegion' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'ap_southeast_1' => '',
- 'cn_hangzhou' => '',
- ],
- 'example' => 'cn_hangzhou',
- ],
- 'PopRegionConfig' => [
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '',
- 'example' => 'cn-shanghai',
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '419F31B9-1FDF-5644-ABA3-D00026FA****', 'title' => ''],
+ 'LoginToken' => ['description' => 'The login token.', 'type' => 'string', 'example' => 'v12369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169-D3F8D19C****\\",\\n \\"IdpInfos\\": [\\n {\\n \\"IdpId\\": \\"idp-hlyexfvwert9m8****\\",\\n \\"IdpName\\": \\"钉钉\\",\\n \\"SsoProtocol\\": \\"SAML\\",\\n \\"IdpProvider\\": \\"钉钉\\",\\n \\"SsoServiceUrl\\": \\"https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso\\",\\n \\"Cookies\\": \\"null\\",\\n \\"AccountType\\": \\"simple\\",\\n \\"JumpSwitch\\": \\"true\\",\\n \\"IdpNameEN\\": \\"wy-simple\\"\\n }\\n ],\\n \\"OfficeSiteInfo\\": {\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-448204****\\",\\n \\"SsoServiceUrl\\": \\"https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"ProviderId\\": \\"26842\\"\\n },\\n \\"TenantAliasInfo\\": {\\n \\"TenantAlias\\": \\"Or09****\\",\\n \\"AccessType\\": \\"INTERNET\\"\\n },\\n \\"ProfileRegion\\": \\"cn_hangzhou\\",\\n \\"PopRegionConfig\\": {\\n \\"key\\": \\"cn-shanghai\\"\\n }\\n}","type":"json"}]',
- 'title' => 'FindIdpListByLoginIdentifier',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"419F31B9-1FDF-5644-ABA3-D00026FA****\\",\\n \\"LoginToken\\": \\"v12369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70****\\"\\n}","type":"json"}]',
+ 'title' => 'Purge Logon Credential',
+ 'summary' => 'Refresh the login token.',
+ 'description' => 'A login token (LoginToken) is valid for 8 hours. If the end user remains logged in to the client for longer than 8 hours, the client must refresh the login token.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com',
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'appstream-center.cn-shanghai.aliyuncs.com', 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com', 'vpc' => 'appstream-center-intl.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'appstream-center.ap-southeast-1.aliyuncs.com', 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com', 'vpc' => 'appstream-center-intl.vpc-proxy.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AddRemoveAccountIsSame', 'message' => 'The same account is to be added and to be removed at the same time.', 'http_code' => 400, 'description' => 'The same account is to be added and to be removed at the same time.'],
+ ['code' => 'AppCenterImageId.Missing', 'message' => 'The AppCenter ImageId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppCenterImageInfo.NotFound', 'message' => 'The AppCenter ImageInfo is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppDeploymentInfo.NotFound', 'message' => 'The AppDeploymentInfo is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstallation.StartFailed', 'message' => 'Start app installation failed.', 'http_code' => 400, 'description' => 'Failed to start the app installation.'],
+ ['code' => 'AppInstallationStatus.IsFailed', 'message' => 'App installation failed.', 'http_code' => 400, 'description' => 'The app installation status is failed.'],
+ ['code' => 'AppInstanceGroupAttributeModify.Failed', 'message' => 'Failed to modify the delivery group attribute.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupIdIsNull', 'message' => 'The AppInstanceGroupId is null.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupImageCreate.Failed', 'message' => 'Failed to create an image from the debugging app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupNotFound', 'message' => 'The AppInstanceGroup is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupNotFound', 'message' => 'The specified AppInstanceGroup not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppType.ValueNotSupported', 'message' => 'The category of the app is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AuthorizeFailed', 'message' => 'Authorize failed, please check your EndUserId and Password.', 'http_code' => 400, 'description' => 'Invalid username or password.'],
+ ['code' => 'BillingItem.InsertFailure', 'message' => 'Failed to insert the billing item.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'BizTypeNotMatch', 'message' => 'The bizType and image do not match.', 'http_code' => 400, 'description' => 'The bizType and image do not match.'],
+ ['code' => 'BuilderImage.StartTaskFailed', 'message' => 'Failed to start the builder image task.', 'http_code' => 400, 'description' => 'Failed to start the builder image task.'],
+ ['code' => 'CallBack.PayOrderCallbackFailed', 'message' => 'Failed to lock the order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CashBookInsufficient', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CheckStock.Failed', 'message' => 'Failed to check the stock.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ConnectLdapServer.Failed', 'message' => 'Failed to connect to the LDAP server. Please check the configuration.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CreateAppInstanceGroup.Failed', 'message' => 'Failed to create the app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CreateDesktopImageRecord.Failed', 'message' => 'Create cloud computer image failed.', 'http_code' => 400, 'description' => 'Failed to create the cloud computer image.'],
+ ['code' => 'DeleteTemplate.Failed', 'message' => 'Delete template failed.', 'http_code' => 400, 'description' => 'Failed to delete the template.'],
+ ['code' => 'DesktopInstance.NotFound', 'message' => 'The cloud computer instance does not exist.', 'http_code' => 400, 'description' => 'The cloud computer instance does not exist.'],
+ ['code' => 'ExceedAddAccountQuota', 'message' => 'The maximum number of account addition is reached.', 'http_code' => 400, 'description' => 'The maximum number of account addition is reached.'],
+ ['code' => 'ExceedAppAuthUserQuota', 'message' => 'The authorized user quota of the app is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedAppInstanceGroupQuota', 'message' => 'The app instance group quota is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedBuilderQuota', 'message' => 'The maximum number of builders is reached.', 'http_code' => 400, 'description' => 'The maximum number of builders is reached.'],
+ ['code' => 'ExceedImageQuota', 'message' => 'The maximum number of images is reached.', 'http_code' => 400, 'description' => 'The maximum number of images is reached.'],
+ ['code' => 'ExceedPoolNodeAmountQuota', 'message' => 'The pool node amount quota is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedRemoveAccountQuota', 'message' => 'The maximum number of account removal is reached.', 'http_code' => 400, 'description' => 'The maximum number of account removal is reached.'],
+ ['code' => 'Forbidden.NoPermission', 'message' => 'You are not authorized to access this page.', 'http_code' => 403, 'description' => 'You are not authorized to access this page.'],
+ ['code' => 'ForbiddenNoRealNameAuthentication', 'message' => 'Operation failed. The user has not completed the real-name authentication.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ForbiddenNoRealNameAuthentication', 'message' => 'Forbidden by user real name authentication status.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'GetLoginTokenError', 'message' => 'Failed to get the login token.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Image.CreateModeInvalid', 'message' => 'The creation mode of this task is invalid.', 'http_code' => 400, 'description' => 'The creation mode of this task is invalid.'],
+ ['code' => 'Image.NotExist', 'message' => 'The image does not exist.', 'http_code' => 400, 'description' => 'The image does not exist.'],
+ ['code' => 'ImageCreateByInstance.TaskExist', 'message' => 'The image task of instance creation already exists.', 'http_code' => 400, 'description' => 'The image task of instance creation already exists.'],
+ ['code' => 'ImageDeleteFailed.HasSharedImage', 'message' => 'The shared image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllow', 'message' => 'The image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllowCommunityParent', 'message' => 'The parent image of a community image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The parent image of a community image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllowSharedImage', 'message' => 'The shared image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be deleted.'],
+ ['code' => 'ImageDistribute.ImageNotSupport', 'message' => 'The image does not support region distribution.', 'http_code' => 400, 'description' => 'The image does not support region distribution. E.g. encrypted images.'],
+ ['code' => 'ImageDistribute.RepeatedDistribution', 'message' => 'This image has been distributed to this region.', 'http_code' => 400, 'description' => 'This image has been distributed to this region.'],
+ ['code' => 'ImageDistribute.TargetDistributeRegionListEmpty', 'message' => 'The target distribution region list is empty.', 'http_code' => 400, 'description' => 'The target distribution region list is empty.'],
+ ['code' => 'ImageDistribute.Undistributed', 'message' => 'The image has not been distributed to any region.', 'http_code' => 400, 'description' => 'The image has not been distributed to any region.'],
+ ['code' => 'ImageIsNull', 'message' => 'The image does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ImageNotAllowDelete', 'message' => 'The image cannot be deleted, because shared cloud computers already exist.', 'http_code' => 400, 'description' => 'The image cannot be deleted, because shared cloud computers already exist.'],
+ ['code' => 'ImageRegion.NotConfigured', 'message' => 'The image does not have any region configuration.', 'http_code' => 400, 'description' => 'The image does not have any region configuration.'],
+ ['code' => 'ImageRegionDistribute.NotAllow', 'message' => 'This image cannot be distributed.', 'http_code' => 400, 'description' => 'This image cannot be distributed.'],
+ ['code' => 'ImageStatus.Error', 'message' => 'The image status is error.', 'http_code' => 400, 'description' => 'The image status is error.'],
+ ['code' => 'ImageStatus.ValueNotSupported', 'message' => 'The image status is not supported for creating a delivery group.', 'http_code' => 400, 'description' => 'You cannot create a delivery group in the current image status.'],
+ ['code' => 'ImageTask.Failed', 'message' => 'Start image task failed.', 'http_code' => 400, 'description' => 'Failed to start the image task.'],
+ ['code' => 'ImageUpdateFailed.NotAllow', 'message' => 'The image is not allowed to be modified.', 'http_code' => 400, 'description' => 'The image is not allowed to be modified.'],
+ ['code' => 'ImageUpdateSharedImageFailed.NotAllow', 'message' => 'The shared image is not allowed to be modified.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be modified.'],
+ ['code' => 'Instance.ImageUnsupported', 'message' => 'A non-centralized image does not support this type of operation.', 'http_code' => 400, 'description' => 'A non-centralized image does not support this type of operation.'],
+ ['code' => 'Instance.NotFound', 'message' => 'The instance is not found.', 'http_code' => 400, 'description' => 'The instance is not found.'],
+ ['code' => 'Instance.PhysicalNodeNotExist', 'message' => 'The instance physical node does not exist.', 'http_code' => 400, 'description' => 'The physical node of this instance does not exist.'],
+ ['code' => 'InternalError', 'message' => 'Internal error.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InternalError.TicketGenInternalError', 'message' => 'An error occurred while generating a ticket.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAliUid.Missing', 'message' => 'The AliUid is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAliUid.Missing', 'message' => 'The specified parameter AliUid is missing.', 'http_code' => 400, 'description' => 'The specified parameter AliUid is missing.'],
+ ['code' => 'InvalidAliUid.NotFound', 'message' => 'The AliUid is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAmount.Invalid', 'message' => 'The Amount is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.Missing', 'message' => 'The AppId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.NotFound', 'message' => 'The AppId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotContainThisAPP', 'message' => 'The app instance group does not contain this app.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotFound', 'message' => 'The app instance group is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotFound', 'message' => 'The AppInstanceGroupId %s is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NullAppInstanceGroup', 'message' => 'The app instance group is null.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NullOrNotPublishedStatus', 'message' => 'The app instance group does not exist or is not published.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.StatusInvalid', 'message' => 'The app instance group status is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.Unauthorized', 'message' => 'Unauthorized to use this app.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupAction.IllegalAction', 'message' => 'The action against the app instance group is not allowed.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupId.Missing', 'message' => 'The AppInstanceGroupId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupName.Missing', 'message' => 'The AppInstanceGroupName is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupSpecItem.NotFound', 'message' => 'The app instance group spec item is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceId.NotFound', 'message' => 'The AppInstanceId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceState', 'message' => 'The app instance state is invalid.', 'http_code' => 200, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.Invalid', 'message' => 'The AppInstanceType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.Missing', 'message' => 'The AppInstanceType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.NotFound', 'message' => 'The app instance type is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppVersion.Missing', 'message' => 'The AppVersion is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBaseImage.InvalidStatus', 'message' => 'Invalid base image status.', 'http_code' => 400, 'description' => 'The status of the base image is invalid.'],
+ ['code' => 'InvalidBaseImage.NotConfigured', 'message' => 'Configuration required for Vhd/Container images.', 'http_code' => 400, 'description' => 'Configuration required for Vhd/Container images.'],
+ ['code' => 'InvalidBaseImage.NotFound', 'message' => 'Base image not found.', 'http_code' => 400, 'description' => 'The base image is not found.'],
+ ['code' => 'InvalidBaseImage.NotSystemImage', 'message' => 'Base image is not system image.', 'http_code' => 400, 'description' => 'The base image is not a system image.'],
+ ['code' => 'InvalidBaseImageVersion.NotOnline', 'message' => 'Base image version is not online.', 'http_code' => 400, 'description' => 'The base image is not of an available online version.'],
+ ['code' => 'InvalidBindRelationship.NotFound', 'message' => 'The bind relationship is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBindStage.Missing', 'message' => 'The BindStage is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBindStrategy.NotFound', 'message' => 'The bind strategy is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBizType', 'message' => 'The bizType parameter is invalid.', 'http_code' => 400, 'description' => 'The bizType parameter is invalid.'],
+ ['code' => 'InvalidBrowserInstanceGroup.NotFound', 'message' => 'The browser instance group is not found.', 'http_code' => 400, 'description' => 'The cloud browser does not exist, please confirm and try again'],
+ ['code' => 'InvalidBundle.NotFound', 'message' => 'The request bundle does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidChargeType.Missing', 'message' => 'The ChargeType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidChargeType.ValueNotSupported', 'message' => 'The ChargeType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDataDiskSize.SmallerThanParent', 'message' => 'Sub-image data disk size is smaller than the parent image.', 'http_code' => 400, 'description' => 'Sub-image data disk size is smaller than the parent image.'],
+ ['code' => 'InvalidDomainId.NotFound', 'message' => 'The DomainId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDriveId.NotFound', 'message' => 'The DriveId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidEndUserId.Missing', 'message' => 'The EndUserId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidEndUserIds.ValueNotSupported', 'message' => 'The EndUserIds is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidExternalFileId.NotFound', 'message' => 'The ExternalFileId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwAddress.NotFound', 'message' => 'The gateway address is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwParam.NotFound', 'message' => 'A parameter error occurred while generating the gateway token.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwToken.ValueTooLong', 'message' => 'The GWToken is too long.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidImageConfig.RegionInvalid', 'message' => 'The region configuration of this image is invalid.', 'http_code' => 400, 'description' => 'The region configuration of this image is invalid.'],
+ ['code' => 'InvalidImageId.Invalid', 'message' => 'The specified parameter imageId is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidImageOperation.Failed', 'message' => 'Invalid image operation.', 'http_code' => 400, 'description' => 'Image operation failed.'],
+ ['code' => 'InvalidImageOperation.ImageIsCreating', 'message' => 'Failed to operation the image, it is creating.', 'http_code' => 400, 'description' => 'Failed to operation the image, it is creating.'],
+ ['code' => 'InvalidImagePackageType.Unsupported', 'message' => 'Unsupported image package type.', 'http_code' => 400, 'description' => 'This package type is not supported.'],
+ ['code' => 'InvalidInstanceId.Missing', 'message' => 'The InstanceId is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidLoginToken.Missing', 'message' => 'The LoginToken is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNextToken', 'message' => 'The NextToken is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNodeInstanceType.NotFound', 'message' => 'The node instance type is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNodeInstanceType.NotSupportOsType', 'message' => 'The node instance type does not support images with this OS type.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrder.CommodityCodeNotMatch', 'message' => 'No CommodityCode matches this order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrder.CommodityCodeNotMatch', 'message' => 'No commodityCode matched for this order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrderId.NotFound', 'message' => 'The order is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrderId.NotFound', 'message' => 'The specified order is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOsType.ValueNotSupported', 'message' => 'The operation system type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.%s', 'message' => 'The parameter %s is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.AddAccount/RemoveAccount', 'message' => 'The tenant ID to be added or removed is invalid.', 'http_code' => 400, 'description' => 'The tenant ID to be added or removed is invalid.'],
+ ['code' => 'InvalidParameter.ImageId', 'message' => 'The image ID is invalid.', 'http_code' => 400, 'description' => 'The image ID is invalid.'],
+ ['code' => 'InvalidParameter.SystemDiskSize', 'message' => 'The system disk size is invalid.', 'http_code' => 400, 'description' => 'The system disk size is invalid.'],
+ ['code' => 'InvalidParentImage.AlreadyHasCommunityImage', 'message' => 'The parent image already has a community image.', 'http_code' => 400, 'description' => 'This image cannot be published to the community because it is already published.'],
+ ['code' => 'InvalidParentImage.ImageTypeIsNotUserImage', 'message' => 'Invalid operation. The parent image is not a user image.', 'http_code' => 400, 'description' => 'Invalid operation. The parent image is not a user image.'],
+ ['code' => 'InvalidParentImage.InvalidStatus', 'message' => 'Invalid parent image status.', 'http_code' => 400, 'description' => 'The status of the parent image is invalid.'],
+ ['code' => 'InvalidParentImage.NotFound', 'message' => 'Parent image not found.', 'http_code' => 400, 'description' => 'The parent image is not found.'],
+ ['code' => 'InvalidPeriod.Invalid', 'message' => 'The Period is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriod.Missing', 'message' => 'The Period is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriodUnit.Missing', 'message' => 'The PeriodUnit is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriodUnit.ValueNotSupported', 'message' => 'The PeriodUnit is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.Invalid', 'message' => 'The ProductType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.Missing', 'message' => 'The ProductType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.ValueNotSupported', 'message' => 'The ProductType is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.ConfigError', 'message' => 'The region configuration is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.Missing', 'message' => 'The Region is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.NotFound', 'message' => 'The region is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.NotMatch', 'message' => 'The region does not match the current environment.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegionBind.NotFound', 'message' => 'The AppRegionBind is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegionId.NotFound', 'message' => 'The RegionId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidResourcePool.NotFound', 'message' => 'The resource pool is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidResponse.Missing', 'message' => 'The response body is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSessionId.Missing', 'message' => 'The SessionId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSourceImage.ImageTypeCannotBeShared', 'message' => 'Source image cannot be shared.', 'http_code' => 400, 'description' => 'This type of source image cannot be shared.'],
+ ['code' => 'InvalidSourceImage.StatusNotAvailable', 'message' => 'Invalid source image status.', 'http_code' => 400, 'description' => 'The status of the source image is invalid.'],
+ ['code' => 'InvalidSpecId.Missing', 'message' => 'The SpecId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStorageType.NotFound', 'message' => 'The StorageType is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.ChargeTypeNotSupported', 'message' => 'The charge type is not supported for the given strategy.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Invalid', 'message' => 'The StrategyConfig is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Invalid', 'message' => 'The policy configuration is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Missing', 'message' => 'The StrategyConfig is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.NotFound', 'message' => 'The StrategyConfig is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyParam.Invalid', 'message' => 'The StrategyParam is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyType.ValueNotSupported', 'message' => 'The strategy type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyType.ValueNotSupported', 'message' => 'The policy type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSubAppType.ValueNotSupported', 'message' => 'The sub-category of the app is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSystemDiskSize.SmallerThanParent', 'message' => 'Sub-image system disk size is smaller than the parent image.', 'http_code' => 400, 'description' => 'Sub-image system disk size is smaller than the parent image.'],
+ ['code' => 'InvalidTargetAliUid.TargetShareImageAlreadyExist', 'message' => 'Target shared image already exists.', 'http_code' => 400, 'description' => 'The target shared image already exists.'],
+ ['code' => 'InvalidTaskId.NotFound', 'message' => 'The TaskId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidTemplate.NotFound', 'message' => 'Template not found.', 'http_code' => 400, 'description' => 'The template is not found.'],
+ ['code' => 'InvalidUserId.NotFound', 'message' => 'The UserId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'LogOffAllSession.Failed', 'message' => 'Failed to log off all sessions in the delivery group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter', 'message' => 'There is a missing parameter.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter.AppIdAndAppVersion', 'message' => 'The AppId and AppVersion are missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter.RegionId', 'message' => 'The RegionId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'nvalidStrategyConfig.NotFound', 'message' => 'The policy configuration is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OperationDenied.NoStock', 'message' => 'The operation is denied, because the instance stock is unavailable.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.Canceled', 'message' => 'The task has been cancelled.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.NotFound', 'message' => 'The ota task is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.Running', 'message' => 'The task is running and cannot be sumitted.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTaskNotifyRegion.Error', 'message' => 'The unit manager failed to receive the OTA upgrade job.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParentImage.NotExist', 'message' => 'The parent image does not exist.', 'http_code' => 400, 'description' => 'The parent image does not exist.'],
+ ['code' => 'ParentImageRegionDistribute.NotExist', 'message' => 'The target distribution region of the parent image does not exist.', 'http_code' => 400, 'description' => 'The target distribution region of the parent image does not exist.'],
+ ['code' => 'ProductTypeInvalid', 'message' => 'The ProductType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ProductTypeNotMatch', 'message' => 'The productType and image do not match.', 'http_code' => 400, 'description' => 'The productType and image do not match.'],
+ ['code' => 'QueryTemplate.Failed', 'message' => 'Query template failed.', 'http_code' => 400, 'description' => 'Failed to query the template.'],
+ ['code' => 'RegionUnBind.Fail', 'message' => 'Failed to unbind.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ServiceUnavailable', 'message' => 'Service unavailable. Please try again later.', 'http_code' => 500, 'description' => 'Service unavailable. Please try again later.'],
+ ['code' => 'StockError.InvalidResourceRequest', 'message' => 'Your request cannot be processed currently due to an error. Please try again later.', 'http_code' => 500, 'description' => 'The inventory check failed and the system is temporarily unable to process your request. Please try again later.'],
+ ['code' => 'StockError.NoStock', 'message' => 'The selected specification is out of stock. Please try again later or select other specifications.', 'http_code' => 400, 'description' => 'The selected specification is out of stock. Please try again later or select other specifications.'],
+ ['code' => 'StorageLock.Exist', 'message' => 'The storage lock exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLock.NotFound', 'message' => 'The storage lock is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockProperties.NotMatch', 'message' => 'The storage lock properties do not match.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockUnitResponse.Empty', 'message' => 'The storage lock unit is found empty.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockUnlockLevel.Error', 'message' => 'An unlock level error occurred while unlocking the storage lock.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Task.ResourceReleased', 'message' => 'Cannot retry because task resource is released.', 'http_code' => 400, 'description' => 'Cannot retry because the resource for builder task is released.'],
+ ['code' => 'TaskType.Invalid', 'message' => 'Invalid task type.', 'http_code' => 400, 'description' => 'Invalid task type.'],
+ ['code' => 'TryBind.AppRegionBindLockFailed', 'message' => 'Failed to lock the app and region bind.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoBindContext', 'message' => 'Failed to bind, because there is no bind context.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoCandidateAppInstanceGroup', 'message' => 'Failed to bind, because there is no candidate app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoSupportedApp', 'message' => 'Failed to bind, because there is no supported app for this file extension.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.BindExistingAppInstanceFail', 'message' => 'Failed to bind existing app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.NoCandidateAppInstance', 'message' => 'Failed to bind, because there is no candidate app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.NoIdleAppInstance', 'message' => 'Failed to bind, because there is no idle app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.TicketIsNull', 'message' => 'Failed to bind, because a null ticket is returned.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'UpdateImage.Failed', 'message' => 'Failed to update the image.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'UpdateRegion.NotSupport', 'message' => 'The distributed regions of vhd or container images cannot be modified.', 'http_code' => 400, 'description' => 'The distributed regions of vhd or container images cannot be modified.'],
+ ['code' => 'UserIdentifier.NotFound', 'message' => 'This username does not exist. Please check if it is correct.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
],
],
+ 'ram' => [
+ 'productCode' => 'AppStreaming',
+ 'productName' => 'App Streaming',
+ 'ramCodes' => ['appstreaming', 'ecd'],
+ 'ramLevel' => 'SERVICE',
+ 'ramConditions' => [],
+ 'ramActions' => [],
+ 'resourceTypes' => [],
+ ],
];
diff --git a/data/en_us/appstream-center/2021-09-01/api-docs.php b/data/en_us/appstream-center/2021-09-01/api-docs.php
index f2cc553..80c4582 100644
--- a/data/en_us/appstream-center/2021-09-01/api-docs.php
+++ b/data/en_us/appstream-center/2021-09-01/api-docs.php
@@ -1,245 +1,199 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'appstream-center',
- 'version' => '2021-09-01',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'appstream-center', 'version' => '2021-09-01'],
'directories' => [
[
- 'id' => 166315,
- 'title' => 'Regions',
- 'type' => 'directory',
'children' => [
- 'ListRegions',
+ [
+ 'children' => ['ListDesktopAgentRuntime'],
+ 'type' => 'directory',
+ 'title' => 'Agent runtime management',
+ ],
+ [
+ 'children' => ['GetRuntimeModelConfig', 'ConfigRuntimeModelTemplate', 'RemoveRuntimeModelTemplate', 'ListModelTemplateResourceGroup', 'ConfigResourceGroupModelTemplate', 'RemoveResourceGroupModelTemplate'],
+ 'type' => 'directory',
+ 'title' => 'Agent model management',
+ ],
+ [
+ 'children' => ['GetRuntimeChannel', 'ConfigRuntimeChannel', 'RemoveRuntimeChannel'],
+ 'type' => 'directory',
+ 'title' => 'Agent channel management',
+ ],
+ [
+ 'children' => ['CreateModelTemplate', 'UpdateModelTemplate', 'DeleteModelTemplate', 'ListModelTemplates', 'CreateModelProviderTemplate', 'UpdateModelProviderTemplate', 'DeleteModelProviderTemplate', 'GetModelProviderTemplate', 'ListModelProviderTemplates', 'BatchCreateLlmTemplates', 'DeleteLlmTemplate', 'ListLlmTemplates'],
+ 'type' => 'directory',
+ 'title' => 'Model group management',
+ ],
],
+ 'type' => 'directory',
+ 'title' => 'Agent management',
],
[
- 'id' => 166366,
- 'title' => 'Resources',
+ 'children' => ['ListRegions'],
'type' => 'directory',
- 'children' => [
- 'ListNodes',
- 'ModifyNodePoolAmount',
- 'ListNodeInstanceType',
- 'GetResourcePrice',
- 'GetResourceRenewPrice',
- ],
+ 'title' => 'Region',
],
[
- 'id' => 286385,
- 'title' => 'Images',
+ 'children' => ['ListNodes', 'ModifyNodePoolAmount', 'ListNodeInstanceType', 'GetResourcePrice', 'GetResourceRenewPrice'],
'type' => 'directory',
- 'children' => [
- 'ListImage',
- 'CreateImageByInstance',
- 'StartTaskForDistributeImage',
- 'DeleteImage',
- ],
+ 'title' => 'Resource',
],
[
- 'id' => 166320,
- 'title' => 'Delivery Groups',
+ 'children' => ['ListImage', 'CreateImageByInstance', 'StartTaskForDistributeImage', 'DeleteImage'],
'type' => 'directory',
- 'children' => [
- 'CreateAppInstanceGroup',
- 'GetAppInstanceGroup',
- 'ListAppInstanceGroup',
- 'PageListAppInstanceGroupUser',
- 'RenewAppInstanceGroup',
- 'UpdateAppInstanceGroupImage',
- 'ModifyAppInstanceGroupAttribute',
- 'ModifyNodePoolAttribute',
- 'AuthorizeInstanceGroup',
- 'LogOffAllSessionsInAppInstanceGroup',
- 'DeleteAppInstanceGroup',
- 'ModifyAppPolicy',
- 'ListAuthorizedUserGroups',
- ],
+ 'title' => 'Image',
],
[
- 'id' => 182244,
- 'title' => 'App Instances',
+ 'children' => ['CreateAppInstanceGroup', 'GetAppInstanceGroup', 'ListAppInstanceGroup', 'PageListAppInstanceGroupUser', 'RenewAppInstanceGroup', 'UpdateAppInstanceGroupImage', 'ModifyAppInstanceGroupAttribute', 'ModifyNodePoolAttribute', 'AuthorizeInstanceGroup', 'LogOffAllSessionsInAppInstanceGroup', 'DeleteAppInstanceGroup', 'ModifyAppPolicy', 'ListAuthorizedUserGroups'],
'type' => 'directory',
- 'children' => [
- 'ListAppInstances',
- 'DeleteAppInstances',
- 'ListPersistentAppInstances',
- ],
+ 'title' => 'Delivery group',
],
[
- 'id' => 180891,
- 'title' => 'Connections',
+ 'children' => ['ListAppInstances', 'DeleteAppInstances', 'ListPersistentAppInstances'],
'type' => 'directory',
- 'children' => [
- 'GetConnectionTicket',
- 'Unbind',
- 'ListBindInfo',
- ],
+ 'title' => 'Application instance',
],
[
- 'id' => 182247,
- 'title' => 'Debugging',
+ 'children' => ['GetConnectionTicket', 'Unbind', 'ListBindInfo'],
'type' => 'directory',
- 'children' => [
- 'CreateImageFromAppInstanceGroup',
- 'GetDebugAppInstance',
- ],
+ 'title' => 'Connection',
],
[
- 'id' => 170452,
- 'title' => 'OTA',
+ 'children' => ['CreateImageFromAppInstanceGroup', 'GetDebugAppInstance'],
'type' => 'directory',
- 'children' => [
- 'ListOtaTask',
- 'GetOtaTaskByTaskId',
- 'ApproveOtaTask',
- ],
+ 'title' => 'Debug',
],
[
- 'id' => 178496,
- 'title' => 'Tenant Account',
+ 'children' => ['ListOtaTask', 'GetOtaTaskByTaskId', 'ApproveOtaTask'],
'type' => 'directory',
- 'children' => [
- 'ListTenantConfig',
- 'ModifyTenantConfig',
- ],
+ 'title' => 'Over-the-air update',
],
[
- 'id' => 203812,
- 'title' => 'Resource Tags',
+ 'children' => ['ListTenantConfig', 'ModifyTenantConfig'],
'type' => 'directory',
- 'children' => [
- 'ListTagCloudResources',
- 'TagCloudResources',
- 'UntagCloudResources',
- ],
+ 'title' => 'Administrator account',
],
[
- 'id' => 263171,
- 'title' => 'Workstations',
+ 'children' => ['ListTagCloudResources', 'TagCloudResources', 'UntagCloudResources'],
'type' => 'directory',
- 'children' => [
- 'DescribeWuyingServerEipInfo',
- 'CreateWuyingServer',
- 'ListWuyingServer',
- 'StartWuyingServer',
- 'StopWuyingServer',
- 'RestartWuyingServer',
- 'ModifyWuyingServerAttribute',
- 'UpdateWuyingServerImage',
- 'RenewWuyingServer',
- 'DeleteWuyingServer',
- ],
+ 'title' => 'Resource tag',
],
[
- 'id' => 313380,
+ 'children' => ['DescribeWuyingServerEipInfo', 'CreateWuyingServer', 'ListWuyingServer', 'StartWuyingServer', 'StopWuyingServer', 'RestartWuyingServer', 'ModifyWuyingServerAttribute', 'UpdateWuyingServerImage', 'RenewWuyingServer', 'DeleteWuyingServer'],
+ 'type' => 'directory',
+ 'title' => 'WUYING workspace',
+ ],
+ [
+ 'children' => ['ModifyBrowserInstanceGroup'],
+ 'type' => 'directory',
'title' => 'Other',
+ ],
+ [
+ 'children' => ['AssignWuyingServerPrivateAddresses', 'DeliverToUserSls', 'DescribeWuyingServer', 'ListModelProviderEndpoints', 'UnassignWuyingServerPrivateAddresses'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'ModifyBrowserInstanceGroup',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'ListRegions' => [
- 'summary' => 'Queries the regions that are supported by App Streaming.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ApproveOtaTask' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ProductType',
- 'in' => 'query',
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The delivery group ID. You can call [ListAppInstanceGroup](~~ListAppInstanceGroup~~) to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****'],
+ ],
+ [
+ 'name' => 'BizRegionId',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
+ 'title' => '',
+ 'description' => 'The region ID of the delivery group. You can call [ListRegions](~~ListRegions~~) to query the list of regions supported by Wuying Cloud Application.',
+ 'enumValueTitles' => [],
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
],
],
[
- 'name' => 'BizSource',
- 'in' => 'query',
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The over-the-air upgrade task ID. You can call [ListAppInstanceGroup](~~ListAppInstanceGroup~~) to obtain the ID.'."\n"
+ ."\n"
+ .'> Each successful call of `ApproveOtaTask` causes the `TaskId` to change. Therefore, before calling this operation again, call `ListAppInstanceGroup` again to obtain the latest `TaskId`.', 'type' => 'string', 'required' => true, 'example' => 'ota-be7jzm29wrrz5****'],
+ ],
+ [
+ 'name' => 'OtaType',
+ 'in' => 'formData',
'schema' => [
- 'description' => '> This parameter is not publicly available.'."\n",
+ 'title' => '',
+ 'description' => 'The over-the-air upgrade task type.',
+ 'enumValueTitles' => ['Fota' => 'Wuying system component update.'],
'type' => 'string',
- 'required' => false,
- 'example' => 'null',
+ 'required' => true,
+ 'enum' => ['Fota', 'ImageUpdate', 'AppUpdate'],
+ 'example' => 'Fota',
],
],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The start time of the over-the-air upgrade task. Specify the time in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'required' => true, 'example' => '2022-08-04T14:36:00+08:00'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'RegionModels' => [
- 'description' => 'The region IDs.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'regionId' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'cn-hangzhou',
- ],
- ],
- 'example' => 'cn-hangzhou',
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Code' => ['description' => 'The execution result. A value of `success` indicates success. Otherwise, an error message is returned.', 'type' => 'string', 'example' => 'OtaTask.Running', 'title' => ''],
+ 'Message' => ['description' => 'The error message. This parameter is not returned when `Code` is `success`.', 'type' => 'string', 'example' => 'The task is running and cannot be sumitted.', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"RegionModels\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListRegions',
- 'description' => '> All supported regions instead of available regions are returned by this operation. For more information, see [Supported regions](~~426036~~).'."\n",
- ],
- 'ListNodes' => [
- 'summary' => 'Queries resource nodes.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Set over-the-air upgrade execution time',
+ 'summary' => 'Sets the execution time for an over-the-air update.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApproveOtaTask'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyAppInstanceGroupAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"OtaTask.Running\\",\\n \\"Message\\": \\"The task is running and cannot be sumitted.\\"\\n}","type":"json"}]',
+ ],
+ 'AssignWuyingServerPrivateAddresses' => [
+ 'summary' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -248,149 +202,58 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '265984',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingEP3FXS',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingU1TTUH'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The number of entries per page. Valid values: 1 to 200.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The page number. Pages start from page 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'WuyingServerId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-53fvrq1oanz6c****',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'example' => 'ws-bp1234567890abcde', 'title' => '', 'description' => ''],
],
[
- 'name' => 'ProductType',
+ 'name' => 'SecondaryPrivateIpAddressCount',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => '', 'description' => ''],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'PerPageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'ToPage' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Count' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'NodeModels' => [
- 'description' => 'The resource nodes.'."\n",
+ 'RequestId' => ['type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => '', 'description' => ''],
+ 'AssignedPrivateIpAddresses' => [
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'NodeId' => [
- 'description' => 'The ID of the resource node.'."\n"
- ."\n"
- .'> This parameter is returned only if the ChargeResourceMode parameter of the delivery group to which the resource node belongs is set to Node.'."\n",
- 'type' => 'string',
- 'example' => 'i-bp13********',
- ],
- 'ChargeType' => [
- 'description' => 'The billing method of the resource node.'."\n"
- ."\n"
- .'> This parameter is returned only if the ChargeResourceMode parameter of the delivery group to which the resource node belongs is set to Node.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* PostPaid: pay-as-you-go'."\n"
- .'* Prepaid: subscription'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'PostPaid' => '',
- 'PrePaid' => '',
- ],
- 'example' => 'PostPaid',
- ],
- ],
- 'description' => '',
- ],
+ 'items' => ['type' => 'string', 'example' => '10.0.0.2', 'title' => '', 'description' => ''],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PerPageSize\\": 10,\\n \\"ToPage\\": 1,\\n \\"Count\\": 100,\\n \\"NodeModels\\": [\\n {\\n \\"NodeId\\": \\"i-bp13********\\",\\n \\"ChargeType\\": \\"PostPaid\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListNodes',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AssignedPrivateIpAddresses\\": [\\n \\"10.0.0.2\\"\\n ]\\n}","type":"json"}]',
],
- 'ModifyNodePoolAmount' => [
- 'summary' => 'Changes the number of nodes in a subscription delivery group.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AuthorizeInstanceGroup' => [
+ 'summary' => 'Add or remove assigned users for a delivery group. Only users added as assigned users can access cloud applications.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -401,2007 +264,1419 @@
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '263378',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingU1TTUH',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '83450',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The delivery group ID. You can call the [ListAppInstanceGroup](~~428506~~) operation to obtain the value.', 'type' => 'string', 'required' => true, 'maxItems' => 100, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ ],
+ [
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'title' => '产品类型。',
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
+ 'description' => 'The product type.'."\n",
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
'example' => 'CloudApp',
+ 'title' => '',
],
],
[
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'AuthorizeUserIds',
'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'title' => '交付组ID。',
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
+ 'description' => 'The list of usernames to be authorized for the delivery group. You can specify 1 to 100 usernames.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The username to be authorized for the delivery group. You can call the [DescribeUsers](~~436936~~) operation to obtain the value.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 200,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'NodePool',
+ 'name' => 'UnAuthorizeUserIds',
'in' => 'formData',
- 'style' => 'json',
+ 'style' => 'flat',
'schema' => [
- 'title' => '节点池相关变配参数',
- 'description' => 'The parameters related to the configuration change of the node pool.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'NodeAmount' => [
- 'title' => '升级后固定节点的数量',
- 'description' => 'The total number of subscription nodes after the change.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- 'PrePaidNodeAmountModifyMode' => [
- 'title' => '预付费节点修改模式。EXPAND_FROM_POST_PAID_EXPLICIT:指定按量节点转换。',
- 'description' => 'The change mode of subscription nodes.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* EXPAND_FROM_POST_PAID_EXPLICIT: changes from specified pay-as-you-go nodes'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'EXPAND_FROM_POST_PAID_EXPLICIT' => '',
- ],
- 'example' => 'EXPAND_FROM_POST_PAID_EXPLICIT',
- ],
- 'PrePaidNodeAmountModifyNodeIds' => [
- 'title' => '待修改计费类型节点列表。',
- 'description' => 'The nodes for which you want to change the billing method.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The node for which you want to change the billing method.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'i-fgssxxx',
- ],
- 'required' => false,
- ],
- ],
- 'required' => true,
+ 'description' => 'The list of usernames to be deauthorized from the delivery group. You can specify 1 to 100 usernames.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The username to be deauthorized from the delivery group. You can call the [DescribeUsers](~~436936~~) operation to obtain the value.', 'type' => 'string', 'required' => false, 'example' => 'tom', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 200,
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'UserMeta',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The user information.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
+ 'Type' => [
+ 'description' => 'The user type.',
+ 'enumValueTitles' => ['ad' => 'AD account', 'simple' => 'WUYING convenience account'],
'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Data' => [
- 'description' => 'The returned data.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'OrderId' => [
- 'description' => 'The order ID.'."\n",
- 'type' => 'string',
- 'example' => '23429322113****',
- ],
- ],
+ 'required' => false,
+ 'example' => 'simple',
+ 'title' => '',
],
+ 'AdDomain' => ['description' => 'The AD domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''],
],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"23429322113****\\"\\n }\\n}","type":"json"}]',
- 'title' => 'ModifyNodePoolAmount',
- ],
- 'ListNodeInstanceType' => [
- 'summary' => 'Queries the resource types that are available for purchase when you create a delivery group.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'ProductType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of the page to return.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'name' => 'AppInstancePersistentId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The persistent session ID.', 'type' => 'string', 'required' => false, 'example' => 'p-0cc7s3mw2fg4j****'],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries to return on each page. Valid values: 1 to 100.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'name' => 'AvatarId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The user avatar ID.'."\n"
+ ."\n"
+ .'> This parameter is not available for public use.', 'type' => 'string', 'example' => 'default', 'default' => 'default', 'required' => false],
],
[
- 'name' => 'OsType',
- 'in' => 'query',
+ 'name' => 'AuthorizeUserGroupIds',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'The operating system that is supported.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* Windows: the Windows operating system'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The list of user group IDs to be authorized.',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => 'The user group ID to be authorized.', 'type' => 'string', 'required' => false, 'example' => 'ug-00001'],
'required' => false,
- 'enumValueTitles' => [
- 'Windows' => '',
- ],
- 'example' => 'Windows',
+ 'maxItems' => 20,
+ 'example' => '',
],
],
[
- 'name' => 'BizRegionId',
- 'in' => 'query',
+ 'name' => 'UnAuthorizeUserGroupIds',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'The ID of the region where the resource resides. For information about the supported regions, see [Limits](~~426036~~).'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* cn-shanghai: China (Shanghai)'."\n"
- .'* cn-hangzhou: China (Hangzhou)'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The list of user group IDs to be deauthorized.',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => 'The user group ID to be deauthorized.', 'type' => 'string', 'required' => false, 'example' => 'ug-00002'],
'required' => false,
- 'enumValueTitles' => [
- 'cn-shanghai' => '',
- 'cn-hangzhou' => '',
- ],
- 'example' => 'cn-hangzhou',
+ 'maxItems' => 20,
+ 'example' => '',
],
],
- [
- 'name' => 'Language',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The language that you want to use.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* en-US: English (US)'."\n"
- .'* zh-CN: Simplified Chinese'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'en-US' => '',
- 'zh-CN' => '',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
- 'example' => 'zh-CN',
- ],
- ],
- [
- 'name' => 'NodeInstanceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The resource type that you want to query. If you do not configure this parameter, all resource types are returned.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'appstreaming.vgpu.4c8g.2g',
- ],
- ],
- [
- 'name' => 'NodeInstanceTypeFamily',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
+ 'example' => '',
],
],
- [
- 'name' => 'Cpu',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Add or remove assigned users for a delivery group',
+ 'description' => '> After changing the assigned users, the selected users will receive corresponding notification emails. Generally, it takes about 2 minutes for the changes to take effect on the client.'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AuthorizeInstanceGroup'],
],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Gpu',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'number',
- 'format' => 'float',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:AuthorizeInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'BatchCreateLlmTemplates' => [
+ 'summary' => 'Creates LLM templates in batches.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Memory',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'GpuMemory',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'name' => 'ModelTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the associated model group.', 'type' => 'string', 'required' => false, 'example' => 'mt-xxxx', 'title' => ''],
],
[
- 'name' => 'SortType',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'DESC/ASC',
- 'type' => 'string',
- ],
+ 'name' => 'ProviderTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the model provider template to which the models belong.', 'type' => 'string', 'required' => true, 'example' => 'mpt-xxxx'],
],
[
- 'name' => 'OrderBy',
- 'in' => 'query',
+ 'name' => 'LlmTemplateItems',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'CPU/Memory',
- 'type' => 'string',
+ 'description' => 'The list of model configurations to create.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The model configuration object to create.',
+ 'type' => 'object',
+ 'properties' => [
+ 'LlmCode' => ['description' => 'The model code, which must be unique within the same provider.', 'type' => 'string', 'required' => false, 'example' => 'qwen3.6-plus', 'title' => ''],
+ 'Name' => ['description' => 'The model name.', 'type' => 'string', 'required' => false, 'example' => 'Qwen3.6-Plus', 'title' => ''],
+ 'Description' => ['description' => 'The model description.', 'type' => 'string', 'required' => false, 'example' => '千问Plus系列模型', 'title' => ''],
+ 'Config' => ['description' => 'The model configuration JSON object.', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "id": "qwen3.6-plus",'."\n"
+ .' "cost": {'."\n"
+ .' "input": 0,'."\n"
+ .' "output": 0,'."\n"
+ .' "cacheRead": 0,'."\n"
+ .' "cacheWrite": 0'."\n"
+ .' },'."\n"
+ .' "name": "Qwen3.6-Plus",'."\n"
+ .' "input": ["image", "text"],'."\n"
+ .' "compat": {'."\n"
+ .' "supportsUsageInStreaming": true'."\n"
+ .' },'."\n"
+ .' "maxTokens": 65536,'."\n"
+ .' "reasoning": false,'."\n"
+ .' "contextWindow": 1000000'."\n"
+ .'}', 'title' => ''],
+ 'IsDefaultModel' => [
+ 'description' => 'Specifies whether to set this model as the default model. Each model group can have at most one default model.',
+ 'enumValueTitles' => ['true' => '是', 'false' => '否'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries on each page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => 'The page number of the returned page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NodeInstanceTypeModels' => [
- 'description' => 'The resource types.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'NodeInstanceType' => [
- 'description' => 'The ID of the resource type.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'appstreaming.vgpu.4c8g.2g',
- ],
- 'NodeInstanceTypeFamily' => [
- 'description' => 'The resource type family.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* appstreaming.general: WUYING - General'."\n"
- .'* appstreaming.vgpu: WUYING - Graphics'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'appstreaming.general' => '',
- 'appstreaming.vgpu' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'LlmTemplateIds' => [
+ 'title' => '',
+ 'description' => 'The list of IDs of the model templates that are created.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The model template ID.', 'type' => 'string', 'example' => 'llmt-xxxx', 'title' => ''],
+ 'example' => '',
+ ],
+ 'SuccessCount' => ['title' => '', 'description' => 'The number of model templates that are created.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of requests.', 'type' => 'integer', 'format' => 'int32', 'example' => '6'],
+ 'SkippedItems' => [
+ 'title' => '',
+ 'description' => 'The list of skipped model configuration items.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The skipped model configuration item.',
+ 'type' => 'object',
+ 'properties' => [
+ 'LlmCode' => ['title' => '', 'description' => 'The model code that is skipped.', 'type' => 'string', 'example' => 'qwen3.5-plus'],
+ 'Reason' => ['title' => '', 'description' => 'The reason why the model is skipped.', 'type' => 'string', 'example' => 'LLM template already exists with same providerTemplateId and llmCode.'],
],
- 'example' => 'appstreaming.vgpu',
- ],
- 'Cpu' => [
- 'description' => 'The number of vCPUs.'."\n",
- 'type' => 'string',
- 'example' => '4',
- ],
- 'Gpu' => [
- 'description' => 'The number of GPUs.'."\n",
- 'type' => 'string',
- 'example' => '2',
- ],
- 'Memory' => [
- 'description' => 'The memory size. Unit: MB.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8192',
- ],
- 'GpuMemory' => [
- 'description' => 'The GPU size. Unit: MB.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8192',
- ],
- 'MaxCapacity' => [
- 'description' => 'The maximum number of sessions to which a resource can connect at the same time. If a resource connects to a large number of sessions at the same time, user experience can be compromised. The value range varies based on the resource type. The following items describe the value ranges of different resource types:'."\n"
- ."\n"
- .'* appstreaming.general.4c8g: 1 to 2'."\n"
- .'* appstreaming.general.8c16g: 1 to 4'."\n"
- .'* appstreaming.vgpu.8c16g.4g: 1 to 4'."\n"
- .'* appstreaming.vgpu.8c31g.16g: 1 to 4'."\n"
- .'* appstreaming.vgpu.14c93g.12g: 1 to 6'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'NodeTypeName' => [
- 'description' => 'The name of the resource type.'."\n",
- 'type' => 'string',
- 'example' => 'WUYING - General - 4 vCPUs 8 GB Memory'."\n",
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 6,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"NodeInstanceTypeModels\\": [\\n {\\n \\"NodeInstanceType\\": \\"appstreaming.vgpu.4c8g.2g\\",\\n \\"NodeInstanceTypeFamily\\": \\"appstreaming.vgpu\\",\\n \\"Cpu\\": \\"4\\",\\n \\"Gpu\\": \\"2\\",\\n \\"Memory\\": 8192,\\n \\"GpuMemory\\": 8192,\\n \\"MaxCapacity\\": 4,\\n \\"NodeTypeName\\": \\"无影-通用型_4核8G\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListNodeInstanceType',
- ],
- 'GetResourcePrice' => [
- 'summary' => 'Queries resource prices.',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create model templates in batches',
+ 'description' => 'You can create model templates in batches under a model provider template in the Wuying Agent Management Center. You can add multiple models at a time and specify one of them as the default model. Existing models are automatically skipped and are not created again.'."\n"
+ ."\n"
+ .'Before you call this operation, make sure that you are familiar with the operations and usage of the Wuying Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:BatchCreateLlmTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"LlmTemplateIds\\": [\\n \\"llmt-xxxx\\"\\n ],\\n \\"SuccessCount\\": 5,\\n \\"TotalCount\\": 6,\\n \\"SkippedItems\\": [\\n {\\n \\"LlmCode\\": \\"qwen3.5-plus\\",\\n \\"Reason\\": \\"LLM template already exists with same providerTemplateId and llmCode.\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ConfigResourceGroupModelTemplate' => [
+ 'summary' => 'Configures the model group for a resource group.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'NodeInstanceType',
- 'in' => 'query',
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'required' => true, 'example' => 'rg-xxxxx'],
+ ],
+ [
+ 'name' => 'ModelTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The model group ID.', 'type' => 'string', 'required' => true, 'example' => 'mt-xxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The ID of the resource type that you purchase. You can call the [ListNodeInstanceType](~~428502~~) to obtain the ID.'."\n"
- ."\n"
- .'You must specify one of AppInstanceType and NodeInstanceType. If you specify both of the parameters, the value of NodeInstanceType takes effect.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* appstreaming.vgpu.8c16g.4g: WUYING - Graphics - 8 vCPUs, 16 GiB Memory, 4 GiB GPU Memory'."\n"
- .'* appstreaming.general.8c16g: WUYING - General - 8 vCPUs, 16 GiB Memory'."\n"
- .'* appstreaming.general.4c8g: WUYING - General - 4 vCPUs, 8 GiB Memory'."\n"
- .'* appstreaming.vgpu.14c93g.12g: WUYING - Graphics - 14 vCPUs, 93 GiB Memory, 12 GiB GPU Memory.'."\n"
- .'* appstreaming.vgpu.8c31g.16g: WUYING - Graphics - 8 vCPUs, 31 GiB Memory, 16 GiB GPU Memory'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'appstreaming.vgpu.8c16g.4g' => '',
- 'appstreaming.general.8c16g' => '',
- 'appstreaming.general.4c8g' => '',
- 'appstreaming.vgpu.14c93g.12g' => '',
- 'appstreaming.vgpu.8c31g.16g' => '',
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
- 'example' => 'appstreaming.vgpu.4c8g.2g',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Configure model group for a resource group',
+ 'description' => 'You can assign a model group to the resources associated with agent runtimes such as JVS Computer, OpenClaw, and Hermes Agent in the WUYING Agent Management Center. The model group serves as the inference engine for tasks executed by agents within the resource group.'."\n"
+ ."\n"
+ .'When an agent runtime has its own model group configured and the resource group it belongs to also has a model group configured, the model group bound to the resource group takes effect. The resource group setting has a higher priority than the agent runtime setting.'."\n"
+ ."\n"
+ .'Before calling this operation, make sure that you are familiar with the operations and usage of the WUYING Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ProductType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ConfigResourceGroupModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'example' => 'CloudApp',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'ConfigRuntimeChannel' => [
+ 'summary' => 'Configures a third-party channel for Agent runtime.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ChargeType',
- 'in' => 'query',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RuntimeType',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The billing method.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* PostPaid: pay-as-you-go'."\n"
- .'* PrePaid: subscription'."\n",
+ 'title' => '',
+ 'description' => 'The Agent runtime type.',
+ 'enumValueTitles' => ['CloudDesktop' => 'Cloud computer.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'PostPaid' => '',
- 'PrePaid' => '',
- ],
- 'example' => 'PrePaid',
+ 'example' => 'CloudDesktop',
],
],
[
- 'name' => 'Period',
- 'in' => 'query',
+ 'name' => 'RuntimeIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The subscription duration of resources. This parameter must be configured together with `PeriodUnit`.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'The list of runtime IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The Agent runtime ID. The ID mappings are as follows:'."\n"
+ ."\n"
+ .'- JVS Computer: JVS Computer ID, in the format of jvs-xxxx.'."\n"
+ .'- OpenClaw: cloud computer ID, in the format of ecd-xxxx.'."\n"
+ .'- Hermes Agent: Hermes Agent ID, in the format of jvs-xxxx.', 'type' => 'string', 'required' => true, 'example' => 'jvs-xxxx', 'title' => ''],
'required' => true,
- 'example' => '1',
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ 'example' => '',
],
],
[
- 'name' => 'PeriodUnit',
- 'in' => 'query',
+ 'name' => 'AgentProvider',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The unit of the subscription duration. This parameter must be configured together with `Period`. The following items describe valid values for the combinations of `Period` and `PeriodUnit`:'."\n"
+ 'title' => '',
+ 'description' => 'The Agent provider.'."\n"
."\n"
- .'* 1 Week'."\n"
- .'* 1 Month'."\n"
- .'* 2 Month'."\n"
- .'* 3 Month'."\n"
- .'* 6 Month'."\n"
- .'* 1 Year'."\n"
- .'* 2 Year'."\n"
- .'* 3 Year'."\n"
- ."\n"
- .'> The value of this parameter is case-insensitive. For example, `Week` is valid and `week` is invalid. If you specify a value combination other than the preceding combinations, such as `2 Week`, the operation can still be called. However, an error occurs when you place the order.'."\n",
+ .'- JVS Computer: set to OpenClaw.'."\n"
+ .'- OpenClaw: set to OpenClaw.'."\n"
+ .'- Hermes Agent: set to HermesAgent.',
+ 'enumValueTitles' => ['HermesAgent' => 'Hermes Agent', 'OpenClaw' => 'OpenClaw'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'Month' => '',
- 'Year' => '',
- 'Week' => '',
- ],
- 'example' => 'Week',
+ 'example' => 'OpenClaw',
],
],
[
- 'name' => 'Amount',
- 'in' => 'query',
+ 'name' => 'AgentPlatform',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The number of resources to purchase.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
+ 'title' => '',
+ 'description' => 'The Agent platform.',
+ 'enumValueTitles' => ['ENTERPRISE' => 'OpenClaw', 'ENTERPRISE_JVS' => 'JVS Computer、Hermes Agent'],
+ 'type' => 'string',
+ 'example' => 'ENTERPRISE',
+ 'required' => false,
],
],
[
- 'name' => 'BizRegionId',
- 'in' => 'query',
+ 'name' => 'Code',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The ID of the region where the delivery group resides. For information about the supported regions, see [Limits](~~426036~~).'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* cn-shanghai: China (Shanghai).'."\n"
- .'* cn-hangzhou: China (Hangzhou)'."\n",
+ 'title' => '',
+ 'description' => 'The third-party channel code.',
+ 'enumValueTitles' => ['dingtalk-connector' => 'DingTalk.', 'wechat' => 'WeChat.', 'feishu' => 'Lark.', 'qqbot' => 'QQ', 'wecom' => 'WeCom.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'cn-shanghai' => '',
- 'cn-hangzhou' => '',
- ],
- 'example' => 'cn-hangzhou',
+ 'example' => 'dingtalk-connector',
],
],
[
- 'name' => 'AppInstanceType',
- 'in' => 'query',
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The channel name.'."\n"
+ ."\n"
+ .'If you leave this parameter empty, the system automatically uses the value of Code as the name.', 'type' => 'string', 'example' => '钉钉', 'required' => false],
+ ],
+ [
+ 'name' => 'ConfigMode',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The type ID of the sessions that you purchase. You can call the `ListAppInstanceType` operation to obtain the ID.'."\n"
- ."\n"
- .'You must specify one of AppInstanceType and NodeInstanceType. If you specify both of the parameters, the value of NodeInstanceType takes effect.'."\n",
+ 'title' => '',
+ 'description' => 'The configuration mode.',
+ 'enumValueTitles' => ['Custom' => 'custom configuration mode.', 'Simple' => 'simple configuration mode.'],
'type' => 'string',
+ 'example' => 'Simple',
+ 'default' => 'Simple',
'required' => false,
- 'example' => 'appstreaming.general',
],
],
+ [
+ 'name' => 'Config',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The channel configuration JSON string.'."\n"
+ ."\n"
+ .'- Simple configuration mode example:'."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "appKey": "abc",'."\n"
+ .' "appSecret": "efg"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'- Custom configuration mode example:'."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "enabled": true,'."\n"
+ .' "clientId": "xxx",'."\n"
+ .' "clientSecret": "xxx"'."\n"
+ .'}'."\n"
+ .'```', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
+ .' "appKey": "abc",'."\n"
+ .' "appSecret": "efg"'."\n"
+ .'}'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The request result.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Code' => [
- 'description' => 'The error code.'."\n",
- 'type' => 'string',
- 'example' => 'InvalidParameter.ProductType',
- ],
- 'Message' => [
- 'description' => 'The error message.'."\n",
- 'type' => 'string',
- 'example' => 'The parameter ProductType is invalid.',
- ],
- 'PriceModel' => [
- 'description' => 'The price object.'."\n"
- ."\n"
- .'This parameter is returned only if a value is specified for NodeInstanceType.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Price' => [
- 'description' => 'The price details.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'OriginalPrice' => [
- 'description' => 'The original price.'."\n",
- 'type' => 'string',
- 'example' => '11.00',
- ],
- 'DiscountPrice' => [
- 'description' => 'The discount. The actual price is calculated based on the following formula: Actual price = Original price - Discount.'."\n",
- 'type' => 'string',
- 'example' => '1.00',
- ],
- 'TradePrice' => [
- 'description' => 'The actual price. The actual price is calculated based on the following formula: Actual price = Original price - Discount.'."\n",
- 'type' => 'string',
- 'example' => '10.00',
- ],
- 'Currency' => [
- 'description' => 'The currency type.'."\n",
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'Promotions' => [
- 'description' => 'The coupon metadata.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OptionCode' => [
- 'description' => 'The coupon code.'."\n",
- 'type' => 'string',
- 'example' => 'coupon****',
- ],
- 'PromotionId' => [
- 'description' => 'The coupon ID.'."\n",
- 'type' => 'string',
- 'example' => '17440009****',
- ],
- 'PromotionName' => [
- 'description' => 'The coupon name.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'PromotionDesc' => [
- 'description' => 'The coupon description.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'Selected' => [
- 'description' => 'Indicates whether the coupon was used.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Rules' => [
- 'description' => 'The price calculation rules.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RuleId' => [
- 'description' => 'The ID of the price calculation rule.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '102002100393****',
- ],
- 'Description' => [
- 'description' => 'The description of the price calculation rule.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
- 'PriceList' => [
- 'description' => 'The price objects.'."\n"
- ."\n"
- .'This parameter is returned only if a value is specified for AppInstanceType.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'PriceType' => [
- 'description' => 'The price type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Connected: in use'."\n"
- .'* Standby: pending for use.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Connected' => '',
- 'Standby' => '',
- ],
- 'example' => 'Standby',
- ],
- 'Price' => [
- 'description' => 'The price details.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'OriginalPrice' => [
- 'description' => 'The original price.'."\n",
- 'type' => 'string',
- 'example' => '6700',
- ],
- 'DiscountPrice' => [
- 'description' => 'The discount. The actual price is calculated based on the following formula: Actual price = Original price - Discount.'."\n",
- 'type' => 'string',
- 'example' => '999.0',
- ],
- 'TradePrice' => [
- 'description' => 'The actual price. The actual price is calculated based on the following formula: Actual price = Original price - Discount.'."\n",
- 'type' => 'string',
- 'example' => '5278.0',
- ],
- 'Currency' => [
- 'description' => 'The currency type.'."\n",
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'Promotions' => [
- 'description' => 'The coupon metadata.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OptionCode' => [
- 'description' => 'The coupon code.'."\n",
- 'type' => 'string',
- 'example' => 'coupon****',
- ],
- 'PromotionId' => [
- 'description' => 'The coupon ID.'."\n",
- 'type' => 'string',
- 'example' => '1847709****',
- ],
- 'PromotionName' => [
- 'description' => 'The coupon name.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'PromotionDesc' => [
- 'description' => 'The coupon description.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'Selected' => [
- 'description' => 'Indicates whether the coupon was used.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Rules' => [
- 'description' => 'The price calculation rules.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RuleId' => [
- 'description' => 'The ID of the price calculation rule.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '260904273633****',
- ],
- 'Description' => [
- 'description' => 'The description of the price calculation rule.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\",\\n \\"PriceModel\\": {\\n \\"Price\\": {\\n \\"OriginalPrice\\": \\"11.00\\",\\n \\"DiscountPrice\\": \\"1.00\\",\\n \\"TradePrice\\": \\"10.00\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Promotions\\": [\\n {\\n \\"OptionCode\\": \\"coupon****\\",\\n \\"PromotionId\\": \\"17440009****\\",\\n \\"PromotionName\\": \\"**优惠\\",\\n \\"PromotionDesc\\": \\"**活动期间的优惠\\",\\n \\"Selected\\": true\\n }\\n ]\\n },\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"Description\\": \\"用户优惠\\"\\n }\\n ]\\n },\\n \\"PriceList\\": [\\n {\\n \\"PriceType\\": \\"Standby\\",\\n \\"Price\\": {\\n \\"OriginalPrice\\": \\"6700\\",\\n \\"DiscountPrice\\": \\"999.0\\",\\n \\"TradePrice\\": \\"5278.0\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Promotions\\": [\\n {\\n \\"OptionCode\\": \\"coupon****\\",\\n \\"PromotionId\\": \\"1847709****\\",\\n \\"PromotionName\\": \\"**优惠\\",\\n \\"PromotionDesc\\": \\"**活动期间的优惠\\",\\n \\"Selected\\": true\\n }\\n ]\\n },\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"Description\\": \\"用户优惠。\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'GetResourcePrice',
- ],
- 'GetResourceRenewPrice' => [
- 'summary' => 'Queries the renewal prices of App Streaming resources.',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Configure a third-party channel for agent runtime',
+ 'description' => 'You can configure third-party channels for Agent runtime resources such as JVS Computer, OpenClaw, and Hermes Agent in the Wuying Agent Management Center. These channels serve as extended Agent communication methods beyond the AgentIM channel.'."\n"
+ ."\n"
+ .'Before you call this operation, make sure that you are familiar with the operations and usage of the Wuying Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ConfigRuntimeChannel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'ConfigRuntimeModelTemplate' => [
+ 'summary' => 'Configures model groups for Agent runtime resources.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'ProductType',
- 'in' => 'query',
+ 'name' => 'RuntimeType',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
+ 'title' => '',
+ 'description' => 'The Agent runtime type.',
+ 'enumValueTitles' => ['CloudDesktop' => 'cloud computer.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
- ],
- ],
- [
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The subscription duration of resources. This parameter must be configured together with `PeriodUnit`.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
+ 'example' => 'CloudDesktop',
],
],
[
- 'name' => 'PeriodUnit',
- 'in' => 'query',
+ 'name' => 'RuntimeIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The unit of the subscription duration. This parameter must be configured together with `Period`. The following items describe valid values for the combinations of `Period` and `PeriodUnit`:'."\n"
+ 'title' => '',
+ 'description' => 'The list of Agent runtime IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The Agent runtime ID. The ID mapping is as follows:'."\n"
."\n"
- .'* 1 Week'."\n"
- .'* 1 Month'."\n"
- .'* 2 Month'."\n"
- .'* 3 Month'."\n"
- .'* 6 Month'."\n"
- .'* 1 Year'."\n"
- .'* 2 Year'."\n"
- .'* 3 Year'."\n"
+ .'JVS Computer: JVS Computer ID, in the format of jvs-xxxx.'."\n"
."\n"
- .'> The value of this parameter is case-insensitive. For example, `Week` is valid and `week` is invalid. If you specify a value combination other than the preceding combinations, such as `2 Week`, the operation can still be called. However, an error occurs when you place the order.'."\n",
- 'type' => 'string',
+ .'OpenClaw: cloud computer ID, in the format of ecd-xxxx.'."\n"
+ ."\n"
+ .'Hermes Agent: Hermes Agent ID, in the format of jvs-xxxx.', 'type' => 'string', 'required' => true, 'example' => 'jvs-xxxxxxxxx', 'title' => ''],
'required' => true,
- 'enumValueTitles' => [
- 'Month' => '',
- 'Year' => '',
- 'Week' => '',
- ],
- 'example' => 'Week',
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ 'example' => '',
],
],
[
- 'name' => 'AppInstanceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the delivery group. You can call the [ListAppInstanceGroup](~~428506~~) operation to obtain the ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
+ 'name' => 'ModelTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The model group ID.', 'type' => 'string', 'required' => true, 'example' => 'mt-xxxxxxxxxx'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'ListResult<RuntimeModelTemplateConfigResult>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
'Data' => [
- 'description' => 'The price object.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Price' => [
- 'description' => 'The price details.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'OriginalPrice' => [
- 'description' => 'The original price.'."\n",
- 'type' => 'string',
- 'example' => '11'."\n",
- ],
- 'DiscountPrice' => [
- 'description' => 'The discount. The actual price is calculated based on the following formula: Actual price = Original price - Discount.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'TradePrice' => [
- 'description' => 'The actual price. The actual price is calculated based on the following formula: Actual price = Original price - Discount.'."\n",
- 'type' => 'string',
- 'example' => '10',
- ],
- 'Currency' => [
- 'description' => 'The currency type.'."\n",
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'Promotions' => [
- 'description' => 'The coupon description.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OptionCode' => [
- 'description' => 'The coupon code.'."\n",
- 'type' => 'string',
- 'example' => 'coupon****',
- ],
- 'PromotionId' => [
- 'description' => 'The coupon ID.'."\n",
- 'type' => 'string',
- 'example' => '139965*****',
- ],
- 'PromotionName' => [
- 'description' => 'The coupon name.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'PromotionDesc' => [
- 'description' => 'The coupon description.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'Selected' => [
- 'description' => 'Indicates whether the coupon was used.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Rules' => [
- 'description' => 'The price calculation rules.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RuleId' => [
- 'description' => 'The ID of the price calculation rule.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20002****',
- ],
- 'Description' => [
- 'description' => 'The description of the price calculation rule.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
+ 'description' => 'The list of execution results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The execution result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuntimeId' => ['title' => '', 'description' => 'The Agent runtime ID. The ID mapping is as follows:'."\n"
+ ."\n"
+ .'JVS Computer: JVS Computer ID, in the format of jvs-xxxx.'."\n"
+ ."\n"
+ .'OpenClaw: cloud computer ID, in the format of ecd-xxxx.'."\n"
+ ."\n"
+ .'Hermes Agent: Hermes Agent ID, in the format of jvs-xxxx.', 'type' => 'string', 'example' => 'jvs-xxxxxxxx'],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the execution is successful.', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '', 'description' => 'The error code returned when the execution fails.', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '', 'description' => 'The error message returned when the execution fails.', 'type' => 'string', 'example' => 'The parameter callerUid may not be null.'],
+ 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned when the execution fails.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '6'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"Price\\": {\\n \\"OriginalPrice\\": \\"11\\\\n\\",\\n \\"DiscountPrice\\": \\"1\\",\\n \\"TradePrice\\": \\"10\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Promotions\\": [\\n {\\n \\"OptionCode\\": \\"coupon****\\",\\n \\"PromotionId\\": \\"139965*****\\",\\n \\"PromotionName\\": \\"**活动\\",\\n \\"PromotionDesc\\": \\"**活动\\",\\n \\"Selected\\": true\\n }\\n ]\\n },\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"Description\\": \\"**活动\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'GetResourceRenewPrice',
- ],
- 'ListImage' => [
- 'summary' => 'Queries the image information about an ECS instance.',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Configure model groups for agent runtime resources',
+ 'description' => 'You can authorize model groups for Agent runtime resources such as JVS Computer, OpenClaw, and Hermes Agent in the Wuying Agent Management Center. The model groups serve as inference engines for Agent task execution.'."\n"
+ ."\n"
+ .'Before calling this operation, make sure that you are familiar with the operations and usage of the Wuying Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ConfigRuntimeModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"RuntimeId\\": \\"jvs-xxxxxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The parameter callerUid may not be null.\\",\\n \\"HttpStatusCode\\": 200\\n }\\n ],\\n \\"TotalCount\\": 6,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ 'translator' => 'machine',
+ ],
+ 'CreateAppInstanceGroup' => [
+ 'summary' => 'Creates a delivery group.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '213313',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingSH8DGI',
- 'FEATUREappstreamingDG81PX',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '134193',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ImageId',
+ 'name' => 'AppCenterImageId',
'in' => 'formData',
- 'schema' => [
- 'title' => '镜像id',
- 'description' => 'The image ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'img-bp13mu****',
- ],
+ 'schema' => ['description' => 'The application image ID. You can obtain the ID from the **O&M** > **Custom Images** or **System Images** page in the [WUYING Cloud Application console](https://appstreaming.console.aliyun.com/).', 'type' => 'string', 'required' => true, 'example' => 'img-8z4nztpaqvay4****', 'title' => ''],
],
[
- 'name' => 'ImageName',
+ 'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'title' => '镜像名称',
- 'description' => 'The image name. Fuzzy match is supported.'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
- 'required' => false,
- 'example' => 'DemoImage',
+ 'required' => true,
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
[
- 'name' => 'Status',
+ 'name' => 'AppInstanceGroupName',
'in' => 'formData',
- 'schema' => [
- 'title' => '镜像状态:INIT/CREATING/AVAILABLE/CREATE_FAILED',
- 'description' => 'The status of the image. You can query images in the specified status. By default, all images in the Not Deleted state are queried.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* AVAILABLE: The image is available.'."\n"
- .'* INIT: The image is being initialized.'."\n"
- .'* CREATE_FAILED: The image failed to be created.'."\n"
- .'* CREATING: The image is being created.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'AVAILABLE' => '',
- 'INIT' => '',
- 'CREATE_FAILED' => '',
- 'CREATING' => '',
- ],
- 'example' => 'INIT',
- ],
+ 'schema' => ['description' => 'The name of the delivery group.', 'type' => 'string', 'required' => false, 'example' => '办公应用', 'title' => ''],
],
[
- 'name' => 'ImageType',
+ 'name' => 'Users',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '镜像类型',
- 'description' => 'The type of the images.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* User: a custom image.'."\n"
- .'* Shared: a shared image.'."\n"
- .'* System: a system image.'."\n"
- .'* Community: a community image.'."\n",
- 'type' => 'string',
+ 'description' => 'The list of usernames to be added to the delivery group as assigned users.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The username to be added to the delivery group as an assigned user. Format: Users.N=`<username>`, where N is a positive integer.', 'type' => 'string', 'required' => false, 'example' => 'Users.1=username1'."\n"
+ .'Users.2=username2', 'title' => ''],
'required' => false,
- 'enumValueTitles' => [
- 'User' => '',
- 'Shared' => '',
- 'System' => '',
- 'Community' => '',
- ],
- 'example' => 'User',
+ 'maxItems' => 200,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PackageType',
+ 'name' => 'UserInfo',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '镜像封装类型',
- 'description' => 'The image encapsulation type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Ecs_Container: ECS and Docker image'."\n"
- .'* Ecs: ECS image'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Ecs_Container' => '',
- 'Ecs' => '',
+ 'description' => 'The user information of the users to be added to the delivery group. This field is required if the `Users` parameter is specified.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The user account type.',
+ 'enumValueTitles' => ['Simple' => 'Convenience account.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Simple',
+ 'title' => '',
+ ],
],
- 'example' => 'Ecs',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'OsType',
+ 'name' => 'ChargeType',
'in' => 'formData',
'schema' => [
- 'title' => '镜像操作系统类型',
- 'description' => 'The OS type of the image.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Linux'."\n"
- .'* Unknown'."\n"
- .'* Windows'."\n"
- .'* Android'."\n",
+ 'description' => 'The billing method.',
+ 'enumValueTitles' => ['PostPaid' => 'Pay-as-you-go.', 'PrePaid' => 'Subscription.'],
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Linux' => 'Linux',
- 'Unknown' => '',
- 'Windows' => 'Windows',
- 'Android' => 'Android',
- ],
- 'example' => 'Windows',
+ 'required' => true,
+ 'example' => 'PrePaid',
+ 'title' => '',
],
],
[
- 'name' => 'BizType',
+ 'name' => 'PromotionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The promotion ID. You can call the [GetResourcePrice](~~428503~~) operation to obtain the ID.', 'type' => 'string', 'required' => false, 'example' => '17440009****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AutoPay',
'in' => 'formData',
'schema' => [
- 'title' => '业务类型',
- 'description' => 'The service type. This parameter is not available publicly.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* 1 (default)'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'Specifies whether to enable automatic payment.',
+ 'enumValueTitles' => ['true' => 'Automatic payment is enabled.', 'false' => 'Manual payment is required. [Default value].'],
+ 'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 1 => '',
- ],
- 'example' => '1',
+ 'example' => 'false',
+ 'title' => '',
],
],
[
- 'name' => 'ProductType',
+ 'name' => 'AutoRenew',
'in' => 'formData',
'schema' => [
- 'title' => '产品类型',
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* CloudDesktop: Elastic Desktop Service'."\n"
- .'* CloudApp: App Streaming'."\n"
- .'* WuyingServer: Workstation'."\n",
- 'type' => 'string',
+ 'description' => 'Specifies whether to enable auto-renewal.',
+ 'enumValueTitles' => ['true' => 'Auto-renewal is enabled.', 'false' => 'Manual renewal is required. [Default value].'],
+ 'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'CloudDesktop' => '',
- 'CloudApp' => '',
- 'WuyingServer' => '',
- ],
- 'example' => 'CloudApp',
+ 'example' => 'false',
+ 'title' => '',
],
],
[
- 'name' => 'ProtocolType',
+ 'name' => 'Period',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The subscription duration of the resource when `ChargeType` is set to `PrePaid`. This parameter is required. The unit is specified by `PeriodUnit`.'."\n"
+ ."\n"
+ .'- If `PeriodUnit` is set to `Week`, valid values:'."\n"
+ ."\n"
+ .' - 1'."\n"
+ ."\n"
+ .'- If `PeriodUnit` is set to `Month`, valid values:'."\n"
+ ."\n"
+ .' - 1'."\n"
+ .' - 2'."\n"
+ .' - 3'."\n"
+ .' - 6'."\n"
+ ."\n"
+ .'- If `PeriodUnit` is set to `Year`, valid values:'."\n"
+ ."\n"
+ .' - 1'."\n"
+ .' - 2'."\n"
+ .' - 3'."\n"
+ ."\n"
+ .'> If `ChargeType` is set to `PostPaid`, set this parameter to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PeriodUnit',
'in' => 'formData',
'schema' => [
- 'title' => '镜像协议类型',
- 'description' => 'The protocol type of the image.'."\n"
+ 'description' => 'The unit of the subscription duration when `ChargeType` is set to `PrePaid`.'."\n"
."\n"
- .'Valid values:'."\n"
+ .'> This parameter is case-sensitive. For example, `Week` is valid, but `week` is invalid.'."\n"
+ .'If the request parameters do not match the valid combinations, such as `2 Week`, the API call succeeds but an error occurs during the order placement.'."\n"
."\n"
- .'* HDX: the High-definition Experience (HDX) protocol'."\n"
- .'* ASP: the Alibaba Cloud-developed ASP protocol'."\n",
+ .'> If `ChargeType` is set to `PostPaid`, set this parameter to `Month`.',
+ 'enumValueTitles' => ['Month' => 'month.', 'Year' => 'year.', 'Week' => 'week.'],
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'HDX' => '',
- 'ASP' => '',
- ],
- 'example' => 'ASP',
+ 'required' => true,
+ 'example' => 'Week',
+ 'title' => '',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'SessionTimeout',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The application recycling timeout period, in minutes. After an end user disconnects from a cloud application for a period of time, the cloud application process exits. This period is the application recycling timeout. Set this parameter to `-1` if you do not want the application to be recycled. Valid values: -1 and 3 to 300 (integer). Default value: `15`.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '300', 'example' => '15', 'title' => ''],
+ ],
+ [
+ 'name' => 'BizRegionId',
'in' => 'formData',
'schema' => [
- 'description' => 'The number of entries per page. Maximum value: 100. Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ 'description' => 'The region ID of the delivery group. For information about supported regions, see [Limits](~~426036~~).',
+ 'enumValueTitles' => ['cn-shanghai' => 'China (Shanghai).', 'cn-hangzhou' => 'China (Hangzhou).'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ChargeResourceMode',
'in' => 'formData',
'schema' => [
- 'description' => 'The current page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ 'description' => 'The sales mode.',
+ 'enumValueTitles' => ['Node' => 'Sold by resource.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Node',
+ 'title' => '',
],
],
[
- 'name' => 'ProductTypeList',
+ 'name' => 'NodePool',
'in' => 'formData',
- 'style' => 'repeatList',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The list of products that are supported when the image supports multiple products.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The product type.'."\n"
+ 'description' => 'The node pool object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeInstanceType' => [
+ 'description' => 'The instance type ID of the resource to purchase. You can call the [ListNodeInstanceType](~~428502~~) operation to obtain the ID.',
+ 'enumValueTitles' => ['appstreaming.vgpu.8c16g.4g' => '无影-图形型_8核16G 4G显存', 'appstreaming.general.8c16g' => '无影-通用型_8核16G', 'appstreaming.general.4c8g' => '无影-通用型_4核8G', 'appstreaming.vgpu.14c93g.12g' => '无影-图形型_14核93G 12G显存', 'appstreaming.vgpu.8c31g.16g' => '无影-图形型_8核31G 16G显存'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'appstreaming.general.4c8g',
+ 'title' => '',
+ ],
+ 'NodeAmount' => ['description' => 'The number of resources to purchase. Valid values: 1 to 100.'."\n"
."\n"
- .'Valid values:'."\n"
+ .'>- This parameter is required for subscription resources.'."\n"
+ .'>- This parameter is required for pay-as-you-go resources when the scaling mode (`StrategyType`) is set to fixed quantity (`NODE_FIXED`) or auto scaling (`NODE_SCALING_BY_USAGE`).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ 'NodeCapacity' => ['description' => 'The number of concurrent sessions, which is the number of sessions that a single resource can handle simultaneously. Too many concurrent sessions may degrade the application experience. The valid value range varies by resource specification. You can call the ListNodeInstanceType operation to obtain the valid value range for each resource specification.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ 'StrategyType' => [
+ 'description' => 'The scaling mode.'."\n"
+ ."\n"
+ .'> '."\n"
+ .'>- `NODE_FIXED` (fixed quantity): applicable to subscription and pay-as-you-go resources.'."\n"
+ .'>- `NODE_SCALING_BY_USAGE` (auto scaling): applicable to subscription and pay-as-you-go resources.'."\n"
+ .'>- `NODE_SCALING_BY_SCHEDULE` (scheduled scaling): applicable only to pay-as-you-go resources.',
+ 'enumValueTitles' => ['NODE_FIXED' => 'Fixed quantity (no elastic scaling).', 'NODE_SCALING_BY_SCHEDULE' => 'Scheduled scaling.', 'NODE_SCALING_BY_USAGE' => 'Auto scaling.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NODE_FIXED',
+ 'title' => '',
+ ],
+ 'MaxScalingAmount' => ['description' => 'The maximum number of resources that can be created during scale-out. This field is required when `StrategyType` is set to `NODE_SCALING_BY_USAGE` (elastic resources).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ 'MaxIdleAppInstanceAmount' => ['description' => 'The maximum number of idle sessions. When this value is specified, auto scale-out is triggered only when the session usage exceeds `ScalingUsageThreshold` and the number of idle sessions in the current delivery group is less than `MaxIdleAppInstanceAmount`. Otherwise, the idle sessions are considered sufficient and no auto scale-out is performed. This parameter allows you to flexibly control elastic scaling behavior and reduce costs.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''],
+ 'ScalingStep' => ['description' => 'The number of resources to create per scale-out operation. Valid values: 1 to 10. This field is required when `StrategyType` is set to `NODE_SCALING_BY_USAGE` (elastic resources).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ 'ScalingUsageThreshold' => ['description' => 'The upper threshold of session usage (%). Auto scale-out is triggered when the session usage exceeds this threshold. The session usage is calculated as follows: `Session usage = Current sessions ÷ (Total resources × Concurrent sessions per resource) × 100%`. This field is required when `StrategyType` is set to `NODE_SCALING_BY_USAGE` (elastic resources). Valid values: 0 to 100. Default value: 85.', 'type' => 'string', 'required' => false, 'example' => '85', 'title' => ''],
+ 'ScalingDownAfterIdleMinutes' => ['description' => 'The maximum duration (in minutes) that a resource without active sessions is retained. When no sessions are connected to a resource, a countdown starts based on this value. The resource is released when the countdown ends. Valid values: 5 to 120. Default value: 5. The following exceptions apply:'."\n"
."\n"
- .'* CloudDesktop: Elastic Desktop Service'."\n"
- .'* CloudApp: App Streaming'."\n"
- .'* WuyingServer: Workstation'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'CloudDesktop' => '',
- 'CloudApp' => '',
- 'WuyingServer' => '',
+ .'- If releasing the resource would trigger auto scale-out again, the scale-down is not performed to avoid repeated scaling operations.'."\n"
+ .'- If auto scale-out is triggered due to increased sessions during this period, the resource is not released as originally planned, and the countdown restarts.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''],
+ 'StrategyEnableDate' => ['description' => 'The date when the policy takes effect. Format: yyyy-MM-dd. The date must be equal to or later than the current date. This field is required when `StrategyType` (scaling mode) is set to `NODE_SCALING_BY_SCHEDULE` (scheduled scaling).', 'type' => 'string', 'required' => false, 'example' => '2022-08-01', 'title' => ''],
+ 'StrategyDisableDate' => ['description' => 'The date when the policy expires. Format: yyyy-MM-dd. The interval between the expiration date and the effective date must be between 7 days and 1 year, inclusive. This field is required when `StrategyType` (scaling mode) is set to `NODE_SCALING_BY_SCHEDULE` (scheduled scaling).', 'type' => 'string', 'required' => false, 'example' => '2022-09-08', 'title' => ''],
+ 'WarmUp' => ['description' => 'Specifies whether to enable the resource prefetch policy. This field is required when `StrategyType` (scaling mode) is set to `NODE_SCALING_BY_SCHEDULE` (scheduled scaling).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'RecurrenceSchedules' => [
+ 'description' => 'The list of recurrence schedules. This field is required when `StrategyType` (scaling mode) is set to `NODE_SCALING_BY_SCHEDULE` (scheduled scaling).',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The recurrence schedule.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RecurrenceType' => [
+ 'description' => 'The type of the recurrence schedule. You must specify both `RecurrenceType` and `RecurrenceValues`.',
+ 'enumValueTitles' => ['weekly' => 'Weekly (the scheduled task is executed on specified days each week).'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'weekly',
+ 'title' => '',
+ ],
+ 'RecurrenceValues' => [
+ 'description' => 'The list of recurrence values.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The recurrence value.',
+ 'enumValueTitles' => [1 => 'Monday.', 'Tuesday.', 'Wednesday.', 'Thursday.', 'Friday.', 'Saturday.', 'Sunday.'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 7,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TimerPeriods' => [
+ 'description' => 'The list of time periods for the recurrence schedule. Requirements for time period settings:'."\n"
+ ."\n"
+ .'- You can add up to 3 time periods.'."\n"
+ .'- Time periods must not overlap.'."\n"
+ .'- The interval between time periods must be at least 5 minutes.'."\n"
+ .'- Each time period must be at least 15 minutes long.'."\n"
+ .'- All time periods combined must not span across days.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The time period for the recurrence schedule.',
+ 'type' => 'object',
+ 'properties' => [
+ 'StartTime' => ['description' => 'The start time. Format: HH:mm.', 'type' => 'string', 'required' => false, 'example' => '12:00', 'title' => ''],
+ 'EndTime' => ['description' => 'The end time. Format: HH:mm.', 'type' => 'string', 'required' => false, 'example' => '15:00', 'title' => ''],
+ 'Amount' => ['description' => 'The resource count.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 5,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 7,
+ 'title' => '',
+ 'example' => '',
],
- 'example' => 'CloudApp',
],
'required' => false,
- 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'BizTypeList',
+ 'name' => 'Network',
'in' => 'formData',
- 'style' => 'repeatList',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The list of all service types. It is not available publicly.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The service type. Specify this parameter based on the service you actually use.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* 1 (default)'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '',
+ 'description' => 'The network configuration.'."\n"
+ ."\n"
+ .'> To use this parameter, submit a ticket.',
+ 'type' => 'object',
+ 'properties' => [
+ 'StrategyType' => [
+ 'description' => 'The network policy type.',
+ 'enumValueTitles' => ['Mixed' => 'Mixed mode: single VPC, dual NICs with dedicated public IP addresses.', 'Shared' => 'Shared mode: single NIC, public network access through NAT gateway.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Shared',
+ 'title' => '',
+ ],
+ 'Routes' => [
+ 'description' => 'The route configurations. This parameter can be configured only when the network policy type (`StrategyType`) is set to mixed mode (`Mixed`).',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The route configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Destination' => ['description' => 'The access destination. CIDR format.', 'type' => 'string', 'required' => false, 'example' => '139.196.XX.XX/32', 'title' => ''],
+ 'Mode' => [
+ 'description' => 'The network egress mode.',
+ 'enumValueTitles' => ['Shared' => 'Access through NAT gateway.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Shared',
+ 'title' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'IpExpireMinutes' => ['description' => 'The duration (in minutes) after which the public IP address is refreshed upon the next logon. Minimum value: 60.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '60', 'required' => false, 'example' => '60', 'title' => ''],
+ 'OfficeSiteId' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong+dir-842567****', 'title' => ''],
+ 'VSwitchIds' => [
+ 'description' => 'The list of vSwitch IDs.'."\n"
+ ."\n"
+ .'- Valid only for custom office networks.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-m5ef1sjhf7bbvqvvy****', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DomainRules' => [
+ 'description' => 'The domain name rule configurations.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The domain name rule.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'required' => false, 'example' => 'www.example.com', 'title' => ''],
+ 'Policy' => [
+ 'description' => 'The policy value.',
+ 'enumValueTitles' => ['allow' => 'Allow access.', 'block' => 'Block access.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'block',
+ 'title' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'example' => '1',
],
'required' => false,
- 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'FeatureList',
+ 'name' => 'StoragePolicy',
'in' => 'formData',
- 'style' => 'repeatList',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The features supported by the image.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The feature supported by the image.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* FotaChannel: supports FOTA channels.'."\n"
- .'* Builder: supports image builder.'."\n"
- .'* MultiSession: supports multiple sessions.'."\n"
- .'* GPU: supports GPU.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'FotaChannel' => '',
- 'Builder' => '',
- 'MultiSession' => '',
- 'GPU' => '',
+ 'description' => 'The storage policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'StorageTypeList' => [
+ 'description' => 'The list of storage types.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The storage type.',
+ 'enumValueTitles' => ['OFF' => 'Disabled.', 'PDS' => 'Drive and Photo Service.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PDS',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'UserProfile' => [
+ 'description' => 'The user data roaming configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserProfileSwitch' => [
+ 'description' => 'Specifies whether to enable user data roaming.',
+ 'enumValueTitles' => ['false' => 'Disabled.', 'true' => 'Enabled.'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
+ ],
+ 'RemoteStorageType' => [
+ 'description' => 'The remote storage type used for user data roaming.',
+ 'enumValueTitles' => ['NAS' => 'NAS'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NAS',
+ 'title' => '',
+ ],
+ 'RemoteStoragePath' => ['description' => 'The remote storage path for user data roaming.'."\n"
+ .'- If not specified, the default value is the delivery group ID.'."\n"
+ .'- For cross-delivery-group (same VPC) user data roaming, set the same value for all delivery groups involved.', 'type' => 'string', 'required' => false, 'example' => 'ID20250101', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'example' => 'GPU',
],
'required' => false,
- 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'LanguageType',
+ 'name' => 'PreOpenAppId',
'in' => 'formData',
+ 'schema' => ['description' => 'The pre-opened application ID.', 'type' => 'string', 'required' => false, 'example' => 'cag-b2ronxxd****', 'title' => ''],
+ ],
+ [
+ 'name' => 'VideoPolicy',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'zh-CN,zh-HK,en-US,ja-JP,CN,EN,JP,CN-HK',
- 'description' => 'The language.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* en-US: English.'."\n"
- .'* zh-HK: Chinese, Traditional (Hong Kong, China).'."\n"
- .'* zh-CN: Simplified Chinese.'."\n"
- .'* ja-JP: Japanese.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'en-US' => '',
- 'zh-HK' => '',
- 'zh-CN' => '',
- 'ja-JP' => '',
+ 'description' => 'The display policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'FrameRate' => [
+ 'description' => 'The frame rate (FPS).',
+ 'enumValueTitles' => [30 => '30 FPS', 60 => '60 FPS'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '60',
+ 'title' => '',
+ ],
+ 'TerminalResolutionAdaptive' => [
+ 'description' => 'Specifies whether to use adaptive resolution.'."\n"
+ ."\n"
+ .'- `true`: The session resolution follows the terminal display area. In this case, `SessionResolutionWidth` and `SessionResolutionHeight` specify the maximum resolution values.'."\n"
+ ."\n"
+ .'- `false`: The session resolution does not follow the terminal display area. In this case, the resolution is fixed to the values of `SessionResolutionWidth` and `SessionResolutionHeight`.',
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
+ ],
+ 'SessionResolutionWidth' => ['description' => 'The width of the resolution, in pixels.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1920', 'title' => ''],
+ 'SessionResolutionHeight' => ['description' => 'The height of the resolution, in pixels.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1080', 'title' => ''],
+ 'StreamingMode' => [
+ 'description' => 'The streaming mode. Used together with the `Webrtc` parameter to specify the protocol type.'."\n"
+ ."\n"
+ .'- `Webrtc`=`true` and `StreamingMode`=`video`: WebRTC streaming.'."\n"
+ .'- `Webrtc`=`false` and `StreamingMode`=`video`: video streaming.'."\n"
+ .'- `Webrtc`=`false` and `StreamingMode`=`mix`: mixed streaming.',
+ 'enumValueTitles' => ['video' => 'Video streaming.', 'mix' => 'Mixed streaming.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'video',
+ 'title' => '',
+ ],
+ 'Webrtc' => [
+ 'description' => 'Specifies whether to enable WebRTC. Used together with the `StreamingMode` parameter to specify the protocol type.'."\n"
+ ."\n"
+ .'- `Webrtc`=`true` and `StreamingMode`=`video`: WebRTC streaming.'."\n"
+ .'- `Webrtc`=`false` and `StreamingMode`=`video`: video streaming.'."\n"
+ .'- `Webrtc`=`false` and `StreamingMode`=`mix`: mixed streaming.',
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'title' => '',
+ ],
],
- 'example' => 'zh-CN',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ResourceInstanceType',
+ 'name' => 'RuntimePolicy',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => 'Find images with certain fixed specifications.'."\n",
- 'type' => 'string',
+ 'description' => 'The runtime policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SessionType' => [
+ 'description' => 'The session type.',
+ 'enumValueTitles' => ['CONSOLE' => 'Console session.', 'NORMAL' => 'RDP session.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NORMAL',
+ 'title' => '',
+ ],
+ 'DebugMode' => [
+ 'description' => 'Specifies whether to enable debug mode. To call `GetDebugAppInstance` and `CreateImageFromAppInstanceGroup`, set this field to `ON`.',
+ 'enumValueTitles' => ['OFF' => 'Disabled.', 'ON' => 'Enabled.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'OFF',
+ 'title' => '',
+ ],
+ 'SessionUserGenerationMode' => [
+ 'description' => 'The generation mode for session users.'."\n"
+ .'- wyid: The session pre-open (SessionPreOpen) must be set to false.',
+ 'enumValueTitles' => ['wyid' => 'wyid'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'wyid',
+ 'title' => '',
+ ],
+ 'SessionPreOpen' => [
+ 'description' => 'Specifies whether to enable session pre-opening.'."\n"
+ .'- If not specified, the default value is true.',
+ 'enumValueTitles' => ['true' => 'Enabled.', 'false' => 'Disabled.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
+ ],
+ 'PerSessionPerApp' => [
+ 'description' => 'Specifies whether to allow only one application per session.'."\n"
+ .'- When enabled, opening multiple applications in the delivery group allocates a separate session for each application, consuming more sessions.',
+ 'enumValueTitles' => ['true' => 'Enabled.', 'false' => 'Disabled.'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
+ ],
+ 'PersistentAppInstanceScheduleMode' => [
+ 'title' => '',
+ 'description' => 'The scheduling mode for persistent sessions.',
+ 'enumValueTitles' => ['DYNAMIC' => 'Dynamic scheduling. The same persistent session can be scheduled to different nodes.', 'FIX_NODE' => 'Fixed-node scheduling. The same persistent session can only be scheduled to a fixed node.'],
+ 'type' => 'string',
+ 'example' => 'DYNAMIC',
+ 'default' => 'DYNAMIC',
+ 'enum' => ['DYNAMIC', 'FIX_NODE'],
+ 'required' => false,
+ ],
+ ],
'required' => false,
- 'example' => 'eds.enterprise_office.2c4g',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'FotaVersion',
+ 'name' => 'SecurityPolicy',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The image version.'."\n",
- 'type' => 'string',
+ 'description' => 'The security policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResetAfterUnbind' => [
+ 'description' => 'Specifies whether to reset after unbinding.',
+ 'enumValueTitles' => ['true' => 'Reset.', 'false' => 'Do not reset.'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ 'SkipUserAuthCheck' => [
+ 'description' => 'Specifies whether to skip user authorization verification.',
+ 'enumValueTitles' => ['true' => 'Skip verification.', 'false' => 'Perform verification. [Default value].'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
+ ],
+ ],
'required' => false,
- 'example' => '2.0.3-xxxx',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PlatformName',
- 'in' => 'formData',
+ 'name' => 'UserDefinePolicy',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The name of the operating system platform.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Ubuntu'."\n"
- .'* Debian'."\n"
- .'* Windows Server 2022'."\n"
- .'* Windows Server 2019'."\n"
- .'* Windows Server 2016'."\n"
- .'* Windows 11'."\n"
- .'* Windows 10'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Ubuntu' => '',
- 'Debian' => '',
- 'Windows Server 2022' => '',
- 'Windows Server 2019' => '',
- 'Windows Server 2016' => '',
- 'Windows 11' => '',
- 'Windows 10' => '',
+ 'description' => 'The user-defined policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CustomConfig' => ['description' => 'The custom policy content. The content must comply with the image version specifications. To use this parameter, submit a ticket to enable the whitelist.', 'type' => 'string', 'required' => false, 'example' => '[{"target":"agent","config":{"abc":"xxx"}}]', 'title' => ''],
],
- 'example' => 'Windows Server 2019',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'BizRegionIdList',
+ 'name' => 'AppPolicyId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'example' => 'pg-0clfzcy0adpcf****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'cls-d39iq73l5c0a8****', 'title' => ''],
+ ],
+ [
+ 'name' => 'SubPayType',
'in' => 'formData',
- 'style' => 'repeatList',
'schema' => [
- 'description' => 'The regions that are supported. The EDS images are centralized. Use this parameter to query the regions where the image is deployed.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'description' => 'The billing method subtype.',
+ 'enumValueTitles' => ['postPaid' => 'Pay-as-you-go.', 'monthPackage' => 'Monthly package (supported only for cloud browsers).', 'prePaid' => 'Subscription.'],
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 100,
+ 'example' => 'postPaid',
+ 'title' => '',
],
],
[
- 'name' => 'TagList',
- 'in' => 'query',
- 'style' => 'repeatList',
+ 'name' => 'AppPackageType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The package type.', 'type' => 'string', 'required' => false, 'example' => 'browser.package.5.250.appstreaming.general.basic', 'title' => ''],
+ ],
+ [
+ 'name' => 'AuthMode',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The tags to query.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The key of the custom tag.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'env',
- ],
- 'Value' => [
- 'description' => 'The value of the custom tag.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- 'required' => false,
- 'description' => '',
- ],
+ 'title' => '',
+ 'description' => 'The authorization mode of the delivery group.',
+ 'enumValueTitles' => ['App' => 'Application authorization.', 'AppInstanceGroup' => 'Delivery group authorization.', 'Session' => 'Persistent session authorization.'],
+ 'type' => 'string',
+ 'example' => 'App',
+ 'default' => 'App',
+ 'enum' => ['App', 'Session', 'AppInstanceGroup'],
'required' => false,
- 'maxItems' => 100,
],
],
[
- 'name' => 'PlatformNameList',
+ 'name' => 'UserGroupIds',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The list of supported platform types. For valid values, refer to PlatformName above.'."\n",
+ 'title' => '',
+ 'description' => 'The list of authorized user group IDs.',
'type' => 'array',
- 'items' => [
- 'description' => 'The name of the image platform.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Windows 11',
- ],
+ 'items' => ['title' => '', 'description' => 'The authorized user group ID.', 'type' => 'string', 'required' => false, 'example' => ''],
'required' => false,
- 'maxItems' => 100,
+ 'maxItems' => 10,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ImageBaseInfoModel',
- 'description' => 'The information about the image.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'title' => '每页展示数据条数。',
- ],
- 'PageNumber' => [
- 'description' => 'The page number returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'title' => '返回数据的页数。',
- ],
- 'Data' => [
- 'description' => 'The returned data.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The returned data.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'GmtCreate' => [
- 'title' => '创建时间',
- 'description' => 'The creation time.'."\n",
- 'type' => 'string',
- 'example' => '2025-04-25 15:13:57',
- ],
- 'GmtModified' => [
- 'title' => '更新时间',
- 'description' => 'The update time.'."\n",
- 'type' => 'string',
- 'example' => '2025-04-25 15:13:57',
- ],
- 'AliUid' => [
- 'title' => '租户ID,0是系统镜像',
- 'description' => 'The tenant ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456789',
- ],
- 'ImageId' => [
- 'title' => '系统镜像id有含义,自定义镜像自动生成',
- 'description' => 'System image IDs follow a descriptive, human-readable format, while custom image IDs are automatically generated by the system.'."\n",
- 'type' => 'string',
- 'example' => 'imgc-xxxx',
- ],
- 'ImageName' => [
- 'title' => '镜像名称',
- 'description' => 'The image name.'."\n",
- 'type' => 'string',
- 'example' => 'DemoImage',
- ],
- 'ImageType' => [
- 'title' => '镜像类型',
- 'description' => 'The type of the image.'."\n",
- 'type' => 'string',
- 'example' => 'User',
- ],
- 'PackageType' => [
- 'title' => '镜像封装类型 ECS/VHD/Container/ECS_APP',
- 'description' => 'The image encapsulation type.'."\n",
- 'type' => 'string',
- 'example' => 'ECS',
- ],
- 'Description' => [
- 'title' => '镜像描述',
- 'description' => 'The description of the image.'."\n",
- 'type' => 'string',
- 'example' => '描述',
- ],
- 'OsType' => [
- 'title' => '镜像类型',
- 'description' => 'The type of the image.'."\n",
- 'type' => 'string',
- 'example' => 'Windows',
- ],
- 'ProtocolType' => [
- 'title' => '协议类型 ASP/HDX/ALL',
- 'description' => 'The protocol type.'."\n",
- 'type' => 'string',
- 'example' => 'ASP',
- ],
- 'BizType' => [
- 'title' => '业务线',
- 'description' => 'The service type.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ProductType' => [
- 'title' => '产品线',
- 'description' => 'The product type.'."\n",
- 'type' => 'string',
- 'example' => 'CloudApp',
- ],
- 'VersionId' => [
- 'title' => '镜像版本',
- 'description' => 'The version of the image.'."\n",
- 'type' => 'string',
- 'example' => 'iv-xxx',
- ],
- 'OnlineVersionId' => [
- 'title' => '当前镜像最新版本',
- 'description' => 'This image tag currently points to the specified sub-version of the parent image. (An image consists of multiple sub-versions.)'."\n",
- 'type' => 'string',
- 'example' => 'iv-xxxx',
- ],
- 'LatestVersionId' => [
- 'title' => '该镜像的最新版本',
- 'description' => 'The latest sub-version of the image. (An image consists of multiple sub-versions.)'."\n",
- 'type' => 'string',
- 'example' => 'iv-xxx',
- ],
- 'Status' => [
- 'title' => '状态 ImageStatusEnum',
- 'description' => 'The state of the image.'."\n",
- 'type' => 'string',
- 'example' => 'INIT',
- ],
- 'ParentImageId' => [
- 'title' => '父镜像ID,只表示继承关系,系统镜像无父镜像',
- 'description' => 'The ID of the parent image from which this image is derived. Note: This field is only applicable to custom images, as system images do not have a parent.'."\n",
- 'type' => 'string',
- 'example' => 'imgc-xxx',
- ],
- 'ParentImageVersion' => [
- 'title' => '父镜像版本',
- 'description' => 'The version of the parent image.'."\n",
- 'type' => 'string',
- 'example' => 'iv-xxx',
- ],
- 'BaseImageId' => [
- 'title' => '基础镜像ID',
- 'description' => 'The base image ID.'."\n",
- 'type' => 'string',
- 'example' => 'imgc-xxx',
- ],
- 'BaseImageVersion' => [
- 'title' => '基础镜像版本',
- 'description' => 'The version of the base image.'."\n",
- 'type' => 'string',
- 'example' => 'iv-xxx',
- ],
- 'FotaVersion' => [
- 'title' => 'fota版本',
- 'description' => 'The FOTA version.'."\n",
- 'type' => 'string',
- 'example' => '2.3.0-xxx',
- ],
- 'Language' => [
- 'title' => '镜像语言',
- 'description' => 'The image language. When the packaging type is VHD or Container, the image inherits its properties from the ECS-type image within the same image bundle.'."\n",
- 'type' => 'string',
- 'example' => 'zh-CN',
- ],
- 'Platform' => [
- 'title' => '镜像平台类型整型值',
- 'description' => 'The operating system platform of the image.'."\n"
- ."\n"
- .'> When the packaging type is VHD or Container, the image inherits its properties from the ECS-type image within the same image bundle.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'Windows',
- ],
- 'OnlineVersion' => [
- 'title' => '当前版本是否是生效版本',
- 'description' => 'Indicates whether the current version is the active version.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'SystemDiskSize' => [
- 'description' => 'The size of the system disk. Unit: GiB.'."\n"
- ."\n"
- .'> The system disk must be at least as large as the image.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- 'title' => '系统盘大小。单位:GiB',
- ],
- 'DataDiskSize' => [
- 'description' => 'The size of the data disk. Unit: GiB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- 'title' => '数据盘大小。单位:GiB',
- ],
- 'AppList' => [
- 'description' => 'The application configuration.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'AppId' => [
- 'description' => 'The ID of the application.'."\n",
- 'type' => 'string',
- 'example' => 'ca-xxx',
- 'title' => '应用ID',
- ],
- 'AppName' => [
- 'description' => 'The name of the application.'."\n",
- 'type' => 'string',
- 'example' => '应用名称',
- 'title' => '应用名称',
- ],
- ],
- 'description' => '',
- 'title' => '应用配置',
- ],
- 'title' => '应用配置列表',
- ],
- 'FeatureList' => [
- 'description' => 'The image feature tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The image feature tag.'."\n",
- 'type' => 'string',
- 'example' => 'Builder',
- 'title' => '镜像特征标记',
- ],
- 'title' => '镜像特征标记',
- ],
- 'ImageCreateMode' => [
- 'description' => 'The image creation type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* BY_SNAPSHOT_ID: The image is created from the snapshot or contains only a system disk.'."\n"
- .'* BUILDER_MANUAL: The image is manually generated.'."\n"
- .'* INSTANCE_AUTO: The image is automatically generated based on an instance.'."\n"
- .'* BY_INSTANCE_ID: The image is created from an instance or contains both a system disk and data disks.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'BY_SNAPSHOT_ID' => '',
- 'BUILDER_MANUAL' => '',
- 'INSTANCE_AUTO' => '',
- 'BY_INSTANCE_ID' => '',
- ],
- 'example' => 'BUILDER_MANUAL',
- 'title' => '镜像创建类型',
- ],
- 'ImageRegionList' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The region.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- 'title' => '地域对象',
- ],
- 'title' => '地域对象',
- ],
- 'Distro' => [
- 'description' => 'The name of the release.'."\n",
- 'type' => 'string',
- 'example' => 'Ubuntu 22.04 64位',
- 'title' => '发行版名字',
- ],
- 'VersionName' => [
- 'description' => 'The version number.'."\n",
- 'type' => 'string',
- 'example' => 'v0.1.0',
- 'title' => '版本名称',
- ],
- 'ResourceInstanceCategory' => [
- 'description' => 'The types of resources that are supported by the images.'."\n",
- 'type' => 'string',
- 'example' => '["eds.cpu.category"]',
- 'title' => '镜像支持资源类型',
- ],
- 'PlatformName' => [
- 'description' => 'The name of the operating system platform.'."\n",
- 'type' => 'string',
- 'example' => 'Windows Server 2022',
- 'title' => '镜像平台类型',
- ],
- 'SupportedLanguageList' => [
- 'description' => 'The supported languages.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The supported language.'."\n",
- 'type' => 'string',
- 'example' => 'zh-CN',
- 'title' => '支持语言',
- ],
- 'title' => '支持语言列表',
- ],
- 'VolumeEncryptionEnabled' => [
- 'description' => 'Specifies whether to enable disk encryption.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- 'title' => '是否开启磁盘加密',
- ],
- 'VolumeEncryptionKey' => [
- 'description' => 'The ID of the Key Management Service (KMS) key that is used to encrypt the disk.'."\n",
- 'type' => 'string',
- 'example' => 'a7b3c0c8-xxxx',
- 'title' => '开启磁盘加密的情况下使用的KMS的密钥ID',
- ],
- 'SessionType' => [
- 'description' => 'The type of the session.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* SINGLE_SESSION'."\n"
- .'* MULTIPLE_SESSION'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'SINGLE_SESSION' => '',
- 'MULTIPLE_SESSION' => '',
- ],
- 'example' => 'SINGLE_SESSION',
- 'title' => '会话类型',
- ],
- 'ImageRegionDistributeList' => [
- 'title' => '叠层有效地域信息',
- 'description' => 'Layered supported regions information.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ImageId' => [
- 'title' => '系统镜像id有含义,自定义镜像自动生成',
- 'description' => 'System image IDs follow a descriptive, human-readable format, while custom image IDs are automatically generated by the system.'."\n",
- 'type' => 'string',
- 'example' => 'imgc-xxx',
- ],
- 'RegionId' => [
- 'title' => '支持地域',
- 'description' => 'The supported region.'."\n",
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- 'Status' => [
- 'title' => '状态',
- 'description' => 'The status.'."\n",
- 'type' => 'string',
- 'example' => 'INIT',
- ],
- 'VersionId' => [
- 'title' => '镜像版本',
- 'description' => 'The version of the image.'."\n",
- 'type' => 'string',
- 'example' => 'iv-xxx',
- ],
- 'Progress' => [
- 'title' => '进度百分比',
- 'description' => 'The progress.'."\n",
- 'type' => 'string',
- 'example' => '70%',
- ],
- ],
- 'description' => '',
- 'title' => '镜像地域列表',
- ],
- ],
- 'FotaChannel' => [
- 'description' => '> This parameter is not available for public use.'."\n",
- 'type' => 'string',
- 'example' => '镜像支持的fota渠道,暂未启用',
- 'title' => '> 此参数暂未对外开放使用。',
- ],
- 'CompatibleMode' => [
- 'description' => 'Specifies whether to use the compatibility mode.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- 'title' => '是否为兼容模式。',
- ],
- 'DriverList' => [
- 'description' => 'The information about each driver.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The drivers.'."\n",
- 'type' => 'string',
- 'example' => '["00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]',
- 'title' => '驱动ID',
- ],
- 'title' => '驱动列表。',
- ],
- 'Scene' => [
- 'title' => '镜像使用的场景',
- 'type' => 'string',
- 'example' => 'AIGC',
- ],
- 'Rating' => [
- 'title' => '镜像评分值,满分100',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '95',
- ],
- 'ImageIconUrl' => [
- 'title' => '镜像图标URL',
- 'type' => 'string',
- ],
- 'EnvironmentId' => [
- 'title' => '镜像使用环境ID',
- 'type' => 'string',
- 'example' => 'env-164c321f405ca84143e4b730dbe4',
- ],
- 'TagList' => [
- 'title' => '标签列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签列表',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签键。',
- 'type' => 'string',
- 'example' => '1630348213973321',
- ],
- 'Value' => [
- 'title' => '标签值。',
- 'type' => 'string',
- 'example' => 'inner',
- ],
- ],
- ],
- ],
- 'SnapshotList' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'SnapshotId' => [
- 'type' => 'string',
- ],
- 'VersionId' => [
- 'type' => 'string',
- ],
- 'DiskType' => [
- 'type' => 'string',
- ],
- 'DiskSubType' => [
- 'type' => 'string',
- ],
- 'BindType' => [
- 'type' => 'string',
- ],
- 'DiskCategory' => [
- 'type' => 'string',
- ],
- 'Size' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- ],
- 'title' => '返回对象。',
- ],
- 'title' => '返回对象。',
- ],
- 'Count' => [
- 'description' => 'The total number of entries.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22',
- 'title' => '总条数。',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true: The request is successful.'."\n"
- .'* false: The request failed.'."\n",
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'AppInstanceGroupModel' => [
+ 'description' => 'The delivery group.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppInstanceGroupId' => ['description' => 'The delivery group ID.', 'type' => 'string', 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '12345****', 'title' => ''],
+ 'NodePoolId' => ['description' => 'The resource group ID. This parameter is returned if a resource group is created at the same time.', 'type' => 'string', 'example' => 'rg-ew7va2g1wl3vm****', 'title' => ''],
],
- 'example' => 'true',
- 'title' => '是否调用成功。',
- ],
- 'Code' => [
- 'description' => 'The HTTP status code that is returned.'."\n",
- 'type' => 'string',
- 'example' => '200',
- 'title' => '错误码。',
- ],
- 'Message' => [
- 'description' => 'The message that is returned for the request.'."\n",
- 'type' => 'string',
- 'example' => 'success',
- 'title' => '接口请求返回的信息。',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '8737D130-BFD0-5D51-96F6-C08EB1139A25',
- 'title' => '请求ID。',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Internal error.',
- ],
- [
- 'errorCode' => 'InvalidBizType',
- 'errorMessage' => 'The bizType parameter is invalid.',
- ],
+ ['errorCode' => 'StockError.NoStock', 'errorMessage' => 'The selected specification is out of stock. Please try again later or select other specifications.', 'description' => 'The selected specification is out of stock. Please try again later or select other specifications.'],
],
- 403 => [
- [
- 'errorCode' => 'Forbidden.NoPermission',
- 'errorMessage' => 'You are not authorized to access this page.',
+ 500 => [
+ ['errorCode' => 'StockError.InvalidResourceRequest', 'errorMessage' => 'Your request cannot be processed currently due to an error. Please try again later.', 'description' => 'The inventory check failed and the system is temporarily unable to process your request. Please try again later.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AppInstanceGroupModel\\": {\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"OrderId\\": \\"12345****\\",\\n \\"NodePoolId\\": \\"rg-ew7va2g1wl3vm****\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a delivery group',
+ 'description' => 'Make sure that you are familiar with the [billing and pricing](~~426039~~) of WUYING Cloud Application before you call this operation.'."\n"
+ ."\n"
+ .'A delivery group is a logical grouping for delivering cloud applications to end users. It includes the underlying cloud application resources, images that contain cloud applications, resource management policies, and user assignment settings. For details, see [Publish a delivery group](~~426046~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppInstanceGroup'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": \\"2025-04-25 15:13:57\\",\\n \\"GmtModified\\": \\"2025-04-25 15:13:57\\",\\n \\"AliUid\\": 123456789,\\n \\"ImageId\\": \\"imgc-xxxx\\",\\n \\"ImageName\\": \\"DemoImage\\",\\n \\"ImageType\\": \\"User\\",\\n \\"PackageType\\": \\"ECS\\",\\n \\"Description\\": \\"描述\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"BizType\\": 1,\\n \\"ProductType\\": \\"CloudApp\\",\\n \\"VersionId\\": \\"iv-xxx\\",\\n \\"OnlineVersionId\\": \\"iv-xxxx\\",\\n \\"LatestVersionId\\": \\"iv-xxx\\",\\n \\"Status\\": \\"INIT\\",\\n \\"ParentImageId\\": \\"imgc-xxx\\",\\n \\"ParentImageVersion\\": \\"iv-xxx\\",\\n \\"BaseImageId\\": \\"imgc-xxx\\",\\n \\"BaseImageVersion\\": \\"iv-xxx\\",\\n \\"FotaVersion\\": \\"2.3.0-xxx\\",\\n \\"Language\\": \\"zh-CN\\",\\n \\"Platform\\": 0,\\n \\"OnlineVersion\\": true,\\n \\"SystemDiskSize\\": 40,\\n \\"DataDiskSize\\": 100,\\n \\"AppList\\": [\\n {\\n \\"AppId\\": \\"ca-xxx\\",\\n \\"AppName\\": \\"应用名称\\"\\n }\\n ],\\n \\"FeatureList\\": [\\n \\"Builder\\"\\n ],\\n \\"ImageCreateMode\\": \\"BUILDER_MANUAL\\",\\n \\"ImageRegionList\\": [\\n \\"地域对象。\\"\\n ],\\n \\"Distro\\": \\"Ubuntu 22.04 64位\\",\\n \\"VersionName\\": \\"v0.1.0\\",\\n \\"ResourceInstanceCategory\\": \\"[\\\\\\"eds.cpu.category\\\\\\"]\\",\\n \\"PlatformName\\": \\"Windows Server 2022\\",\\n \\"SupportedLanguageList\\": [\\n \\"zh-CN\\"\\n ],\\n \\"VolumeEncryptionEnabled\\": true,\\n \\"VolumeEncryptionKey\\": \\"a7b3c0c8-xxxx\\",\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"ImageRegionDistributeList\\": [\\n {\\n \\"ImageId\\": \\"imgc-xxx\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Status\\": \\"INIT\\",\\n \\"VersionId\\": \\"iv-xxx\\",\\n \\"Progress\\": \\"70%\\"\\n }\\n ],\\n \\"FotaChannel\\": \\"镜像支持的fota渠道,暂未启用\\",\\n \\"CompatibleMode\\": true,\\n \\"DriverList\\": [\\n \\"[\\\\\\"00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\\\\\"]\\"\\n ],\\n \\"Scene\\": \\"AIGC\\",\\n \\"Rating\\": 95,\\n \\"ImageIconUrl\\": \\"\\",\\n \\"EnvironmentId\\": \\"env-164c321f405ca84143e4b730dbe4\\",\\n \\"TagList\\": [\\n {\\n \\"Key\\": \\"1630348213973321\\",\\n \\"Value\\": \\"inner\\"\\n }\\n ],\\n \\"SnapshotList\\": [\\n {\\n \\"SnapshotId\\": \\"\\",\\n \\"VersionId\\": \\"\\",\\n \\"DiskType\\": \\"\\",\\n \\"DiskSubType\\": \\"\\",\\n \\"BindType\\": \\"\\",\\n \\"DiskCategory\\": \\"\\",\\n \\"Size\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Count\\": 22,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"8737D130-BFD0-5D51-96F6-C08EB1139A25\\"\\n}","type":"json"}]',
- 'title' => 'ListImage',
],
'CreateImageByInstance' => [
- 'summary' => 'Create a custom image from a deployed instance. This allows you to quickly create more instances with the same configurations and avoid repeatedly configuring the instance environment each time you create the instance.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Creates a custom image from a deployed WUYING instance. You can use the custom image to quickly create more WUYING instances with the same configurations, without having to repeatedly configure the instance environment each time.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2414,9 +1689,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '248026',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingSH8DGI',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingSH8DGI'],
'autoTest' => true,
],
'parameters' => [
@@ -2424,64 +1697,38 @@
'name' => 'ImageName',
'in' => 'formData',
'schema' => [
- 'title' => '镜像名称',
- 'description' => 'The name of the image.'."\n",
+ 'title' => '',
+ 'description' => 'The image name.',
+ 'enumValueTitles' => [],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [],
'example' => 'test',
],
],
[
'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'title' => '镜像描述',
- 'description' => 'The description of the image.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my test image v1.0',
- ],
+ 'schema' => ['title' => '', 'description' => 'The image description.', 'type' => 'string', 'required' => false, 'example' => 'my test image v1.0'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The ID of the RDS instance. The instance can be a CloudDesktop instance, a workstation instance. To ensure data consistency in the image, we recommend that you shut down the instance before you create an image.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ws-0buj1s9gm******',
- ],
+ 'schema' => ['title' => '', 'description' => 'The WUYING instance ID. The instance can be a cloud desktop instance or a workstation instance. To ensure data consistency in the image, stop the instance before creating the image.', 'type' => 'string', 'required' => false, 'example' => 'ws-0buj1s9gm******'],
],
[
'name' => 'SubInstanceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '实例版本',
- 'description' => 'The ID of the child instance. This parameter is not used in cloud computing scenarios. Workstation scenarios, you need to specify a persistent session ID to ensure that a specific instance is located.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'p-0cc7s3n1l*****',
- ],
+ 'schema' => ['title' => '', 'description' => 'The sub-instance ID. This parameter is not applicable to cloud desktop scenarios. In workstation scenarios, specify the persistent session ID to identify a specific instance.', 'type' => 'string', 'required' => false, 'example' => 'p-0cc7s3n1l*****'],
],
[
'name' => 'InstanceType',
'in' => 'formData',
'schema' => [
- 'title' => '实例类型',
- 'description' => 'The instance type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* CloudDesktop: Cloud Desktop.'."\n"
- .'* WuyingServer: Workstation'."\n",
+ 'title' => '',
+ 'description' => 'The instance type.',
+ 'enumValueTitles' => ['CloudDesktop' => 'Cloud desktop.', 'WuyingServer' => 'Workstation.'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'CloudDesktop' => '',
- 'WuyingServer' => '',
- ],
'example' => 'WuyingServer',
],
],
@@ -2489,62 +1736,35 @@
'name' => 'AutoCleanUserdata',
'in' => 'formData',
'schema' => [
- 'description' => 'This parameter is applicable only to scenarios in which the instance type is Cloud Desktop. Specifies whether to clear private data of users. If this parameter is set to true, the created image clears data in directories other than Administrator and Public in the C:\\Users directory.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true: cleanup.'."\n"
- .'* false: does not clear.'."\n",
+ 'description' => 'This parameter is applicable only when the instance type is cloud desktop. Specifies whether to clear user personal data. If you set this parameter to true, the created image clears data in all directories under C:\\Users except the Administrator and Public directories.',
+ 'enumValueTitles' => ['true' => 'clear.', 'false' => 'do not clear.'],
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
'example' => 'false',
+ 'title' => '',
],
],
[
'name' => 'DiskType',
'in' => 'formData',
'schema' => [
- 'description' => 'The type of disk data contained in the image. By default, the system disk and data disk of the instance are included.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* SYSTEM: only system disk.'."\n"
- .'* ALL: system disk + data disk'."\n",
+ 'description' => 'The type of disk data included in the image. By default, the image includes both the system cloud disk and data cloud disk of the instance.',
+ 'enumValueTitles' => ['SYSTEM' => 'system cloud disk only.', 'ALL' => 'system cloud disk and data cloud disk.'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'SYSTEM' => '',
- 'ALL' => '',
- ],
'example' => 'ALL',
+ 'title' => '',
],
],
[
'name' => 'BizType',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务线 1:BASE/2:PERSONAL/3:CLOUD_OFFICE/4:CLOUD_FLOW/10:STANDARD',
- 'description' => 'This parameter is not publicly available.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'This parameter is not publicly available.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'ProductType',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品类型 CloudGame/CloudApp/CloudBrowser/CloudDesktop',
- 'description' => 'This parameter is not publicly available.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'WuyingServer',
- ],
+ 'schema' => ['title' => '', 'description' => 'This parameter is not publicly available.', 'type' => 'string', 'required' => false, 'example' => 'WuyingServer'],
],
[
'name' => 'TagList',
@@ -2555,516 +1775,431 @@
'items' => [
'type' => 'object',
'properties' => [
- 'Key' => [
- 'type' => 'string',
- ],
- 'Value' => [
- 'type' => 'string',
- ],
+ 'Key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<CreateImageResultModel>',
- 'description' => 'The request response structure.'."\n",
+ 'title' => '',
+ 'description' => 'The response struct.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'The returned data.'."\n",
+ 'description' => 'The returned object.',
'type' => 'object',
'properties' => [
- 'ImageId' => [
- 'title' => '系统镜像id有含义,自定义镜像自动生成',
- 'description' => 'The ID of the RDS image.'."\n",
- 'type' => 'string',
- 'example' => 'imgc-07hnjj5fp****',
- ],
- 'VersionId' => [
- 'title' => '镜像版本',
- 'description' => 'The version of the image.'."\n",
- 'type' => 'string',
- 'example' => 'iv-0abxi0lbi*****',
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => 'The ID of the image creation task.'."\n",
- 'type' => 'string',
- 'example' => 'tid-0abxi0lbih******',
- ],
+ 'ImageId' => ['title' => '', 'description' => 'The WUYING image ID.', 'type' => 'string', 'example' => 'imgc-07hnjj5fp****'],
+ 'VersionId' => ['title' => '', 'description' => 'The image version.', 'type' => 'string', 'example' => 'iv-0abxi0lbi*****'],
+ 'TaskId' => ['title' => '', 'description' => 'The task ID for creating the image.', 'type' => 'string', 'example' => 'tid-0abxi0lbih******'],
],
+ 'title' => '',
+ 'example' => '',
],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => 'The error code.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'The error message.'."\n",
- 'type' => 'string',
- 'example' => 'NULL',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'NULL', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Instance.NotFound',
- 'errorMessage' => 'The instance is not found.',
- ],
- [
- 'errorCode' => 'DesktopInstance.NotFound',
- 'errorMessage' => 'The cloud computer instance does not exist.',
- ],
- [
- 'errorCode' => 'Instance.ImageUnsupported',
- 'errorMessage' => 'A non-centralized image does not support this type of operation.',
- ],
- [
- 'errorCode' => 'Instance.PhysicalNodeNotExist',
- 'errorMessage' => 'The instance physical node does not exist.',
- ],
- [
- 'errorCode' => 'ImageCreateByInstance.TaskExist',
- 'errorMessage' => 'The image task of instance creation already exists.',
- ],
- [
- 'errorCode' => 'ExceedBuilderQuota',
- 'errorMessage' => 'The maximum number of builders is reached.',
- ],
- [
- 'errorCode' => 'InvalidBaseImage.NotConfigured',
- 'errorMessage' => 'Configuration required for Vhd/Container images.',
- ],
- [
- 'errorCode' => 'CreateDesktopImageRecord.Failed',
- 'errorMessage' => 'Create cloud computer image failed.',
- ],
- [
- 'errorCode' => 'Image.NotExist',
- 'errorMessage' => 'The image does not exist.',
- ],
- [
- 'errorCode' => 'ImageRegionDistribute.NotAllow',
- 'errorMessage' => 'This image cannot be distributed.',
- ],
- [
- 'errorCode' => 'ImageUpdateFailed.NotAllow',
- 'errorMessage' => 'The image is not allowed to be modified.',
- ],
- [
- 'errorCode' => 'ImageUpdateSharedImageFailed.NotAllow',
- 'errorMessage' => 'The shared image is not allowed to be modified.',
- ],
- [
- 'errorCode' => 'ParentImageRegionDistribute.NotExist',
- 'errorMessage' => 'The target distribution region of the parent image does not exist.',
- ],
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Internal error.',
+ ['errorCode' => 'Instance.NotFound', 'errorMessage' => 'The instance is not found.', 'description' => 'The instance is not found.'],
+ ['errorCode' => 'DesktopInstance.NotFound', 'errorMessage' => 'The cloud computer instance does not exist.', 'description' => 'The cloud computer instance does not exist.'],
+ ['errorCode' => 'Instance.ImageUnsupported', 'errorMessage' => 'A non-centralized image does not support this type of operation.', 'description' => 'A non-centralized image does not support this type of operation.'],
+ ['errorCode' => 'Instance.PhysicalNodeNotExist', 'errorMessage' => 'The instance physical node does not exist.', 'description' => 'The physical node of this instance does not exist.'],
+ ['errorCode' => 'ImageCreateByInstance.TaskExist', 'errorMessage' => 'The image task of instance creation already exists.', 'description' => 'The image task of instance creation already exists.'],
+ ['errorCode' => 'ExceedBuilderQuota', 'errorMessage' => 'The maximum number of builders is reached.', 'description' => 'The maximum number of builders is reached.'],
+ ['errorCode' => 'InvalidBaseImage.NotConfigured', 'errorMessage' => 'Configuration required for Vhd/Container images.', 'description' => 'Configuration required for Vhd/Container images.'],
+ ['errorCode' => 'CreateDesktopImageRecord.Failed', 'errorMessage' => 'Create cloud computer image failed.', 'description' => 'Failed to create the cloud computer image.'],
+ ['errorCode' => 'Image.NotExist', 'errorMessage' => 'The image does not exist.', 'description' => 'The image does not exist.'],
+ ['errorCode' => 'ImageRegionDistribute.NotAllow', 'errorMessage' => 'This image cannot be distributed.', 'description' => 'This image cannot be distributed.'],
+ ['errorCode' => 'ImageUpdateFailed.NotAllow', 'errorMessage' => 'The image is not allowed to be modified.', 'description' => 'The image is not allowed to be modified.'],
+ ['errorCode' => 'ImageUpdateSharedImageFailed.NotAllow', 'errorMessage' => 'The shared image is not allowed to be modified.', 'description' => 'The shared image is not allowed to be modified.'],
+ ['errorCode' => 'ParentImageRegionDistribute.NotExist', 'errorMessage' => 'The target distribution region of the parent image does not exist.', 'description' => 'The target distribution region of the parent image does not exist.'],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'Create a custom image from an instance',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateImageByInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ImageId\\": \\"imgc-07hnjj5fp****\\",\\n \\"VersionId\\": \\"iv-0abxi0lbi*****\\",\\n \\"TaskId\\": \\"tid-0abxi0lbih******\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"NULL\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'CreateImageByInstance',
],
- 'StartTaskForDistributeImage' => [
- 'methods' => [
- 'post',
+ 'CreateImageFromAppInstanceGroup' => [
+ 'summary' => 'Creates a new image from a debug delivery group.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
+ [
+ 'name' => 'ProductType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Workspace.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'CloudApp',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'AppCenterImageName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the application image.', 'type' => 'string', 'required' => true, 'example' => 'test_name', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The delivery group ID. You can call the [ListAppInstanceGroup](~~428506~~) operation to obtain the value.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'ImageId' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'img-bp13mu****', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create a new image from a debug delivery group',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageFromAppInstanceGroup'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateImageFromAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"ImageId\\": \\"img-bp13mu****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateModelProviderTemplate' => [
+ 'summary' => 'Create Model Provider Template',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '219723',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingSH8DGI',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ImageId',
- 'in' => 'formData',
+ 'name' => 'BizType',
+ 'in' => 'query',
'schema' => [
- 'title' => '镜像id',
- 'description' => 'The image ID.'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Business type.',
+ 'enumValueTitles' => [1 => 'Enterprise Edition'],
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
- 'example' => 'imgc-07jyldnd9i*****',
+ 'example' => '1',
],
],
[
- 'name' => 'VersionId',
- 'in' => 'formData',
+ 'name' => 'AgentPlatform',
+ 'in' => 'query',
'schema' => [
- 'title' => '版本id',
- 'description' => 'The ID of the image version. If you do not specify this parameter, the latest image version is used by default.'."\n",
+ 'description' => 'Agent platform.',
+ 'enumValueTitles' => ['ENTERPRISE' => 'Enterprise Edition', 'ENTERPRISE_JVS' => 'Enterprise Edition JVS Computer, Enterprise Edition Hermes Agent'],
'type' => 'string',
'required' => false,
- 'example' => 'iv-07jyldnd9i****',
+ 'example' => 'ENTERPRISE',
+ 'title' => '',
],
],
[
- 'name' => 'RetryType',
- 'in' => 'formData',
+ 'name' => 'AgentProvider',
+ 'in' => 'query',
'schema' => [
- 'title' => 'RESET/CONTINUE',
- 'description' => 'This parameter is not publicly available.'."\n",
+ 'title' => '',
+ 'description' => 'Agent provider name.',
+ 'enumValueTitles' => ['OpenClaw' => 'OpenClaw'],
'type' => 'string',
- 'required' => false,
- 'example' => 'RETRY',
+ 'required' => true,
+ 'example' => 'OpenClaw',
],
],
[
- 'name' => 'DestinationRegionList',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The regions to which you want to replicate the image.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'name' => 'ModelTemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Associated model group ID.', 'type' => 'string', 'required' => true, 'example' => 'mt-xxxx'],
],
[
- 'name' => 'ProductType',
- 'in' => 'formData',
+ 'name' => 'ProviderName',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Model provider name. Must be unique within the same model template. Naming rules vary by ProviderType. For details, see the ProviderType description.', 'type' => 'string', 'required' => true, 'example' => 'bailian'],
+ ],
+ [
+ 'name' => 'ProviderType',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* CloudDesktop: Elastic Desktop Service'."\n"
- .'* CloudApp: App Streaming'."\n"
- .'* WuyingServer: Workstation'."\n",
+ 'description' => 'Model provider type. Different types impose different constraints on ProviderName and Config:'."\n"
+ .'- WuyingCredit: Wuying credit package. ProviderName must be wuying-credit. Created by copying from the system template. Config is not required.'."\n"
+ .'- Managed: Managed provider. System-reserved names such as wuying-credit cannot be used. Config is required.'."\n"
+ .'- Custom: User-defined provider. ProviderName must start with the provider- prefix. Config is required.',
+ 'enumValueTitles' => ['WuyingCredit' => 'Wuying credit package model. Available after purchasing a credit package.', 'Custom' => 'Provider with custom configuration', 'Managed' => 'Third-party managed provider, centrally managed by the platform (e.g., Bailian, Moonshot)'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'CloudDesktop' => '',
- 'CloudApp' => '',
- 'WuyingServer' => '',
- ],
- 'example' => 'CloudApp',
+ 'example' => 'Managed',
+ 'title' => '',
],
],
[
- 'name' => 'SourceRegion',
- 'in' => 'formData',
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Model provider template name.', 'type' => 'string', 'required' => false, 'example' => '阿里云百炼'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Model provider template description.', 'type' => 'string', 'required' => false, 'example' => '阿里云百炼服务商'],
+ ],
+ [
+ 'name' => 'Config',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Model provider configuration JSON, containing connection information such as baseUrl, apiKey, and api. The apiKey is encrypted after creation. Not required when ProviderType is WuyingCredit, as it is copied from the system template.', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
+ .' "api": "openai-completions",'."\n"
+ .' "apiKey": "sk-xxxx",'."\n"
+ .' "baseUrl": "https://dashscope.aliyuncs.com/compatible-mode/v1"'."\n"
+ .'}'],
+ ],
+ [
+ 'name' => 'EnableWuyingProxy',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The region where the source image is located. If you leave this parameter empty, a random region is selected.'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Whether to enable Wuying security proxy. Must be true when ProviderType is WuyingCredit.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
'required' => false,
- 'example' => 'cn-shanghai',
+ 'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<String>',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Request result.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'The ID of the image replication task.'."\n",
- 'type' => 'string',
- 'example' => 'tid-06xnr5lyp77e7****',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the task is successful.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => 'The error code if an error occurred.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'The error message if an error occurred.'."\n",
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '419F31B9-1FDF-5644-ABA3-D00026FA****',
+ 'description' => 'Returned result object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProviderTemplateId' => ['title' => '', 'description' => 'Model provider template ID.', 'type' => 'string', 'example' => 'mpt-xxxx'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Instance.NotFound',
- 'errorMessage' => 'The instance is not found.',
- ],
- [
- 'errorCode' => 'DesktopInstance.NotFound',
- 'errorMessage' => 'The cloud computer instance does not exist.',
- ],
- [
- 'errorCode' => 'Instance.ImageUnsupported',
- 'errorMessage' => 'A non-centralized image does not support this type of operation.',
- ],
- [
- 'errorCode' => 'Instance.PhysicalNodeNotExist',
- 'errorMessage' => 'The instance physical node does not exist.',
- ],
- [
- 'errorCode' => 'ImageCreateByInstance.TaskExist',
- 'errorMessage' => 'The image task of instance creation already exists.',
- ],
- [
- 'errorCode' => 'ExceedBuilderQuota',
- 'errorMessage' => 'The maximum number of builders is reached.',
- ],
- [
- 'errorCode' => 'InvalidBaseImage.NotConfigured',
- 'errorMessage' => 'Configuration required for Vhd/Container images.',
- ],
- [
- 'errorCode' => 'CreateDesktopImageRecord.Failed',
- 'errorMessage' => 'Create cloud computer image failed.',
- ],
- [
- 'errorCode' => 'Image.NotExist',
- 'errorMessage' => 'The image does not exist.',
- ],
- [
- 'errorCode' => 'ImageRegionDistribute.NotAllow',
- 'errorMessage' => 'This image cannot be distributed.',
- ],
- [
- 'errorCode' => 'ImageUpdateFailed.NotAllow',
- 'errorMessage' => 'The image is not allowed to be modified.',
- ],
- [
- 'errorCode' => 'ImageUpdateSharedImageFailed.NotAllow',
- 'errorMessage' => 'The shared image is not allowed to be modified.',
- ],
- [
- 'errorCode' => 'ParentImageRegionDistribute.NotExist',
- 'errorMessage' => 'The target distribution region of the parent image does not exist.',
- ],
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Internal error.',
- ],
- [
- 'errorCode' => 'ImageDistribute.TargetDistributeRegionListEmpty',
- 'errorMessage' => 'The target distribution region list is empty.',
- ],
- [
- 'errorCode' => 'ImageDistribute.ImageNotSupport',
- 'errorMessage' => 'The image does not support region distribution.',
- ],
- [
- 'errorCode' => 'ImageDistribute.RepeatedDistribution',
- 'errorMessage' => 'This image has been distributed to this region.',
- ],
- [
- 'errorCode' => 'ImageDistribute.Undistributed',
- 'errorMessage' => 'The image has not been distributed to any region.',
- ],
- [
- 'errorCode' => 'ImageRegion.NotConfigured',
- 'errorMessage' => 'The image does not have any region configuration.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create Model Provider Template',
+ 'description' => 'You can create a model provider template under a model template in the Wuying Agent Management Center. This template is used to configure the connection information and keys for model services (such as Alibaba Cloud Bailian, Token Plan, and Moonshot) that Agents can call. After creation, the model provider template is automatically associated with the specified model template.'."\n"
+ ."\n"
+ .'Make sure you are fully familiar with the operations and usage of the Wuying Agent Management Center before calling this API.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateModelProviderTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"tid-06xnr5lyp77e7****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"419F31B9-1FDF-5644-ABA3-D00026FA****\\"\\n}","type":"json"}]',
- 'title' => 'StartTaskForDistributeImage',
- 'summary' => 'Initiates a task to replicate an image to another region.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ProviderTemplateId\\": \\"mpt-xxxx\\"\\n },\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
- 'DeleteImage' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateModelTemplate' => [
+ 'summary' => 'Creates a model creation template.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
- 'abilityTreeCode' => '219749',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingSH8DGI',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ImageId',
- 'in' => 'formData',
+ 'name' => 'BizType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The business type.',
+ 'enumValueTitles' => [1 => 'Enterprise Edition.'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'AgentPlatform',
+ 'in' => 'query',
'schema' => [
- 'title' => '镜像名称',
- 'description' => 'The ID of the RDS image.'."\n",
+ 'description' => 'The Agent platform.',
+ 'enumValueTitles' => ['ENTERPRISE' => 'Enterprise Edition.', 'ENTERPRISE_JVS' => 'Enterprise Edition JVS Computer or Enterprise Edition Hermes Agent.'],
'type' => 'string',
'required' => false,
- 'example' => 'img-bp13mu****',
+ 'example' => 'ENTERPRISE',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'AgentProvider',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The Agent provider name.',
+ 'enumValueTitles' => ['OpenClaw' => 'OpenClaw'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OpenClaw',
],
],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The template group name.', 'type' => 'string', 'required' => true, 'example' => 'model-template-001'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The template group description.', 'type' => 'string', 'required' => false, 'example' => '测试模型分组'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Boolean>',
- 'description' => 'The returned data.'."\n",
+ 'title' => '',
+ 'description' => 'The request result.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Whether the deletion is successful.'."\n"
- ."\n"
- .'Enumerated values:'."\n"
- ."\n"
- .'* true:Deleted successfully.'."\n"
- .'* false:Deletion failure.'."\n",
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
+ 'description' => 'The creation result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ModelTemplateId' => ['title' => '', 'description' => 'The model group ID.', 'type' => 'string', 'example' => 'mt-xxxx'],
],
- 'example' => 'true',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => 'Status code:'."\n"
- ."\n"
- .'* `200`: Success.'."\n"
- .'* `400`: An error occurred.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'The error message.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Internal error.',
- ],
- [
- 'errorCode' => 'Image.NotExist',
- 'errorMessage' => 'The image does not exist.',
- ],
- [
- 'errorCode' => 'ImageDeleteFailed.NotAllow',
- 'errorMessage' => 'The image is not allowed to be deleted.',
- ],
- [
- 'errorCode' => 'ImageDeleteFailed.NotAllowCommunityParent',
- 'errorMessage' => 'The parent image of a community image is not allowed to be deleted.',
- ],
- [
- 'errorCode' => 'ImageDeleteFailed.NotAllowSharedImage',
- 'errorMessage' => 'The shared image is not allowed to be deleted.',
- ],
- [
- 'errorCode' => 'ImageNotAllowDelete',
- 'errorMessage' => 'The image cannot be deleted, because shared cloud computers already exist.',
- ],
- [
- 'errorCode' => 'InvalidImageOperation.ImageIsCreating',
- 'errorMessage' => 'Failed to operation the image, it is creating.',
- ],
- [
- 'errorCode' => 'DeleteTemplate.Failed',
- 'errorMessage' => 'Delete template failed.',
- ],
- [
- 'errorCode' => 'QueryTemplate.Failed',
- 'errorMessage' => 'Query template failed.',
- ],
- [
- 'errorCode' => 'InvalidTemplate.NotFound',
- 'errorMessage' => 'Template not found.',
- ],
- [
- 'errorCode' => 'ImageDeleteFailed.HasSharedImage',
- 'errorMessage' => 'The shared image is not allowed to be deleted.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'Service unavailable. Please try again later.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create a model group',
+ 'description' => 'You can create a model group in the WUYING Agent Management Center to manage the model providers and model scope that an Agent can invoke. After creation, you can attach the model group to a cloud computer as the inference engine configuration for Agent task execution.'."\n"
+ ."\n"
+ .'Make sure that you are familiar with the operations and usage of the WUYING Agent Management Center before calling this operation.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteImage',
- 'summary' => 'Delete a custom RDS image',
- 'description' => '* You can only delete custom images to which a user belongs.'."\n"
- .'* If the product line is an image of the RDS cloud computer pool, RDS cloud application, and RDS workstation, make sure that no RDS instances use the image before you delete it.'."\n"
- .'* The RDS CloudDesktop template references an image. When you delete an image, the template is also deleted.'."\n"
- .'* If the image contains multiple regions, the images in all regions are deleted when the image is deleted.'."\n",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ModelTemplateId\\": \\"mt-xxxx\\"\\n },\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
- 'CreateAppInstanceGroup' => [
- 'summary' => 'Creates a delivery group.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateWuyingServer' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3076,1082 +2211,1065 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeCode' => '134193',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeNodes' => ['FEATUREappstreamingU1TTUH'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AppCenterImageId',
+ 'name' => 'WuyingServerName',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The image ID of the application. To obtain the image ID, log on to the [App Streaming console](https://appstreaming.console.aliyun.com/). In the left-side navigation pane, choose **Maintenance** > **Custom Images** or Maintenance > **System Images**.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'img-8z4nztpaqvay4****',
- ],
+ 'schema' => ['description' => 'The workstation name. When you create multiple workstations, a numeric suffix is automatically appended.', 'type' => 'string', 'required' => false, 'example' => 'exampleServerName', 'title' => ''],
],
[
- 'name' => 'ProductType',
+ 'name' => 'Amount',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
- ],
+ 'schema' => ['description' => 'The number of workstations to create.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'AppInstanceGroupName',
+ 'name' => 'ServerInstanceType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The workstation instance type.', 'type' => 'string', 'required' => false, 'example' => 'eds.proworkstation_flagship_elite_ne.96c384g.192g4x', 'title' => ''],
+ ],
+ [
+ 'name' => 'SystemDiskSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The size of the system cloud disk. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
+ ],
+ [
+ 'name' => 'SystemDiskCategory',
'in' => 'formData',
'schema' => [
- 'description' => 'The name of the delivery group.'."\n",
+ 'description' => 'The type of the system cloud disk.',
+ 'enumValueTitles' => ['cloud_auto' => 'cloud_auto'],
'type' => 'string',
'required' => false,
- 'example' => '',
+ 'example' => 'cloud_auto',
+ 'title' => '',
],
],
[
- 'name' => 'Users',
+ 'name' => 'SystemDiskPerformanceLevel',
'in' => 'formData',
- 'style' => 'repeatList',
+ 'schema' => ['description' => 'The performance level of the system cloud disk.', 'type' => 'string', 'required' => false, 'example' => 'PL0', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataDisk',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'The users that you want to add to the assigned user list of the delivery group.'."\n",
+ 'description' => 'The list of data cloud disks.',
'type' => 'array',
'items' => [
- 'description' => 'The user that you want to add to the assigned user list of the delivery group. The name of the user is in the Users.N=`<username>` format, where N is an integer greater than 0.'."\n",
- 'type' => 'string',
+ 'description' => 'The data cloud disk information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataDiskSize' => ['description' => 'The size of the data cloud disk.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
+ 'DataDiskCategory' => [
+ 'description' => 'The type of the data cloud disk.',
+ 'enumValueTitles' => ['cloud_auto' => 'cloud_auto'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cloud_auto',
+ 'title' => '',
+ ],
+ 'DataDiskPerformanceLevel' => ['description' => 'The performance level of the data cloud disk.', 'type' => 'string', 'required' => false, 'example' => 'PL0', 'title' => ''],
+ ],
'required' => false,
- 'example' => 'Users.1=username1'."\n"
- .'Users.2=username2',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'maxItems' => 200,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'UserInfo',
+ 'name' => 'ImageId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The information about the user that you want to add to the assigned user list of the delivery group. This parameter is required if you configure `Users`.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => 'The account type of the user.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* Simple: convenience account'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Simple' => '',
- ],
- 'example' => 'Simple',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'img-bp13mu****', 'title' => ''],
+ ],
+ [
+ 'name' => 'BizRegionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-643067****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The logon password of the workstation.', 'type' => 'string', 'required' => false, 'example' => 'YourPassword123', 'title' => ''],
],
[
'name' => 'ChargeType',
'in' => 'formData',
'schema' => [
- 'description' => 'The billing method.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* PostPaid: pay-as-you-go'."\n"
- .'* PrePaid: subscription'."\n",
+ 'description' => 'The billing method.',
+ 'enumValueTitles' => ['PrePaid' => 'subscription.'],
'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'PostPaid' => '',
- 'PrePaid' => '',
- ],
+ 'required' => false,
'example' => 'PrePaid',
+ 'title' => '',
],
],
[
- 'name' => 'PromotionId',
+ 'name' => 'Period',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The subscription duration.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PeriodUnit',
'in' => 'formData',
'schema' => [
- 'description' => 'The promotion ID. You can call the [GetResourcePrice](~~428503~~) operation to obtain the ID.'."\n",
+ 'description' => 'The unit of the subscription duration.',
+ 'enumValueTitles' => ['Month' => 'month.', 'Year' => 'year.'],
'type' => 'string',
'required' => false,
- 'example' => '17440009****',
+ 'example' => 'Month',
+ 'title' => '',
],
],
[
'name' => 'AutoPay',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Specifies whether to enable automatic payment.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false: manual payment. This is the default value.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to enable automatic payment.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'AutoRenew',
'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether to enable auto-renewal.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The promotion ID.'."\n"
+ ."\n\n"
+ .'> If PromotionId is specified, the corresponding discount is applied.', 'type' => 'string', 'required' => false, 'example' => '17440009****', 'title' => ''],
+ ],
+ [
+ 'name' => 'VSwitchIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'Specifies whether to enable auto-renewal.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false: manual payment. This is the default value.'."\n",
- 'type' => 'boolean',
+ 'description' => 'The list of vSwitches in the office network.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-55vk6****5vatze7jg', 'title' => ''],
'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'false',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Period',
+ 'name' => 'VirtualNodePoolId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The subscription duration of resources. This parameter is required if you set `ChargeType` to `PrePaid`. The unit of this parameter is specified by `PeriodUnit`.'."\n"
- ."\n"
- .'* Valid value if you set `PeriodUnit` to `Week`:'."\n"
- ."\n"
- .' * 1'."\n"
- ."\n"
- .'* Valid values if you set `PeriodUnit` to `Month`:'."\n"
- ."\n"
- .' * 1'."\n"
- .' * 2'."\n"
- .' * 3'."\n"
- .' * 6'."\n"
- ."\n"
- .'* Valid values if you set `PeriodUnit` to `Year`:'."\n"
- ."\n"
- .' * 1'."\n"
- .' * 2'."\n"
- .' * 3'."\n"
- ."\n"
- .'> If you set `ChargeType` to `PostPaid`, set this parameter to 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'vnp-0b************gyw', 'title' => ''],
],
[
- 'name' => 'PeriodUnit',
+ 'name' => 'NetworkStrategyType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The network policy type (in invitational preview).', 'type' => 'string', 'required' => false, 'example' => 'DirectIp', 'title' => ''],
+ ],
+ [
+ 'name' => 'Bandwidth',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The bandwidth value. This parameter takes effect only when NetworkStrategyType is set to DirectIp. Unit: Mbit/s. Valid values: 2 to 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '2', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'IdempotenceToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The idempotence token that ensures the uniqueness of the operation.', 'type' => 'string', 'example' => '6a1b8c3d', 'required' => false],
+ ],
+ [
+ 'name' => 'ServerPortRange',
'in' => 'formData',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'SavingPlanId',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'HostName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The hostname. The following limits apply:'."\n"
+ ."\n"
+ .'- A period (.) or hyphen (-) cannot be used as the first or last character, and consecutive periods or hyphens are not allowed.'."\n"
+ ."\n"
+ .'- Windows workstations: The hostname must be 2 to 15 characters in length. It cannot contain periods (.), consecutive hyphens, or consist entirely of digits. It can contain uppercase and lowercase letters, digits, and hyphens (-).'."\n"
+ ."\n"
+ .'- Linux workstations:'."\n"
+ ."\n"
+ .' - The hostname must be 2 to 64 characters in length and can contain multiple periods (.). Each segment separated by a period can contain uppercase and lowercase letters, digits, and hyphens (-).'."\n"
+ ."\n"
+ .' - You can use the placeholder `${instance_id}` to include the instance ID in the HostName parameter. For example, if you set `HostName=k8s-${instance_id}` and the ECS instance ID is `i-123abc****`, the hostname is `k8s-i-123abc****`.'."\n"
+ ."\n"
+ .'- When you create multiple workstation instances at a time, you can use the `name_prefix[begin_number,bits]name_suffix` format to assign sequential hostnames. For example, if you set HostName to `ecd-[1,4]-test`, the hostname of the first workstation is `ecd-0001-test`, the hostname of the second workstation is `ecd-0002-test`, and so on.'."\n"
+ ."\n"
+ .' - `name_prefix`: the prefix of the hostname.'."\n"
+ ."\n"
+ .' - `[begin_number,bits]`: the sequential number in the hostname.'."\n"
+ ."\n"
+ .' - `begin_number`: the starting number. Valid values: 0 to 999999. Default value: 0. If the value is invalid, 0 is used.'."\n"
+ ."\n"
+ .' - `bits`: the number of digits. Valid values: 1 to 6. Default value: 6. If the value is invalid, 6 is used.'."\n"
+ ."\n"
+ .' - `name_suffix`: the suffix of the hostname.', 'type' => 'string', 'required' => false, 'example' => 'testhost', 'title' => ''],
+ ],
+ [
+ 'name' => 'SubPayType',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'MaxPrice',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The unit of the subscription duration. This parameter is available if you set `ChargeType` to `PrePaid`.'."\n"
- ."\n"
- .'> The value of this parameter is case-insensitive. For example, `Week` is valid and `week` is invalid. If you specify an invalid value combination for Period and PeriodUnit, such as `2 Week`, the operation can still be called. However, an error occurs when you place the order.'."\n"
- ."\n"
- .'> If you set `ChargeType` to `PostPaid`, set this parameter to `Month`.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Month'."\n"
- .'* Year'."\n"
- .'* Week'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'Month' => '',
- 'Year' => '',
- 'Week' => '',
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Data' => [
+ 'description' => 'The response data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '23429322113****', 'title' => ''],
+ 'WuyingServerIdList' => [
+ 'description' => 'The list of workstation IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The workstation ID.', 'type' => 'string', 'example' => 'ws-0byd****2lwi', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
- 'example' => 'Week',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Create workstations',
+ 'summary' => 'Creates one or more workstations.',
+ 'description' => '1. A project corresponds to the resource configuration module in the CloudFlow console.'."\n"
+ .'2. If the ContentId specified in the request parameters has multiple versions, this API operation <notice>uses the default version</notice> for binding.'."\n"
+ .'3. This operation succeeds only when the default version of the content is in an available state.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SessionTimeout',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The period of time during which the application can be recycled. The recycling period is the period of time between the time when the end user disconnects from the application and the time when processes exit the application. If you do not want to recycle the application, set this parameter to `-1`. Valid values:-1 and 3 to 300. The value must be an integer. Default value: `15`. Unit: minutes.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '300',
- 'example' => '15',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"23429322113****\\",\\n \\"WuyingServerIdList\\": [\\n \\"ws-0byd****2lwi\\"\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DeleteAppInstanceGroup' => [
+ 'summary' => 'Deletes a pay-as-you-go resource-based delivery group.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'BizRegionId',
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'maxItems' => 100, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'description' => 'The ID of the region where the delivery group resides. For information about the supported regions, see [Limits](~~426036~~).'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* cn-shanghai: China (Shanghai)'."\n"
- .'* cn-hangzhou: China (Hangzhou)'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'cn-shanghai' => '',
- 'cn-hangzhou' => '',
+ 'example' => 'CloudApp',
+ 'title' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
- 'example' => 'cn-hangzhou',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidAppInstanceGroupSpecItem.NotFound', 'errorMessage' => 'The app instance group spec item is not found.', 'description' => ''],
+ ['errorCode' => 'InvalidBrowserInstanceGroup.NotFound', 'errorMessage' => 'The browser instance group is not found.', 'description' => 'The cloud browser does not exist, please confirm and try again'],
+ ],
+ ],
+ 'title' => 'Delete a pay-as-you-go delivery group',
+ 'description' => '> This operation does not support deleting delivery groups that use subscription resources.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppInstanceGroup'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ChargeResourceMode',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteAppInstances' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
+ [
+ 'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'description' => 'The sales mode.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* Node: by resource'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Workspace.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'Node' => '',
- ],
- 'example' => 'Node',
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
[
- 'name' => 'NodePool',
+ 'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The node pool object.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'NodeInstanceType' => [
- 'description' => 'The ID of the resource type that you want to purchase. You can call the [ListNodeInstanceType](~~428502~~) operation to obtain the ID.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* appstreaming.vgpu.8c16g.4g: WUYING - Graphics\\_8 vCPUs, 16 GiB Memory, 4 GiB GPU Memory'."\n"
- .'* appstreaming.general.8c16g: WUYING - General\\_8 vCPUs, 16 GiB Memory'."\n"
- .'* appstreaming.general.4c8g: WUYING - General\\_4 vCPUs, 8 GiB Memory'."\n"
- .'* appstreaming.vgpu.14c93g.12g: WUYING - Graphics\\_14 vCPUs, 93 GiB Memory, 12 GiB GPU Memory.'."\n"
- .'* appstreaming.vgpu.8c31g.16g: WUYING - Graphics\\_8 vCPUs, 31 GiB Memory, 16 GiB GPU Memory'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'appstreaming.vgpu.8c16g.4g' => '',
- 'appstreaming.general.8c16g' => '',
- 'appstreaming.general.4c8g' => '',
- 'appstreaming.vgpu.14c93g.12g' => '',
- 'appstreaming.vgpu.8c31g.16g' => '',
- ],
- 'example' => 'appstreaming.general.4c8g',
- ],
- 'NodeAmount' => [
- 'description' => 'The number of resources that you want to purchase. Valid values: 1 to 100.'."\n"
- ."\n"
- .'> '."\n"
- ."\n"
- .'* This parameter is required if the resources are subscription resources.'."\n"
- ."\n"
- .'* If the resources are pay-as-you-go resources, this parameter is required only if you set `StrategyType` to `NODE_FIXED` or `NODE_SCALING_BY_USAGE`.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'NodeCapacity' => [
- 'description' => 'The maximum number of sessions to which a resource can connect at the same time. If a resource connects to a large number of sessions at the same time, the user experience can be compromised. The value range varies based on the resource type. The following items describe the value ranges of different resource types:'."\n"
- ."\n"
- .'* appstreaming.general.4c8g: 1 to 2'."\n"
- .'* appstreaming.general.8c16g: 1 to 4'."\n"
- .'* appstreaming.vgpu.8c16g.4g: 1 to 4'."\n"
- .'* appstreaming.vgpu.8c31g.16g: 1 to 4'."\n"
- .'* appstreaming.vgpu.14c93g.12g: 1 to 6'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'StrategyType' => [
- 'description' => 'The scaling policy of resources.'."\n"
- ."\n"
- .'> '."\n"
- ."\n"
- .'* `NODE_FIXED`: fixed number of resources. This value is applicable to pay-as-you-go resources and subscription resources.'."\n"
- ."\n"
- .'* `NODE_SCALING_BY_USAGE`: auto scaling. This value is applicable to pay-as-you-go resources and subscription resources.'."\n"
- ."\n"
- .'* `NODE_SCALING_BY_SCHEDULE`: scheduled scaling. This value is applicable only to pay-as-you-go resources.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* NODE_FIXED: fixed number of resources'."\n"
- .'* NODE_SCALING_BY_SCHEDULE: scheduled scaling'."\n"
- .'* NODE_SCALING_BY_USAGE: auto scaling'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'NODE_FIXED' => '',
- 'NODE_SCALING_BY_SCHEDULE' => '',
- 'NODE_SCALING_BY_USAGE' => '',
- ],
- 'example' => 'NODE_FIXED',
- ],
- 'MaxScalingAmount' => [
- 'description' => 'The maximum number of resources that can be created for scale-out. This parameter is required if you set `StrategyType` to `NODE_SCALING_BY_USAGE`.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'MaxIdleAppInstanceAmount' => [
- 'description' => 'Maximum number of idle sessions. When this value is specified, auto-scaling is triggered only if the session utilization exceeds `ScalingUsageThreshold` and the current number of idle sessions in the delivery group is less than `MaxIdleAppInstanceAmount`. Otherwise, it is considered that sufficient idle sessions are available, and no auto-scaling will occur. This parameter allows flexible control over elastic scaling behavior and helps reduce usage costs.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
- 'ScalingStep' => [
- 'description' => 'The number of resources that are created each time resources are scaled out. Valid values: 1 to 10. This parameter is required if you set `StrategyType` to `NODE_SCALING_BY_USAGE`.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'ScalingUsageThreshold' => [
- 'description' => 'The upper limit of session usage. If the session usage exceeds the specified upper limit, auto scaling is automatically triggered. The session usage is calculated by using the following formula: `Session usage = Number of current sessions/(Total number of resources × Number of concurrent sessions) × 100%`. This parameter is required if you set `StrategyType` to `NODE_SCALING_BY_USAGE`. Valid values: 0 to 100. Default value: 85.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '85',
- ],
- 'ScalingDownAfterIdleMinutes' => [
- 'description' => 'The maximum retention period of a resource to which no session is connected. If no session is connected to a resource, the resource is automatically scaled in after the specified retention period elapses. Valid values: 5 to 120. Default value: 5. Unit: minutes. If one of the following situations occurs, the resource is not scaled in.'."\n"
- ."\n"
- .'* If automatic scale-out is triggered after the resource is scaled in, the scale-in is not executed. This prevents repeated scale-in and scale-out.'."\n"
- .'* If automatic scale-out is triggered due to an increase in the number of sessions during the specified period of time, the resource is not scaled in and the countdown restarts.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
- 'StrategyEnableDate' => [
- 'description' => 'The effective date of the scaling policy. Format: yyyy-MM-dd. The date must be the same as or later than the current date. This parameter is required if you set `StrategyType` to `NODE_SCALING_BY_SCHEDULE`.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-08-01',
- ],
- 'StrategyDisableDate' => [
- 'description' => 'The expiration date of the scaling policy. Format: yyyy-MM-dd. The interval between the expiration date and the effective date must be from 7 days to 1 year. This parameter is required if you set `StrategyType` to `NODE_SCALING_BY_SCHEDULE`.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-09-08',
- ],
- 'WarmUp' => [
- 'description' => 'Specifies whether to enable the warmup policy for resources. This parameter is required if you set `StrategyType` to `NODE_SCALING_BY_SCHEDULE`.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'RecurrenceSchedules' => [
- 'description' => 'The schedules of the scaling policy. This parameter is required if you set `StrategyType` to `NODE_SCALING_BY_SCHEDULE`.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RecurrenceType' => [
- 'description' => 'The schedule type of the scaling policy. This parameter must be configured together with `RecurrenceValues`.``'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* Weekly: The scaling policy is executed on specific days each week.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'weekly' => '',
- ],
- 'example' => 'weekly',
- ],
- 'RecurrenceValues' => [
- 'description' => 'The days of each week on which the scaling policy is executed.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The day of each week on which the scaling policy is executed.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* 1: Monday'."\n"
- .'* 2: Tuesday'."\n"
- .'* 3: Wednesday'."\n"
- .'* 4: Thursday'."\n"
- .'* 5: Friday'."\n"
- .'* 6: Saturday'."\n"
- .'* 7: Sunday'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '',
- '',
- '',
- '',
- '',
- '',
- '',
- ],
- 'example' => '1',
- ],
- 'required' => false,
- 'maxItems' => 7,
- ],
- 'TimerPeriods' => [
- 'description' => 'The time periods during which the scaling policy can be executed. The time periods must meet the following requirements:'."\n"
- ."\n"
- .'* Up to three time periods can be added.'."\n"
- .'* Time periods cannot be overlapped.'."\n"
- .'* The interval between two consecutive time periods must be greater than or equal to 5 minutes.'."\n"
- .'* Each time period must be greater than or equal to 15 minutes.'."\n"
- .'* The total length of the time periods that you specify cannot be greater than a day.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'StartTime' => [
- 'description' => 'The start time of the time period. Format: HH:mm.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '12:00',
- ],
- 'EndTime' => [
- 'description' => 'The end time of the time period. Format: HH:mm.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '15:00',
- ],
- 'Amount' => [
- 'description' => 'The number of resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 5,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 7,
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The delivery group ID. You can call [ListAppInstanceGroup](~~428506~~) to obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
],
[
- 'name' => 'Network',
+ 'name' => 'AppInstanceIds',
'in' => 'formData',
- 'style' => 'json',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The network settings.'."\n"
+ 'description' => 'The list of application instance IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The application instance ID.'."\n"
."\n"
- .'> If you want to use this parameter, submit a ticket.'."\n",
+ .'> Only specific customers can obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => 'ai-gbuea*****', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'StrategyType' => [
- 'description' => 'The type of the network policy.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Mixed: the hybrid mode. In this mode, a device is deployed in one virtual private cloud (VPC). Two NICs are provided and an independent public IP address is configured for the device.'."\n"
- .'* Shared: the shared mode. In this mode, a single NIC is provided for a device and the network is accessed by using NAT Gateway.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Mixed' => '',
- 'Shared' => '',
- ],
- 'example' => 'Shared',
- ],
- 'Routes' => [
- 'description' => 'The route settings. This parameter is available only if you set `StrategyType` to `Mixed`.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Destination' => [
- 'description' => 'The destination. The value is a CIDR block.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '139.196.XX.XX/32',
- ],
- 'Mode' => [
- 'description' => 'The network egress mode.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* Shared: accesses the network by using NAT Gateway.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Shared' => '',
- ],
- 'example' => 'Shared',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'IpExpireMinutes' => [
- 'description' => 'The validity period of the public IP address. If the specified value is exceeded, the IP address is updated at next logon. Minimum value: 60. Unit: minutes.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '60',
- 'example' => '60',
- ],
- 'OfficeSiteId' => [
- 'description' => 'Office Network ID.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hongkong+dir-842567****',
- ],
- 'VSwitchIds' => [
- 'description' => 'List of virtual switch IDs.'."\n"
- .'- Valid only for custom office networks.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Virtual Switch ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-m5ef1sjhf7bbvqvvy****',
- ],
- 'required' => false,
- ],
- 'DomainRules' => [
- 'description' => 'The domain name rules.'."\n",
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'DeleteAppInstanceModels' => [
+ 'description' => 'The list of instance deletion results.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The instance deletion result.',
'type' => 'object',
'properties' => [
- 'Domain' => [
- 'description' => 'The domain name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'www.example.com',
- ],
- 'Policy' => [
- 'description' => 'The policy used for the domain name.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* allow'."\n"
- .'* block'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'allow' => '',
- 'block' => '',
- ],
- 'example' => 'block',
+ 'AppInstanceId' => ['description' => 'The application instance ID.', 'type' => 'string', 'example' => 'ai-gbuea*****'."\n", 'title' => ''],
+ 'Success' => [
+ 'description' => 'Indicates whether the deletion is triggered.',
+ 'enumValueTitles' => ['true' => 'The deletion is triggered.', 'false' => 'The deletion failed to be triggered.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'title' => '',
],
+ 'Code' => ['description' => 'The error code returned when an error occurs.', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', 'title' => ''],
],
- 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
- 'required' => false,
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete a specified application instance',
+ 'summary' => 'Deletes a specified application instance.',
+ 'description' => 'Only instances in the init or idle state can be deleted. This operation is available only to specific customers.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppInstances'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'StoragePolicy',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The storage policy.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'StorageTypeList' => [
- 'description' => 'The storage types.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The storage type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* OFF'."\n"
- .'* PDS: Photo and Drive Service'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'OFF' => '',
- 'PDS' => '',
- ],
- 'example' => 'PDS',
- ],
- 'required' => false,
- ],
- 'UserProfile' => [
- 'description' => 'User data roaming configuration.',
- 'type' => 'object',
- 'properties' => [
- 'UserProfileSwitch' => [
- 'description' => 'User data roaming toggle.',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'false' => 'Disable',
- 'true' => 'Enable',
- ],
- 'example' => 'false',
- ],
- 'RemoteStorageType' => [
- 'description' => 'Remote storage type used for user data roaming.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'NAS' => 'NAS',
- ],
- 'example' => 'NAS',
- ],
- 'RemoteStoragePath' => [
- 'description' => 'Remote storage path for user data roaming.'."\n"
- ."\n"
- .'- If left empty, the default value is the delivery group ID.'."\n"
- .'- For cross-delivery-group (within the same VPC) user data roaming, the same value must be configured for all participating delivery groups.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ID20250101',
- ],
- ],
- 'required' => false,
- ],
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteAppInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DeleteAppInstanceModels\\": [\\n {\\n \\"AppInstanceId\\": \\"ai-gbuea*****\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DeleteImage' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PreOpenAppId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the pre-open application.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cag-b2ron*******',
- ],
+ 'AK' => [],
],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '219749',
+ 'abilityTreeNodes' => ['FEATUREappstreamingSH8DGI'],
+ ],
+ 'parameters' => [
[
- 'name' => 'VideoPolicy',
+ 'name' => 'ImageId',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '', 'description' => 'The AppStream image ID.', 'type' => 'string', 'required' => false, 'example' => 'img-bp13mu****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'Display policy.',
+ 'title' => '',
+ 'description' => 'The response structure.',
'type' => 'object',
'properties' => [
- 'FrameRate' => [
- 'description' => 'Frame rate (FPS).',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 30 => '30 FPS',
- 60 => '60 FPS',
- ],
- 'example' => '60',
- ],
- 'TerminalResolutionAdaptive' => [
- 'description' => 'Whether to use adaptive resolution.'."\n"
- ."\n"
- .'- true: The session resolution follows changes in the terminal\'s display area. In this case, SessionResolutionWidth and SessionResolutionHeight represent the maximum values for resolution adjustment.'."\n"
- ."\n"
- .'- false: The session resolution does not follow changes in the terminal\'s display area. In this case, the resolution is fixed to the values of SessionResolutionWidth and SessionResolutionHeight.',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
- ],
- 'example' => 'false',
- ],
- 'SessionResolutionWidth' => [
- 'description' => 'Resolution width, in pixels.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1920',
- ],
- 'SessionResolutionHeight' => [
- 'description' => 'Resolution height, in pixels.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1080',
- ],
- 'StreamingMode' => [
- 'description' => 'Streaming mode. Combined with the Webrtc parameter, it indicates the protocol type.'."\n"
- ."\n"
- .'- When Webrtc=true and StreamingMode=video, it indicates a WebRTC stream.'."\n"
- .'- When Webrtc=false and StreamingMode=video, it indicates a video stream.'."\n"
- .'- When Webrtc=false and StreamingMode=mix, it indicates a mixed stream.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'video' => 'Video stream',
- 'mix' => 'Mixed stream',
- ],
- 'example' => 'video',
- ],
- 'Webrtc' => [
- 'description' => 'Whether to enable WebRTC. Combined with the StreamingMode parameter, it indicates the protocol type.'."\n"
- ."\n"
- .'- When Webrtc=true and StreamingMode=video, it indicates a WebRTC stream.'."\n"
- .'- When Webrtc=false and StreamingMode=video, it indicates a video stream.'."\n"
- .'- When Webrtc=false and StreamingMode=mix, it indicates a mixed stream.',
+ 'Data' => [
+ 'description' => 'Indicates whether the deletion is successful.',
+ 'enumValueTitles' => ['true' => 'The deletion is successful.', 'false' => 'The deletion failed.'],
'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
- ],
'example' => 'true',
+ 'title' => '',
],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code:'."\n"
+ ."\n"
+ .'- `200`: Success.'."\n"
+ .'- `400`: Error.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
- 'required' => false,
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error.', 'description' => ''],
+ ['errorCode' => 'Image.NotExist', 'errorMessage' => 'The image does not exist.', 'description' => 'The image does not exist.'],
+ ['errorCode' => 'ImageDeleteFailed.NotAllow', 'errorMessage' => 'The image is not allowed to be deleted.', 'description' => 'The image is not allowed to be deleted.'],
+ ['errorCode' => 'ImageDeleteFailed.NotAllowCommunityParent', 'errorMessage' => 'The parent image of a community image is not allowed to be deleted.', 'description' => 'The parent image of a community image is not allowed to be deleted.'],
+ ['errorCode' => 'ImageDeleteFailed.NotAllowSharedImage', 'errorMessage' => 'The shared image is not allowed to be deleted.', 'description' => 'The shared image is not allowed to be deleted.'],
+ ['errorCode' => 'ImageNotAllowDelete', 'errorMessage' => 'The image cannot be deleted, because shared cloud computers already exist.', 'description' => 'The image cannot be deleted, because shared cloud computers already exist.'],
+ ['errorCode' => 'InvalidImageOperation.ImageIsCreating', 'errorMessage' => 'Failed to operation the image, it is creating.', 'description' => 'Failed to operation the image, it is creating.'],
+ ['errorCode' => 'DeleteTemplate.Failed', 'errorMessage' => 'Delete template failed.', 'description' => 'Failed to delete the template.'],
+ ['errorCode' => 'QueryTemplate.Failed', 'errorMessage' => 'Query template failed.', 'description' => 'Failed to query the template.'],
+ ['errorCode' => 'InvalidTemplate.NotFound', 'errorMessage' => 'Template not found.', 'description' => 'The template is not found.'],
+ ['errorCode' => 'ImageDeleteFailed.HasSharedImage', 'errorMessage' => 'The shared image is not allowed to be deleted.', 'description' => 'The shared image is not allowed to be deleted.'],
+ ],
+ 500 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'Service unavailable. Please try again later.', 'description' => 'Service unavailable. Please try again later.'],
+ ],
+ ],
+ 'title' => 'Delete a custom image',
+ 'summary' => 'Deletes a custom AppStream image.',
+ 'description' => '- You can delete only custom images that belong to you.'."\n"
+ .'- For images associated with the AppStream Cloud Computer Pool, AppStream Cloud Application, or AppStream Workstation product lines, you must ensure that no AppStream instances are using the image before you can delete it.'."\n"
+ .'- If an AppStream Cloud Desktop template references an image, the template is also deleted when the image is deleted.'."\n"
+ .'- If an image is available in multiple regions, deleting the image removes it from all regions.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'RuntimePolicy',
- 'in' => 'formData',
- 'style' => 'json',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteLlmTemplate' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'LlmTemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the model template.', 'type' => 'string', 'required' => true, 'example' => 'llmt-xxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The runtime policy.'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'SessionType' => [
- 'description' => 'The session type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* CONSOLE: console session'."\n"
- .'* NORMAL: Remote Desktop Protocol (RDP)-based O\\&M session'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'CONSOLE' => '',
- 'NORMAL' => '',
- ],
- 'example' => 'NORMAL',
- ],
- 'DebugMode' => [
- 'description' => 'Specifies whether to enable the debugging mode. If you want to call the `GetDebugAppInstance` and `CreateImageFromAppInstanceGroup` operations, you must set this parameter to `ON`.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* OFF'."\n"
- .'* ON'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'OFF' => '',
- 'ON' => '',
- ],
- 'example' => 'OFF',
- ],
- 'SessionUserGenerationMode' => [
- 'description' => 'The generation mode of the session users. Valid value:'."\n"
- .'- wyid. In this case, you must set sessionPreOpen to false.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'wyid' => 'wyid',
- ],
- 'example' => 'wyid',
- ],
- 'SessionPreOpen' => [
- 'description' => 'Session pre-launch toggle.'."\n"
- ."\n"
- .'- If not specified, the default value is true.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => 'Enable',
- 'false' => 'Disable',
- ],
- 'example' => 'false',
- ],
- 'PerSessionPerApp' => [
- 'description' => 'Only one application is allowed to be opened within a single session.'."\n"
- ."\n"
- .'- When enabled, launching multiple applications from the delivery group will allocate a separate session for each application, resulting in higher session consumption.',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => 'Enable',
- 'false' => 'Disable',
- ],
- 'example' => 'false',
- ],
- 'PersistentAppInstanceScheduleMode' => [
- 'title' => '持久会话调度模式。'."\n"
- .'DYNAMIC:动态调度 - 同一个持久会话可调度到不同节点上。'."\n"
- .'FIX_NODE:固定节点调度 - 同一个持久会话只能调度到固定的节点上。',
- 'description' => 'Persistent session scheduling mode.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'DYNAMIC' => 'Dynamic scheduling - The same persistent session can be scheduled to different nodes.',
- 'FIX_NODE' => 'Fixed node scheduling - The same persistent session can only be scheduled to a fixed node.',
- ],
- 'example' => 'DYNAMIC',
- 'default' => 'DYNAMIC',
- 'enum' => [
- 'DYNAMIC',
- 'FIX_NODE',
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
- 'required' => false,
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete a model template',
+ 'description' => 'You can delete a model template that has been created under a model provider template in the Wuying Agent Management Center. Before deletion, ensure that the model is not the default model of an associated model group. Otherwise, the deletion fails. After deletion, the model configurations of associated cloud computers are automatically refreshed.'."\n"
+ ."\n"
+ .'Before using this operation, make sure that you are familiar with the operations and usage of the Wuying Agent Management Center.',
+ 'summary' => 'Deletes an LLM template.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SecurityPolicy',
- 'in' => 'formData',
- 'style' => 'json',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteLlmTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteModelProviderTemplate' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProviderTemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the model provider template.', 'type' => 'string', 'required' => true, 'example' => 'mpt-xxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The security policy.'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'ResetAfterUnbind' => [
- 'description' => 'Specifies whether to reset after unbinding from a delivery group.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'true',
- ],
- 'SkipUserAuthCheck' => [
- 'description' => 'Specifies whether to skip user permission verification.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false: This is the default value.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'false',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
- 'required' => false,
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete a model provider template',
+ 'description' => 'You can delete a model provider template that has been created under model templates in the WUYING Agent Management Center. Before deletion, make sure that the model provider is not the provider of the default model and is not a system preset type provider (such as WUYING credits package). After deletion, the associated models and key configurations are also removed.'."\n"
+ ."\n"
+ .'Before using this operation, make sure that you are familiar with the operations and usage of the WUYING Agent Management Center.',
+ 'summary' => 'Deletes a model provider template.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'UserDefinePolicy',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteModelProviderTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteModelTemplate' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ModelTemplateId',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['title' => '', 'description' => 'The model group ID.', 'type' => 'string', 'required' => true, 'example' => 'mt-xxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The custom policy.'."\n",
+ 'title' => '',
+ 'description' => 'The request result.',
'type' => 'object',
'properties' => [
- 'CustomConfig' => [
- 'description' => 'The content of the custom policy. The content must meet the specifications of image versions. To use this parameter, submit a ticket to apply to enable the whitelist feature.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '[{"target":"agent","config":{"abc":"xxx"}}]',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
- 'required' => false,
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete a model group',
+ 'description' => 'You can delete a model group that has been created in the WUYING Agent Management Center. Before deletion, ensure that the template has not been authorized to any resource. Otherwise, the deletion fails. After deletion, the model providers and models under the model group are also removed.'."\n"
+ ."\n"
+ .'Before using this operation, make sure that you are familiar with the operations and usage of the WUYING Agent Management Center.',
+ 'summary' => 'Deletes a model template.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'AppPolicyId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Policy ID.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pg-0clfzcy0adpcf****',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteWuyingServer' => [
+ 'summary' => 'Deletes a cloud graphics workstation.',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ClusterId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREappstreamingKER98U'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WuyingServerId',
'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the cloud graphics workstation.', 'type' => 'string', 'required' => true, 'maxItems' => 100, 'example' => 'ws-0bw2f11****dial', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
'schema' => [
- 'description' => 'Cluster ID.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cls-d39iq73l5c0a8****',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete a cloud graphics workstation',
+ 'description' => 'Deletes a cloud graphics workstation.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SubPayType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Payment method subtype.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'postPaid' => 'Postpaid [Pay-as-you-go]',
- 'monthPackage' => 'Package plan [Cloud Browser only]',
- 'prePaid' => 'Prepaid [Subscription - Monthly/Yearly]',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'example' => 'postPaid',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'DeliverToUserSls' => [
+ 'summary' => 'Configure LogShipper for Simple Log Service',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'AppPackageType',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '266681',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Package type.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'browser.package.5.250.appstreaming.general.basic',
- ],
+ 'schema' => ['description' => 'Simple Log Service project name; either this or ExistedProjectName is required', 'title' => 'Simple Log Service project name; either this or ExistedProjectName is required', 'type' => 'string', 'example' => 'elastic-desktop-xxx', 'required' => false],
],
[
- 'name' => 'AuthMode',
+ 'name' => 'LogStoreName',
'in' => 'formData',
- 'schema' => [
- 'title' => '交付组授权模式。',
- 'description' => 'The authentication mode of the delivery group.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'App' => 'Application authorization',
- 'AppInstanceGroup' => 'Delivery group authorization',
- 'Session' => 'Persistent session authorization',
- ],
- 'example' => 'App',
- 'default' => 'App',
- 'enum' => [
- 'App',
- 'Session',
- 'AppInstanceGroup',
- ],
- ],
+ 'schema' => ['description' => 'LogStore name', 'title' => 'LogStore name', 'type' => 'string', 'example' => 'elastic_desktop_xxx', 'required' => false],
],
[
- 'name' => 'UserGroupIds',
+ 'name' => 'Ttl',
'in' => 'formData',
- 'style' => 'repeatList',
+ 'schema' => ['description' => 'Data retention period (Day), default 30', 'title' => 'Data retention period (Day), default 30', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'required' => false],
+ ],
+ [
+ 'name' => 'ExistedProjectName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Existing Simple Log Service project name; either this or ProjectName is required', 'title' => 'Existing Simple Log Service project name; either this or ProjectName is required', 'type' => 'string', 'example' => 'elastic-desktop-xxx', 'required' => false],
+ ],
+ [
+ 'name' => 'SlsRegionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Region ID of Simple Log Service', 'title' => 'Region ID of Simple Log Service', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'DeliveryScopes',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'title' => '授权用户组ID列表。',
- 'description' => 'List of authorized user group IDs.',
+ 'description' => 'List of delivery scopes',
+ 'title' => 'List of delivery scopes',
'type' => 'array',
'items' => [
- 'title' => '授权用户组ID。',
- 'description' => 'Authorized user group ID.',
- 'type' => 'string',
+ 'description' => 'Element of the delivery scope',
+ 'title' => 'Element of the delivery scope',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductType' => ['description' => 'product type', 'title' => 'product type', 'type' => 'string', 'required' => true, 'example' => 'CloudBrowser'],
+ ],
'required' => false,
+ 'example' => '',
],
- 'required' => false,
- 'maxItems' => 10,
+ 'required' => true,
+ 'example' => '[{"productType":"China_China"}]',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Schema of Response',
'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'AppInstanceGroupModel' => [
- 'description' => 'The delivery group.'."\n",
+ 'RequestId' => ['description' => 'request ID', 'title' => 'request ID', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Deliver operation logs to user\'s Simple Log Service',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ 'translator' => 'machine',
+ ],
+ 'DescribeWuyingServer' => [
+ 'summary' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingU1TTUH'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WuyingServerId',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'example' => 'aig-bp1234567890abcde', 'title' => '', 'description' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => '', 'description' => ''],
+ 'Data' => [
'type' => 'object',
'properties' => [
- 'AppInstanceGroupId' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
- 'OrderId' => [
- 'description' => 'The order ID.'."\n",
- 'type' => 'string',
- 'example' => '12345****',
- ],
- 'NodePoolId' => [
- 'description' => 'The ID of the resource group. This parameter is returned if a resource group was created.'."\n",
- 'type' => 'string',
- 'example' => 'rg-ew7va2g1wl3vm****',
+ 'WuyingServerId' => ['type' => 'string', 'example' => 'aig-bp1234567890abcde', 'title' => '', 'description' => ''],
+ 'WuyingServerName' => ['type' => 'string', 'example' => 'my-dev-server', 'title' => '', 'description' => ''],
+ 'BizRegionId' => ['type' => 'string', 'example' => 'cn-hangzhou', 'title' => '', 'description' => ''],
+ 'ImageId' => ['type' => 'string', 'example' => 'img-bp1234567890abcde', 'title' => '', 'description' => ''],
+ 'ImageName' => ['type' => 'string', 'example' => 'Ubuntu 22.04', 'title' => '', 'description' => ''],
+ 'OsType' => ['type' => 'string', 'example' => 'Linux', 'title' => '', 'description' => ''],
+ 'OfficeSiteId' => ['type' => 'string', 'example' => 'cn-hangzhou+dir-abc123', 'title' => '', 'description' => ''],
+ 'OfficeSiteName' => ['type' => 'string', 'example' => '默认工作区', 'title' => '', 'description' => ''],
+ 'OfficeSiteType' => ['type' => 'string', 'example' => 'Simple', 'title' => '', 'description' => ''],
+ 'NetworkInterfaceIp' => ['type' => 'string', 'example' => '10.0.0.1', 'title' => '', 'description' => ''],
+ 'ChargeType' => ['type' => 'string', 'example' => 'PrePaid', 'title' => '', 'description' => ''],
+ 'CreateTime' => ['type' => 'string', 'example' => '2026-01-01T00:00:00Z', 'title' => '', 'description' => ''],
+ 'ExpiredTime' => ['type' => 'string', 'example' => '2027-01-01T00:00:00Z', 'title' => '', 'description' => ''],
+ 'Status' => ['type' => 'string', 'example' => 'Running', 'title' => '', 'description' => ''],
+ 'SystemDiskSize' => ['type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => '', 'description' => ''],
+ 'SystemDiskCategory' => ['type' => 'string', 'example' => 'cloud_essd', 'title' => '', 'description' => ''],
+ 'Bandwidth' => ['type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'description' => ''],
+ 'EniPrivateIpAddressQuantity' => ['type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'description' => ''],
+ 'PrivateIpSets' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PrivateIpAddress' => ['type' => 'string', 'example' => '10.0.0.1', 'title' => '', 'description' => ''],
+ 'Primary' => ['type' => 'boolean', 'example' => 'true', 'title' => '', 'description' => ''],
+ ],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'StockError.NoStock',
- 'errorMessage' => 'The selected specification is out of stock. Please try again later or select other specifications.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"WuyingServerId\\": \\"aig-bp1234567890abcde\\",\\n \\"WuyingServerName\\": \\"my-dev-server\\",\\n \\"BizRegionId\\": \\"cn-hangzhou\\",\\n \\"ImageId\\": \\"img-bp1234567890abcde\\",\\n \\"ImageName\\": \\"Ubuntu 22.04\\",\\n \\"OsType\\": \\"Linux\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-abc123\\",\\n \\"OfficeSiteName\\": \\"默认工作区\\",\\n \\"OfficeSiteType\\": \\"Simple\\",\\n \\"NetworkInterfaceIp\\": \\"10.0.0.1\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"CreateTime\\": \\"2026-01-01T00:00:00Z\\",\\n \\"ExpiredTime\\": \\"2027-01-01T00:00:00Z\\",\\n \\"Status\\": \\"Running\\",\\n \\"SystemDiskSize\\": 80,\\n \\"SystemDiskCategory\\": \\"cloud_essd\\",\\n \\"Bandwidth\\": 10,\\n \\"EniPrivateIpAddressQuantity\\": 10,\\n \\"PrivateIpSets\\": [\\n {\\n \\"PrivateIpAddress\\": \\"10.0.0.1\\",\\n \\"Primary\\": true\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeWuyingServerEipInfo' => [
+ 'summary' => 'Queries the Elastic IP Address (EIP) information of a Wuying workspace.',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WuyingServerId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'ws-0bw2f11****dial', 'title' => ''],
+ ],
+ [
+ 'name' => 'Isp',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The Internet service operation provider (ISP). Valid values: '."\n"
+ .'- ChinaMobile: Shift.'."\n"
+ .'- ChinaTelecom: China Telecom.'."\n"
+ .'- ChinaUnicom: China Unicom.', 'type' => 'string', 'required' => false, 'example' => 'ChinaTelecom', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'EipInfoModel' => [
+ 'description' => 'The EIP information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NetworkInterfaceId' => ['description' => 'The network interface controller (NIC) ID.', 'type' => 'string', 'example' => 'eni-bp174p2xxxxxbyh02ix', 'title' => ''],
+ 'IpAddress' => ['description' => 'The public IP address.', 'type' => 'string', 'example' => '171.xxx.xxx.221', 'title' => ''],
+ 'ServerPortRange' => ['description' => 'The port range.', 'type' => 'string', 'example' => '6606/6607', 'title' => ''],
+ 'EipId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
- 500 => [
- [
- 'errorCode' => 'StockError.InvalidResourceRequest',
- 'errorMessage' => 'Your request cannot be processed currently due to an error. Please try again later.',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query wuying workspace EIP information',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DescribeWuyingServerEipInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AppInstanceGroupModel\\": {\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"OrderId\\": \\"12345****\\",\\n \\"NodePoolId\\": \\"rg-ew7va2g1wl3vm****\\"\\n }\\n}","type":"json"}]',
- 'title' => 'CreateAppInstanceGroup',
- 'description' => 'Before you call this operation, make sure that you fully understand the [billing methods and prices](~~426039~~) of App Streaming.'."\n"
- ."\n"
- .'A delivery group is a logical group that is used to deliver cloud applications to end users, including the images, resource management policies, and user groups on which the cloud applications rely. For more information, see [Publish delivery groups](~~426046~~).'."\n",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"EipInfoModel\\": {\\n \\"NetworkInterfaceId\\": \\"eni-bp174p2xxxxxbyh02ix\\",\\n \\"IpAddress\\": \\"171.xxx.xxx.221\\",\\n \\"ServerPortRange\\": \\"6606/6607\\",\\n \\"EipId\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'GetAppInstanceGroup' => [
- 'summary' => 'Queries the details of a delivery group.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4164,9 +3282,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '150264',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -4174,816 +3290,1663 @@
[
'name' => 'AppInstanceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the delivery group. You can call the [listAppInstanceGroup](~~428506~~) operation to obtain the ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
+ 'schema' => ['description' => 'The delivery group ID. You can call the [ListAppInstanceGroup](~~ListAppInstanceGroup~~) operation to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
],
[
'name' => 'ProductType',
'in' => 'query',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
'example' => 'CloudApp',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'AppInstanceGroupModels' => [
- 'title' => 'AppInstanceGroupModels',
- 'description' => 'AppInstanceGroupModels'."\n",
+ 'title' => '',
+ 'description' => 'AppInstanceGroupModels',
'type' => 'object',
'properties' => [
'Apps' => [
- 'description' => 'The applications.'."\n",
+ 'description' => 'The list of application information.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The application information.',
'type' => 'object',
'properties' => [
- 'AppId' => [
- 'description' => 'The application ID.'."\n",
- 'type' => 'string',
- 'example' => 'ca-i87mycyn419nu****',
- ],
- 'AppName' => [
- 'description' => 'The application name.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'AppVersion' => [
- 'description' => 'The application version.'."\n",
- 'type' => 'string',
- 'example' => '1.0.0',
- ],
- 'AppVersionName' => [
- 'description' => 'The name of the application version.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'AppIcon' => [
- 'description' => 'The application icon.'."\n",
- 'type' => 'string',
- 'example' => 'https://app-center-icon-****.png',
- ],
+ 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'ca-i87mycyn419nu****', 'title' => ''],
+ 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => '办公应用', 'title' => ''],
+ 'AppVersion' => ['description' => 'The application version.', 'type' => 'string', 'example' => '1.0.0', 'title' => ''],
+ 'AppVersionName' => ['description' => 'The application version name.', 'type' => 'string', 'example' => '初始版本', 'title' => ''],
+ 'AppIcon' => ['description' => 'The application icon.', 'type' => 'string', 'example' => 'https://app-center-icon-****.png', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'AppCenterImageId' => [
- 'description' => 'The image ID of the application.'."\n",
- 'type' => 'string',
- 'example' => 'img-8z4nztpaqvay4****',
- ],
- 'RegionId' => [
- 'description' => 'The ID of the region where the delivery group resides. For information about the supported regions, see [Limits](~~426036~~).'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
+ 'AppCenterImageId' => ['description' => 'The application image ID.', 'type' => 'string', 'example' => 'img-8z4nztpaqvay4****', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID of the delivery group. For more information about supported regions, see [Limits](~~426036~~).', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ProductType' => [
- 'description' => 'The product type.'."\n",
- 'type' => 'string',
+ 'description' => 'The product type.',
'enumValueTitles' => [],
- 'example' => 'CloudApp',
- ],
- 'AppInstanceType' => [
- 'description' => 'The resource type of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => '__dynamic__',
- ],
- 'AppInstanceTypeName' => [
- 'description' => 'The name of the resource type of the delivery group.'."\n",
'type' => 'string',
- 'example' => 'test001',
- ],
- 'AppInstanceGroupId' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
- 'Amount' => [
- 'description' => 'The number of subscription resources. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'MinAmount' => [
- 'description' => 'The minimum number of instances. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'MaxAmount' => [
- 'description' => 'The maximum number of instances. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'ReserveAmountRatio' => [
- 'description' => 'The percentage of reserved instances. The value indicates the percentage of unused sessions in the delivery group. Valid values: 0 to 99.'."\n",
- 'type' => 'string',
- 'example' => '20',
- ],
- 'ReserveMinAmount' => [
- 'description' => 'The minimum number of reserved instances. The value indicates the minimum number of unused sessions in the delivery group. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ReserveMaxAmount' => [
- 'description' => 'The maximum number of reserved instances. The value indicates the maximum number of unused sessions in the delivery group. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'ScalingStep' => [
- 'description' => 'The number of sessions that are created each time the delivery group is scaled out. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'ScalingUsageThreshold' => [
- 'description' => 'The upper limit of session usage. If the session usage exceeds the specified upper limit, auto scaling is automatically triggered. The session usage rate is calculated by using the following formula: Session usage rate = Number of sessions in use/Total number of sessions × 100%. Valid values: 0 to 99.'."\n",
- 'type' => 'string',
- 'example' => '85',
- ],
- 'ScalingDownAfterIdleMinutes' => [
- 'description' => 'The duration for which no session is connected. Unit: minutes. If no session is connected in the resources after the specified duration elapses, automatic scale-in is triggered. Minimum value: 0.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
+ 'example' => 'CloudApp',
+ 'title' => '',
],
+ 'AppInstanceType' => ['description' => 'The instance type of the delivery group.', 'type' => 'string', 'example' => '__dynamic__', 'title' => ''],
+ 'AppInstanceTypeName' => ['description' => 'The name of the instance type of the delivery group.', 'type' => 'string', 'example' => 'test001', 'title' => ''],
+ 'AppInstanceGroupId' => ['description' => 'The delivery group ID.', 'type' => 'string', 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ 'Amount' => ['description' => 'The number of subscription resources configured by the user. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'MinAmount' => ['description' => 'The minimum number of instances. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'MaxAmount' => ['description' => 'The maximum number of instances. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'ReserveAmountRatio' => ['description' => 'The percentage of reserved instances, which represents the ratio of unused sessions in the delivery group. Valid values: 0 to 99.', 'type' => 'string', 'example' => '20', 'title' => ''],
+ 'ReserveMinAmount' => ['description' => 'The minimum number of reserved instances, which represents the minimum number of unused sessions in the delivery group. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ReserveMaxAmount' => ['description' => 'The maximum number of reserved instances, which represents the maximum number of unused sessions in the delivery group. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'ScalingStep' => ['description' => 'The number of sessions created during each scale-out event. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'ScalingUsageThreshold' => ['description' => 'The upper threshold of session usage (%). When the session usage exceeds this threshold, automatic scale-out is triggered. The session usage is calculated as follows: Session usage = Number of sessions in use ÷ Total number of sessions × 100%. Valid values: 0 to 99.', 'type' => 'string', 'example' => '85', 'title' => ''],
+ 'ScalingDownAfterIdleMinutes' => ['description' => 'The idle duration without session connections, in minutes. When a resource remains without session connections for the specified duration, automatic scale-in is triggered. Minimum value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'ChargeType' => [
- 'description' => 'The billing method.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* PostPaid: pay-as-you-go'."\n"
- .'* PrePaid: subscription'."\n",
+ 'description' => 'The billing method.',
+ 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go.', 'PrePaid' => 'subscription.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'PostPaid' => '',
- 'PrePaid' => '',
- ],
'example' => 'PrePaid',
+ 'title' => '',
],
'ChargeResourceMode' => [
- 'description' => 'The sales mode.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* AppInstance: by session'."\n"
- .'* Node: by resource'."\n",
+ 'description' => 'The sales mode.',
+ 'enumValueTitles' => ['AppInstance' => 'sold by session.', 'Node' => 'sold by resource.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'AppInstance' => '',
- 'Node' => '',
- ],
'example' => 'Node',
+ 'title' => '',
],
- 'GmtCreate' => [
- 'description' => 'The time when the delivery group was created.'."\n",
- 'type' => 'string',
- 'example' => '2022-04-26T15:06:16.000+00:00',
- ],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-04-26T15:06:16.000+00:00', 'title' => ''],
'Status' => [
- 'description' => 'The status of the delivery group.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* PUBLISHED: The delivery group is published.'."\n"
- .'* FAILED: The delivery group failed to be published.'."\n"
- .'* MAINTAIN_FAILED: The delivery group failed to be updated.'."\n"
- .'* EXPIRED: The delivery group is expired.'."\n"
- .'* MAINTAINING: The delivery group is being updated.'."\n"
- .'* CEASED: The delivery group has overdue payments.'."\n"
- .'* EXPIRED_RECYCLING: The delivery group is expired and being recycled.'."\n"
- .'* DEPLOYING: The delivery group is being published.'."\n",
+ 'description' => 'The delivery group status.',
+ 'enumValueTitles' => ['PUBLISHED' => 'Published.', 'FAILED' => 'Publishing failed.', 'MAINTAIN_FAILED' => 'Update failed.', 'EXPIRED' => 'Expired.', 'MAINTAINING' => 'Updating.', 'CEASED' => 'Overdue.', 'EXPIRED_RECYCLING' => 'Recycling after expiration.', 'DEPLOYING' => 'Publishing.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'PUBLISHED' => '',
- 'FAILED' => '',
- 'MAINTAIN_FAILED' => '',
- 'EXPIRED' => '',
- 'MAINTAINING' => '',
- 'CEASED' => '',
- 'EXPIRED_RECYCLING' => '',
- 'DEPLOYING' => '',
- ],
'example' => 'PUBLISHED',
+ 'title' => '',
],
'NodePool' => [
- 'description' => 'The information about the resource group.'."\n",
+ 'description' => 'The resource group information.',
'type' => 'array',
'items' => [
- 'description' => 'The resource group.'."\n",
+ 'description' => 'The resource group information.',
'type' => 'object',
'properties' => [
- 'NodePoolId' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'example' => 'rg-g6922kced36hx****',
- ],
- 'NodeInstanceType' => [
- 'description' => 'The ID of the resource type that you purchase.'."\n",
- 'type' => 'string',
- 'example' => 'appstreaming.vgpu.4c8g.2g',
- ],
- 'NodeAmount' => [
- 'description' => 'The total number of subscription resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NodeUsed' => [
- 'description' => 'The number of subscription resources that are in use.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NodeCapacity' => [
- 'description' => 'The maximum number of sessions to which a resource can connect at the same time. If a resource connects to a large number of sessions at the same time, user experience can be compromised. The value range varies based on the resource type. The following items describe the value ranges of different resource types:'."\n"
- ."\n"
- .'* appstreaming.general.4c8g: 1 to 2'."\n"
- .'* appstreaming.general.8c16g: 1 to 4'."\n"
- .'* appstreaming.vgpu.8c16g.4g: 1 to 4'."\n"
- .'* appstreaming.vgpu.8c31g.16g: 1 to 4'."\n"
- .'* appstreaming.vgpu.14c93g.12g: 1 to 6'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ScalingNodeAmount' => [
- 'description' => 'The total number of scalable resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'ScalingNodeUsed' => [
- 'description' => 'The number of scalable resources that are in use.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
+ 'NodePoolId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-g6922kced36hx****', 'title' => ''],
+ 'NodeInstanceType' => ['description' => 'The instance type ID of the purchased resource.', 'type' => 'string', 'example' => 'appstreaming.vgpu.4c8g.2g', 'title' => ''],
+ 'NodeAmount' => ['description' => 'The total number of current subscription resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'NodeUsed' => ['description' => 'The resource count of subscription resources in use.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'NodeCapacity' => ['description' => 'The number of concurrent sessions, which is the number of sessions that a single resource can handle simultaneously. If too many sessions are connected simultaneously, the application experience may degrade. The valid values vary by resource specification:'."\n"
+ ."\n"
+ .'- appstreaming.general.4c8g: 1 to 2.'."\n"
+ .'- appstreaming.general.8c16g: 1 to 4.'."\n"
+ .'- appstreaming.vgpu.8c16g.4g: 1 to 4.'."\n"
+ .'- appstreaming.vgpu.8c31g.16g: 1 to 4.'."\n"
+ .'- appstreaming.vgpu.14c93g.12g: 1 to 6.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'ScalingNodeAmount' => ['description' => 'The total number of elastic resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
+ 'ScalingNodeUsed' => ['description' => 'The resource count of elastic resources in use.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
'StrategyType' => [
- 'description' => 'The type of the scaling policy.'."\n"
- ."\n"
- .'> `NODE_SCALING_BY_USAGE` is returned for this parameter only if ChargeType is set to `PrePaid`. `NODE_SCALING_BY_SCHEDULE` is returned for this parameter only if ChargeType is set to `PostPaid`.'."\n"
- ."\n"
- .'Valid values:'."\n"
+ 'description' => 'The elastic policy type.'."\n"
."\n"
- .'* NODE_FIXED: No scalable resources are used.'."\n"
- .'* NODE_SCALING_BY_SCHEDULE: Scheduled scaling is used.'."\n"
- .'* NODE_SCALING_BY_USAGE: Resources are scaled based on usage.'."\n",
+ .'> `NODE_SCALING_BY_USAGE` (usage-based scaling policy) applies only to `PrePaid` (subscription) resources. `NODE_SCALING_BY_SCHEDULE` (scheduled scaling policy) applies only to `PostPaid` (pay-as-you-go) resources.',
+ 'enumValueTitles' => ['NODE_FIXED' => 'No elastic resources used.', 'NODE_SCALING_BY_SCHEDULE' => 'Scheduled scaling.', 'NODE_SCALING_BY_USAGE' => 'Usage-based scaling policy.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'NODE_FIXED' => '',
- 'NODE_SCALING_BY_SCHEDULE' => '',
- 'NODE_SCALING_BY_USAGE' => '',
- ],
'example' => 'NODE_FIXED',
+ 'title' => '',
],
- 'Amount' => [
- 'description' => 'The number of resources purchased when the delivery group was created.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'MaxScalingAmount' => [
- 'description' => 'The maximum number of resources that can be created for scale-out.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'MaxIdleAppInstanceAmount' => [
- 'description' => '空闲会话数上限。指定该值时,当会话使用率超过`ScalingUsageThreshold`且当前交付组空闲会话数小于`MaxIdleAppInstanceAmount`时,才会触发自动扩容,否则认为交付组空闲会话已足够使用,不自动扩容。该参数可用于灵活控制弹性扩容行为和降低使用成本。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'ScalingStep' => [
- 'description' => 'The number of resources that are created each time resources are scaled out. Valid values: 1 to 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ScalingUsageThreshold' => [
- 'description' => 'The upper limit of session usage. If the session usage exceeds the specified upper limit, auto scaling is automatically triggered. The session usage is calculated by using the following formula: `Session usage = Number of current sessions/(Total number of resources × Number of concurrent sessions) × 100%`.'."\n",
- 'type' => 'string',
- 'example' => '85',
- ],
- 'ScalingDownAfterIdleMinutes' => [
- 'description' => 'The duration for which no session is connected. Unit: minutes. If no session is connected in the resources after the specified duration elapses, automatic scale-in is triggered. Default value: 5.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'Amount' => ['description' => 'The number of resources purchased when the delivery group was created.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'MaxScalingAmount' => ['description' => 'The maximum number of resources that can be created during scale-out.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
+ 'MaxIdleAppInstanceAmount' => ['description' => 'The upper limit of idle sessions. When this value is specified, automatic scale-out is triggered only when the session usage exceeds `ScalingUsageThreshold` and the number of idle sessions in the delivery group is less than `MaxIdleAppInstanceAmount`. Otherwise, the delivery group is considered to have sufficient idle sessions and no automatic scale-out is performed. This parameter allows you to flexibly control elastic scaling behavior and reduce costs.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'ScalingStep' => ['description' => 'The number of resources created during each scale-out event. Valid values: 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'ScalingUsageThreshold' => ['description' => 'The upper threshold of session usage (%). When the session usage exceeds this threshold, automatic scale-out is triggered. The session usage is calculated as follows: `Session usage = Number of current sessions ÷ (Total number of resources × Concurrent sessions per resource) × 100%`.', 'type' => 'string', 'example' => '85', 'title' => ''],
+ 'ScalingDownAfterIdleMinutes' => ['description' => 'The idle duration without session connections, in minutes. When a resource remains without session connections for the specified duration, automatic scale-in is triggered. Default value: 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'RecurrenceSchedules' => [
- 'description' => 'The schedules of the scaling policy.'."\n",
+ 'description' => 'The list of policy execution cycles.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The policy execution cycle.',
'type' => 'object',
'properties' => [
- 'RecurrenceType' => [
- 'description' => 'The schedule type of the scaling policy. This parameter must be configured together with `RecurrenceValues`.``'."\n",
- 'type' => 'string',
- 'example' => 'Weekly',
- ],
+ 'RecurrenceType' => ['description' => 'The type of the policy execution cycle. You must specify both `RecurrenceType` and `RecurrenceValues`.', 'type' => 'string', 'example' => 'Weekly', 'title' => ''],
'RecurrenceValues' => [
- 'description' => 'The days of each week on which the scaling policy is executed.'."\n",
+ 'description' => 'The list of values for the policy execution cycle.',
'type' => 'array',
- 'items' => [
- 'description' => 'The day of each week on which the scaling policy is executed.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'items' => ['description' => 'The value of the policy execution cycle.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
'TimerPeriods' => [
- 'description' => 'The time periods during which the scaling policy can be executed.'."\n",
+ 'description' => 'The list of time periods for the policy execution cycle.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The time period for the policy execution cycle.',
'type' => 'object',
'properties' => [
- 'Amount' => [
- 'description' => 'The number of destination resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'EndTime' => [
- 'description' => 'The end time of the scaling policy. Format: HH:mm.'."\n",
- 'type' => 'string',
- 'example' => '11:00',
- ],
- 'StartTime' => [
- 'description' => 'The start time of the scaling policy. Format: HH:mm.'."\n",
- 'type' => 'string',
- 'example' => '09:30',
- ],
+ 'Amount' => ['description' => 'The target resource count.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'EndTime' => ['description' => 'The end time. Format: HH:mm.', 'type' => 'string', 'example' => '11:00', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time. Format: HH:mm.', 'type' => 'string', 'example' => '09:30', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'StrategyDisableDate' => [
- 'description' => 'The expiration date of the scaling policy. Format: yyyy-MM-dd.'."\n",
- 'type' => 'string',
- 'example' => '2022-09-08',
- ],
- 'StrategyEnableDate' => [
- 'description' => 'The effective date of the scaling policy. Format: yyyy-MM-dd.'."\n",
- 'type' => 'string',
- 'example' => '2022-08-01',
- ],
- 'WarmUp' => [
- 'description' => 'Indicates whether the warmup policy is enabled for resources.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'NodeTypeName' => [
- 'description' => 'The name of the resource type.'."\n",
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
+ 'StrategyDisableDate' => ['description' => 'The date when the policy expires. Format: yyyy-MM-dd.', 'type' => 'string', 'example' => '2022-09-08', 'title' => ''],
+ 'StrategyEnableDate' => ['description' => 'The date when the policy takes effect. Format: yyyy-MM-dd.', 'type' => 'string', 'example' => '2022-08-01', 'title' => ''],
+ 'WarmUp' => ['description' => 'Indicates whether the resource prefetch policy is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'NodeTypeName' => ['description' => 'The resource specification name.', 'type' => 'string', 'example' => '无影-通用型_4核8G', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'SpecId' => [
- 'description' => 'The specification ID that uniquely corresponds to the ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'spec-8o18t8uc31qib0****',
- ],
- 'SessionTimeout' => [
- 'description' => 'The duration for which sessions are retained after disconnection. Unit: minutes. After an end user disconnects from a session, the session is closed only after the specified duration elapses. If you want to permanently retain sessions, set this parameter to `-1`. Valid values:-1 and 3 to 300. Default value: `15`.'."\n",
- 'type' => 'string',
- 'example' => '15',
- ],
- 'AppInstanceGroupName' => [
- 'description' => 'The name of the delivery group.'."\n",
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'ExpiredTime' => [
- 'description' => 'The time when the delivery group expires.'."\n",
- 'type' => 'string',
- 'example' => '2022-04-27T16:00:00.000+00:00',
- ],
+ 'SpecId' => ['description' => 'The ID that uniquely corresponds to the delivery group ID.', 'type' => 'string', 'example' => 'spec-8o18t8uc31qib0****', 'title' => ''],
+ 'SessionTimeout' => ['description' => 'The session disconnection retention duration, in minutes. After an end user session is disconnected, the session is retained for the specified duration before being logged off. Set this parameter to `-1` to retain the session indefinitely. Valid values: -1 and 3 to 300. Default value: `15`.', 'type' => 'string', 'example' => '15', 'title' => ''],
+ 'AppInstanceGroupName' => ['description' => 'The delivery group name.', 'type' => 'string', 'example' => '办公应用', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'The expiration time of the delivery group.', 'type' => 'string', 'example' => '2022-04-27T16:00:00.000+00:00', 'title' => ''],
'OtaInfo' => [
- 'description' => 'The information about the over-the-air (OTA) update task.'."\n",
+ 'description' => 'The OTA upgrade task information.',
'type' => 'object',
'properties' => [
- 'OtaVersion' => [
- 'title' => '当前ota版本',
- 'description' => 'The current OTA version.'."\n",
- 'type' => 'string',
- 'example' => '0.0.1-D-20220615.11****',
- ],
- 'NewOtaVersion' => [
- 'title' => '新ota版本,为空表示没有新版本',
- 'description' => 'The new OTA version. A null value indicates that no new version is available.'."\n",
- 'type' => 'string',
- 'example' => '0.0.1-D-20220630.11****',
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => 'The ID of the OTA update task.'."\n",
- 'type' => 'string',
- 'example' => 'ota-e49929gv8acz5****',
- ],
+ 'OtaVersion' => ['title' => '', 'description' => 'The current OTA version.', 'type' => 'string', 'example' => '0.0.1-D-20220615.11****'],
+ 'NewOtaVersion' => ['title' => '', 'description' => 'The new OTA version. An empty value indicates that no new version is available.', 'type' => 'string', 'example' => '0.0.1-D-20220630.11****'],
+ 'TaskId' => ['title' => '', 'description' => 'The OTA upgrade task ID.', 'type' => 'string', 'example' => 'ota-e49929gv8acz5****'],
],
+ 'title' => '',
+ 'example' => '',
],
'OsType' => [
- 'title' => '系统类型',
- 'description' => 'The type of the operating system.'."\n",
+ 'title' => '',
+ 'description' => 'The operating system type.',
'type' => 'string',
'example' => 'Windows',
- 'enum' => [
- 'Windows',
- 'Linux',
- 'Android',
- ],
- ],
- 'AppCenterImageName' => [
- 'description' => 'The image name of the application.'."\n",
- 'type' => 'string',
- 'example' => 'OfficeApps',
- ],
- 'ResourceStatus' => [
- 'description' => 'The resource status.'."\n",
- 'type' => 'string',
- 'example' => 'AVAILABLE',
- ],
- 'OfficeSiteId' => [
- 'description' => '办公网络ID。',
- 'type' => 'string',
- 'example' => 'cn-beijing+dir-172301****'."\n",
- ],
- 'AppPolicyId' => [
- 'description' => 'The policy ID of the application.'."\n",
- 'type' => 'string',
- 'example' => 'pg-g3k5wa2ms2****',
+ 'enum' => ['Windows', 'Linux', 'Android'],
],
+ 'AppCenterImageName' => ['description' => 'The application image name.', 'type' => 'string', 'example' => 'OfficeApps', 'title' => ''],
+ 'ResourceStatus' => ['description' => 'The resource status.', 'type' => 'string', 'example' => 'AVAILABLE', 'title' => ''],
+ 'OfficeSiteId' => ['description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-beijing+dir-172301****'."\n", 'title' => ''],
+ 'AppPolicyId' => ['description' => 'The application policy ID.', 'type' => 'string', 'example' => 'pg-g3k5wa2ms2****', 'title' => ''],
'SkipUserAuthCheck' => [
- 'description' => 'Indicates whether user permission verification is skipped.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false: This is the default value.'."\n",
+ 'description' => 'Indicates whether user authorization verification is skipped.',
+ 'enumValueTitles' => ['true' => 'Verification is skipped.', 'false' => 'Verification is performed. [Default value].'],
'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
'example' => 'false',
+ 'title' => '',
],
'SessionType' => [
- 'description' => '会话类型。',
+ 'description' => 'The session type.',
+ 'enumValueTitles' => ['CONSOLE' => 'Console session.', 'NORMAL' => 'RDP session.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'CONSOLE' => 'Console会话',
- 'NORMAL' => 'RDP会话',
- ],
'example' => 'NORMAL',
+ 'title' => '',
],
'Tags' => [
- 'title' => '资源标签列表。',
- 'description' => '资源标签列表。',
+ 'title' => '',
+ 'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
- 'title' => '资源标签。',
- 'description' => '资源标签。',
+ 'title' => '',
+ 'description' => 'The resource tag.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签键。',
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'department',
- ],
- 'Value' => [
- 'title' => '标签值。',
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'design',
- ],
+ 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'department'],
+ 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'design'],
'Scope' => [
- 'title' => '标签类型。取值范围:'."\n"
- .'Custom:自定义标签。'."\n"
- .'System:系统标签。',
- 'description' => '标签类型。',
+ 'title' => '',
+ 'description' => 'The tag type.',
+ 'enumValueTitles' => ['Custom' => 'Custom tag.', 'System' => 'System tag.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'Custom' => '自定义标签',
- 'System' => '系统标签',
- ],
'example' => 'Custom',
],
],
+ 'example' => '',
],
+ 'example' => '',
],
'AuthMode' => [
- 'title' => '授权模式。',
- 'description' => '授权模式。',
+ 'title' => '',
+ 'description' => 'The authorization mode.',
+ 'enumValueTitles' => ['App' => 'Application-based authorization.', 'AppInstanceGroup' => 'Delivery group-based authorization.', 'Session' => 'Session-based authorization.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'App' => '应用授权',
- 'AppInstanceGroup' => '交付组授权',
- 'Session' => '会话授权',
- ],
'example' => 'App',
'default' => 'App',
- 'enum' => [
- 'App',
- 'Session',
- 'AppInstanceGroup',
- ],
+ 'enum' => ['App', 'Session', 'AppInstanceGroup'],
],
'AccessType' => [
- 'title' => '接入类型。',
- 'description' => '接入类型。',
+ 'title' => '',
+ 'description' => 'The access type.',
+ 'enumValueTitles' => ['INTERNET' => 'Internet.', 'VPC' => 'Enterprise private network (VPC).', 'ANY' => 'Internet and enterprise private network (VPC).'],
'type' => 'string',
- 'enumValueTitles' => [
- 'INTERNET' => '互联网',
- 'VPC' => '企业专网(VPC)',
- 'ANY' => '互联网和企业专网(VPC)',
- ],
'example' => 'INTERNET',
'default' => 'INTERNET',
- 'enum' => [
- 'INTERNET',
- 'VPC',
- 'ANY',
- ],
- ],
- 'SupportUserGroupMixedAuth' => [
- 'title' => '是否支持用户和用户组混合授权。',
- 'type' => 'boolean',
- 'default' => 'true',
+ 'enum' => ['INTERNET', 'VPC', 'ANY'],
],
+ 'SupportUserGroupMixedAuth' => ['type' => 'boolean', 'default' => 'true', 'description' => '', 'title' => '', 'example' => ''],
'UserGroupAuthMode' => [
- 'title' => '用户和用户组授权模式。',
'type' => 'string',
'example' => 'Mixed',
'default' => 'Mixed',
- 'enum' => [
- 'Mixed',
- 'User',
- 'UserGroup',
- ],
+ 'enum' => ['Mixed', 'User', 'UserGroup'],
+ 'description' => '',
+ 'title' => '',
],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AppInstanceGroupModels\\": {\\n \\"Apps\\": [\\n {\\n \\"AppId\\": \\"ca-i87mycyn419nu****\\",\\n \\"AppName\\": \\"办公应用\\",\\n \\"AppVersion\\": \\"1.0.0\\",\\n \\"AppVersionName\\": \\"初始版本\\",\\n \\"AppIcon\\": \\"https://app-center-icon-****.png\\"\\n }\\n ],\\n \\"AppCenterImageId\\": \\"img-8z4nztpaqvay4****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ProductType\\": \\"CloudApp\\",\\n \\"AppInstanceType\\": \\"__dynamic__\\",\\n \\"AppInstanceTypeName\\": \\"test001\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"Amount\\": 1,\\n \\"MinAmount\\": 1,\\n \\"MaxAmount\\": 10,\\n \\"ReserveAmountRatio\\": \\"20\\",\\n \\"ReserveMinAmount\\": 1,\\n \\"ReserveMaxAmount\\": 5,\\n \\"ScalingStep\\": 10,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"ChargeResourceMode\\": \\"Node\\",\\n \\"GmtCreate\\": \\"2022-04-26T15:06:16.000+00:00\\",\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"NodePool\\": [\\n {\\n \\"NodePoolId\\": \\"rg-g6922kced36hx****\\",\\n \\"NodeInstanceType\\": \\"appstreaming.vgpu.4c8g.2g\\",\\n \\"NodeAmount\\": 1,\\n \\"NodeUsed\\": 1,\\n \\"NodeCapacity\\": 2,\\n \\"ScalingNodeAmount\\": 8,\\n \\"ScalingNodeUsed\\": 4,\\n \\"StrategyType\\": \\"NODE_FIXED\\",\\n \\"Amount\\": 2,\\n \\"MaxScalingAmount\\": 8,\\n \\"MaxIdleAppInstanceAmount\\": 3,\\n \\"ScalingStep\\": 2,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"RecurrenceSchedules\\": [\\n {\\n \\"RecurrenceType\\": \\"Weekly\\",\\n \\"RecurrenceValues\\": [\\n 1\\n ],\\n \\"TimerPeriods\\": [\\n {\\n \\"Amount\\": 5,\\n \\"EndTime\\": \\"11:00\\",\\n \\"StartTime\\": \\"09:30\\"\\n }\\n ]\\n }\\n ],\\n \\"StrategyDisableDate\\": \\"2022-09-08\\",\\n \\"StrategyEnableDate\\": \\"2022-08-01\\",\\n \\"WarmUp\\": false,\\n \\"NodeTypeName\\": \\"无影-通用型_4核8G\\"\\n }\\n ],\\n \\"SpecId\\": \\"spec-8o18t8uc31qib0****\\",\\n \\"SessionTimeout\\": \\"15\\",\\n \\"AppInstanceGroupName\\": \\"办公应用\\",\\n \\"ExpiredTime\\": \\"2022-04-27T16:00:00.000+00:00\\",\\n \\"OtaInfo\\": {\\n \\"OtaVersion\\": \\"0.0.1-D-20220615.11****\\",\\n \\"NewOtaVersion\\": \\"0.0.1-D-20220630.11****\\",\\n \\"TaskId\\": \\"ota-e49929gv8acz5****\\"\\n },\\n \\"OsType\\": \\"Windows\\",\\n \\"AppCenterImageName\\": \\"OfficeApps\\",\\n \\"ResourceStatus\\": \\"AVAILABLE\\",\\n \\"OfficeSiteId\\": \\"cn-beijing+dir-172301****\\\\n\\",\\n \\"AppPolicyId\\": \\"pg-g3k5wa2ms2****\\",\\n \\"SkipUserAuthCheck\\": false,\\n \\"SessionType\\": \\"NORMAL\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"design\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"AuthMode\\": \\"App\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"SupportUserGroupMixedAuth\\": true,\\n \\"UserGroupAuthMode\\": \\"Mixed\\"\\n }\\n}","type":"json"}]',
- 'title' => 'GetAppInstanceGroup',
- ],
- 'ListAppInstanceGroup' => [
- 'summary' => 'Queries the details of multiple delivery groups that meet the query conditions.',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query details of a specified delivery group',
+ 'summary' => 'Queries the details of a specified delivery group.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppInstanceGroup'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AppInstanceGroupModels\\": {\\n \\"Apps\\": [\\n {\\n \\"AppId\\": \\"ca-i87mycyn419nu****\\",\\n \\"AppName\\": \\"办公应用\\",\\n \\"AppVersion\\": \\"1.0.0\\",\\n \\"AppVersionName\\": \\"初始版本\\",\\n \\"AppIcon\\": \\"https://app-center-icon-****.png\\"\\n }\\n ],\\n \\"AppCenterImageId\\": \\"img-8z4nztpaqvay4****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ProductType\\": \\"CloudApp\\",\\n \\"AppInstanceType\\": \\"__dynamic__\\",\\n \\"AppInstanceTypeName\\": \\"test001\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"Amount\\": 1,\\n \\"MinAmount\\": 1,\\n \\"MaxAmount\\": 10,\\n \\"ReserveAmountRatio\\": \\"20\\",\\n \\"ReserveMinAmount\\": 1,\\n \\"ReserveMaxAmount\\": 5,\\n \\"ScalingStep\\": 10,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"ChargeResourceMode\\": \\"Node\\",\\n \\"GmtCreate\\": \\"2022-04-26T15:06:16.000+00:00\\",\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"NodePool\\": [\\n {\\n \\"NodePoolId\\": \\"rg-g6922kced36hx****\\",\\n \\"NodeInstanceType\\": \\"appstreaming.vgpu.4c8g.2g\\",\\n \\"NodeAmount\\": 1,\\n \\"NodeUsed\\": 1,\\n \\"NodeCapacity\\": 2,\\n \\"ScalingNodeAmount\\": 8,\\n \\"ScalingNodeUsed\\": 4,\\n \\"StrategyType\\": \\"NODE_FIXED\\",\\n \\"Amount\\": 2,\\n \\"MaxScalingAmount\\": 8,\\n \\"MaxIdleAppInstanceAmount\\": 3,\\n \\"ScalingStep\\": 2,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"RecurrenceSchedules\\": [\\n {\\n \\"RecurrenceType\\": \\"Weekly\\",\\n \\"RecurrenceValues\\": [\\n 1\\n ],\\n \\"TimerPeriods\\": [\\n {\\n \\"Amount\\": 5,\\n \\"EndTime\\": \\"11:00\\",\\n \\"StartTime\\": \\"09:30\\"\\n }\\n ]\\n }\\n ],\\n \\"StrategyDisableDate\\": \\"2022-09-08\\",\\n \\"StrategyEnableDate\\": \\"2022-08-01\\",\\n \\"WarmUp\\": false,\\n \\"NodeTypeName\\": \\"无影-通用型_4核8G\\"\\n }\\n ],\\n \\"SpecId\\": \\"spec-8o18t8uc31qib0****\\",\\n \\"SessionTimeout\\": \\"15\\",\\n \\"AppInstanceGroupName\\": \\"办公应用\\",\\n \\"ExpiredTime\\": \\"2022-04-27T16:00:00.000+00:00\\",\\n \\"OtaInfo\\": {\\n \\"OtaVersion\\": \\"0.0.1-D-20220615.11****\\",\\n \\"NewOtaVersion\\": \\"0.0.1-D-20220630.11****\\",\\n \\"TaskId\\": \\"ota-e49929gv8acz5****\\"\\n },\\n \\"OsType\\": \\"Windows\\",\\n \\"AppCenterImageName\\": \\"OfficeApps\\",\\n \\"ResourceStatus\\": \\"AVAILABLE\\",\\n \\"OfficeSiteId\\": \\"cn-beijing+dir-172301****\\\\n\\",\\n \\"AppPolicyId\\": \\"pg-g3k5wa2ms2****\\",\\n \\"SkipUserAuthCheck\\": false,\\n \\"SessionType\\": \\"NORMAL\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"design\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"AuthMode\\": \\"App\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"SupportUserGroupMixedAuth\\": false,\\n \\"UserGroupAuthMode\\": \\"Mixed\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetConnectionTicket' => [
+ 'summary' => 'Retrieves connection credentials for a cloud application.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '134196',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
+ 'abilityTreeCode' => '169756',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PageSize',
- 'in' => 'query',
+ 'name' => 'ProductType',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The number of entries per page. The value cannot be greater than `100`.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '20',
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'Cloud application.', 'AndroidCloud' => 'Android cloud.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
[
- 'name' => 'PageNumber',
- 'in' => 'query',
+ 'name' => 'EndUserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''],
+ ],
+ [
+ 'name' => 'BizRegionId',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The region ID.'."\n"
+ ."\n"
+ .'> If you specify this parameter, application instances are allocated only from delivery groups in the specified region.',
+ 'enumValueTitles' => ['cn-shenzhen' => 'cn-shenzhen', 'cn-beijing' => 'cn-beijing', 'cn-shanghai' => 'cn-shanghai', 'cn-zhangjiakou' => 'cn-zhangjiakou', 'cn-hangzhou' => 'cn-hangzhou'],
+ 'type' => 'string',
'required' => false,
- 'example' => '1',
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
],
],
[
- 'name' => 'Status',
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The task ID.'."\n"
+ ."\n"
+ .'> This request parameter is required for non-initial invokes. Use this parameter to check the task status and connection credentials.', 'type' => 'string', 'required' => false, 'example' => '28778acb-a469-4bc0-8e0f****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The application ID.'."\n"
+ ."\n"
+ .'> This parameter is required for the initial call and optional for subsequent calls.', 'type' => 'string', 'required' => false, 'example' => 'ca-e4s0puhmwi7v****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppVersion',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The application version. If you specify this parameter, only the specified version of the application is opened. If you do not specify this parameter, any authorized version of the application is opened.', 'type' => 'string', 'required' => false, 'example' => '1.0.0', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppStartParam',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The application startup parameter. For information about how to obtain startup parameters, see [How to obtain application installation and startup parameters](~~426045~~).', 'type' => 'string', 'required' => false, 'example' => '/q /n', 'title' => ''],
+ ],
+ [
+ 'name' => 'EnvironmentConfig',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The environment configuration.', 'type' => 'string', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'AppInstanceGroupIdList',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The status of the delivery groups.'."\n",
+ 'description' => 'The list of delivery groups.'."\n"
+ ."\n"
+ .'> - If you specify this parameter, application instances are allocated only from the specified authorized delivery groups.'."\n"
+ .'> - If you specify the `AppInstanceId` or `AppInstancePersistentId` parameter, this parameter is required.',
'type' => 'array',
- 'items' => [
- 'description' => 'The status of the delivery group.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* PUBLISHED: The delivery group is published.'."\n"
- .'* FAILED: The delivery group failed to be published.'."\n"
- .'* MAINTAIN_FAILED: The delivery group failed to be updated.'."\n"
- .'* EXPIRED: The delivery group is expired.'."\n"
- .'* MAINTAINING: The delivery group is being updated.'."\n"
- .'* CEASED: The delivery group has overdue payments.'."\n"
- .'* EXPIRED_RECYCLING: The delivery group is expired and being recycled.'."\n"
- .'* DEPLOYING: The delivery group is being published.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'PUBLISHED' => '',
- 'FAILED' => '',
- 'MAINTAIN_FAILED' => '',
- 'EXPIRED' => '',
- 'MAINTAINING' => '',
- 'CEASED' => '',
- 'EXPIRED_RECYCLING' => '',
- 'DEPLOYING' => '',
+ 'items' => ['description' => 'The delivery group ID.', 'type' => 'string', 'required' => false, 'example' => 'aig-4xz0oy8x4ipyv****', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'AppInstancePersistentId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The persistent session ID.', 'type' => 'string', 'required' => false, 'example' => 'p-0bxls9m3cl7s****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppInstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The application instance ID.'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> - If you specify this parameter, only the specified application instance is allocated.'."\n"
+ .'> - If you specify this parameter, you must also specify the `AppInstanceGroupIdList` parameter, and the number of delivery group IDs in `AppInstanceGroupIdList` must be 1.', 'type' => 'string', 'required' => false, 'example' => 'ai-1rznfnrvsa99d****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AccessType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The access type. If you do not specify this parameter, both types are displayed. Valid values:'."\n"
+ .'- INTERNET: Internet access.'."\n"
+ .'- VPC: Express Connect access.',
+ 'type' => 'string',
+ 'example' => 'INTERNET',
+ 'maxLength' => 10,
+ 'minLength' => 0,
+ 'default' => 'INTERNET',
+ 'enum' => ['INTERNET', 'VPC'],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'AppPolicyId',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'TaskStatus' => [
+ 'description' => 'The task status.',
+ 'enumValueTitles' => ['Finished' => 'Completed.', 'Failed' => 'Failed.', 'Running' => 'Running.'],
+ 'type' => 'string',
+ 'example' => 'Running',
+ 'title' => '',
+ ],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'f3d1b31c-605e-4d04-a896****', 'title' => ''],
+ 'BizRegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'Ticket' => ['description' => 'The credentials for connecting to the cloud application.'."\n"
+ .'> This parameter is returned only on non-initial calls.', 'type' => 'string', 'example' => 'DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****', 'title' => ''],
+ 'AppInstanceGroupId' => ['description' => 'The delivery group ID.', 'type' => 'string', 'example' => 'aig-53fvrq1oan****', 'title' => ''],
+ 'AppInstancePersistentId' => ['description' => 'The persistent session ID.', 'type' => 'string', 'example' => 'p-0bxls9m3cl7s****', 'title' => ''],
+ 'AppInstanceId' => ['description' => 'The application instance ID.', 'type' => 'string', 'example' => 'ai-7ybdeiyoeh5e****', 'title' => ''],
+ 'OsType' => [
+ 'description' => 'The operating system type.',
+ 'enumValueTitles' => ['Windows' => 'Windows operating system.'],
+ 'type' => 'string',
+ 'example' => 'Windows',
+ 'title' => '',
],
- 'example' => '"Status.1":"PUBLISHED","Status.2":"FAILED"',
+ 'TenantId' => ['description' => 'The tenant ID (Alibaba Cloud account UID).', 'type' => 'integer', 'format' => 'int64', 'example' => '148871678899****', 'title' => ''],
+ 'AvatarId' => ['title' => '', 'description' => 'The avatar ID.', 'type' => 'string', 'example' => ''],
],
- 'required' => false,
- 'maxItems' => 1000,
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve cloud application connection credentials',
+ 'description' => 'This operation requires multiple invokes (at least two) to obtain the connection credentials.'."\n"
+ ."\n"
+ .'On the first invoke, an application instance is allocated to the specified convenience account and the application is started. A startup task ID (`TaskID`) is returned.'."\n"
+ ."\n"
+ .'On subsequent invokes, pass the `TaskID` request parameter to query whether the task is complete. When the returned task status (`TaskStatus`) is completed (`Finished`), the connection credentials (`Ticket`) are also returned.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionTicket'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetConnectionTicket',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"Running\\",\\n \\"TaskId\\": \\"f3d1b31c-605e-4d04-a896****\\",\\n \\"BizRegionId\\": \\"cn-hangzhou\\",\\n \\"Ticket\\": \\"DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****\\",\\n \\"AppInstanceGroupId\\": \\"aig-53fvrq1oan****\\",\\n \\"AppInstancePersistentId\\": \\"p-0bxls9m3cl7s****\\",\\n \\"AppInstanceId\\": \\"ai-7ybdeiyoeh5e****\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"TenantId\\": 0,\\n \\"AvatarId\\": \\"\\"\\n}","type":"json"}]',
+ ],
+ 'GetDebugAppInstance' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'ProductType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Workspace.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
[
'name' => 'AppInstanceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The delivery group ID. You can obtain this value by calling the listAppInstanceGroup operation.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'AppInstanceGroupId' => ['description' => 'The delivery group ID.', 'type' => 'string', 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ 'AppInstanceId' => ['description' => 'The application instance ID.', 'type' => 'string', 'example' => 'ai-7ybdeiyoeh5e****', 'title' => ''],
+ 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '__DEBUG_APP', 'title' => ''],
+ 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '__debug__', 'title' => ''],
+ 'AuthCode' => ['description' => 'The authorization code. The authorization code is valid for 3 minutes and can be used only once regardless of whether the verification succeeds or fails. If multiple authorization codes are generated for a user, only the last generated code is valid.', 'type' => 'string', 'example' => 'e4e169bea1cc48e8afac53**********', 'title' => ''],
+ 'AppVersion' => ['description' => 'The application version ID.', 'type' => 'string', 'example' => '1.1', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve debug application instance information',
+ 'summary' => 'Retrieves the information about a debug application instance.',
+ 'responseParamsDescription' => 'Based on the returned parameters, you can concatenate a URL to obtain the connection information. The following example shows how to concatenate the URL:'."\n"
+ ."\n"
+ .'`<https://wuying.aliyun.com/appMyBank>?AppId=__DEBUG_APP&AppVersion=1.0&AppInstanceGroupId=aig-5wfetbb7aovy8****&Env=online&AppInstanceId=ai-c7ruhxqww38ws****&AuthCode=acv2j%2BqjU3GAIBVOz33KxdcVyHJ58Dc2N2GC3ZpWNu9Q3zX84cxbNJcPX5enF%2BPePBEgBHxvF28QQcUOjgMk5tHgQKbe%2FUXbIDfg83vN7C3XMzkXo8ByHepfSLQwFLdP4S83zA327ugaB1w1pNnDwhbSvkfRmTA3JOc%2FNEqNs6w%2FePg5NmS4bRhodpYkb4wL****`.'."\n"
+ ."\n"
+ .'> Replace `<https://wuying.aliyun.com/appMyBank>` based on your actual business requirements.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDebugAppInstance'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetDebugAppInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"AppInstanceId\\": \\"ai-7ybdeiyoeh5e****\\",\\n \\"AppId\\": \\"__DEBUG_APP\\",\\n \\"UserId\\": \\"__debug__\\",\\n \\"AuthCode\\": \\"e4e169bea1cc48e8afac53**********\\",\\n \\"AppVersion\\": \\"1.1\\"\\n}","type":"json"}]',
+ ],
+ 'GetModelProviderTemplate' => [
+ 'summary' => 'Queries the details of a model provider template.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProviderTemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the model provider template.', 'type' => 'string', 'required' => true, 'example' => 'mpt-xxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The returned data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProviderTemplateId' => ['title' => '', 'description' => 'The ID of the model provider template.', 'type' => 'string', 'example' => 'mpt-xxxx'],
+ 'ProviderName' => ['title' => '', 'description' => 'The name of the model provider.', 'type' => 'string', 'example' => 'bailian'],
+ 'Name' => ['title' => '', 'description' => 'The name of the model provider template.', 'type' => 'string', 'example' => '阿里云百炼。'],
+ 'Description' => ['title' => '', 'description' => 'The description of the model provider template.', 'type' => 'string', 'example' => '阿里云百炼服务商。'],
+ 'Config' => ['title' => '', 'description' => 'The JSON configuration object of the model provider template.', 'type' => 'string', 'example' => '{'."\n"
+ .' "api": "openai-completions",'."\n"
+ .' "apiKey": "sk-xxxx",'."\n"
+ .' "baseUrl": "https://dashscope.aliyuncs.com/compatible-mode/v1"'."\n"
+ .'}'],
+ 'EnableWuyingProxy' => [
+ 'title' => '',
+ 'description' => 'Indicates whether the WUYING secure gateway proxy is enabled.',
+ 'enumValueTitles' => ['true' => 'yes.', 'false' => 'no.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query model provider template details',
+ 'description' => 'You can query the details of a specified model provider template in the WUYING Agent Management Center, including the provider name, description, and connection configuration list.'."\n"
+ ."\n"
+ .'Before you call this operation, make sure that you are familiar with the operations and usage of the WUYING Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetModelProviderTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ProviderTemplateId\\": \\"mpt-xxxx\\",\\n \\"ProviderName\\": \\"bailian\\",\\n \\"Name\\": \\"阿里云百炼。\\",\\n \\"Description\\": \\"阿里云百炼服务商。\\",\\n \\"Config\\": \\"{\\\\n\\\\t\\\\\\"api\\\\\\": \\\\\\"openai-completions\\\\\\",\\\\n\\\\t\\\\\\"apiKey\\\\\\": \\\\\\"sk-xxxx\\\\\\",\\\\n\\\\t\\\\\\"baseUrl\\\\\\": \\\\\\"https://dashscope.aliyuncs.com/compatible-mode/v1\\\\\\"\\\\n}\\",\\n \\"EnableWuyingProxy\\": true\\n },\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'GetOtaTaskByTaskId' => [
+ 'summary' => 'Queries the details of an over-the-air update task, including the available version and version description.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The over-the-air update task ID. You can call [ListAppInstanceGroup](~~428506~~) to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'ota-be7jzm29wrrz5****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Code' => ['title' => '', 'description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => 'OtaTask.Running'],
+ 'Message' => ['title' => '', 'description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'The task is running and cannot be sumitted.'],
+ 'ReleaseNote' => ['title' => '', 'description' => 'The version description that describes the content of the over-the-air update.', 'type' => 'string', 'example' => '测试升级'],
+ 'OtaVersion' => ['title' => '', 'description' => 'The OTA version.', 'type' => 'string', 'example' => '0.0.1-R-20220708.110604'],
+ 'TaskStartTime' => ['title' => '', 'description' => 'The task execution time in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2022-08-04T14:36:00+08:00'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'title' => 'Query over-the-air update task details',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOtaTaskByTaskId'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyAppInstanceGroupAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"OtaTask.Running\\",\\n \\"Message\\": \\"The task is running and cannot be sumitted.\\",\\n \\"ReleaseNote\\": \\"测试升级\\",\\n \\"OtaVersion\\": \\"0.0.1-R-20220708.110604\\",\\n \\"TaskStartTime\\": \\"2022-08-04T14:36:00+08:00\\"\\n}","type":"json"}]',
+ ],
+ 'GetResourcePrice' => [
+ 'summary' => 'Queries the price information of a resource.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'NodeInstanceType',
'in' => 'query',
'schema' => [
- 'description' => 'The ID of the delivery group.'."\n",
+ 'description' => 'The ID of the resource instance type to purchase. You can call the [ListNodeInstanceType](~~428502~~) operation to obtain the ID.'."\n"
+ ."\n"
+ .'Either AppInstanceType or NodeInstanceType must have a value. If both have values, NodeInstanceType is used.',
+ 'enumValueTitles' => ['appstreaming.vgpu.8c16g.4g' => '无影-图形型_8核16G 4G显存', 'appstreaming.general.8c16g' => '无影-通用型_8核16G', 'appstreaming.general.4c8g' => '无影-通用型_4核8G', 'appstreaming.vgpu.14c93g.12g' => '无影-图形型_14核93G 12G显存', 'appstreaming.vgpu.8c31g.16g' => '无影-图形型_8核31G 16G显存'],
'type' => 'string',
'required' => false,
- 'example' => 'aig-9ciijz60n4xsv****',
+ 'example' => 'appstreaming.vgpu.4c8g.2g',
+ 'title' => '',
],
],
[
'name' => 'ProductType',
'in' => 'query',
'schema' => [
- 'description' => 'The product type.'."\n"
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'CloudApp',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'ChargeType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The billing method.',
+ 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go.', 'PrePaid' => 'subscription.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PrePaid',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The numeric part of the purchase duration. This parameter is used together with PeriodUnit to specify the complete purchase duration.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unit part of the purchase duration. This parameter is used together with Period to specify the complete purchase duration. The following combinations of Period and PeriodUnit are supported:'."\n"
."\n"
- .'Valid value:'."\n"
+ .'- 1 Week (1 week)'."\n"
+ .'- 1 Month (1 month)'."\n"
+ .'- 2 Month (2 months)'."\n"
+ .'- 3 Month (3 months)'."\n"
+ .'- 6 Month (6 months)'."\n"
+ .'- 1 Year (1 year)'."\n"
+ .'- 2 Year (2 years)'."\n"
+ .'- 3 Year (3 years)'."\n"
."\n"
- .'* CloudApp: App Streaming'."\n",
+ .'> This parameter is case-sensitive. For example, `Week` is valid, but `week` is invalid. If the request parameters do not match the supported combinations, such as `2 Week`, the API call succeeds but an error occurs during the order placement stage.',
+ 'enumValueTitles' => ['Month' => 'month.', 'Year' => 'year.', 'Week' => 'week.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Week',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'Amount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The quantity of resources to purchase.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID of the delivery group. For more information about supported regions, see [Limits](~~426036~~).',
+ 'enumValueTitles' => ['cn-shanghai' => 'China (Shanghai).', 'cn-hangzhou' => 'China (Hangzhou).'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'AppInstanceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the session instance type to purchase. You can call the `ListAppInstanceType` operation to obtain the ID.'."\n"
+ ."\n"
+ .'Either AppInstanceType or NodeInstanceType must have a value. If both have values, NodeInstanceType is used.', 'type' => 'string', 'required' => false, 'example' => 'appstreaming.general', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Code' => ['description' => 'The error code returned when an error occurs.', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', 'title' => ''],
+ 'PriceModel' => [
+ 'description' => 'The price object.'."\n"
+ ."\n"
+ .'This parameter is returned when the request parameter NodeInstanceType has a value.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Price' => [
+ 'description' => 'The price details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'string', 'example' => '11.00', 'title' => ''],
+ 'DiscountPrice' => ['description' => 'The discount amount. The actual price equals the original price minus the discount amount.', 'type' => 'string', 'example' => '1.00', 'title' => ''],
+ 'TradePrice' => ['description' => 'The actual price. The actual price equals the original price minus the discount amount.', 'type' => 'string', 'example' => '10.00', 'title' => ''],
+ 'Currency' => ['description' => 'The currency.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'Promotions' => [
+ 'description' => 'The coupon metadata.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The coupon metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OptionCode' => ['description' => 'The coupon code.', 'type' => 'string', 'example' => 'coupon****', 'title' => ''],
+ 'PromotionId' => ['description' => 'The coupon ID.', 'type' => 'string', 'example' => '17440009****', 'title' => ''],
+ 'PromotionName' => ['description' => 'The coupon name.', 'type' => 'string', 'example' => '**优惠', 'title' => ''],
+ 'PromotionDesc' => ['description' => 'The coupon description.', 'type' => 'string', 'example' => '**活动期间的优惠', 'title' => ''],
+ 'Selected' => [
+ 'description' => 'Indicates whether the coupon is selected.',
+ 'enumValueTitles' => ['true' => 'Selected.', 'false' => 'Not selected.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Rules' => [
+ 'description' => 'The pricing rules.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The pricing rules.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleId' => ['description' => 'The pricing rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '102002100393****', 'title' => ''],
+ 'Description' => ['description' => 'The pricing rule description.', 'type' => 'string', 'example' => '用户优惠', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'PriceList' => [
+ 'description' => 'The list of price objects.'."\n"
+ ."\n"
+ .'This parameter is returned when the request parameter AppInstanceType has a value.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The price object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PriceType' => [
+ 'description' => 'The price type.',
+ 'enumValueTitles' => ['Connected' => 'in-use phase.', 'Standby' => 'pre-launch phase.'],
+ 'type' => 'string',
+ 'example' => 'Standby',
+ 'title' => '',
+ ],
+ 'Price' => [
+ 'description' => 'The price details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'string', 'example' => '6700', 'title' => ''],
+ 'DiscountPrice' => ['description' => 'The discount amount. The actual price equals the original price minus the discount amount.', 'type' => 'string', 'example' => '999.0', 'title' => ''],
+ 'TradePrice' => ['description' => 'The actual price. The actual price equals the original price minus the discount amount.', 'type' => 'string', 'example' => '5278.0', 'title' => ''],
+ 'Currency' => ['description' => 'The currency.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'Promotions' => [
+ 'description' => 'The coupon metadata.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The coupon metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OptionCode' => ['description' => 'The coupon code.', 'type' => 'string', 'example' => 'coupon****', 'title' => ''],
+ 'PromotionId' => ['description' => 'The coupon ID.', 'type' => 'string', 'example' => '1847709****', 'title' => ''],
+ 'PromotionName' => ['description' => 'The coupon name.', 'type' => 'string', 'example' => '**优惠', 'title' => ''],
+ 'PromotionDesc' => ['description' => 'The coupon description.', 'type' => 'string', 'example' => '**活动期间的优惠', 'title' => ''],
+ 'Selected' => [
+ 'description' => 'Indicates whether the coupon is selected.',
+ 'enumValueTitles' => ['true' => 'Selected.', 'false' => 'Not selected.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Rules' => [
+ 'description' => 'The pricing rules.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The pricing rules.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleId' => ['description' => 'The pricing rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '260904273633****', 'title' => ''],
+ 'Description' => ['description' => 'The pricing rule description.', 'type' => 'string', 'example' => '用户优惠。', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'title' => 'Query resource price',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourcePrice'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetResourcePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\",\\n \\"PriceModel\\": {\\n \\"Price\\": {\\n \\"OriginalPrice\\": \\"11.00\\",\\n \\"DiscountPrice\\": \\"1.00\\",\\n \\"TradePrice\\": \\"10.00\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Promotions\\": [\\n {\\n \\"OptionCode\\": \\"coupon****\\",\\n \\"PromotionId\\": \\"17440009****\\",\\n \\"PromotionName\\": \\"**优惠\\",\\n \\"PromotionDesc\\": \\"**活动期间的优惠\\",\\n \\"Selected\\": true\\n }\\n ]\\n },\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"Description\\": \\"用户优惠\\"\\n }\\n ]\\n },\\n \\"PriceList\\": [\\n {\\n \\"PriceType\\": \\"Standby\\",\\n \\"Price\\": {\\n \\"OriginalPrice\\": \\"6700\\",\\n \\"DiscountPrice\\": \\"999.0\\",\\n \\"TradePrice\\": \\"5278.0\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Promotions\\": [\\n {\\n \\"OptionCode\\": \\"coupon****\\",\\n \\"PromotionId\\": \\"1847709****\\",\\n \\"PromotionName\\": \\"**优惠\\",\\n \\"PromotionDesc\\": \\"**活动期间的优惠\\",\\n \\"Selected\\": true\\n }\\n ]\\n },\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"Description\\": \\"用户优惠。\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetResourceRenewPrice' => [
+ 'summary' => 'Queries the renewal price of WUYING Cloud Application resources.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'ProductType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
+ 'type' => 'string',
+ 'required' => true,
'example' => 'CloudApp',
+ 'title' => '',
],
],
[
- 'name' => 'AppInstanceGroupName',
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The numeric part of the purchase duration. This parameter is used together with PeriodUnit to specify the complete purchase duration.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
- 'description' => 'The name of the delivery groups to query. Fuzzy match is used for queries. For example, if you set this parameter to `Office App`, all delivery groups whose names contain `Office App` are queried, such as `My Office Apps` and `Office App A`.'."\n",
+ 'description' => 'The unit part of the purchase duration. This parameter is used together with Period to specify the complete purchase duration. Valid combinations of Period and PeriodUnit:'."\n"
+ ."\n"
+ .'- 1 Week'."\n"
+ .'- 1 Month'."\n"
+ .'- 2 Month'."\n"
+ .'- 3 Month'."\n"
+ .'- 6 Month'."\n"
+ .'- 1 Year'."\n"
+ .'- 2 Year'."\n"
+ .'- 3 Year'."\n"
+ ."\n"
+ .'> This parameter is case-sensitive. For example, `Week` is valid, but `week` is invalid. If the request parameters do not match the combinations listed above, such as `2 Week`, the call to this operation succeeds, but an error occurs during the order placement phase.',
+ 'enumValueTitles' => ['Month' => 'month.', 'Year' => 'year.', 'Week' => 'week.'],
'type' => 'string',
- 'required' => false,
+ 'required' => true,
+ 'example' => 'Week',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The delivery group ID. You can call the [ListAppInstanceGroup](~~428506~~) operation to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Data' => [
+ 'description' => 'The price object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Price' => [
+ 'description' => 'The price details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'string', 'example' => '11'."\n", 'title' => ''],
+ 'DiscountPrice' => ['description' => 'The discount amount. The actual price is calculated by subtracting the discount amount from the original price.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'TradePrice' => ['description' => 'The actual price. The actual price is calculated by subtracting the discount amount from the original price.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'Currency' => ['description' => 'The currency.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'Promotions' => [
+ 'description' => 'The coupon descriptions.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The coupon metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OptionCode' => ['description' => 'The coupon code.', 'type' => 'string', 'example' => 'coupon****', 'title' => ''],
+ 'PromotionId' => ['description' => 'The coupon ID.', 'type' => 'string', 'example' => '139965*****', 'title' => ''],
+ 'PromotionName' => ['description' => 'The coupon name.', 'type' => 'string', 'example' => '**活动', 'title' => ''],
+ 'PromotionDesc' => ['description' => 'The coupon descriptions.', 'type' => 'string', 'example' => '**活动', 'title' => ''],
+ 'Selected' => [
+ 'description' => 'Indicates whether the coupon is selected.',
+ 'enumValueTitles' => ['true' => 'selected.', 'false' => 'not selected.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Rules' => [
+ 'description' => 'The pricing rules.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The pricing rules.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleId' => ['description' => 'The pricing rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20002****', 'title' => ''],
+ 'Description' => ['description' => 'The pricing rule description.', 'type' => 'string', 'example' => '**活动', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'example' => '',
],
],
+ ],
+ 'title' => 'Query resource renewal price',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceRenewPrice'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'AppCenterImageId',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetResourceRenewPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"Price\\": {\\n \\"OriginalPrice\\": \\"11\\\\n\\",\\n \\"DiscountPrice\\": \\"1\\",\\n \\"TradePrice\\": \\"10\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Promotions\\": [\\n {\\n \\"OptionCode\\": \\"coupon****\\",\\n \\"PromotionId\\": \\"139965*****\\",\\n \\"PromotionName\\": \\"**活动\\",\\n \\"PromotionDesc\\": \\"**活动\\",\\n \\"Selected\\": true\\n }\\n ]\\n },\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"Description\\": \\"**活动\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetRuntimeChannel' => [
+ 'summary' => 'Queries the third-party channel configurations of an Agent runtime.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RuntimeType',
'in' => 'query',
'schema' => [
- 'title' => '应用中心镜像ID',
- 'description' => 'The image ID of the app. You can obtain the ID from the Images page in the App Streaming console.'."\n",
+ 'title' => '',
+ 'description' => 'The type of the Agent runtime.',
+ 'enumValueTitles' => ['CloudDesktop' => 'cloud computer.'],
'type' => 'string',
+ 'required' => true,
+ 'example' => 'CloudDesktop',
+ ],
+ ],
+ [
+ 'name' => 'RuntimeId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The Agent runtime ID. The ID mappings are as follows:'."\n"
+ ."\n"
+ .'- JVS Computer: the JVS Computer ID, in the format of jvs-xxxx.'."\n"
+ .'- OpenClaw: the cloud computer ID, in the format of ecd-xxxx.'."\n"
+ .'- Hermes Agent: the Hermes Agent ID, in the format of jvs-xxxx.', 'type' => 'string', 'required' => true, 'example' => 'jvs-xxxx'],
+ ],
+ [
+ 'name' => 'AgentProvider',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The Agent provider.'."\n"
+ ."\n"
+ .'- JVS Computer: set to OpenClaw.'."\n"
+ .'- OpenClaw: set to OpenClaw.'."\n"
+ .'- Hermes Agent: set to HermesAgent.',
+ 'enumValueTitles' => ['HermesAgent' => 'Hermes Agent', 'OpenClaw' => 'OpenClaw'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OpenClaw',
+ ],
+ ],
+ [
+ 'name' => 'AgentPlatform',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The Agent platform.',
+ 'enumValueTitles' => ['ENTERPRISE' => 'OpenClaw', 'ENTERPRISE_JVS' => 'JVS Computer、Hermes Agent'],
+ 'type' => 'string',
+ 'example' => 'ENTERPRISE',
'required' => false,
- 'example' => 'img-8z4nztpaqvay4****',
],
],
[
- 'name' => 'RegionId',
+ 'name' => 'IncludeRiskInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Specifies whether to include risk information.',
+ 'enumValueTitles' => ['true' => 'yes.', 'false' => 'no.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The request result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The returned object.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => '',
+ 'description' => 'The channel code.',
+ 'enumValueTitles' => ['dingtalk-connector' => 'DingTalk.', 'wechat' => 'WeChat.', 'feishu' => 'Lark.', 'qqbot' => 'QQ', 'wecom' => 'WeCom.'],
+ 'type' => 'string',
+ 'example' => 'dingtalk-connector',
+ ],
+ 'Status' => [
+ 'title' => '',
+ 'description' => 'The configuration status.',
+ 'enumValueTitles' => ['Unconfigured' => 'Unconfigured.', 'Configured' => 'Configured.'],
+ 'type' => 'string',
+ 'example' => 'Configured',
+ ],
+ 'Config' => ['title' => '', 'description' => 'The channel configuration JSON string.'."\n"
+ ."\n"
+ .'Currently, only the simple configuration mode is supported. You must pass AppKey and AppSecret.', 'type' => 'string', 'example' => '{'."\n"
+ .' "appKey": "abc",'."\n"
+ .' "appSecret": "efg"'."\n"
+ .'}'],
+ 'ConfigMode' => [
+ 'title' => '',
+ 'description' => 'The configuration mode.',
+ 'enumValueTitles' => ['Custom' => 'Custom configuration mode.', 'Simple' => 'Simple configuration mode.'],
+ 'type' => 'string',
+ 'example' => 'Simple',
+ ],
+ 'AvatarUrl' => ['title' => '', 'description' => 'The channel avatar URL.', 'type' => 'string', 'example' => 'https://test.com/test.jpg'],
+ 'RiskType' => [
+ 'title' => '',
+ 'description' => 'The risk type. This parameter is returned only when **includeRiskInfo=true**.',
+ 'enumValueTitles' => ['UserAdded' => 'A channel added by the user but not configured by the administrator.', 'UserRemoved' => 'A channel configured by the administrator but removed by the user.', 'Normal' => 'Consistent with the administrator configuration (no risk).'],
+ 'type' => 'string',
+ 'example' => 'Normal',
+ ],
+ 'QrCodeStatus' => ['title' => '', 'description' => 'The QR code configuration status. This parameter is returned only when the status is not in a desired state.', 'type' => 'string', 'example' => 'https://q.qq.com/qqbot/openclaw/entity-picker.html?session_id=c0882266-77c0-4094-af93-442*****2a58'],
+ 'QrCodeNotifyUrl' => ['title' => '', 'description' => 'The QR code configuration notification page URL. This parameter is returned only for the ENTERPRISE or ENTERPRISE_JVS platform.', 'type' => 'string', 'example' => 'https://eds.console.aliyun.com/public/scan-pair?taskId=e7eb5d86-1b94-4d58-****-3b78b01df99e&code=dingtalk-connector&region=cn-shanghai'],
+ 'ChannelType' => [
+ 'title' => '',
+ 'description' => 'The channel type.',
+ 'enumValueTitles' => ['Custom' => 'Custom channel.', 'System' => 'System-supported channel.'],
+ 'type' => 'string',
+ 'example' => 'System',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '6'],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query third-party channel configurations of an agent runtime',
+ 'description' => 'You can query the third-party channel configuration status of Agent runtimes such as JVS Computer, OpenClaw, and Hermes Agent in the Wuying Agent Management Center.'."\n"
+ ."\n"
+ .'Make sure that you are familiar with the operations and usage of the Wuying Agent Management Center before you call this operation.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetRuntimeChannel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"dingtalk-connector\\",\\n \\"Status\\": \\"Configured\\",\\n \\"Config\\": \\"{\\\\n \\\\\\"appKey\\\\\\": \\\\\\"abc\\\\\\",\\\\n \\\\\\"appSecret\\\\\\": \\\\\\"efg\\\\\\"\\\\n}\\",\\n \\"ConfigMode\\": \\"Simple\\",\\n \\"AvatarUrl\\": \\"https://test.com/test.jpg\\",\\n \\"RiskType\\": \\"Normal\\",\\n \\"QrCodeStatus\\": \\"https://q.qq.com/qqbot/openclaw/entity-picker.html?session_id=c0882266-77c0-4094-af93-442*****2a58\\",\\n \\"QrCodeNotifyUrl\\": \\"https://eds.console.aliyun.com/public/scan-pair?taskId=e7eb5d86-1b94-4d58-****-3b78b01df99e&code=dingtalk-connector&region=cn-shanghai\\",\\n \\"ChannelType\\": \\"System\\"\\n }\\n ],\\n \\"TotalCount\\": 6,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'GetRuntimeModelConfig' => [
+ 'summary' => 'Queries the model configuration details of a cloud computer.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RuntimeType',
'in' => 'query',
'schema' => [
- 'title' => '地域ID',
- 'description' => 'The region ID'."\n",
+ 'title' => '',
+ 'description' => 'The Agent runtime type.',
+ 'enumValueTitles' => ['CloudDesktop' => 'cloud computer.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'CloudDesktop',
+ ],
+ ],
+ [
+ 'name' => 'RuntimeId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The Agent runtime ID. The ID mappings are as follows:'."\n"
+ ."\n"
+ .'JVS Computer: JVS Computer ID, in the format of jvs-xxxx.'."\n"
+ ."\n"
+ .'OpenClaw: Cloud computer ID, in the format of ecd-xxxx.'."\n"
+ ."\n"
+ .'Hermes Agent: Hermes Agent ID, in the format of jvs-xxxx.', 'type' => 'string', 'required' => true, 'example' => 'ecd-xxxx'],
+ ],
+ [
+ 'name' => 'AgentPlatform',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The Agent platform.',
+ 'enumValueTitles' => ['ENTERPRISE' => 'Enterprise Edition.', 'ENTERPRISE_JVS' => 'Enterprise Edition JVS Computer or Enterprise Edition Hermes Agent.'],
'type' => 'string',
- 'deprecated' => true,
'required' => false,
- 'example' => 'cn-hangzhou',
+ 'example' => 'ENTERPRISE',
+ 'title' => '',
],
],
[
- 'name' => 'BizRegionId',
+ 'name' => 'AgentProvider',
'in' => 'query',
'schema' => [
- 'description' => 'The ID of the region where the delivery group resides. For information about the supported regions, see [Limits](~~426036~~).'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* cn-shanghai: China (Shanghai)'."\n"
- .'* cn-hangzhou: China (Hangzhou)'."\n",
+ 'title' => '',
+ 'description' => 'The Agent provider.',
+ 'enumValueTitles' => ['OpenClaw' => 'OpenClaw'],
'type' => 'string',
+ 'required' => true,
+ 'example' => 'OpenClaw',
+ ],
+ ],
+ [
+ 'name' => 'IncludeRiskInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Specifies whether to include risk information.',
+ 'enumValueTitles' => ['true' => 'yes.', 'false' => 'no.'],
+ 'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'cn-shanghai' => '',
- 'cn-hangzhou' => '',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The query result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The returned result object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ModelTemplateId' => ['title' => '', 'description' => 'The configured model group ID.', 'type' => 'string', 'example' => 'mt-xxxx'],
+ 'ModelTemplateName' => ['title' => '', 'description' => 'The model group name.', 'type' => 'string', 'example' => 'model-template-001'],
+ 'DefaultModel' => ['title' => '', 'description' => 'The default model (format: providerName/llmCode).', 'type' => 'string', 'example' => 'bailian/qwen3.6-plus'],
+ 'ModelTemplateRefType' => [
+ 'title' => '',
+ 'description' => 'The model template association type (returned only when an association exists).',
+ 'enumValueTitles' => ['Runtime' => 'Runtime dimension.', 'ResourceGroup' => 'resource group dimension.'],
+ 'type' => 'string',
+ 'example' => 'Runtime',
+ ],
+ 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID to which the runtime belongs. The value is null if the runtime is not associated with a resource group.', 'type' => 'string', 'example' => 'rg-xxxxx'],
+ 'ModelProviderList' => [
+ 'title' => '',
+ 'description' => 'The list of model providers.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ModelProviderTemplateId' => ['title' => '', 'description' => 'The model provider template ID.', 'type' => 'string', 'example' => 'mpt-xxxx'],
+ 'ProviderName' => ['title' => '', 'description' => 'The model provider name.', 'type' => 'string', 'example' => 'bailian'],
+ 'Name' => ['title' => '', 'description' => 'The model provider template name.', 'type' => 'string', 'example' => '百炼'],
+ 'LlmInfoList' => [
+ 'title' => '',
+ 'description' => 'The list of model information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'LlmCode' => ['title' => '', 'description' => 'The model code.', 'type' => 'string', 'example' => 'qwen3.6-plus'],
+ 'Name' => ['title' => '', 'description' => 'The model name.', 'type' => 'string', 'example' => 'Qwen3.6-Plus'],
+ 'Description' => ['title' => '', 'description' => 'The model description.', 'type' => 'string', 'example' => 'Qwen3.6原生视觉语言系列Plus模型,展现出与当前顶尖前沿模型相媲美的卓越性能,模型效果相较3.5系列显著提升。模型在Agentic coding、前端编程、Vibe coding等代码能力、多模态万物识别、OCR、物体定位等能力上显著增强。'],
+ 'PublishedTime' => ['title' => '', 'description' => 'The publish time in ISO 8601 format.', 'type' => 'string', 'example' => '2026-03-04T06:25:17.000+00:00'],
+ 'Features' => [
+ 'title' => '',
+ 'description' => 'The list of model features, such as function-calling, web-search, and structured-outputs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The model feature.', 'type' => 'string', 'example' => 'function-calling', 'title' => ''],
+ 'example' => '',
+ ],
+ 'InferenceMetadata' => [
+ 'title' => '',
+ 'description' => 'The inference metadata, including request and response modalities.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestModality' => [
+ 'title' => '',
+ 'description' => 'The list of request modalities, such as Text, Image, and Audio.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The request modality.', 'type' => 'string', 'example' => 'Text', 'title' => ''],
+ 'example' => '',
+ ],
+ 'ResponseModality' => [
+ 'title' => '',
+ 'description' => 'The list of response modalities, such as Text, Image, and Audio.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The response modality.', 'type' => 'string', 'example' => 'Text', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'RiskType' => [
+ 'title' => '',
+ 'description' => 'The model risk type. This parameter is returned only when the request parameter IncludeRiskInfo is set to true.',
+ 'enumValueTitles' => ['UserAdded' => 'a model added by the user but not configured by the administrator.', 'UserRemoved' => 'a model configured by the administrator but removed by the user.', 'Normal' => 'consistent with the administrator configuration (no risk).'],
+ 'type' => 'string',
+ 'example' => 'Normal',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
- 'example' => 'cn-hangzhou',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query model configuration of an agent runtime',
+ 'description' => 'You can query the model configuration details currently bound to a specified cloud computer in the Wuying Agent Management Center, including model groups, model provider lists, and associated model information. After you enable the risk information mode, you can also identify differences between the end user\'s actual configuration and the configuration delivered by the administrator.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'NodeInstanceType',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetRuntimeModelConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ModelTemplateId\\": \\"mt-xxxx\\",\\n \\"ModelTemplateName\\": \\"model-template-001\\",\\n \\"DefaultModel\\": \\"bailian/qwen3.6-plus\\",\\n \\"ModelTemplateRefType\\": \\"Runtime\\",\\n \\"ResourceGroupId\\": \\"rg-xxxxx\\",\\n \\"ModelProviderList\\": [\\n {\\n \\"ModelProviderTemplateId\\": \\"mpt-xxxx\\",\\n \\"ProviderName\\": \\"bailian\\",\\n \\"Name\\": \\"百炼\\",\\n \\"LlmInfoList\\": [\\n {\\n \\"LlmCode\\": \\"qwen3.6-plus\\",\\n \\"Name\\": \\"Qwen3.6-Plus\\",\\n \\"Description\\": \\"Qwen3.6原生视觉语言系列Plus模型,展现出与当前顶尖前沿模型相媲美的卓越性能,模型效果相较3.5系列显著提升。模型在Agentic coding、前端编程、Vibe coding等代码能力、多模态万物识别、OCR、物体定位等能力上显著增强。\\",\\n \\"PublishedTime\\": \\"2026-03-04T06:25:17.000+00:00\\",\\n \\"Features\\": [\\n \\"function-calling\\"\\n ],\\n \\"InferenceMetadata\\": {\\n \\"RequestModality\\": [\\n \\"Text\\"\\n ],\\n \\"ResponseModality\\": [\\n \\"Text\\"\\n ]\\n },\\n \\"RiskType\\": \\"Normal\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'ListAppInstanceGroup' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '134196',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['description' => 'The number of query results per page. Maximum value: `100`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number of the query results to display.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The ID of the resource specification that you purchase. You can call the [ListNodeInstanceType](~~ListNodeInstanceType~~) operation to obtain the ID.'."\n",
- 'type' => 'string',
+ 'description' => 'The list of delivery group statuses.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The delivery group status.',
+ 'enumValueTitles' => ['PUBLISHED' => '发布成功', 'FAILED' => '发布失败', 'MAINTAIN_FAILED' => '更新失败', 'EXPIRED' => '已到期', 'MAINTAINING' => '更新中', 'CEASED' => '已欠费', 'EXPIRED_RECYCLING' => '过期回收中', 'DEPLOYING' => '发布中'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '"Status.1":"PUBLISHED","Status.2":"FAILED"',
+ 'title' => '',
+ ],
'required' => false,
- 'example' => 'appstreaming.vgpu.4c8g.2g',
+ 'maxItems' => 1000,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'OfficeSiteId',
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The delivery group ID.', 'type' => 'string', 'required' => false, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ProductType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'CloudApp',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'AppInstanceGroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The delivery group name. Fuzzy match is used for the query. For example, if you set the delivery group name to `Office App`, all delivery groups whose names contain `Office App` are returned, such as `My Office App` and `Office App A`.', 'type' => 'string', 'required' => false, 'example' => '办公应用', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppCenterImageId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The application image ID. You can obtain this value from the Image Management page in the WUYING Cloud Application console.', 'type' => 'string', 'required' => false, 'example' => 'img-8z4nztpaqvay4****'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID of the delivery group. For more information about supported regions, see [Limits](~~426036~~).',
+ 'enumValueTitles' => ['cn-shanghai' => 'China (Shanghai).', 'cn-hangzhou' => 'China (Hangzhou).'],
'type' => 'string',
'required' => false,
- 'example' => 'cn-hongkong+dir-643067****',
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
],
],
[
+ 'name' => 'NodeInstanceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The specification type ID of the purchased resources. You can call the [ListNodeInstanceType](~~ListNodeInstanceType~~) operation to obtain this value.', 'type' => 'string', 'required' => false, 'example' => 'appstreaming.vgpu.4c8g.2g', 'title' => ''],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong+dir-643067****', 'title' => ''],
+ ],
+ [
'name' => 'Tag',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'title' => '标签列表。',
+ 'title' => '',
+ 'description' => 'The tags.',
'type' => 'array',
'items' => [
- 'title' => '标签。',
+ 'title' => '',
+ 'description' => 'The tag.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签键。',
- 'type' => 'string',
- ],
- 'Value' => [
- 'title' => '标签值。',
- 'type' => 'string',
- ],
+ 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'department'],
+ 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'design'],
],
+ 'required' => false,
+ 'example' => '',
],
+ 'required' => false,
'maxItems' => 20,
'minItems' => 0,
+ 'example' => '',
],
],
[
@@ -4991,13 +4954,12 @@
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'title' => '授权用户组ID列表。',
'type' => 'array',
- 'items' => [
- 'title' => '授权用户组ID。',
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'maxItems' => 10,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
[
@@ -5005,688 +4967,364 @@
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'title' => '排除授权用户组ID列表。',
'type' => 'array',
- 'items' => [
- 'title' => '排除授权用户组ID。',
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'maxItems' => 10,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '15',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of query results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the query results currently displayed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'AppInstanceGroupModels' => [
- 'title' => 'AppInstanceGroupModels',
- 'description' => 'The delivery groups.'."\n",
+ 'title' => '',
+ 'description' => 'The delivery group information.',
'type' => 'array',
'items' => [
- 'description' => 'The delivery group.'."\n",
+ 'description' => 'The delivery group information.',
'type' => 'object',
'properties' => [
'Apps' => [
- 'description' => 'The apps.'."\n",
+ 'description' => 'The application information.',
'type' => 'array',
'items' => [
- 'description' => 'The app.'."\n",
+ 'description' => 'The application information.',
'type' => 'object',
'properties' => [
- 'AppId' => [
- 'description' => 'The app ID.'."\n",
- 'type' => 'string',
- 'example' => 'ca-i87mycyn419nu****',
- ],
- 'AppName' => [
- 'description' => 'The app name.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'AppVersion' => [
- 'description' => 'The app version.'."\n",
- 'type' => 'string',
- 'example' => '1.0.0',
- ],
- 'AppVersionName' => [
- 'description' => 'The name of the app version.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'AppIcon' => [
- 'description' => 'The app icon.'."\n",
- 'type' => 'string',
- 'example' => 'https://app-center-icon-****.png',
- ],
+ 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'ca-i87mycyn419nu****', 'title' => ''],
+ 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => '办公应用', 'title' => ''],
+ 'AppVersion' => ['description' => 'The application version.', 'type' => 'string', 'example' => '1.0.0', 'title' => ''],
+ 'AppVersionName' => ['description' => 'The application version name.', 'type' => 'string', 'example' => '初始版本', 'title' => ''],
+ 'AppIcon' => ['description' => 'The application icon.', 'type' => 'string', 'example' => 'https://app-center-icon-****.png', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'AppCenterImageId' => [
- 'description' => 'The image ID of the app.'."\n",
- 'type' => 'string',
- 'example' => 'img-8z4nztpaqvay4****',
- ],
+ 'AppCenterImageId' => ['description' => 'The application image ID.', 'type' => 'string', 'example' => 'img-8z4nztpaqvay4****', 'title' => ''],
'RegionId' => [
- 'description' => 'The ID of the region where the delivery group resides. For information about the supported regions, see [Limits](~~426036~~).'."\n",
- 'type' => 'string',
+ 'description' => 'The region ID of the delivery group. For more information about supported regions, see [Limits](~~426036~~).',
'enumValueTitles' => [],
+ 'type' => 'string',
'example' => 'cn-hangzhou',
+ 'title' => '',
],
'ProductType' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
'example' => 'CloudApp',
- ],
- 'AppInstanceType' => [
- 'description' => 'The resource type of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => '__dynamic__',
- ],
- 'AppInstanceGroupId' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
- 'Amount' => [
- 'description' => 'The number of subscription resources. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'MinAmount' => [
- 'description' => 'The minimum number of instances. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'MaxAmount' => [
- 'description' => 'The maximum number of instances. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'ReserveAmountRatio' => [
- 'description' => 'The percentage of reserved instances. The value indicates the percentage of unused sessions in the delivery group. Valid values: 0 to 99.'."\n",
- 'type' => 'string',
- 'example' => '20',
- ],
- 'ReserveMinAmount' => [
- 'description' => 'The minimum number of reserved instances. The value indicates the minimum number of unused sessions in the delivery group. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ReserveMaxAmount' => [
- 'description' => 'The maximum number of reserved instances. The value indicates the maximum number of unused sessions in the delivery group. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'ScalingStep' => [
- 'description' => 'The number of sessions that are created each time the delivery group is scaled out. Minimum value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'ScalingUsageThreshold' => [
- 'description' => 'The upper limit of session usage. If the session usage exceeds the specified upper limit, auto scale-out is triggered. The session usage rate is calculated by using the following formula: Session usage rate = Number of sessions in use/Total number of sessions × 100%. Valid values: 0 to 99.'."\n",
- 'type' => 'string',
- 'example' => '85',
- ],
- 'ScalingDownAfterIdleMinutes' => [
- 'description' => 'The duration for which no session is connected. Unit: minutes. If no session is connected in the resources after the specified duration elapses, auto scale-in is triggered. Minimum value: 0.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'title' => '',
+ ],
+ 'AppInstanceType' => ['description' => 'The specification type of the delivery group.', 'type' => 'string', 'example' => '__dynamic__', 'title' => ''],
+ 'AppInstanceGroupId' => ['description' => 'The delivery group ID.', 'type' => 'string', 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ 'Amount' => ['description' => 'The number of subscription resources configured by the user. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'MinAmount' => ['description' => 'The minimum number of instances. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'MaxAmount' => ['description' => 'The maximum number of instances. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'ReserveAmountRatio' => ['description' => 'The percentage of reserved instances, which represents the ratio of unused sessions in the delivery group. Valid values: 0 to 99.', 'type' => 'string', 'example' => '20', 'title' => ''],
+ 'ReserveMinAmount' => ['description' => 'The minimum number of reserved instances, which represents the minimum number of unused sessions in the delivery group. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ReserveMaxAmount' => ['description' => 'The maximum number of reserved instances, which represents the maximum number of unused sessions in the delivery group. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'ScalingStep' => ['description' => 'The number of sessions created during each scale-out event. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'ScalingUsageThreshold' => ['description' => 'The upper threshold of session usage (%). When the session usage exceeds this threshold, automatic scale-out is triggered. The formula for session usage is: Session usage = Number of sessions in use ÷ Total number of sessions × 100%. Valid values: 0 to 99.', 'type' => 'string', 'example' => '85', 'title' => ''],
+ 'ScalingDownAfterIdleMinutes' => ['description' => 'The duration of no session connections, in minutes. When a resource remains in a no-session-connection state for the specified duration, automatic scale-in is triggered. Minimum value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'ChargeType' => [
- 'description' => 'The billing method.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* PostPaid: pay-as-you-go'."\n"
- .'* PrePaid: subscription'."\n",
+ 'description' => 'The billing method.',
+ 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go.', 'PrePaid' => 'subscription.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'PostPaid' => '',
- 'PrePaid' => '',
- ],
'example' => 'PrePaid',
+ 'title' => '',
],
- 'GmtCreate' => [
- 'description' => 'The time when the delivery group was created.'."\n",
- 'type' => 'string',
- 'example' => '2022-04-26T15:06:16.000+00:00',
- ],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-04-26T15:06:16.000+00:00', 'title' => ''],
'Status' => [
- 'description' => 'The status of the delivery group.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* PUBLISHED: The delivery group is published.'."\n"
- .'* FAILED: The delivery group failed to be published.'."\n"
- .'* MAINTAIN_FAILED: The delivery group failed to be updated.'."\n"
- .'* EXPIRED: The delivery group is expired.'."\n"
- .'* MAINTAINING: The delivery group is being updated.'."\n"
- .'* CEASED: The delivery group has overdue payments.'."\n"
- .'* EXPIRED_RECYCLING: The delivery group is expired and being recycled.'."\n"
- .'* DEPLOYING: The delivery group is being published.'."\n",
+ 'description' => 'The delivery group status.',
+ 'enumValueTitles' => ['PUBLISHED' => 'Published.', 'FAILED' => 'Publishing failed.', 'MAINTAIN_FAILED' => 'Update failed.', 'EXPIRED' => 'Expired.', 'MAINTAINING' => 'Updating.', 'CEASED' => 'Overdue.', 'EXPIRED_RECYCLING' => 'Expired and being recycled.', 'DEPLOYING' => 'Publishing.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'PUBLISHED' => '',
- 'FAILED' => '',
- 'MAINTAIN_FAILED' => '',
- 'EXPIRED' => '',
- 'MAINTAINING' => '',
- 'CEASED' => '',
- 'EXPIRED_RECYCLING' => '',
- 'DEPLOYING' => '',
- ],
'example' => 'PUBLISHED',
+ 'title' => '',
],
'NodePool' => [
- 'description' => 'The resource groups.'."\n",
+ 'description' => 'The resource group information.',
'type' => 'array',
'items' => [
- 'description' => 'The resource group.'."\n",
+ 'description' => 'The resource group object.',
'type' => 'object',
'properties' => [
- 'NodePoolId' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'example' => 'rg-g6922kced36hx****',
- ],
+ 'NodePoolId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-g6922kced36hx****', 'title' => ''],
'NodeInstanceType' => [
- 'description' => 'The ID of the resource specification that you purchase.'."\n",
- 'type' => 'string',
+ 'description' => 'The specification type ID of the purchased resources.',
'enumValueTitles' => [],
+ 'type' => 'string',
'example' => 'appstreaming.vgpu.4c8g.2g',
+ 'title' => '',
],
- 'NodeAmount' => [
- 'description' => 'The total number of subscription resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NodeUsed' => [
- 'description' => 'The number of subscription resources that are in use.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NodeCapacity' => [
- 'description' => 'The maximum number of sessions that can be connected to a resource at the same time. If a resource connects to a large number of sessions at the same time, user experience can be compromised. The value range varies based on the resource specification. The following items describe the value ranges of different resource types:'."\n"
- ."\n"
- .'* appstreaming.general.4c8g: 1 to 2'."\n"
- .'* appstreaming.general.8c16g: 1 to 4'."\n"
- .'* appstreaming.vgpu.8c16g.4g: 1 to 4'."\n"
- .'* appstreaming.vgpu.8c31g.16g: 1 to 4'."\n"
- .'* appstreaming.vgpu.14c93g.12g: 1 to 6'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ScalingNodeAmount' => [
- 'description' => 'The total number of scalable resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'ScalingNodeUsed' => [
- 'description' => 'The number of scalable resources that are in use.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
+ 'NodeAmount' => ['description' => 'The total number of current subscription resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'NodeUsed' => ['description' => 'The resource count of subscription resources in use.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'NodeCapacity' => ['description' => 'The number of concurrent sessions, which is the number of sessions that a single resource can handle simultaneously. Too many simultaneous sessions may degrade the application experience. The valid values vary depending on the resource specification.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'ScalingNodeAmount' => ['description' => 'The total number of elastic resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
+ 'ScalingNodeUsed' => ['description' => 'The resource count of elastic resources in use.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
'StrategyType' => [
- 'description' => 'The type of the scaling policy.'."\n"
- ."\n"
- .'> `NODE_SCALING_BY_USAGE` is returned for this parameter only if ChargeType is set to `PrePaid`. `NODE_SCALING_BY_SCHEDULE` is returned for this parameter only if ChargeType is set to `PostPaid`.'."\n"
+ 'description' => 'The elastic policy type.'."\n"
."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* NODE_FIXED: No scalable resources are used.'."\n"
- .'* NODE_SCALING_BY_SCHEDULE: Scheduled scaling is used.'."\n"
- .'* NODE_SCALING_BY_USAGE: Resources are scaled based on usage.'."\n",
+ .'> `NODE_SCALING_BY_USAGE` (usage-based scaling policy) applies only to `PrePaid` (subscription) resources. `NODE_SCALING_BY_SCHEDULE` (scheduled scaling policy) applies only to `PostPaid` (pay-as-you-go) resources.',
+ 'enumValueTitles' => ['NODE_FIXED' => 'No elastic resources used.', 'NODE_SCALING_BY_SCHEDULE' => 'Scheduled scaling.', 'NODE_SCALING_BY_USAGE' => 'Usage-based scaling policy.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'NODE_FIXED' => '',
- 'NODE_SCALING_BY_SCHEDULE' => '',
- 'NODE_SCALING_BY_USAGE' => '',
- ],
'example' => 'NODE_FIXED',
+ 'title' => '',
],
- 'Amount' => [
- 'description' => 'The number of resources purchased when the delivery group was created.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'MaxScalingAmount' => [
- 'description' => 'The maximum number of resources that can be created for scale-out.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'MaxIdleAppInstanceAmount' => [
- 'description' => 'The maximum number of idle sessions. After you specify a value for this parameter, auto scale-out is triggered only if the number of idle sessions in the delivery group is smaller than the specified value and the session usage exceeds the value specified for `ScalingUsageThreshold`. Otherwise, the system determines that idle sessions in the delivery group are sufficient and does not perform auto scale-out.`` You can use this parameter to flexibly manage auto scaling and reduce costs.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'ScalingStep' => [
- 'description' => 'The number of resources that are created each time resources are scaled out. Valid values: 1 to 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ScalingUsageThreshold' => [
- 'description' => 'The upper limit of session usage. If the session usage exceeds the specified upper limit, auto scale-out is triggered. The session usage is calculated by using the following formula: `Session usage = Number of current sessions/(Total number of resources × Number of concurrent sessions) × 100%`.'."\n",
- 'type' => 'string',
- 'example' => '85',
- ],
- 'ScalingDownAfterIdleMinutes' => [
- 'description' => 'The duration for which no session is connected. Unit: minutes. If no session is connected in the resources after the specified duration elapses, auto scale-in is triggered. Default value: 5.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'Amount' => ['description' => 'The number of resources purchased when the delivery group was created.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'MaxScalingAmount' => ['description' => 'The maximum number of resources that can be created during scale-out.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
+ 'MaxIdleAppInstanceAmount' => ['description' => 'The upper limit of idle sessions. When this value is specified, automatic scale-out is triggered only when the session usage exceeds `ScalingUsageThreshold` and the number of idle sessions in the delivery group is less than `MaxIdleAppInstanceAmount`. Otherwise, the delivery group is considered to have sufficient idle sessions and no automatic scale-out is performed. This parameter allows you to flexibly control elastic scaling behavior and reduce costs.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'ScalingStep' => ['description' => 'The number of resources created during each scale-out event. Valid values: 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'ScalingUsageThreshold' => ['description' => 'The upper threshold of session usage (%). When the session usage exceeds this threshold, automatic scale-out is triggered. The formula for session usage is: `Session usage = Number of current sessions ÷ (Total number of resources × Concurrent sessions per resource) × 100%`.', 'type' => 'string', 'example' => '85', 'title' => ''],
+ 'ScalingDownAfterIdleMinutes' => ['description' => 'The duration of no session connections, in minutes. When a resource remains in a no-session-connection state for the specified duration, automatic scale-in is triggered. Default value: 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'RecurrenceSchedules' => [
- 'description' => 'The intervals at which the scaling policy is executed.'."\n",
+ 'description' => 'The list of policy execution cycles.',
'type' => 'array',
'items' => [
- 'description' => 'The interval at which the scaling policy is executed.'."\n",
+ 'description' => 'The policy execution cycle.',
'type' => 'object',
'properties' => [
'RecurrenceType' => [
- 'description' => 'The schedule type of the scaling policy. This parameter must be configured together with `RecurrenceValues`.``'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* weekly: The scaling policy is executed on specific days each week.'."\n",
+ 'description' => 'The type of the policy execution cycle. You must specify both `RecurrenceType` and `RecurrenceValues`.',
+ 'enumValueTitles' => ['weekly' => 'Weekly (the scheduled task is executed on specified days each week).'],
'type' => 'string',
- 'enumValueTitles' => [
- 'weekly' => '',
- ],
'example' => 'Weekly',
+ 'title' => '',
],
'RecurrenceValues' => [
- 'description' => 'The days of each week on which the scaling policy is executed.'."\n",
+ 'description' => 'The list of values for the policy execution cycle.',
'type' => 'array',
'items' => [
- 'description' => 'The day of each week on which the scaling policy is executed.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* 1: Monday'."\n"
- .'* 2: Tuesday'."\n"
- .'* 3: Wednesday'."\n"
- .'* 4: Thursday'."\n"
- .'* 5: Friday'."\n"
- .'* 6: Saturday'."\n"
- .'* 7: Sunday'."\n",
+ 'description' => 'The value of the policy execution cycle.',
+ 'enumValueTitles' => [1 => 'Monday.', 'Tuesday.', 'Wednesday.', 'Thursday.', 'Friday.', 'Saturday.', 'Sunday.'],
'type' => 'integer',
'format' => 'int32',
- 'enumValueTitles' => [
- 1 => '',
- '',
- '',
- '',
- '',
- '',
- '',
- ],
'example' => '1',
+ 'title' => '',
],
+ 'title' => '',
+ 'example' => '',
],
'TimerPeriods' => [
- 'description' => 'The time periods during which the scaling policy can be executed.'."\n",
+ 'description' => 'The list of time periods for the policy execution cycle.',
'type' => 'array',
'items' => [
- 'description' => 'The time period during which the scaling policy can be executed.'."\n",
+ 'description' => 'The time period for the policy execution cycle.',
'type' => 'object',
'properties' => [
- 'Amount' => [
- 'description' => 'The number of destination resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'EndTime' => [
- 'description' => 'The time when the scaling policy ends. Format: HH:mm.'."\n",
- 'type' => 'string',
- 'example' => '11:00',
- ],
- 'StartTime' => [
- 'description' => 'The time when the scaling policy starts. Format: HH:mm.'."\n",
- 'type' => 'string',
- 'example' => '09:30',
- ],
+ 'Amount' => ['description' => 'The target resource count.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'EndTime' => ['description' => 'The end time. Format: HH:mm.', 'type' => 'string', 'example' => '11:00', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time. Format: HH:mm.', 'type' => 'string', 'example' => '09:30', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'StrategyDisableDate' => [
- 'description' => 'The expiration date of the scaling policy. Format: yyyy-MM-dd.'."\n",
- 'type' => 'string',
- 'example' => '2022-09-08',
- ],
- 'StrategyEnableDate' => [
- 'description' => 'The effective date of the scaling policy. Format: yyyy-MM-dd.'."\n",
- 'type' => 'string',
- 'example' => '2022-08-01',
- ],
- 'WarmUp' => [
- 'description' => 'Indicates whether resource prefetch is enabled.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'NodeTypeName' => [
- 'description' => 'The name of the resource specification.'."\n",
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
+ 'StrategyDisableDate' => ['description' => 'The date when the policy expires. Format: yyyy-MM-dd.', 'type' => 'string', 'example' => '2022-09-08', 'title' => ''],
+ 'StrategyEnableDate' => ['description' => 'The date when the policy takes effect. Format: yyyy-MM-dd.', 'type' => 'string', 'example' => '2022-08-01', 'title' => ''],
+ 'WarmUp' => ['description' => 'Indicates whether the resource prefetch policy is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'NodeTypeName' => ['description' => 'The resource specification name.', 'type' => 'string', 'example' => '无影-通用型_4核8G', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'SpecId' => [
- 'description' => 'The specification ID that uniquely corresponds to the ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'spec-8o18t8uc31qib0****',
- ],
- 'SessionTimeout' => [
- 'description' => 'The duration for which sessions are retained after disconnection. Unit: minutes. After an end user disconnects from a session, the session is closed only after the specified duration elapses. If you want to permanently retain sessions, set this parameter to `-1`. Valid values:-1 and 3 to 300. Default value: `15`.'."\n",
- 'type' => 'string',
- 'example' => '15',
- ],
- 'AppInstanceGroupName' => [
- 'description' => 'The name of the delivery group.'."\n",
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'ExpiredTime' => [
- 'description' => 'The time when the delivery group expires.'."\n",
- 'type' => 'string',
- 'example' => '2022-04-27T16:00:00.000+00:00',
- ],
+ 'SpecId' => ['description' => 'The ID that uniquely corresponds to the delivery group ID.', 'type' => 'string', 'example' => 'spec-8o18t8uc31qib0****', 'title' => ''],
+ 'SessionTimeout' => ['description' => 'The session disconnection retention duration, in minutes. After an end user session is disconnected, the session is retained for the specified duration before being logged off. Set this parameter to `-1` to retain the session indefinitely. Valid values: -1 and 3 to 300. Default value: `15`.', 'type' => 'string', 'example' => '15', 'title' => ''],
+ 'AppInstanceGroupName' => ['description' => 'The delivery group name.', 'type' => 'string', 'example' => '办公应用', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'The expiration time of the delivery group.', 'type' => 'string', 'example' => '2022-04-27T16:00:00.000+00:00', 'title' => ''],
'OtaInfo' => [
- 'description' => 'The information about the over-the-air (OTA) update task.'."\n",
+ 'description' => 'The over-the-air update task information.',
'type' => 'object',
'properties' => [
- 'OtaVersion' => [
- 'title' => '当前ota版本',
- 'description' => 'The current OTA version.'."\n",
- 'type' => 'string',
- 'example' => '0.0.1-D-20220615.11****',
- ],
- 'NewOtaVersion' => [
- 'title' => '新ota版本,为空表示没有新版本',
- 'description' => 'The new OTA version. A null value indicates that no new version is available.'."\n",
- 'type' => 'string',
- 'example' => '0.0.1-D-20220630.11****',
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => 'The ID of the OTA update task.'."\n",
- 'type' => 'string',
- 'example' => 'ota-e49929gv8acz5****',
- ],
+ 'OtaVersion' => ['title' => '', 'description' => 'The current OTA version.', 'type' => 'string', 'example' => '0.0.1-D-20220615.11****'],
+ 'NewOtaVersion' => ['title' => '', 'description' => 'The new OTA version. An empty value indicates that no new version is available.', 'type' => 'string', 'example' => '0.0.1-D-20220630.11****'],
+ 'TaskId' => ['title' => '', 'description' => 'The OTA upgrade task ID.', 'type' => 'string', 'example' => 'ota-e49929gv8acz5****'],
],
+ 'title' => '',
+ 'example' => '',
],
'OsType' => [
- 'title' => '系统类型',
- 'description' => 'The type of the operating system.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* Windows'."\n",
+ 'title' => '',
+ 'description' => 'The operating system type.',
+ 'enumValueTitles' => ['Windows' => 'Windows'],
'type' => 'string',
- 'enumValueTitles' => [
- 'Windows' => 'Windows',
- ],
'example' => 'Windows',
- 'enum' => [
- 'Windows',
- 'Linux',
- 'Android',
- ],
+ 'enum' => ['Windows', 'Linux', 'Android'],
],
'ResourceStatus' => [
- 'description' => 'The resource status.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* AVAILABLE'."\n"
- .'* RELEASED'."\n"
- .'* EXPIRED_IN\\_7\\_DAYS'."\n"
- .'* UNAVAILABLE'."\n"
- .'* UPGRADING'."\n"
- .'* CREATING'."\n",
+ 'description' => 'The resource status.',
+ 'enumValueTitles' => ['AVAILABLE' => 'Available.', 'RELEASED' => 'Released.', 'EXPIRED_IN_7_DAYS' => 'Expiring within 7 days.', 'UNAVAILABLE' => 'Unavailable.', 'UPGRADING' => 'Updating.', 'CREATING' => 'Being created.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'AVAILABLE' => '',
- 'RELEASED' => '',
- 'EXPIRED_IN_7_DAYS' => '',
- 'UNAVAILABLE' => '',
- 'UPGRADING' => '',
- 'CREATING' => '',
- ],
'example' => 'AVAILABLE',
+ 'title' => '',
],
- 'AppPolicyId' => [
- 'description' => 'The policy ID.'."\n",
- 'type' => 'string',
- 'example' => 'pg-g3k5wa2ms2****',
- ],
+ 'AppPolicyId' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => 'pg-g3k5wa2ms2****', 'title' => ''],
'ChargeResourceMode' => [
- 'description' => 'The sales mode.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* AppInstance: by session'."\n"
- .'* Node: by resource'."\n",
+ 'description' => 'The sales mode.',
+ 'enumValueTitles' => ['AppInstance' => 'Sold by session.', 'Node' => 'Sold by resource.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'AppInstance' => '',
- 'Node' => '',
- ],
'example' => 'Node',
+ 'title' => '',
],
'SkipUserAuthCheck' => [
- 'description' => 'Indicates whether user permission verification is skipped.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false: This is the default value.'."\n",
+ 'description' => 'Indicates whether user authorization verification is skipped.',
+ 'enumValueTitles' => ['true' => 'Verification is skipped.', 'false' => 'Verification is performed. [Default].'],
'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
'example' => 'false',
+ 'title' => '',
],
- 'OfficeSiteId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-beijing+dir-172301****'."\n",
- ],
+ 'OfficeSiteId' => ['description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-beijing+dir-172301****'."\n", 'title' => ''],
'AppPolicyVersion' => [
- 'description' => '',
+ 'description' => 'The policy version.',
+ 'enumValueTitles' => ['CENTER' => 'Unified policy [new policy].', 'DEFAULT' => 'Default policy [legacy policy].'],
'type' => 'string',
- 'enumValueTitles' => [
- 'CENTER' => '统一策略[新策略]',
- 'DEFAULT' => '默认策略[旧策略]',
- ],
'example' => 'CENTER',
+ 'title' => '',
],
'AppPolicyImageCheck' => [
- 'description' => '',
+ 'description' => 'Indicates whether the current image supports the unified policy.',
+ 'enumValueTitles' => ['true' => 'Supported.', 'false' => 'Not supported.'],
'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '支持',
- 'false' => '不支持',
- ],
'example' => 'false',
+ 'title' => '',
],
'ResourceTags' => [
- 'title' => '资源标签列表。请使用Tags字段。',
- 'description' => 'The resource tags.'."\n",
+ 'title' => '',
+ 'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
- 'title' => '资源标签。',
- 'description' => 'The resource tag.'."\n",
+ 'title' => '',
+ 'description' => 'The resource tag.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签键。',
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'example' => 'department',
- ],
- 'Value' => [
- 'title' => '标签值。',
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'example' => 'design',
- ],
+ 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'department'],
+ 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'design'],
'Scope' => [
- 'title' => '标签类型。取值范围:'."\n"
- .'Custom:自定义标签。'."\n"
- .'System:系统标签。',
- 'description' => 'The tag type. Valid values: Custom System'."\n",
+ 'title' => '',
+ 'description' => 'The tag type.',
+ 'enumValueTitles' => ['Custom' => 'Custom tag.', 'System' => 'System tag.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'Custom' => '自定义标签',
- 'System' => '系统标签',
- ],
'example' => 'Custom',
],
],
+ 'example' => '',
],
+ 'example' => '',
],
'Tags' => [
- 'title' => '资源标签列表。',
+ 'title' => '',
+ 'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
- 'title' => '资源标签。',
+ 'title' => '',
+ 'description' => 'The resource tag.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签键。',
- 'type' => 'string',
- ],
- 'Value' => [
- 'title' => '标签值。',
- 'type' => 'string',
- ],
+ 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'department'],
+ 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'design'],
'Scope' => [
- 'title' => '标签类型。取值范围:'."\n"
- .'Custom:自定义标签。'."\n"
- .'System:系统标签。',
+ 'title' => '',
+ 'description' => 'The tag type.',
+ 'enumValueTitles' => ['Custom' => 'Custom tag.', 'System' => 'System tag.'],
'type' => 'string',
+ 'example' => 'Custom',
],
],
+ 'example' => '',
],
+ 'example' => '',
],
'AuthMode' => [
- 'title' => '授权模式。',
+ 'title' => '',
+ 'description' => 'The authorization mode.',
+ 'enumValueTitles' => ['App' => 'Application authorization.', 'AppInstanceGroup' => 'Delivery group authorization.', 'Session' => 'Session authorization.'],
'type' => 'string',
'example' => 'App',
'default' => 'App',
- 'enum' => [
- 'App',
- 'Session',
- 'AppInstanceGroup',
- ],
+ 'enum' => ['App', 'Session', 'AppInstanceGroup'],
],
'AccessType' => [
- 'title' => '接入类型。',
+ 'title' => '',
+ 'description' => 'The access type.',
+ 'enumValueTitles' => ['INTERNET' => 'Internet.', 'VPC' => 'Enterprise private network (VPC).', 'ANY' => 'Internet and enterprise private network (VPC).'],
'type' => 'string',
'example' => 'INTERNET',
'default' => 'INTERNET',
- 'enum' => [
- 'INTERNET',
- 'VPC',
- 'ANY',
- ],
- ],
- 'SupportUserGroupMixedAuth' => [
- 'title' => '是否支持用户和用户组混合授权。',
- 'type' => 'boolean',
- 'default' => 'true',
+ 'enum' => ['INTERNET', 'VPC', 'ANY'],
],
+ 'SupportUserGroupMixedAuth' => ['type' => 'boolean', 'default' => 'true', 'description' => '', 'title' => '', 'example' => ''],
'UserGroupAuthMode' => [
- 'title' => '用户和用户组授权模式。',
'type' => 'string',
'example' => 'Mixed',
'default' => 'Mixed',
- 'enum' => [
- 'Mixed',
- 'User',
- 'UserGroup',
- ],
+ 'enum' => ['Mixed', 'User', 'UserGroup'],
+ 'description' => '',
+ 'title' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"AppInstanceGroupModels\\": [\\n {\\n \\"Apps\\": [\\n {\\n \\"AppId\\": \\"ca-i87mycyn419nu****\\",\\n \\"AppName\\": \\"办公应用\\",\\n \\"AppVersion\\": \\"1.0.0\\",\\n \\"AppVersionName\\": \\"初始版本\\",\\n \\"AppIcon\\": \\"https://app-center-icon-****.png\\"\\n }\\n ],\\n \\"AppCenterImageId\\": \\"img-8z4nztpaqvay4****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ProductType\\": \\"CloudApp\\",\\n \\"AppInstanceType\\": \\"__dynamic__\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"Amount\\": 1,\\n \\"MinAmount\\": 1,\\n \\"MaxAmount\\": 10,\\n \\"ReserveAmountRatio\\": \\"20\\",\\n \\"ReserveMinAmount\\": 1,\\n \\"ReserveMaxAmount\\": 5,\\n \\"ScalingStep\\": 10,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"GmtCreate\\": \\"2022-04-26T15:06:16.000+00:00\\",\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"NodePool\\": [\\n {\\n \\"NodePoolId\\": \\"rg-g6922kced36hx****\\",\\n \\"NodeInstanceType\\": \\"appstreaming.vgpu.4c8g.2g\\",\\n \\"NodeAmount\\": 1,\\n \\"NodeUsed\\": 1,\\n \\"NodeCapacity\\": 2,\\n \\"ScalingNodeAmount\\": 8,\\n \\"ScalingNodeUsed\\": 4,\\n \\"StrategyType\\": \\"NODE_FIXED\\",\\n \\"Amount\\": 2,\\n \\"MaxScalingAmount\\": 8,\\n \\"MaxIdleAppInstanceAmount\\": 3,\\n \\"ScalingStep\\": 2,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"RecurrenceSchedules\\": [\\n {\\n \\"RecurrenceType\\": \\"Weekly\\",\\n \\"RecurrenceValues\\": [\\n 1\\n ],\\n \\"TimerPeriods\\": [\\n {\\n \\"Amount\\": 5,\\n \\"EndTime\\": \\"11:00\\",\\n \\"StartTime\\": \\"09:30\\"\\n }\\n ]\\n }\\n ],\\n \\"StrategyDisableDate\\": \\"2022-09-08\\",\\n \\"StrategyEnableDate\\": \\"2022-08-01\\",\\n \\"WarmUp\\": false,\\n \\"NodeTypeName\\": \\"无影-通用型_4核8G\\"\\n }\\n ],\\n \\"SpecId\\": \\"spec-8o18t8uc31qib0****\\",\\n \\"SessionTimeout\\": \\"15\\",\\n \\"AppInstanceGroupName\\": \\"办公应用\\",\\n \\"ExpiredTime\\": \\"2022-04-27T16:00:00.000+00:00\\",\\n \\"OtaInfo\\": {\\n \\"OtaVersion\\": \\"0.0.1-D-20220615.11****\\",\\n \\"NewOtaVersion\\": \\"0.0.1-D-20220630.11****\\",\\n \\"TaskId\\": \\"ota-e49929gv8acz5****\\"\\n },\\n \\"OsType\\": \\"Windows\\",\\n \\"ResourceStatus\\": \\"AVAILABLE\\",\\n \\"AppPolicyId\\": \\"pg-g3k5wa2ms2****\\",\\n \\"ChargeResourceMode\\": \\"Node\\",\\n \\"SkipUserAuthCheck\\": false,\\n \\"OfficeSiteId\\": \\"cn-beijing+dir-172301****\\\\n\\",\\n \\"AppPolicyVersion\\": \\"CENTER\\",\\n \\"AppPolicyImageCheck\\": false,\\n \\"ResourceTags\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"design\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"design\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"AuthMode\\": \\"App\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"SupportUserGroupMixedAuth\\": true,\\n \\"UserGroupAuthMode\\": \\"Mixed\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListAppInstanceGroup',
- ],
- 'PageListAppInstanceGroupUser' => [
- 'summary' => 'Queries the assigned users that are added to a delivery group by page.',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query multiple delivery groups',
+ 'summary' => 'Queries the details of multiple delivery groups. This operation does not specify a particular delivery group but queries the details of all delivery groups that meet the specified conditions.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppInstanceGroup'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"AppInstanceGroupModels\\": [\\n {\\n \\"Apps\\": [\\n {\\n \\"AppId\\": \\"ca-i87mycyn419nu****\\",\\n \\"AppName\\": \\"办公应用\\",\\n \\"AppVersion\\": \\"1.0.0\\",\\n \\"AppVersionName\\": \\"初始版本\\",\\n \\"AppIcon\\": \\"https://app-center-icon-****.png\\"\\n }\\n ],\\n \\"AppCenterImageId\\": \\"img-8z4nztpaqvay4****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ProductType\\": \\"CloudApp\\",\\n \\"AppInstanceType\\": \\"__dynamic__\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"Amount\\": 1,\\n \\"MinAmount\\": 1,\\n \\"MaxAmount\\": 10,\\n \\"ReserveAmountRatio\\": \\"20\\",\\n \\"ReserveMinAmount\\": 1,\\n \\"ReserveMaxAmount\\": 5,\\n \\"ScalingStep\\": 10,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"GmtCreate\\": \\"2022-04-26T15:06:16.000+00:00\\",\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"NodePool\\": [\\n {\\n \\"NodePoolId\\": \\"rg-g6922kced36hx****\\",\\n \\"NodeInstanceType\\": \\"appstreaming.vgpu.4c8g.2g\\",\\n \\"NodeAmount\\": 1,\\n \\"NodeUsed\\": 1,\\n \\"NodeCapacity\\": 2,\\n \\"ScalingNodeAmount\\": 8,\\n \\"ScalingNodeUsed\\": 4,\\n \\"StrategyType\\": \\"NODE_FIXED\\",\\n \\"Amount\\": 2,\\n \\"MaxScalingAmount\\": 8,\\n \\"MaxIdleAppInstanceAmount\\": 3,\\n \\"ScalingStep\\": 2,\\n \\"ScalingUsageThreshold\\": \\"85\\",\\n \\"ScalingDownAfterIdleMinutes\\": 5,\\n \\"RecurrenceSchedules\\": [\\n {\\n \\"RecurrenceType\\": \\"Weekly\\",\\n \\"RecurrenceValues\\": [\\n 1\\n ],\\n \\"TimerPeriods\\": [\\n {\\n \\"Amount\\": 5,\\n \\"EndTime\\": \\"11:00\\",\\n \\"StartTime\\": \\"09:30\\"\\n }\\n ]\\n }\\n ],\\n \\"StrategyDisableDate\\": \\"2022-09-08\\",\\n \\"StrategyEnableDate\\": \\"2022-08-01\\",\\n \\"WarmUp\\": false,\\n \\"NodeTypeName\\": \\"无影-通用型_4核8G\\"\\n }\\n ],\\n \\"SpecId\\": \\"spec-8o18t8uc31qib0****\\",\\n \\"SessionTimeout\\": \\"15\\",\\n \\"AppInstanceGroupName\\": \\"办公应用\\",\\n \\"ExpiredTime\\": \\"2022-04-27T16:00:00.000+00:00\\",\\n \\"OtaInfo\\": {\\n \\"OtaVersion\\": \\"0.0.1-D-20220615.11****\\",\\n \\"NewOtaVersion\\": \\"0.0.1-D-20220630.11****\\",\\n \\"TaskId\\": \\"ota-e49929gv8acz5****\\"\\n },\\n \\"OsType\\": \\"Windows\\",\\n \\"ResourceStatus\\": \\"AVAILABLE\\",\\n \\"AppPolicyId\\": \\"pg-g3k5wa2ms2****\\",\\n \\"ChargeResourceMode\\": \\"Node\\",\\n \\"SkipUserAuthCheck\\": false,\\n \\"OfficeSiteId\\": \\"cn-beijing+dir-172301****\\\\n\\",\\n \\"AppPolicyVersion\\": \\"CENTER\\",\\n \\"AppPolicyImageCheck\\": false,\\n \\"ResourceTags\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"design\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"design\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"AuthMode\\": \\"App\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"SupportUserGroupMixedAuth\\": false,\\n \\"UserGroupAuthMode\\": \\"Mixed\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListAppInstances' => [
+ 'summary' => 'Queries the details of session instances in a delivery group, including instance ID, instance status, creation time, update time, session status, and public IP address of the primary network interface.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5698,288 +5336,317 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingV87T4P',
- ],
+ 'abilityTreeCode' => '170357',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AppInstanceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-4p5f8tj16yb8b****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The application instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ai-azn3kmwruh1vl****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
+ 'description' => 'The list of application instance statuses.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The application instance status.',
+ 'enumValueTitles' => ['INIT' => 'Initializing.', 'STARTING' => 'Application starting.', 'CLOSING' => 'Application stopping.', 'CLOSED' => 'Application closed.', 'RUNNING' => 'Application running.', 'IDLE' => 'Idle.', 'BOUND' => 'Bound.', 'UNAVAILABLE' => 'Unavailable.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'INIT',
+ 'title' => '',
+ ],
+ 'required' => false,
'maxItems' => 100,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ProductType',
+ 'name' => 'AppInstanceIdList',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
+ 'description' => 'The list of application instance IDs. Maximum length: 100.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The application instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ai-azn3kmwruh1vl****', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'PageSize',
- 'in' => 'formData',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of query results per page. Maximum value: `100`. Default value: `20`. Specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number of the query results to display. Default value: `1`. Specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'IncludeDeleted',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The number of entries to be return on each page. The value cannot be greater than `100`. We recommend that you configure this parameter.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'Specifies whether to query information about deleted instances. If this parameter is set to true, the AppInstanceIdList parameter is required. Otherwise, a parameter error is returned.',
+ 'enumValueTitles' => ['true' => 'Query deleted instances.', 'false' => 'Do not query deleted instances. (Default)'],
+ 'type' => 'boolean',
+ 'default' => 'false',
'required' => false,
- 'example' => '10',
+ 'example' => 'true',
+ 'title' => '',
],
],
[
- 'name' => 'PageNumber',
- 'in' => 'formData',
+ 'name' => 'UserIdList',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The number of the page to return. We recommend that you configure this parameter.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The list of user IDs. Maximum length: 100.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'Alice', 'title' => ''],
'required' => false,
- 'example' => '1',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Users' => [
- 'description' => 'The users.'."\n",
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '18', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of query results per page. Maximum value: `100`. Specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the query results to display. Specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'AppInstanceModels' => [
+ 'description' => 'The list of queried application instances.',
'type' => 'array',
'items' => [
- 'description' => 'The usernames.'."\n",
- 'type' => 'string',
- 'example' => 'username1',
+ 'description' => 'The queried application instance.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppInstanceId' => ['description' => 'The application instance ID.', 'type' => 'string', 'example' => 'ai-8dl7dzchklmka****', 'title' => ''],
+ 'AppInstanceGroupId' => ['description' => 'The delivery group ID.', 'type' => 'string', 'example' => 'aig-dk8p95irqfst9****', 'title' => ''],
+ 'Status' => ['description' => 'The application instance status.', 'type' => 'string', 'example' => 'BOUND', 'title' => ''],
+ 'MainEthPublicIp' => ['description' => 'The public IP address of the primary network interface controller (NIC). This value is returned only when the network policy (`StrategyType`) of the delivery group is set to the mixed pattern (`Mixed`). Otherwise, this value is empty.', 'type' => 'string', 'example' => '10.13.13.211', 'title' => ''],
+ 'NetworkInterfaceIp' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2023-03-07T20:29:19.000+08:00', 'title' => ''],
+ 'GmtModified' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2023-03-07T20:29:19.000+08:00', 'title' => ''],
+ 'SessionStatus' => [
+ 'description' => 'The session connection status. This value is returned only when the instance status is running (`RUNNING`). Otherwise, this value is empty.',
+ 'enumValueTitles' => ['disconnect' => 'Disconnected.', 'connect' => 'Connected.'],
+ 'type' => 'string',
+ 'example' => 'connect',
+ 'title' => '',
+ ],
+ 'BindInfo' => [
+ 'description' => 'The binding information between the instance and the user.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndUserId' => ['description' => 'The end user ID bound to the instance.', 'type' => 'string', 'example' => 'app.test', 'title' => ''],
+ 'UsageDuration' => ['description' => 'The usage duration of the instance. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'NodeId' => ['description' => 'The ID of the node on which the instance runs.'."\n"
+ .'> This parameter is returned only when the billing mode of the delivery group to which this instance belongs is resource-based billing (ChargeResourceMode=Node).', 'type' => 'string', 'example' => 'i-bp13********', 'title' => ''],
+ 'ChargeType' => [
+ 'description' => 'The billing method of the instance. Valid values:'."\n"
+ .'- **PrePaid**: subscription.'."\n"
+ .'- **PostPaid**: pay-as-you-go.'."\n"
+ .'> This parameter is returned only when the billing mode of the delivery group to which this instance belongs is resource-based billing (ChargeResourceMode=Node).',
+ 'enumValueTitles' => ['PostPaid' => 'Pay-as-you-go.', 'PrePaid' => 'Subscription.'],
+ 'type' => 'string',
+ 'example' => 'PostPaid',
+ 'title' => '',
+ ],
+ 'NetworkInterfaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Users\\": [\\n \\"username1\\"\\n ]\\n}","type":"json"}]',
- 'title' => 'PageListAppInstanceGroupUser',
- ],
- 'RenewAppInstanceGroup' => [
- 'summary' => 'Renews a delivery group.',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query instance details in a delivery group',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppInstances'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListAppInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 18,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"AppInstanceModels\\": [\\n {\\n \\"AppInstanceId\\": \\"ai-8dl7dzchklmka****\\",\\n \\"AppInstanceGroupId\\": \\"aig-dk8p95irqfst9****\\",\\n \\"Status\\": \\"BOUND\\",\\n \\"MainEthPublicIp\\": \\"10.13.13.211\\",\\n \\"NetworkInterfaceIp\\": \\"\\",\\n \\"GmtCreate\\": \\"2023-03-07T20:29:19.000+08:00\\",\\n \\"GmtModified\\": \\"2023-03-07T20:29:19.000+08:00\\",\\n \\"SessionStatus\\": \\"connect\\",\\n \\"BindInfo\\": {\\n \\"EndUserId\\": \\"app.test\\",\\n \\"UsageDuration\\": 2000\\n },\\n \\"NodeId\\": \\"i-bp13********\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"NetworkInterfaceId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListAuthorizedUserGroups' => [
+ 'summary' => 'Queries the list of user groups authorized by a specified delivery group.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingU1TTUH',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingD8SMIE'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ProductType',
- 'in' => 'query',
+ 'in' => 'formData',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
+ 'title' => '',
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
'example' => 'CloudApp',
],
],
[
- 'name' => 'PromotionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The promotion ID. You can call the [GetResourcePrice](~~428503~~) operation to obtain the ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '17440009****',
- ],
- ],
- [
- 'name' => 'AutoPay',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable automatic payment.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false: manual payment. This is the default value.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The subscription duration of resources. This parameter must be configured together with `PeriodUnit`.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'example' => '10'],
],
[
- 'name' => 'PeriodUnit',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The unit of the subscription duration. This parameter must be configured together with `Period`. The following items describe valid values for the combinations of `Period` and `PeriodUnit`:'."\n"
- ."\n"
- .'* 1 Week'."\n"
- .'* 1 Month'."\n"
- .'* 2 Month'."\n"
- .'* 3 Month'."\n"
- .'* 6 Month'."\n"
- .'* 1 Year'."\n"
- .'* 2 Year'."\n"
- .'* 3 Year'."\n"
- ."\n"
- .'> The value of this parameter is case-insensitive. For example, `Week` is valid and `week` is invalid. If you specify a value combination other than the preceding combinations, such as `2 Week`, the operation can still be called. However, an error occurs when you place the order.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'Month' => '',
- 'Year' => '',
- 'Week' => '',
- ],
- 'example' => 'Week',
- ],
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'AppInstanceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
- ],
- [
- 'name' => 'RenewMode',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****'],
],
[
- 'name' => 'RenewAmount',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'name' => 'GroupId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The user group ID. This parameter is used for exact match.', 'type' => 'string', 'required' => false, 'example' => 'ug-00001'],
],
[
- 'name' => 'RenewNodes',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
+ 'name' => 'GroupName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The user group name. This parameter is used for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => '用户组001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response body.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Code' => [
- 'description' => 'The error code.'."\n",
- 'type' => 'string',
- 'example' => 'InvalidParameter.ProductType',
- ],
- 'OrderId' => [
- 'description' => 'The order ID.'."\n",
- 'type' => 'string',
- 'example' => '123456****',
- ],
- 'Message' => [
- 'description' => 'The error message.'."\n",
- 'type' => 'string',
- 'example' => 'The parameter ProductType is invalid.',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '6'],
+ 'PageSize' => ['title' => '', 'description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'UserGroups' => [
+ 'title' => '',
+ 'description' => 'The list of user group information.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The user group information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => ['title' => '', 'description' => 'The user group name.', 'type' => 'string', 'example' => '用户组001'],
+ 'AppInstanceGroupId' => ['title' => '', 'description' => 'The delivery group ID.', 'type' => 'string', 'example' => 'aig-9ciijz60n4xsv****'],
+ 'AuthMode' => [
+ 'title' => '',
+ 'description' => 'The authorization mode.',
+ 'enumValueTitles' => ['App' => 'application authorization.', 'AppInstanceGroup' => 'delivery group authorization.', 'Session' => 'session authorization.'],
+ 'type' => 'string',
+ 'example' => 'App',
+ 'default' => 'App',
+ 'enum' => ['App', 'Session', 'AppInstanceGroup'],
+ ],
+ 'GroupId' => ['title' => '', 'description' => 'The user group ID.', 'type' => 'string', 'example' => 'ug-00001'],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"OrderId\\": \\"123456****\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n}","type":"json"}]',
- 'title' => 'RenewAppInstanceGroup',
- 'description' => 'Before you call this operation, make sure that you fully understand the [billing methods and prices](~~426039~~) of App Streaming.'."\n",
- ],
- 'UpdateAppInstanceGroupImage' => [
- 'summary' => 'Updates the image of a delivery group.',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 6,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"UserGroups\\": [\\n {\\n \\"GroupName\\": \\"用户组001\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"AuthMode\\": \\"App\\",\\n \\"GroupId\\": \\"ug-00001\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query user groups authorized by a delivery group',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListAuthorizedUserGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListBindInfo' => [
+ 'summary' => 'Queries the binding information between users and resources.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5987,1309 +5654,1603 @@
],
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '262111',
+ 'abilityTreeNodes' => ['FEATUREappstreamingV87T4P'],
],
'parameters' => [
[
- 'name' => 'ProductType',
- 'in' => 'query',
+ 'name' => 'UserIdList',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
+ 'description' => 'The list of user IDs. You can specify 1 to 100 IDs.'."\n"
."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
+ .'> If you specify this parameter, only the binding information of the specified users is returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'Alice', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'AppInstanceGroupId',
- 'in' => 'query',
+ 'name' => 'WyIdList',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
+ 'description' => 'The list of WUYING user IDs. You can specify 1 to 100 IDs.'."\n"
+ ."\n"
+ .'> If you specify this parameter, only the binding information of the specified WUYING users is returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The WUYING user ID.', 'type' => 'string', 'required' => false, 'example' => '2ca6f5a93536****', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'AppCenterImageId',
- 'in' => 'query',
+ 'name' => 'AppInstanceGroupIdList',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The image ID of the application. You can obtain the ID from the Images page in the App Streaming console.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'img-8z4nztpaqvay4****',
+ 'description' => 'The list of delivery group IDs. You can specify 1 to 100 IDs.'."\n"
+ ."\n"
+ .'> If you specify this parameter, only the binding information of the specified delivery groups is returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The delivery group ID.', 'type' => 'string', 'required' => false, 'example' => 'aig-4xz0oy8x4ipyv****', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'BizRegionId',
- 'in' => 'query',
+ 'name' => 'AppInstanceIdList',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The ID of the region where the delivery group resides. For information about the supported regions, see [Limits](~~426036~~).'."\n"
+ 'description' => 'The list of application instance IDs. You can specify 1 to 100 IDs.'."\n"
."\n"
- .'Valid values:'."\n"
+ .'> If you specify this parameter, only the binding information of the specified application instances is returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The application instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ai-azn3kmwruh1vl****', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'AppIdList',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of application IDs. You can specify 1 to 100 IDs.'."\n"
."\n"
- .'* cn-shanghai: China (Shanghai).'."\n"
- .'* cn-hangzhou: China (Hangzhou)',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'cn-shanghai' => '',
- 'cn-hangzhou' => '',
- ],
- 'example' => 'cn-hangzhou',
+ .'> If you specify this parameter, only the binding information of the specified applications is returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'ca-fq738or6vd854****', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The number of query results per page. Maximum value: `100`. Default value: `20`. Specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The page number of the query results to display. Default value: `1`. Specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Code' => [
- 'description' => 'The error code.'."\n",
- 'type' => 'string',
- 'example' => 'InvalidParameter.ProductType',
- ],
- 'Message' => [
- 'description' => 'The error message.'."\n",
- 'type' => 'string',
- 'example' => 'The parameter ProductType is invalid.',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AD2D0761-1FE5-549D-B169-D3F8D19C****'],
+ 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of query results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the query results currently displayed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'BindInfoModels' => [
+ 'description' => 'The list of binding information returned.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The binding information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'ca-fq738or6vd854****', 'title' => ''],
+ 'AppVersion' => ['description' => 'The application version number.', 'type' => 'string', 'example' => '1.0', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''],
+ 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'Alice', 'title' => ''],
+ 'WyId' => ['description' => 'The WUYING user ID.', 'type' => 'string', 'example' => '2ca6f5a93536****', 'title' => ''],
+ 'AccountType' => [
+ 'description' => 'The account type.',
+ 'enumValueTitles' => ['ad' => 'AD domain account.', 'simple' => 'convenience account.'],
+ 'type' => 'string',
+ 'example' => 'simple',
+ 'title' => '',
+ ],
+ 'AppInstanceGroupId' => ['description' => 'The delivery group ID.', 'type' => 'string', 'example' => 'aig-0abxhr6ce35w8****', 'title' => ''],
+ 'AppInstanceId' => ['description' => 'The application instance ID.', 'type' => 'string', 'example' => 'ai-83oe276fre4l3****', 'title' => ''],
+ 'ProductType' => [
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'cloud application.', 'CloudBrowser' => 'cloud browser.', 'AndroidCloud' => 'cloud phone.'],
+ 'type' => 'string',
+ 'example' => 'CloudApp',
+ 'title' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n}","type":"json"}]',
- 'title' => 'UpdateAppInstanceGroupImage',
- 'description' => '**'."\n"
- ."\n"
- .'**Warning** After the image is updated, the end user session accessing the cloud application will be disconnected. Exercise caution to avoid end user data loss.'."\n"
- ."\n"
- .'> After the image of the delivery group is updated, the change takes effect on the terminal in approximately 2 minutes.'."\n",
- ],
- 'ModifyAppInstanceGroupAttribute' => [
- 'summary' => 'Modifies the general policies of a delivery group, including the number of concurrent sessions and the retention period of disconnected sessions.',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169-D3F8D19C****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"BindInfoModels\\": [\\n {\\n \\"AppId\\": \\"ca-fq738or6vd854****\\",\\n \\"AppVersion\\": \\"1.0\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"UserId\\": \\"Alice\\",\\n \\"WyId\\": \\"2ca6f5a93536****\\",\\n \\"AccountType\\": \\"simple\\",\\n \\"AppInstanceGroupId\\": \\"aig-0abxhr6ce35w8****\\",\\n \\"AppInstanceId\\": \\"ai-83oe276fre4l3****\\",\\n \\"ProductType\\": \\"CloudApp\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query binding information',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListBindInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListDesktopAgentRuntime' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '134213',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'ProductType',
+ 'name' => 'AgentProvider',
'in' => 'query',
- 'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
- ],
+ 'schema' => ['title' => '', 'description' => 'The name of the agent provider.', 'type' => 'string', 'example' => 'OpenClaw', 'required' => true],
],
[
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'ModelTemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The model group ID.', 'type' => 'string', 'example' => 'mt-xxxx', 'required' => false],
+ ],
+ [
+ 'name' => 'DesktopIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
+ 'title' => '',
+ 'description' => 'The list of agent runtime IDs.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The agent runtime ID. The ID mapping is as follows:'."\n"
+ ."\n"
+ .'JVS Computer: JVS Computer ID, in the format of jvs-xxxx.'."\n"
+ ."\n"
+ .'OpenClaw: Cloud computer ID, in the format of ecd-xxxx.'."\n"
+ ."\n"
+ .'Hermes Agent: Hermes Agent ID, in the format of jvs-xxxx.',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ecd-xxxx',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'example' => 'jvs-xxxxx',
],
],
[
- 'name' => 'AppInstanceGroupName',
+ 'name' => 'ResourceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The name of the delivery group.'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The list of resource IDs (underlying real resource IDs).',
+ 'type' => 'array',
+ 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'ecd-xxxx', 'required' => false, 'title' => ''],
'required' => false,
- 'example' => '',
+ 'maxItems' => 100,
+ 'example' => 'ecd-xxxxx',
],
],
[
- 'name' => 'SessionTimeout',
+ 'name' => 'DesktopStatuses',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The duration for which sessions are retained after disconnection. Unit: minutes. After an end user disconnects from a session, the session is closed only after the specified duration elapses. If you want to permanently retain sessions, set this parameter to `-1`. Valid values:-1 and 3 to 300. Default value: `15`.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'The list of cloud computer statuses.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The cloud computer status.',
+ 'enumValueTitles' => ['Stopped' => 'Stopped', 'Starting' => 'Starting', 'Rebuilding' => 'Rebuilding', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Expired' => 'Expired', 'Deleted' => 'Deleted', 'Pending' => 'Pending'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Running',
+ 'title' => '',
+ ],
'required' => false,
- 'maximum' => '300',
- 'example' => '15',
+ 'maxItems' => 10,
+ 'example' => 'Running',
],
],
[
- 'name' => 'NodePool',
+ 'name' => 'AuthUsers',
'in' => 'query',
- 'style' => 'json',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The information about the resource group.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'NodePoolId' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-ew7va2g1wl3vm****',
- ],
- 'NodeCapacity' => [
- 'description' => 'The maximum number of sessions to which a resource can connect at the same time. If a resource connects to a large number of sessions at the same time, user experience can be compromised. The value range varies based on the resource type. The following items describe the value ranges of different resource types:'."\n"
- ."\n"
- .'* appstreaming.general.4c8g: 1 to 2'."\n"
- .'* appstreaming.general.8c16g: 1 to 4'."\n"
- .'* appstreaming.vgpu.8c16g.4g: 1 to 4'."\n"
- .'* appstreaming.vgpu.8c31g.16g: 1 to 4'."\n"
- .'* appstreaming.vgpu.14c93g.12g: 1 to 6'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
+ 'title' => '',
+ 'description' => 'The list of authorized users.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The authorized user.', 'type' => 'string', 'required' => true, 'example' => 'user-001', 'title' => ''],
'required' => false,
+ 'maxItems' => 100,
+ 'example' => 'user001',
],
],
[
- 'name' => 'StoragePolicy',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'AgentInstanceVersions',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The storage policy.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'StorageTypeList' => [
- 'description' => 'The storage types.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The storage type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* OFF: disabled'."\n"
- .'* PDS: Photo and Drive Service'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'OFF' => '',
- 'PDS' => '',
- ],
- 'example' => 'PDS',
- ],
- 'required' => false,
- ],
- 'UserProfileFollow' => [
- 'type' => 'object',
- 'properties' => [
- 'ProfileFollowSwitch' => [
- 'type' => 'boolean',
- 'required' => false,
- ],
- 'FileSystemId' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'UserProfile' => [
- 'description' => 'The configurations of user data roaming.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'UserProfileSwitch' => [
- 'description' => 'Specifies whether user data roaming is enabled.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'false',
- ],
- 'FileSystemId' => [
- 'description' => 'The ID of the File Storage NAS (NAS) file system used to store user data.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '06ae94****',
- ],
- ],
- 'required' => false,
- ],
- ],
+ 'title' => '',
+ 'description' => 'The list of agent instance versions.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The agent instance version.', 'type' => 'string', 'required' => true, 'example' => '2026.3.13', 'title' => ''],
'required' => false,
+ 'maxItems' => 10,
+ 'example' => 'OpenClaw 2026.4.15',
],
],
[
- 'name' => 'SecurityPolicy',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'AgentInstanceStatuses',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The security policy.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'SkipUserAuthCheck' => [
- 'description' => 'Specifies whether to skip user permission verification.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false: This is the default value.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'false',
- ],
- 'ResetAfterUnbind' => [
- 'description' => 'Specifies whether to reset after unbinding from a delivery group.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'description' => 'The list of agent instance statuses.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The agent instance status.',
+ 'enumValueTitles' => ['Undeployed' => 'Undeployed', 'Deploying' => 'Deploying', 'Stopped' => 'Stopped', 'Starting' => 'Starting', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Deleted' => 'Deleted', 'Deployed' => 'Deployed', 'Unavailable' => 'Unavailable'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Running',
+ 'title' => '',
],
'required' => false,
+ 'maxItems' => 10,
+ 'example' => 'Running',
],
],
[
- 'name' => 'PreOpenMode',
- 'in' => 'formData',
+ 'name' => 'DeploymentSource',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The pre-open mode.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* SINGLE_APP: enables the pre-open mode for a single application.'."\n"
- .'* OFF: disables the pre-open mode. This is the default value.'."\n",
+ 'title' => '',
+ 'description' => 'The deployment source.',
+ 'enumValueTitles' => ['User' => 'User deployment', 'Admin' => 'Admin deployment'],
'type' => 'string',
+ 'example' => 'Admin',
'required' => false,
- 'enumValueTitles' => [
- 'SINGLE_APP' => '',
- 'OFF' => '',
- ],
- 'example' => 'OFF',
],
],
[
- 'name' => 'PreOpenAppId',
- 'in' => 'formData',
+ 'name' => 'ModelConfigure',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The application ID of the pre-open application. If you set `PreOpenMode` to `SINGLE_APP`, you cannot leave this parameter empty.``'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Specifies whether the model is configured.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
+ 'example' => 'true',
'required' => false,
- 'example' => 'ca-b2ronxxd****'."\n",
],
],
[
- 'name' => 'PerSessionPerApp',
- 'in' => 'formData',
+ 'name' => 'ChannelConfigure',
+ 'in' => 'query',
'schema' => [
- 'description' => 'Specifies whether only one application can be opened in a session.'."\n"
- ."\n"
- .'* After you enable this feature, the system assigns a session to each application if you open multiple applications in a delivery group. This consumes a larger number of sessions.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
+ 'title' => '',
+ 'description' => 'Specifies whether the third-party channel is configured.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
'type' => 'boolean',
+ 'example' => 'true',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'false',
],
],
[
- 'name' => 'Network',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxx', 'required' => false],
+ ],
+ [
+ 'name' => 'DesktopNames',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The network settings.'."\n"
- ."\n"
- .'> If you want to use this parameter, submit a ticket.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'DomainRules' => [
- 'description' => 'The domain name rules.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Domain' => [
- 'description' => 'The domain name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'www.example.com',
- ],
- 'Policy' => [
- 'description' => 'The policy used for the domain name.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* allow'."\n"
- .'* block'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'allow' => '',
- 'block' => '',
- ],
- 'example' => 'block',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
+ 'title' => '',
+ 'description' => 'The list of agent runtime names.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The agent runtime name.', 'type' => 'string', 'required' => true, 'example' => 'Agent-001', 'title' => ''],
'required' => false,
+ 'maxItems' => 10,
+ 'example' => 'Desktop001',
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'BizType',
+ 'in' => 'query',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Code' => [
- 'description' => 'The error code.'."\n",
- 'type' => 'string',
- 'example' => 'InvalidParameter.ProductType',
- ],
- 'Message' => [
- 'description' => 'The error message.'."\n",
- 'type' => 'string',
- 'example' => 'The parameter ProductType is invalid.',
- ],
- ],
+ 'title' => '',
+ 'description' => 'The business type.',
+ 'enumValueTitles' => [1 => 'Enterprise Edition'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'default' => '1',
+ 'required' => false,
],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n}","type":"json"}]',
- 'title' => 'ModifyAppInstanceGroupAttribute',
- ],
- 'ModifyNodePoolAttribute' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'AgentPlatform',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The agent platform.',
+ 'enumValueTitles' => ['ENTERPRISE' => 'Enterprise Edition', 'ENTERPRISE_JVS' => 'Enterprise Edition JVS Computer, Enterprise Edition Hermes Agent'],
+ 'type' => 'string',
+ 'example' => 'ENTERPRISE',
+ 'required' => false,
+ ],
],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
[
- 'name' => 'ProductType',
- 'in' => 'formData',
+ 'name' => 'HasAuthUser',
+ 'in' => 'query',
'schema' => [
- 'title' => '产品类型',
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Specifies whether authorized users exist.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'false'],
+ 'type' => 'boolean',
+ 'example' => 'true',
'required' => false,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
],
],
[
- 'name' => 'PoolId',
- 'in' => 'formData',
+ 'name' => 'IncludeRiskInfo',
+ 'in' => 'query',
'schema' => [
- 'title' => '资源组id',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Specifies whether to query and return risk information. Default value: false. When set to true, the response includes the RiskInfo field, and the HasRisk filter condition takes effect.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
+ 'example' => 'true',
'required' => false,
- 'example' => 'rg-ew7va2g1wl3vm****',
],
],
[
- 'name' => 'NodeCapacity',
- 'in' => 'formData',
+ 'name' => 'HasRisk',
+ 'in' => 'query',
'schema' => [
- 'title' => '按资源售卖的,单个节点允许运行的应用实例数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'Specifies whether a risk exists. Used to filter cloud computers with or without risks. This parameter takes effect only when IncludeRiskInfo is set to true.'."\n"
+ ."\n"
+ .'Set to true to return only records with risks. Set to false to return only records without risks. If not specified, no filtering is applied.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
+ 'example' => 'true',
'required' => false,
- 'example' => '2',
],
],
[
- 'name' => 'NodePoolStrategy',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'ManagementStatus',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'example' => 'Hibernated', 'description' => '', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The page number, starting from 1. Values 0 and 1 return the same result.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '节点池策略',
- 'description' => 'The auto scaling policy used by the delivery group.'."\n",
+ 'title' => '',
+ 'description' => 'The query result.',
'type' => 'object',
'properties' => [
- 'StrategyType' => [
- 'title' => '策略类型,默认为NODE_FIXED',
- 'description' => 'The scaling mode.'."\n"
- ."\n"
- .'> '."\n"
- ."\n"
- .'* `NODE_FIXED`: no scaling. This value is applicable to pay-as-you-go resources and subscription resources.'."\n"
- .'* `NODE_SCALING_BY_USAGE`: auto scaling. This value is applicable to pay-as-you-go resources and subscription resources.'."\n"
- .'* `NODE_SCALING_BY_SCHEDULE`: scheduled scaling. This value is applicable only to pay-as-you-go resources.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* NODE_FIXED: no scaling'."\n"
- .'* NODE_SCALING_BY_SCHEDULE: scheduled scaling'."\n"
- .'* NODE_SCALING_BY_USAGE: auto scaling'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'NODE_FIXED' => '',
- 'NODE_SCALING_BY_SCHEDULE' => '',
- 'NODE_SCALING_BY_USAGE' => '',
- ],
- 'example' => 'NODE_FIXED',
- ],
- 'NodeAmount' => [
- 'description' => 'The number of resources to purchase. Valid values: 1 to 100.'."\n"
- ."\n"
- .'> '."\n"
- ."\n"
- .'* If you use subscription resources, you cannot modify this parameter.'."\n"
- .'* If you use pay-as-you-go resources, you can modify this parameter only if you set `StrategyType` to `NODE_FIXED` or `NODE_SCALING_BY_USAGE`.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'MaxScalingAmount' => [
- 'title' => '最大弹性数量',
- 'description' => 'The maximum number of resources that can be created for scale-out. This parameter is required only if you set `StrategyType` to `NODE_SCALING_BY_USAGE`.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'MaxIdleAppInstanceAmount' => [
- 'description' => 'The maximum number of idle sessions. After you specify a value for this parameter, auto scaling is triggered only if the number of idle sessions in the delivery group is smaller than the specified value and the session usage exceeds the value specified for `ScalingUsageThreshold`. Otherwise, the system determines that the idle sessions in the delivery group are sufficient and does not perform auto scaling.`` You can use this parameter to flexibly manage auto scaling and reduce costs.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
- 'ScalingStep' => [
- 'title' => '弹性扩容步长',
- 'description' => 'The number of resources that are created each time resources are scaled out. Valid values: 1 to 10. This parameter is required only if you set `StrategyType` to `NODE_SCALING_BY_USAGE`.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'ScalingUsageThreshold' => [
- 'title' => '触发弹性扩容的会话百分比',
- 'description' => 'The upper limit of session usage. If the session usage exceeds the specified upper limit, auto scaling is automatically triggered. The session usage is calculated by using the following formula: `Session usage = Number of current sessions/(Total number of resources × Number of concurrent sessions) × 100%`. This parameter is required only if you set `StrategyType` to `NODE_SCALING_BY_USAGE`. Valid values: 0 to 100. Default value: 85.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '85',
- ],
- 'ScalingDownAfterIdleMinutes' => [
- 'title' => '资源回收时间',
- 'description' => 'The maximum retention period of a resource to which no session is connected. If no session is connected to a resource, the resource is automatically scaled in after the specified retention period elapses. Valid values: 5 to 120. Default value: 5. Unit: minutes. If one of the following situations occurs, the resource is not scaled in.'."\n"
- ."\n"
- .'* If a scale-out is automatically triggered after the resource is scaled in, the scale-in is not executed. This prevents repeated scale-in and scale-out.'."\n"
- .'* If a scale-out is automatically triggered due to an increase in the number of sessions during the specified period of time, the resource is not scaled in and the countdown restarts.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
- 'StrategyEnableDate' => [
- 'description' => 'The effective date of the scaling policy. Format: yyyy-MM-dd. The date must be the same as or later than the current date. This parameter is required only if you set `StrategyType` to `NODE_SCALING_BY_SCHEDULE`.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-01-05',
- ],
- 'StrategyDisableDate' => [
- 'description' => 'The expiration date of the scaling policy. Format: yyyy-MM-dd. The interval between the expiration date and the effective date must be from 7 days to 1 year. This parameter is required only if you set `StrategyType` to `NODE_SCALING_BY_SCHEDULE`.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-01-19',
- ],
- 'WarmUp' => [
- 'description' => 'Specifies whether to enable the warmup policy for resources. This parameter is required only if you set `StrategyType` to `NODE_SCALING_BY_SCHEDULE`.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'RecurrenceSchedules' => [
- 'description' => 'The intervals at which the scaling policy is executed. This parameter is required only if you set `StrategyType` to `NODE_SCALING_BY_SCHEDULE`.'."\n",
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'PageNumber' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Data' => [
+ 'description' => 'The list of returned result objects.',
'type' => 'array',
'items' => [
- 'description' => 'The interval at which the scaling policy is executed.'."\n",
+ 'description' => 'The returned result object.',
'type' => 'object',
'properties' => [
- 'RecurrenceType' => [
- 'description' => 'The schedule type of the scaling policy. This parameter must be configured together with `RecurrenceValues`.``'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* weekly: The scaling policy is executed on specific days each week.'."\n",
+ 'DesktopId' => ['title' => '', 'description' => 'The agent runtime ID.', 'type' => 'string', 'example' => 'ecd-xxxx'],
+ 'ResourceId' => ['title' => '', 'description' => 'The resource ID, which is the cloud computer ID.', 'type' => 'string', 'example' => 'ecd-xxxx'],
+ 'RegionId' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'RegionLocation' => [
+ 'title' => '',
+ 'description' => 'The region location (domestic/overseas).',
+ 'enumValueTitles' => ['Mainland' => 'Chinese Mainland', 'Overseas' => 'Overseas (including Hong Kong, China)'],
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'weekly' => '',
- ],
- 'example' => 'weekly',
+ 'example' => 'Mainland',
],
- 'RecurrenceValues' => [
- 'description' => 'The days of each week on which the scaling policy is executed.'."\n",
+ 'DesktopName' => ['title' => '', 'description' => 'The agent runtime name.', 'type' => 'string', 'example' => 'Agent-001'],
+ 'DesktopStatus' => [
+ 'title' => '',
+ 'description' => 'The cloud computer status.',
+ 'enumValueTitles' => ['Stopped' => 'Stopped', 'Starting' => 'Starting', 'Rebuilding' => 'Rebuilding', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Expired' => 'Expired', 'Deleted' => 'Deleted', 'Pending' => 'Pending'],
+ 'type' => 'string',
+ 'example' => 'Running',
+ ],
+ 'OsType' => [
+ 'title' => '',
+ 'description' => 'The operating system type.',
+ 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
+ 'type' => 'string',
+ 'example' => 'Windows',
+ ],
+ 'AuthUsers' => [
+ 'title' => '',
+ 'description' => 'The list of authorized users.',
'type' => 'array',
- 'items' => [
- 'description' => 'The day of each week on which the scaling policy is executed.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* 1: Monday'."\n"
- .'* 2: Tuesday'."\n"
- .'* 3: Wednesday'."\n"
- .'* 4: Thursday'."\n"
- .'* 5: Friday'."\n"
- .'* 6: Saturday'."\n"
- .'* 7: Sunday'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '',
- '',
- '',
- '',
- '',
- '',
- '',
- ],
- 'example' => '1',
- ],
- 'required' => false,
- 'maxItems' => 7,
+ 'items' => ['description' => 'The authorized user.', 'type' => 'string', 'example' => 'user-001', 'title' => ''],
+ 'example' => '',
],
- 'TimerPeriods' => [
- 'description' => 'The time periods during which the scaling policy can be executed. The time periods must meet the following requirements:'."\n"
- ."\n"
- .'* Up to three time periods can be added.'."\n"
- .'* Time periods cannot be overlapped.'."\n"
- .'* The interval between two consecutive time periods must be greater than or equal to 5 minutes.'."\n"
- .'* Each time period must be greater than or equal to 15 minutes.'."\n"
- .'* The total length of the time periods that you specify cannot be greater than a day.'."\n",
+ 'HasAuthUser' => [
+ 'title' => '',
+ 'description' => 'Indicates whether authorized users exist.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'AgentInstanceInfoList' => [
+ 'title' => '',
+ 'description' => 'The list of agent instance information.',
'type' => 'array',
'items' => [
- 'description' => 'The time period during which the scaling policy can be executed.'."\n",
+ 'description' => 'The agent instance information object.',
'type' => 'object',
'properties' => [
- 'StartTime' => [
- 'description' => 'The beginning of the time period during which the scaling policy is executed. Format: HH:mm.'."\n",
+ 'AgentPlatform' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AgentProvider' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AgentInstanceVersion' => ['title' => '', 'description' => 'The agent instance version.', 'type' => 'string', 'example' => '2026.3.13'],
+ 'AgentInstanceStatus' => [
+ 'title' => '',
+ 'description' => 'The agent instance status.',
+ 'enumValueTitles' => ['Undeployed' => 'Undeployed', 'Deploying' => 'Deploying', 'Stopped' => 'Stopped', 'Starting' => 'Starting', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Deleted' => 'Deleted', 'Deployed' => 'Deployed', 'Unavailable' => 'Unavailable'],
'type' => 'string',
- 'required' => false,
- 'example' => '12:00',
+ 'example' => 'Running',
],
- 'EndTime' => [
- 'description' => 'The end of the time period during which the scaling policy is executed. Format: HH:mm.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '15:00',
+ 'ModelConfigure' => [
+ 'title' => '',
+ 'description' => 'Indicates whether the agent instance has a configured model.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ChannelConfigure' => [
+ 'title' => '',
+ 'description' => 'Indicates whether the agent instance has a configured third-party channel.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ChannelConfiguredList' => [
+ 'title' => '',
+ 'description' => 'The list of third-party channels configured for the agent instance.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The third-party channel configured for the agent instance.',
+ 'enumValueTitles' => ['dingtalk-connector' => 'DingTalk', 'wechat' => 'WeChat', 'feishu' => 'Lark', 'qqbot' => 'QQ', 'wecom' => 'WeCom'],
+ 'type' => 'string',
+ 'example' => 'dingtalk-connector',
+ 'title' => '',
+ ],
+ 'example' => '',
],
- 'Amount' => [
- 'description' => 'The number of resources.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
+ 'DeploymentSource' => [
+ 'title' => '',
+ 'description' => 'The deployment source.',
+ 'enumValueTitles' => ['User' => 'User deployment', 'Admin' => 'Admin deployment'],
+ 'type' => 'string',
+ 'example' => 'Admin',
],
+ 'ModelTemplateId' => ['title' => '', 'description' => 'The configured model group ID.', 'type' => 'string', 'example' => 'mt-xxxx'],
],
- 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
- 'maxItems' => 5,
+ 'example' => '',
+ ],
+ 'ModelConfigure' => [
+ 'title' => '',
+ 'description' => 'Indicates whether the agent runtime has a configured model.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'false'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ModelTemplateId' => ['title' => '', 'description' => 'The effective model template ID (returned only when modelConfigure=true).', 'type' => 'string', 'example' => 'mt-xxxx'],
+ 'ModelTemplateName' => ['title' => '', 'description' => 'The effective model template name (returned only when modelConfigure=true).', 'type' => 'string', 'example' => 'model-template-001'],
+ 'ChannelConfigure' => [
+ 'title' => '',
+ 'description' => 'Indicates whether the agent runtime has a configured third-party channel.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ChannelConfiguredList' => [
+ 'title' => '',
+ 'description' => 'The list of third-party channels configured for the agent runtime.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The third-party channel configured for the agent runtime.',
+ 'enumValueTitles' => ['dingtalk-connector' => 'DingTalk', 'wechat' => 'WeChat', 'feishu' => 'Lark', 'qqbot' => 'QQ', 'wecom' => 'WeCom'],
+ 'type' => 'string',
+ 'example' => 'dingtalk-connector',
+ 'title' => '',
+ ],
+ 'example' => '',
+ ],
+ 'QrCodeConfiguringList' => [
+ 'title' => '',
+ 'description' => 'The list of channels in QR code configuration.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The channel in QR code configuration.', 'type' => 'string', 'example' => 'wechat', 'title' => ''],
+ 'example' => '',
+ ],
+ 'AgentImInfo' => [
+ 'title' => '',
+ 'description' => 'The agent IM information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AgentImStatus' => [
+ 'title' => '',
+ 'description' => 'The agent IM status.',
+ 'enumValueTitles' => ['Enabled' => 'Enabled', 'Disabled' => 'Disabled'],
+ 'type' => 'string',
+ 'example' => 'Enabled',
+ ],
+ 'CloudSpaceStatus' => [
+ 'title' => '',
+ 'description' => 'The CloudSpace status.',
+ 'enumValueTitles' => ['Enabled' => 'Enabled', 'Disabled' => 'Disabled'],
+ 'type' => 'string',
+ 'example' => 'Enabled',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'RiskInfo' => [
+ 'title' => '',
+ 'description' => 'The risk information (returned only when the request parameter IncludeRiskInfo is set to true, otherwise null).',
+ 'type' => 'object',
+ 'properties' => [
+ 'ModelModified' => [
+ 'title' => '',
+ 'description' => 'Indicates whether the model configuration is modified (inconsistent with the admin-distributed configuration).',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ChannelModified' => [
+ 'title' => '',
+ 'description' => 'Indicates whether the third-party channel configuration is modified (inconsistent with the admin-distributed configuration).',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'AgentUninstalled' => [
+ 'title' => '',
+ 'description' => 'Indicates whether the agent is uninstalled.',
+ 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'ResourceGroup' => [
+ 'title' => '',
+ 'description' => 'The resource group information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxx'],
+ 'ResourceGroupName' => ['title' => '', 'description' => 'The resource group name.', 'type' => 'string', 'example' => 'resource-group-001'],
+ ],
+ 'example' => '',
+ ],
+ 'ManagementStatuses' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
- 'maxItems' => 7,
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'BizRegionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the region where the delivery group resides. For information about the supported regions, see [Limits](~~426036~~).'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* cn-shanghai: China (Shanghai)'."\n"
- .'* cn-hangzhou: China (Hangzhou)'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cn-shanghai' => '',
- 'cn-hangzhou' => '',
- ],
- 'example' => 'cn-hangzhou',
+ 'example' => '',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'BaseResult',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InvalidParameter.PoolId',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The parameter PoolId is invalid.',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDesktopAgentRuntime',
+ 'summary' => 'Queries the list of desktop agent runtimes.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListDesktopAgentRuntime',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.PoolId\\",\\n \\"Message\\": \\"The parameter PoolId is invalid.\\"\\n}","type":"json"}]',
- 'title' => 'ModifyNodePoolAttribute',
- 'summary' => 'Changes the scaling policy of a delivery group. The following scaling policies are supported: fixed resource number, scheduled scaling, and auto scaling.',
- 'description' => 'You can select one of the following scaling policies for cloud app resources:'."\n"
- ."\n"
- .'* No scaling: Resources are not scaled.'."\n"
- .'* Auto scaling: Resources are automatically scaled based on the number of connected sessions and the duration during which no session is connected.'."\n"
- .'* Scheduled scaling: Resources are scaled during specific periods of time on specific dates.'."\n"
- ."\n"
- .'Before you call this operation, make sure that you fully understand the [billing methods and prices](~~426039~~) of App Streaming.'."\n",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"DesktopId\\": \\"ecd-xxxx\\",\\n \\"ResourceId\\": \\"ecd-xxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionLocation\\": \\"Mainland\\",\\n \\"DesktopName\\": \\"Agent-001\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"AuthUsers\\": [\\n \\"user-001\\"\\n ],\\n \\"HasAuthUser\\": true,\\n \\"AgentInstanceInfoList\\": [\\n {\\n \\"AgentPlatform\\": \\"\\",\\n \\"AgentProvider\\": \\"\\",\\n \\"AgentInstanceVersion\\": \\"2026.3.13\\",\\n \\"AgentInstanceStatus\\": \\"Running\\",\\n \\"ModelConfigure\\": true,\\n \\"ChannelConfigure\\": true,\\n \\"ChannelConfiguredList\\": [\\n \\"dingtalk-connector\\"\\n ],\\n \\"DeploymentSource\\": \\"Admin\\",\\n \\"ModelTemplateId\\": \\"mt-xxxx\\"\\n }\\n ],\\n \\"ModelConfigure\\": true,\\n \\"ModelTemplateId\\": \\"mt-xxxx\\",\\n \\"ModelTemplateName\\": \\"model-template-001\\",\\n \\"ChannelConfigure\\": true,\\n \\"ChannelConfiguredList\\": [\\n \\"dingtalk-connector\\"\\n ],\\n \\"QrCodeConfiguringList\\": [\\n \\"wechat\\"\\n ],\\n \\"AgentImInfo\\": {\\n \\"AgentImStatus\\": \\"Enabled\\",\\n \\"CloudSpaceStatus\\": \\"Enabled\\"\\n },\\n \\"RiskInfo\\": {\\n \\"ModelModified\\": true,\\n \\"ChannelModified\\": true,\\n \\"AgentUninstalled\\": true\\n },\\n \\"ResourceGroup\\": {\\n \\"ResourceGroupId\\": \\"rg-xxxx\\",\\n \\"ResourceGroupName\\": \\"resource-group-001\\"\\n },\\n \\"ManagementStatuses\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"TotalCount\\": 30,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
- 'AuthorizeInstanceGroup' => [
- 'summary' => 'Adds assigned users to or removes assigned users from a delivery group. Only users added to the assigned user list can access App Streaming.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListImage' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '83450',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '213313',
+ 'abilityTreeNodes' => ['FEATUREappstreamingSH8DGI', 'FEATUREappstreamingDG81PX'],
],
'parameters' => [
[
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'ImageId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'img-bp13mu****'],
+ ],
+ [
+ 'name' => 'ImageName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The image name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'DemoImage'],
+ ],
+ [
+ 'name' => 'Status',
'in' => 'formData',
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The image status. Specifies the status of images to query. By default, all images that are not deleted are queried.',
+ 'enumValueTitles' => ['AVAILABLE' => 'available.', 'INIT' => 'initializing.', 'CREATE_FAILED' => 'creation failed.', 'CREATING' => 'being created.'],
'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- 'maxItems' => 100,
+ 'required' => false,
+ 'example' => 'INIT',
+ ],
+ ],
+ [
+ 'name' => 'ImageType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The image type.',
+ 'enumValueTitles' => ['User' => 'custom image.', 'Shared' => 'shared image.', 'System' => 'system image.', 'Community' => 'community image.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'User',
+ ],
+ ],
+ [
+ 'name' => 'PackageType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The image package type.',
+ 'enumValueTitles' => ['Ecs_Container' => 'ECS+Docker image.', 'Ecs' => 'ECS image.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Ecs',
+ ],
+ ],
+ [
+ 'name' => 'OsType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The operating system type of the image.',
+ 'enumValueTitles' => ['Linux' => 'Linux', 'Unknown' => 'unknown.', 'Windows' => 'Windows', 'Android' => 'Android'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Windows',
+ ],
+ ],
+ [
+ 'name' => 'BizType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The business type. This parameter is not publicly available.',
+ 'enumValueTitles' => [1 => '[Default value].'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
],
],
[
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudDesktop' => 'WUYING Workspace.', 'CloudApp' => 'WUYING CloudApp.', 'WuyingServer' => 'WUYING Workstation.'],
'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
+ 'required' => false,
'example' => 'CloudApp',
],
],
[
- 'name' => 'AuthorizeUserIds',
+ 'name' => 'ProtocolType',
'in' => 'formData',
- 'style' => 'flat',
'schema' => [
- 'description' => 'The IDs of the users that you want to add to the authorization list of the delivery group. You can specify 1 to 100 user IDs.'."\n",
+ 'title' => '',
+ 'description' => 'The protocol type of the image.',
+ 'enumValueTitles' => ['HDX' => 'HDX protocol.', 'ASP' => 'Alibaba Cloud proprietary ASP protocol.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ASP',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The number of entries per page for paging queries. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ProductTypeList',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of products supported when the image supports multiple products.',
'type' => 'array',
'items' => [
- 'description' => 'The ID of the user that you want to add to the authorization list of the delivery group. You can call the [DescribeUsers](~~436936~~) operation to obtain the ID.'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudDesktop' => 'WUYING Workspace.', 'CloudApp' => 'WUYING CloudApp.', 'WuyingServer' => 'WUYING Workstation.'],
'type' => 'string',
'required' => false,
- 'example' => '"AuthorizeUserIds.1":"username1","AuthorizeUserIds.2":"username2"',
+ 'example' => 'CloudApp',
+ 'title' => '',
],
'required' => false,
- 'maxItems' => 200,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'UnAuthorizeUserIds',
+ 'name' => 'BizTypeList',
'in' => 'formData',
- 'style' => 'flat',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The IDs of the users that you want to remove from the authorization list of the delivery group. You can specify 1 to 100 user IDs.'."\n",
+ 'description' => 'The list of all business types. This parameter is not publicly available.',
'type' => 'array',
'items' => [
- 'description' => 'The ID of the user that you want to remove from the authorization list of the delivery group. You can call the [DescribeUsers](~~436936~~) operation to obtain the ID.'."\n",
- 'type' => 'string',
+ 'description' => 'The business type. Set this parameter based on your business.',
+ 'enumValueTitles' => [1 => '[Default value].'],
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => '"UnAuthorizeUserIds.1":"username3","UnAuthorizeUserIds.2":"username4"',
+ 'example' => '1',
+ 'title' => '',
],
'required' => false,
- 'maxItems' => 200,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'UserMeta',
+ 'name' => 'FeatureList',
'in' => 'formData',
- 'style' => 'json',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The user information.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => 'The user type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* ad: Active Directory (AD) account'."\n"
- .'* simple: convenience account'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ad' => '',
- 'simple' => '',
- ],
- 'example' => 'simple',
- ],
- 'AdDomain' => [
- 'description' => 'The AD domain name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'example.com',
- ],
+ 'description' => 'The list of features supported by the image.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The feature supported by the image.',
+ 'enumValueTitles' => ['FotaChannel' => 'Supported FOTA channel.', 'Builder' => 'Supports image Builder.', 'MultiSession' => 'Supports multiple sessions.', 'GPU' => 'Supports GPU.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'GPU',
+ 'title' => '',
],
'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'AppInstancePersistentId',
+ 'name' => 'LanguageType',
'in' => 'formData',
'schema' => [
- 'title' => '持久会话ID。',
- 'description' => '持久会话ID。',
+ 'title' => '',
+ 'description' => 'The language.',
+ 'enumValueTitles' => ['en-US' => 'English.', 'zh-HK' => 'Traditional Chinese (Hong Kong).', 'zh-CN' => 'Simplified Chinese.', 'ja-JP' => 'Japanese.'],
'type' => 'string',
'required' => false,
- 'example' => 'p-0cc7s3mw2fg4j****',
+ 'example' => 'zh-CN',
],
],
[
- 'name' => 'AvatarId',
+ 'name' => 'ResourceInstanceType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Queries images of specific defined specifications.', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.2c4g', 'title' => ''],
+ ],
+ [
+ 'name' => 'FotaVersion',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The image version information.', 'type' => 'string', 'required' => false, 'example' => '2.0.3-xxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'PlatformName',
'in' => 'formData',
'schema' => [
- 'title' => '用户分身ID。',
+ 'description' => 'The operating system platform name.',
+ 'enumValueTitles' => ['Ubuntu' => 'Ubuntu operating system.', 'Debian' => 'Debian operating system.', 'Windows Server 2022' => 'Windows Server 2022 operating system.', 'Windows Server 2019' => 'Windows Server 2019 operating system.', 'Windows Server 2016' => 'Windows Server 2016 operating system.', 'Windows 11' => 'Windows 11 operating system.', 'Windows 10' => 'Windows 10 operating system.'],
'type' => 'string',
- 'example' => 'default',
- 'default' => 'default',
+ 'required' => false,
+ 'example' => 'Windows Server 2019',
+ 'title' => '',
],
],
[
- 'name' => 'AuthorizeUserGroupIds',
+ 'name' => 'BizRegionIdList',
'in' => 'formData',
- 'style' => 'flat',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of supported regions.'."\n"
+ .'WUYING images are centralized. Use this parameter to query the regions where the image is deployed.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'TagList',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '授权用户组ID列表。',
+ 'description' => 'The tags for query.',
'type' => 'array',
'items' => [
- 'title' => '授权用户组ID。',
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The custom tag key.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''],
+ 'Value' => ['description' => 'The custom tag value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'maxItems' => 20,
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'UnAuthorizeUserGroupIds',
+ 'name' => 'PlatformNameList',
'in' => 'formData',
- 'style' => 'flat',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '取消授权用户组ID列表。',
+ 'description' => 'The list of supported platform types. For valid values, refer to PlatformName above.',
'type' => 'array',
- 'items' => [
- 'title' => '取消授权用户组ID列表。',
- 'type' => 'string',
- ],
- 'maxItems' => 20,
+ 'items' => ['description' => 'The image platform name.', 'type' => 'string', 'required' => false, 'example' => 'Windows 11', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'Distro',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The image information struct.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the returned data.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned data object.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-04-25 15:13:57'],
+ 'GmtModified' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2025-04-25 15:13:57'],
+ 'AliUid' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'],
+ 'ImageId' => ['title' => '', 'description' => 'The image ID. System image IDs are meaningful, while custom image IDs are automatically generated.', 'type' => 'string', 'example' => 'imgc-xxxx'],
+ 'ImageName' => ['title' => '', 'description' => 'The image name.', 'type' => 'string', 'example' => 'DemoImage'],
+ 'ImageType' => ['title' => '', 'description' => 'The image type.', 'type' => 'string', 'example' => 'User'],
+ 'PackageType' => ['title' => '', 'description' => 'The image package type.', 'type' => 'string', 'example' => 'ECS'],
+ 'Description' => ['title' => '', 'description' => 'The image description.', 'type' => 'string', 'example' => '描述'],
+ 'OsType' => ['title' => '', 'description' => 'The image type.', 'type' => 'string', 'example' => 'Windows'],
+ 'ProtocolType' => ['title' => '', 'description' => 'The protocol type.', 'type' => 'string', 'example' => 'ASP'],
+ 'BizType' => ['title' => '', 'description' => 'The business type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ProductType' => ['title' => '', 'description' => 'The product type.', 'type' => 'string', 'example' => 'CloudApp'],
+ 'VersionId' => ['title' => '', 'description' => 'The image version.', 'type' => 'string', 'example' => 'iv-xxx'],
+ 'OnlineVersionId' => ['title' => '', 'description' => 'The sub-version from which the current image reads the primary image information. An image consists of multiple sub-versions.', 'type' => 'string', 'example' => 'iv-xxxx'],
+ 'LatestVersionId' => ['title' => '', 'description' => 'The latest sub-version of the image. An image consists of multiple sub-versions.', 'type' => 'string', 'example' => 'iv-xxx'],
+ 'Status' => ['title' => '', 'description' => 'The image status.', 'type' => 'string', 'example' => 'INIT'],
+ 'ParentImageId' => ['title' => '', 'description' => 'The parent image ID. This parameter indicates only the inheritance relationship. System images do not have a parent image.', 'type' => 'string', 'example' => 'imgc-xxx'],
+ 'ParentImageVersion' => ['title' => '', 'description' => 'The parent image version.', 'type' => 'string', 'example' => 'iv-xxx'],
+ 'BaseImageId' => ['title' => '', 'description' => 'The base image ID.', 'type' => 'string', 'example' => 'imgc-xxx'],
+ 'BaseImageVersion' => ['title' => '', 'description' => 'The base image version.', 'type' => 'string', 'example' => 'iv-xxx'],
+ 'FotaVersion' => ['title' => '', 'description' => 'The FOTA version.', 'type' => 'string', 'example' => '2.3.0-xxx'],
+ 'Language' => ['title' => '', 'description' => 'The image language. If the package type is VHD or Container, this property is inherited from the ECS-packaged image in the image combination.', 'type' => 'string', 'example' => 'zh-CN'],
+ 'Platform' => ['title' => '', 'description' => 'The operating system platform of the image.'."\n"
+ ."\n"
+ .'> If the package type is VHD or Container, this property is inherited from the ECS-packaged image in the image combination.', 'type' => 'integer', 'format' => 'int32', 'example' => 'Windows'],
+ 'OnlineVersion' => ['title' => '', 'description' => 'Indicates whether the current version is the active version.', 'type' => 'boolean', 'example' => 'true'],
+ 'SystemDiskSize' => ['description' => 'The system cloud disk size. Unit: GiB.'."\n"
+ ."\n"
+ .'> The system cloud disk size cannot be smaller than the image file.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''],
+ 'DataDiskSize' => ['description' => 'The data cloud disk size. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'AppList' => [
+ 'description' => 'The application configurations.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'ca-xxx', 'title' => ''],
+ 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => '应用名称', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'FeatureList' => [
+ 'description' => 'The list of image feature tags.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The image feature tag.', 'type' => 'string', 'example' => 'Builder', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ImageCreateMode' => [
+ 'description' => 'The image creation type.',
+ 'enumValueTitles' => ['BY_SNAPSHOT_ID' => 'Created from a snapshot or contains only a system cloud disk.', 'BUILDER_MANUAL' => 'Manually created image.', 'INSTANCE_AUTO' => 'Automatically created image based on an instance.', 'BY_INSTANCE_ID' => 'Created from an instance or contains both a system cloud disk and data cloud disks.'],
+ 'type' => 'string',
+ 'example' => 'BUILDER_MANUAL',
+ 'title' => '',
+ ],
+ 'ImageRegionList' => [
+ 'description' => 'The regions.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The region object.', 'type' => 'string', 'example' => '地域对象。', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Distro' => ['description' => 'The distribution name.', 'type' => 'string', 'example' => 'Ubuntu 22.04 64位', 'title' => ''],
+ 'VersionName' => ['description' => 'The version name.', 'type' => 'string', 'example' => 'v0.1.0', 'title' => ''],
+ 'ResourceInstanceCategory' => ['description' => 'The resource type supported by the image.', 'type' => 'string', 'example' => '["eds.cpu.category"]', 'title' => ''],
+ 'PlatformName' => ['description' => 'The system platform name.', 'type' => 'string', 'example' => 'Windows Server 2022', 'title' => ''],
+ 'SupportedLanguageList' => [
+ 'description' => 'The list of supported languages.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The supported language.', 'type' => 'string', 'example' => 'zh-CN', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'VolumeEncryptionEnabled' => ['description' => 'Indicates whether cloud disk encryption is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'VolumeEncryptionKey' => ['description' => 'The KMS key ID used when cloud disk encryption is enabled.', 'type' => 'string', 'example' => 'a7b3c0c8-xxxx', 'title' => ''],
+ 'SessionType' => [
+ 'description' => 'The session type.',
+ 'enumValueTitles' => ['SINGLE_SESSION' => 'single session.', 'MULTIPLE_SESSION' => 'multiple sessions.'],
+ 'type' => 'string',
+ 'example' => 'SINGLE_SESSION',
+ 'title' => '',
+ ],
+ 'ImageRegionDistributeList' => [
+ 'title' => '',
+ 'description' => 'The effective region information for overlay layers.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageId' => ['title' => '', 'description' => 'The image ID. System image IDs are meaningful, while custom image IDs are automatically generated.', 'type' => 'string', 'example' => 'imgc-xxx'],
+ 'RegionId' => ['title' => '', 'description' => 'The supported region.', 'type' => 'string', 'example' => 'cn-shanghai'],
+ 'Status' => ['title' => '', 'description' => 'The status.', 'type' => 'string', 'example' => 'INIT'],
+ 'VersionId' => ['title' => '', 'description' => 'The image version.', 'type' => 'string', 'example' => 'iv-xxx'],
+ 'Progress' => ['title' => '', 'description' => 'The progress percentage.', 'type' => 'string', 'example' => '70%'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'FotaChannel' => ['description' => '> This parameter is not publicly available.', 'type' => 'string', 'example' => '镜像支持的fota渠道,暂未启用', 'title' => ''],
+ 'CompatibleMode' => ['description' => 'Indicates whether the compatibility mode is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'DriverList' => [
+ 'description' => 'The list of driver information.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The driver list.', 'type' => 'string', 'example' => '["00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Scene' => ['type' => 'string', 'example' => 'AIGC', 'description' => '', 'title' => ''],
+ 'Rating' => ['type' => 'integer', 'format' => 'int32', 'example' => '95', 'description' => '', 'title' => ''],
+ 'ImageIconUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EnvironmentId' => ['type' => 'string', 'example' => 'env-164c321f405ca84143e4b730dbe4', 'description' => '', 'title' => ''],
+ 'TagList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['type' => 'string', 'example' => '1630348213973321', 'description' => '', 'title' => ''],
+ 'Value' => ['type' => 'string', 'example' => 'inner', 'description' => '', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SnapshotList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SnapshotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'VersionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DiskType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DiskSubType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'BindType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DiskCategory' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Size' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Count' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''],
+ 'Success' => [
+ 'description' => 'Indicates whether the call was successful.',
+ 'enumValueTitles' => ['true' => 'The call was successful.', 'false' => 'The call failed.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'title' => '',
],
+ 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the API request.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8737D130-BFD0-5D51-96F6-C08EB1139A25', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error.', 'description' => ''],
+ ['errorCode' => 'InvalidBizType', 'errorMessage' => 'The bizType parameter is invalid.', 'description' => 'The bizType parameter is invalid.'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'You are not authorized to access this page.', 'description' => 'You are not authorized to access this page.'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'AuthorizeInstanceGroup',
- ],
- 'LogOffAllSessionsInAppInstanceGroup' => [
- 'summary' => 'Closes all sessions in a pay-as-you-go delivery group for which a scheduled scaling policy is used.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Query image information',
+ 'summary' => 'Queries image information.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'http',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": \\"2025-04-25 15:13:57\\",\\n \\"GmtModified\\": \\"2025-04-25 15:13:57\\",\\n \\"AliUid\\": 123456789,\\n \\"ImageId\\": \\"imgc-xxxx\\",\\n \\"ImageName\\": \\"DemoImage\\",\\n \\"ImageType\\": \\"User\\",\\n \\"PackageType\\": \\"ECS\\",\\n \\"Description\\": \\"描述\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"BizType\\": 1,\\n \\"ProductType\\": \\"CloudApp\\",\\n \\"VersionId\\": \\"iv-xxx\\",\\n \\"OnlineVersionId\\": \\"iv-xxxx\\",\\n \\"LatestVersionId\\": \\"iv-xxx\\",\\n \\"Status\\": \\"INIT\\",\\n \\"ParentImageId\\": \\"imgc-xxx\\",\\n \\"ParentImageVersion\\": \\"iv-xxx\\",\\n \\"BaseImageId\\": \\"imgc-xxx\\",\\n \\"BaseImageVersion\\": \\"iv-xxx\\",\\n \\"FotaVersion\\": \\"2.3.0-xxx\\",\\n \\"Language\\": \\"zh-CN\\",\\n \\"Platform\\": 0,\\n \\"OnlineVersion\\": true,\\n \\"SystemDiskSize\\": 40,\\n \\"DataDiskSize\\": 100,\\n \\"AppList\\": [\\n {\\n \\"AppId\\": \\"ca-xxx\\",\\n \\"AppName\\": \\"应用名称\\"\\n }\\n ],\\n \\"FeatureList\\": [\\n \\"Builder\\"\\n ],\\n \\"ImageCreateMode\\": \\"BUILDER_MANUAL\\",\\n \\"ImageRegionList\\": [\\n \\"地域对象。\\"\\n ],\\n \\"Distro\\": \\"Ubuntu 22.04 64位\\",\\n \\"VersionName\\": \\"v0.1.0\\",\\n \\"ResourceInstanceCategory\\": \\"[\\\\\\"eds.cpu.category\\\\\\"]\\",\\n \\"PlatformName\\": \\"Windows Server 2022\\",\\n \\"SupportedLanguageList\\": [\\n \\"zh-CN\\"\\n ],\\n \\"VolumeEncryptionEnabled\\": true,\\n \\"VolumeEncryptionKey\\": \\"a7b3c0c8-xxxx\\",\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"ImageRegionDistributeList\\": [\\n {\\n \\"ImageId\\": \\"imgc-xxx\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Status\\": \\"INIT\\",\\n \\"VersionId\\": \\"iv-xxx\\",\\n \\"Progress\\": \\"70%\\"\\n }\\n ],\\n \\"FotaChannel\\": \\"镜像支持的fota渠道,暂未启用\\",\\n \\"CompatibleMode\\": true,\\n \\"DriverList\\": [\\n \\"[\\\\\\"00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\\\\\"]\\"\\n ],\\n \\"Scene\\": \\"AIGC\\",\\n \\"Rating\\": 95,\\n \\"ImageIconUrl\\": \\"\\",\\n \\"EnvironmentId\\": \\"env-164c321f405ca84143e4b730dbe4\\",\\n \\"TagList\\": [\\n {\\n \\"Key\\": \\"1630348213973321\\",\\n \\"Value\\": \\"inner\\"\\n }\\n ],\\n \\"SnapshotList\\": [\\n {\\n \\"SnapshotId\\": \\"\\",\\n \\"VersionId\\": \\"\\",\\n \\"DiskType\\": \\"\\",\\n \\"DiskSubType\\": \\"\\",\\n \\"BindType\\": \\"\\",\\n \\"DiskCategory\\": \\"\\",\\n \\"Size\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Count\\": 22,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"8737D130-BFD0-5D51-96F6-C08EB1139A25\\"\\n}","type":"json"}]',
+ ],
+ 'ListLlmTemplates' => [
+ 'summary' => 'Queries a list of LLM templates.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'ProductType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品类型',
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
- ],
+ 'name' => 'ModelTemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the associated model group.', 'type' => 'string', 'required' => false, 'example' => 'mt-xxxx'],
],
[
- 'name' => 'AppInstanceGroupId',
- 'in' => 'formData',
+ 'name' => 'ProviderTemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the model provider template.', 'type' => 'string', 'required' => false, 'example' => 'mpt-xxxx'],
+ ],
+ [
+ 'name' => 'LlmTemplateIds',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '实例组id',
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
+ 'title' => '',
+ 'description' => 'The model template IDs used for filtering.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The model template ID.', 'type' => 'string', 'required' => false, 'example' => 'llmt-xxxx', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
],
],
+ [
+ 'name' => 'LlmCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The model code used for filtering. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'qwen3.6-plus'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The page number. Pages start from page 1. Values 0 and 1 return the same result.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'The error code.'."\n",
- 'type' => 'string',
- 'example' => 'InvalidParameter.ProductType',
- ],
- 'Message' => [
- 'description' => 'The error message.'."\n",
- 'type' => 'string',
- 'example' => 'The parameter ProductType is invalid.',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The list of returned data objects.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'LlmTemplateId' => ['title' => '', 'description' => 'The model template ID.', 'type' => 'string', 'example' => 'llmt-xxxx'],
+ 'ProviderTemplateId' => ['title' => '', 'description' => 'The ID of the model provider template.', 'type' => 'string', 'example' => 'mpt-xxxx'],
+ 'LlmCode' => ['title' => '', 'description' => 'The model code.', 'type' => 'string', 'example' => 'qwen3.6-plus'],
+ 'Name' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => 'Qwen3.6-Plus'],
+ 'Description' => ['title' => '', 'description' => 'The template description.', 'type' => 'string', 'example' => '千问Plus系列模型'],
+ 'Config' => ['title' => '', 'description' => 'The model configuration JSON object.', 'type' => 'string', 'example' => '{'."\n"
+ .' "id": "qwen3.6-plus",'."\n"
+ .' "cost": {'."\n"
+ .' "input": 0,'."\n"
+ .' "output": 0,'."\n"
+ .' "cacheRead": 0,'."\n"
+ .' "cacheWrite": 0'."\n"
+ .' },'."\n"
+ .' "name": "Qwen3.6-Plus",'."\n"
+ .' "input": ["image", "text"],'."\n"
+ .' "compat": {'."\n"
+ .' "supportsUsageInStreaming": true'."\n"
+ .' },'."\n"
+ .' "maxTokens": 65536,'."\n"
+ .' "reasoning": false,'."\n"
+ .' "contextWindow": 1000000'."\n"
+ .'}'],
+ 'IsDefaultModel' => [
+ 'title' => '',
+ 'description' => 'Indicates whether this is the default model in the associated model group.',
+ 'enumValueTitles' => ['true' => 'Yes.', 'false' => 'No.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'LogOffAllSessionsInAppInstanceGroup',
- 'description' => '> This operation can be called only if you use a pay-as-you-go delivery group for which a scheduled scaling policy is used and if you call the operation at a time other than the scheduled time.'."\n",
- ],
- 'DeleteAppInstanceGroup' => [
- 'summary' => 'Deletes a delivery group that uses the By Resource - Pay-as-you-go billing method.',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query LLM template list',
+ 'description' => 'You can use paging to retrieve the list of model templates under a model provider template in the Wuying Agent Management Center. You can filter results by model group ID, model provider template ID, model template ID, and model encoding. When you query by model group dimension, the default model is automatically pinned to the top.'."\n"
+ ."\n"
+ .'Before you call this operation, make sure that you are familiar with the operations and usage of the Wuying Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListLlmTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"LlmTemplateId\\": \\"llmt-xxxx\\",\\n \\"ProviderTemplateId\\": \\"mpt-xxxx\\",\\n \\"LlmCode\\": \\"qwen3.6-plus\\",\\n \\"Name\\": \\"Qwen3.6-Plus\\",\\n \\"Description\\": \\"千问Plus系列模型\\",\\n \\"Config\\": \\"{\\\\n\\\\t\\\\\\"id\\\\\\": \\\\\\"qwen3.6-plus\\\\\\",\\\\n\\\\t\\\\\\"cost\\\\\\": {\\\\n\\\\t\\\\t\\\\\\"input\\\\\\": 0,\\\\n\\\\t\\\\t\\\\\\"output\\\\\\": 0,\\\\n\\\\t\\\\t\\\\\\"cacheRead\\\\\\": 0,\\\\n\\\\t\\\\t\\\\\\"cacheWrite\\\\\\": 0\\\\n\\\\t},\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"Qwen3.6-Plus\\\\\\",\\\\n\\\\t\\\\\\"input\\\\\\": [\\\\\\"image\\\\\\", \\\\\\"text\\\\\\"],\\\\n\\\\t\\\\\\"compat\\\\\\": {\\\\n\\\\t\\\\t\\\\\\"supportsUsageInStreaming\\\\\\": true\\\\n\\\\t},\\\\n\\\\t\\\\\\"maxTokens\\\\\\": 65536,\\\\n\\\\t\\\\\\"reasoning\\\\\\": false,\\\\n\\\\t\\\\\\"contextWindow\\\\\\": 1000000\\\\n}\\",\\n \\"IsDefaultModel\\": true\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListModelProviderEndpoints' => [
+ 'summary' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'AppInstanceGroupId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'ProductType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
- ],
+ 'name' => 'ProviderName',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'Data' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProviderName' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''],
+ 'Description' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''],
+ 'ProviderUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Endpoints' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''],
+ 'Description' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''],
+ 'BaseUrl' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''],
+ 'ProviderUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ApiType' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''],
+ 'Tags' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['type' => 'string', 'example' => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'description' => '', 'title' => ''],
],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidAppInstanceGroupSpecItem.NotFound',
- 'errorMessage' => 'The app instance group spec item is not found.',
- ],
- [
- 'errorCode' => 'InvalidBrowserInstanceGroup.NotFound',
- 'errorMessage' => 'The browser instance group is not found.',
- ],
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteAppInstanceGroup',
- 'description' => '> You cannot call this operation to delete a subscription delivery group.'."\n",
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ProviderName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"ProviderUrl\\": \\"\\",\\n \\"Endpoints\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"BaseUrl\\": \\"\\",\\n \\"ProviderUrl\\": \\"\\",\\n \\"ApiType\\": \\"\\",\\n \\"Tags\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\\"\\n}","type":"json"}]',
+ 'title' => '',
],
- 'ModifyAppPolicy' => [
- 'summary' => 'Modify the delivery group display policy, including settings such as frame rate, resolution, and protocol type.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListModelProviderTemplates' => [
+ 'summary' => 'Queries the list of model provider templates.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'ProductType',
+ 'name' => 'BizType',
'in' => 'query',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Enumerated values:'."\n"
- ."\n"
- .'* CloudApp: RDS Cloud App'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The business type.',
+ 'enumValueTitles' => [1 => 'enterprise edition.'],
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
+ 'example' => '1',
],
],
[
- 'name' => 'AppPolicyId',
+ 'name' => 'AgentPlatform',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The Agent platform.',
+ 'enumValueTitles' => ['ENTERPRISE' => 'enterprise edition.', 'ENTERPRISE_JVS' => 'enterprise edition JVS Computer or enterprise edition Hermes Agent.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ENTERPRISE',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'AgentProvider',
'in' => 'query',
'schema' => [
- 'description' => 'The policy ID.'."\n",
+ 'title' => '',
+ 'description' => 'The name of the Agent provider.',
+ 'enumValueTitles' => ['OpenClaw' => 'OpenClaw'],
'type' => 'string',
'required' => true,
- 'example' => 'pg-ee2znjktwgxu2****',
+ 'example' => 'OpenClaw',
],
],
[
- 'name' => 'VideoPolicy',
+ 'name' => 'ProviderName',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The name of the model provider to filter by.', 'type' => 'string', 'required' => false, 'example' => 'bailian'],
+ ],
+ [
+ 'name' => 'ModelTemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The model group ID to filter by.', 'type' => 'string', 'required' => false, 'example' => 'mt-xxxx'],
+ ],
+ [
+ 'name' => 'ProviderTemplateIds',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => 'Displays the policy.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'FrameRate' => [
- 'description' => 'The frame rate (FPS).'."\n"
- ."\n"
- .'Enumerated values:'."\n"
- ."\n"
- .'* 30: 30 FPS'."\n"
- .'* 60: 60 FPS'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 30 => '30 FPS',
- 60 => '60 FPS',
- ],
- 'example' => '60',
- ],
- 'TerminalResolutionAdaptive' => [
- 'description' => 'Whether to use adaptive resolution.'."\n"
- ."\n"
- .'* `true`: The session resolution changes with the display area of the terminal. In this case, `SessionResolutionWidth` indicates the maximum resolution width and `SessionResolutionHeight` indicates the maximum resolution height.'."\n"
- .'* `false`: The session resolution does not change with the display area of the terminal. In this case, `SessionResolutionWidth` specifies the fixed resolution width and `SessionResolutionHeight` specifies the fixed resolution height.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
- ],
- 'example' => 'false',
- ],
- 'SessionResolutionWidth' => [
- 'description' => 'The width of the resolution, in pixels.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1920',
- ],
- 'SessionResolutionHeight' => [
- 'description' => 'The height of the resolution, in pixels.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1080',
- ],
- 'StreamingMode' => [
- 'description' => 'The stream mode. This parameter is used together with `Webrtc` to specify the protocol type.'."\n"
- ."\n"
- .'* If you set `Webrtc` to `true` and `StreamingMode` to `video`, Web Real-Time Communications (WebRTC) streams are used.'."\n"
- .'* If you set `Webrtc` to `false` and `StreamingMode` to `video`, video streams are used.'."\n"
- .'* If you set `Webrtc` to `false` and `StreamingMode` to `mix`, mixed streams are used.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'video' => '',
- 'mix' => '',
- ],
- 'example' => 'video',
- ],
- 'Webrtc' => [
- 'description' => 'Specifies whether to enable WebRTC. This parameter is used together with `StreamingMode` to specify the protocol type.'."\n"
- ."\n"
- .'* If you set `Webrtc` to `true` and `StreamingMode` to `video`, WebRTC streams are used.'."\n"
- .'* If you set `Webrtc` to `false` and `StreamingMode` to `video`, video streams are used.'."\n"
- .'* If you set `Webrtc` to `false` and `StreamingMode` to `mix`, mixed streams are used.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
- ],
- 'example' => 'true',
- ],
- 'VisualQualityStrategy' => [
- 'description' => 'The image quality policy.'."\n"
- ."\n"
- .'Enumerated values:'."\n"
- ."\n"
- .'* adaptive: adaptive.'."\n"
- .'* smooth: smooth first.'."\n"
- .'* quality: quality first.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'adaptive' => '',
- 'smooth' => '',
- 'quality' => '',
- ],
- 'example' => 'smooth',
- ],
- ],
+ 'title' => '',
+ 'description' => 'The model provider template IDs to filter by.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The model provider template ID.', 'type' => 'string', 'required' => false, 'example' => 'mpt-xxxx', 'title' => ''],
'required' => false,
+ 'example' => '',
],
],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The page number, starting from 1. Values 0 and 1 return the same result.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The information that is returned.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page in the query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'PageNumber' => ['title' => '', 'description' => 'The page number of the current query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Data' => [
+ 'description' => 'The list of returned data objects.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProviderTemplateId' => ['title' => '', 'description' => 'The model provider template ID.', 'type' => 'string', 'example' => 'mpt-xxxx'],
+ 'ProviderType' => [
+ 'description' => 'The model provider type.',
+ 'enumValueTitles' => ['WuyingCredit' => 'WUYING credit-based model. You must purchase a credit plan to unlock this model.', 'Custom' => 'A provider connected through custom configuration.', 'Managed' => 'A third-party managed provider that is connected and managed by the platform, such as Bailian or Moonshot.', 'WuyingPlan' => 'A model included in the WUYING plan. This model is ready to use out of the box and requires no additional configuration.'],
+ 'type' => 'string',
+ 'example' => 'WuyingCredit',
+ 'title' => '',
+ ],
+ 'ProviderName' => ['title' => '', 'description' => 'The name of the model provider.', 'type' => 'string', 'example' => 'bailian'],
+ 'Name' => ['title' => '', 'description' => 'The name of the model provider template.', 'type' => 'string', 'example' => '阿里云百炼'],
+ 'Description' => ['title' => '', 'description' => 'The description of the model provider template.', 'type' => 'string', 'example' => '阿里云百炼服务商'],
+ 'Config' => ['title' => '', 'description' => 'The model provider configuration as a JSON object.', 'type' => 'string', 'example' => '{'."\n"
+ .' "api": "openai-completions",'."\n"
+ .' "apiKey": "sk-xxxx",'."\n"
+ .' "baseUrl": "https://dashscope.aliyuncs.com/compatible-mode/v1"'."\n"
+ .'}'],
+ 'EnableWuyingProxy' => [
+ 'title' => '',
+ 'description' => 'Indicates whether the WUYING secure gateway proxy is enabled.',
+ 'enumValueTitles' => ['true' => 'Enabled.', 'false' => 'Disabled.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'ModifyAppPolicy',
- ],
- 'ListAuthorizedUserGroups' => [
- 'summary' => 'Queries the user groups authorized by a delivery group.',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query model provider template list',
+ 'description' => 'You can perform a paged query to retrieve the list of model provider templates under a specified model group in the WUYING Agent Management Center. You can filter results by provider name, model group ID, and provider template ID. Paging is supported.'."\n"
+ ."\n"
+ .'Before calling this operation, make sure that you are familiar with the operations and usage of the WUYING Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListModelProviderTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"ProviderTemplateId\\": \\"mpt-xxxx\\",\\n \\"ProviderType\\": \\"WuyingCredit\\",\\n \\"ProviderName\\": \\"bailian\\",\\n \\"Name\\": \\"阿里云百炼\\",\\n \\"Description\\": \\"阿里云百炼服务商\\",\\n \\"Config\\": \\"{\\\\n\\\\t\\\\\\"api\\\\\\": \\\\\\"openai-completions\\\\\\",\\\\n\\\\t\\\\\\"apiKey\\\\\\": \\\\\\"sk-xxxx\\\\\\",\\\\n\\\\t\\\\\\"baseUrl\\\\\\": \\\\\\"https://dashscope.aliyuncs.com/compatible-mode/v1\\\\\\"\\\\n}\\",\\n \\"EnableWuyingProxy\\": true\\n }\\n ],\\n \\"TotalCount\\": 30,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'ListModelTemplateResourceGroup' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7301,202 +7262,270 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingD8SMIE',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'ProductType',
- 'in' => 'formData',
+ 'name' => 'ModelTemplateId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the model group.', 'type' => 'string', 'required' => true, 'example' => 'mt-xxxxx'],
+ ],
+ [
+ 'name' => 'ResourceGroupIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '产品类型。',
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid values:'."\n"
+ 'title' => '',
+ 'description' => 'The list of resource group IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The list of resource group IDs used as filter conditions for the query.'."\n"
."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
+ .'You can specify up to 100 resource group IDs.', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxx', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'example' => '',
],
],
[
'name' => 'PageSize',
- 'in' => 'formData',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The page number. Pages start from page 1. Both 0 and 1 return the same result.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '每页最大返回的数量。',
- 'description' => 'The maximum number of entries returned per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '100',
- 'example' => '10',
+ 'title' => '',
+ 'description' => 'The query result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'PageNumber' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Data' => [
+ 'description' => 'The returned results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxx'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '15'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query resource groups associated with a model group',
+ 'summary' => 'Queries the list of resource groups associated with a model group.',
+ 'description' => 'You can call this operation to query the list of resource groups authorized by a model group in the Wuying Agent Management Center.'."\n"
+ ."\n"
+ .'Before you call this operation, make sure that you are familiar with the operations and usage of the Wuying Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PageNumber',
- 'in' => 'formData',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListModelTemplateResourceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg-xxxxx\\"\\n }\\n ],\\n \\"TotalCount\\": 15,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'ListModelTemplates' => [
+ 'summary' => 'Queries a list of model templates.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BizType',
+ 'in' => 'query',
'schema' => [
- 'title' => '页码,从1开始。',
- 'description' => 'The page number. Pages start from page 1.'."\n",
+ 'title' => '',
+ 'description' => 'The business type.',
+ 'enumValueTitles' => [1 => 'Enterprise edition.'],
'type' => 'integer',
'format' => 'int32',
'required' => true,
- 'minimum' => '1',
'example' => '1',
],
],
[
- 'name' => 'AppInstanceGroupId',
- 'in' => 'formData',
+ 'name' => 'AgentPlatform',
+ 'in' => 'query',
'schema' => [
- 'title' => '交付组ID。',
- 'description' => 'The ID of the delivery group.'."\n",
+ 'description' => 'The Agent platform.',
+ 'enumValueTitles' => ['ENTERPRISE' => 'Enterprise edition.', 'ENTERPRISE_JVS' => 'Enterprise edition JVS Computer and Enterprise edition Hermes Agent.'],
'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
+ 'required' => false,
+ 'example' => 'ENTERPRISE',
+ 'title' => '',
],
],
[
- 'name' => 'GroupId',
- 'in' => 'formData',
+ 'name' => 'AgentProvider',
+ 'in' => 'query',
'schema' => [
- 'title' => '用户组ID,精确查询。',
- 'description' => 'The ID of the user group (exact match).'."\n",
+ 'title' => '',
+ 'description' => 'The name of the Agent provider.',
+ 'enumValueTitles' => ['OpenClaw' => 'OpenClaw'],
'type' => 'string',
- 'required' => false,
- 'example' => 'ug-00001',
+ 'required' => true,
+ 'example' => 'OpenClaw',
],
],
[
- 'name' => 'GroupName',
- 'in' => 'formData',
+ 'name' => 'ModelTemplateIdList',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '用户组名称,模糊查询。',
- 'description' => 'The name of the user group (fuzzy match).'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The list of template group IDs used for filtering.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The template group ID used for filtering.', 'type' => 'string', 'required' => false, 'example' => 'mt-xxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
+ [
+ 'name' => 'HasModel',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether models have been configured in the group.',
+ 'enumValueTitles' => ['true' => 'Yes.', 'false' => 'No.'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The page number, starting from 1. Values 0 and 1 return the same result.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The request result.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'TotalCount' => [
- 'title' => '总数。',
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'PageSize' => [
- 'title' => '每页返回的最大数量。',
- 'description' => 'The maximum number of entries returned on each page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'title' => '页码。',
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'UserGroups' => [
- 'title' => '用户组信息列表。',
- 'description' => 'The information about the user groups.'."\n",
+ 'PageSize' => ['description' => 'The number of entries per page in the query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the current query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries in the query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The list of returned data objects.',
'type' => 'array',
'items' => [
- 'title' => '用户组信息。',
- 'description' => 'The information about the user group.'."\n",
+ 'description' => 'The returned data object.',
'type' => 'object',
'properties' => [
- 'GroupName' => [
- 'title' => '用户组名称。',
- 'description' => 'The name of the user group.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'AppInstanceGroupId' => [
- 'title' => '交付组ID。',
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
- 'AuthMode' => [
- 'title' => '授权模式。',
- 'description' => 'The authorization mode.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* App: authorizes access to apps.'."\n"
- .'* AppInstanceGroup: authorizes access to delivery groups.'."\n"
- .'* Session: authorizes access to sessions.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'App' => '',
- 'AppInstanceGroup' => '',
- 'Session' => '',
- ],
- 'example' => 'App',
- 'default' => 'App',
- 'enum' => [
- 'App',
- 'Session',
- 'AppInstanceGroup',
- ],
- ],
- 'GroupId' => [
- 'title' => '用户组ID。',
- 'description' => 'The ID of the user group.'."\n",
- 'type' => 'string',
- 'example' => 'ug-00001',
+ 'ModelTemplateId' => ['title' => '', 'description' => 'The model group ID.', 'type' => 'string', 'example' => 'mt-xxxx'],
+ 'AgentProvider' => [
+ 'title' => '',
+ 'description' => 'The name of the Agent provider.',
+ 'enumValueTitles' => ['OpenClaw' => 'OpenClaw'],
+ 'type' => 'string',
+ 'example' => 'OpenClaw',
+ ],
+ 'Name' => ['title' => '', 'description' => 'The template group name.', 'type' => 'string', 'example' => 'model-template-001'],
+ 'Description' => ['title' => '', 'description' => 'The template group description.', 'type' => 'string', 'example' => '测试模型分组'],
+ 'Config' => ['title' => '', 'description' => 'The model group configuration JSON object.', 'type' => 'string', 'example' => '{'."\n"
+ .' "defaults": {'."\n"
+ .' "model": {'."\n"
+ .' "primary": "bailian/qwen3.5-plus"'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .'}'],
+ 'HasModel' => [
+ 'description' => 'Specifies whether models have been configured in the group.',
+ 'enumValueTitles' => ['true' => 'Yes.', 'false' => 'No.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'title' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query model group list',
+ 'description' => 'You can use paged query to retrieve model groups that have been created in the Wuying Agent Management Center, with paging support. You can filter results by Agent provider, Agent platform, template group ID, and whether models have been configured.'."\n"
+ ."\n"
+ .'Before calling this operation, make sure that you are familiar with the operations and usage of the Wuying Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListModelTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 6,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"UserGroups\\": [\\n {\\n \\"GroupName\\": \\"用户组001\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"AuthMode\\": \\"App\\",\\n \\"GroupId\\": \\"ug-00001\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListAuthorizedUserGroups',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 30,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": [\\n {\\n \\"ModelTemplateId\\": \\"mt-xxxx\\",\\n \\"AgentProvider\\": \\"OpenClaw\\",\\n \\"Name\\": \\"model-template-001\\",\\n \\"Description\\": \\"测试模型分组\\",\\n \\"Config\\": \\"{\\\\n\\\\t\\\\\\"defaults\\\\\\": {\\\\n\\\\t\\\\t\\\\\\"model\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\\\"primary\\\\\\": \\\\\\"bailian/qwen3.5-plus\\\\\\"\\\\n\\\\t\\\\t}\\\\n\\\\t}\\\\n}\\",\\n \\"HasModel\\": true\\n }\\n ]\\n}","type":"json"}]',
],
- 'ListAppInstances' => [
- 'summary' => 'Queries the details of application instances in a delivery group, including the IDs, status, creation time, update time, session status, and public IP addresses associated with the primary NICs of the instances.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListNodeInstanceType' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7508,360 +7537,360 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '170357',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'ProductType',
'in' => 'query',
'schema' => [
- 'description' => 'The ID of the delivery group.'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
'required' => true,
- 'example' => 'aig-4p5f8tj16yb8b****',
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
[
- 'name' => 'AppInstanceId',
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number of the query results to display.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of query results per page. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'OsType',
'in' => 'query',
'schema' => [
- 'description' => 'The ID of the application instance.'."\n",
+ 'description' => 'The supported operating system type.',
+ 'enumValueTitles' => ['Windows' => 'Windows operating system.'],
'type' => 'string',
'required' => false,
- 'example' => 'ai-azn3kmwruh1vl****',
+ 'example' => 'Windows',
+ 'title' => '',
],
],
[
- 'name' => 'Status',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The status of the application instances.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The status of the application instance.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* INIT: The application instance is being initialized.'."\n"
- .'* STARTING: The application instance is being started.'."\n"
- .'* CLOSING: The application instance is being stopped.'."\n"
- .'* CLOSED: The application instance is closed.'."\n"
- .'* RUNNING: The application instance is running.'."\n"
- .'* idle: The application instance is idle.'."\n"
- .'* BOUND: The application instance is bound to an application instance group.'."\n"
- .'* UNAVAILABLE: The application instance is unavailable.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'INIT' => '',
- 'STARTING' => '',
- 'CLOSING' => '',
- 'CLOSED' => '',
- 'RUNNING' => '',
- 'IDLE' => '',
- 'BOUND' => '',
- 'UNAVAILABLE' => '',
- ],
- 'example' => 'INIT',
- ],
+ 'description' => 'The region ID of the resource. For more information about supported regions, see [Limits](~~426036~~).',
+ 'enumValueTitles' => ['cn-shanghai' => 'China (Shanghai).', 'cn-hangzhou' => 'China (Hangzhou).'],
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 100,
- 'minItems' => 1,
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
],
],
[
- 'name' => 'AppInstanceIdList',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'Language',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The IDs of the application instances. Up to 100 IDs can be specified.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the application instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ai-azn3kmwruh1vl****',
- ],
+ 'description' => 'The language type.',
+ 'enumValueTitles' => ['en-US' => 'English (United States).', 'zh-CN' => 'Simplified Chinese.'],
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 100,
- 'minItems' => 1,
+ 'example' => 'zh-CN',
+ 'title' => '',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'NodeInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. The value cannot be greater than `100`. Default value: `20`. We recommend that you specify this parameter.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
- ],
+ 'schema' => ['description' => 'The resource specification type to query. If you leave this parameter empty, all specification types are returned.', 'type' => 'string', 'required' => false, 'example' => 'appstreaming.vgpu.4c8g.2g', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'NodeInstanceTypeFamily',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Default value: `1`. We recommend that you specify this parameter.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The instance family.', 'type' => 'string', 'required' => false, 'example' => 'appstreaming.vgpu', 'title' => ''],
],
[
- 'name' => 'IncludeDeleted',
+ 'name' => 'Cpu',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to query the information about deleted app instances. If you set this parameter to true, you must configure AppInstanceIdList. Otherwise, a parameter error is reported.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'The number of CPU cores.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '2', 'title' => ''],
],
[
- 'name' => 'UserIdList',
+ 'name' => 'Gpu',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The user IDs. You can specify up to 100 IDs.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The user ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Alice',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The number of GPUs.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Memory',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The memory size. Unit: MB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10240', 'title' => ''],
+ ],
+ [
+ 'name' => 'GpuMemory',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The GPU memory size. This parameter is meaningful only for GPU-accelerated cloud desktops. Unit: MB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2048', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortType',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'DESC/ASC.', 'type' => 'string', 'required' => false, 'example' => 'ASC'],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'CPU/Memory.', 'type' => 'string', 'required' => false, 'example' => 'CPU'],
+ ],
+ [
+ 'name' => 'InstanceTypeForModify',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'OrderType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '18',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries returned on each page. The value cannot be greater than `100`. We recommend that you configure this parameter.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => 'The page number of the returned page. We recommend that you configure this parameter.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AppInstanceModels' => [
- 'description' => 'The app instances.'."\n",
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of query results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the query results currently displayed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'NodeInstanceTypeModels' => [
+ 'description' => 'The list of resource specifications.',
'type' => 'array',
'items' => [
- 'description' => 'The app instance.'."\n",
+ 'description' => 'The resource specification.',
'type' => 'object',
'properties' => [
- 'AppInstanceId' => [
- 'description' => 'The ID of the application instance.'."\n",
- 'type' => 'string',
- 'example' => 'ai-8dl7dzchklmka****',
- ],
- 'AppInstanceGroupId' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'aig-dk8p95irqfst9****',
- ],
- 'Status' => [
- 'description' => 'The status of the application instance.'."\n",
- 'type' => 'string',
- 'example' => 'BOUND',
- ],
- 'MainEthPublicIp' => [
- 'description' => 'The public IP address associated with the primary NIC. This value is returned only if `StrategyType` is set to `Mixed`.'."\n",
- 'type' => 'string',
- 'example' => '10.13.13.211',
- ],
- 'NetworkInterfaceIp' => [
- 'type' => 'string',
- ],
- 'GmtCreate' => [
- 'description' => 'The time when the application instance was created.'."\n",
- 'type' => 'string',
- 'example' => '2023-03-07T20:29:19.000+08:00',
- ],
- 'GmtModified' => [
- 'description' => 'The time when the application instance was updated.'."\n",
- 'type' => 'string',
- 'example' => '2023-03-07T20:29:19.000+08:00',
- ],
- 'SessionStatus' => [
- 'description' => 'The session status. This parameter is returned only if the application instance is in the `RUNNING` state.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* disconnect: disconnected'."\n"
- .'* connect: connected'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'disconnect' => '',
- 'connect' => '',
- ],
- 'example' => 'connect',
- ],
- 'BindInfo' => [
- 'description' => 'The information about the binding between the application instance and end users.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'EndUserId' => [
- 'description' => 'The ID of the end user that is bound to the application instance.'."\n",
- 'type' => 'string',
- 'example' => 'app.test',
- ],
- 'UsageDuration' => [
- 'description' => 'The use duration of the application instance. Unit: seconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2000',
- ],
- ],
- ],
- 'NodeId' => [
- 'description' => 'The ID of the node on which the app instance runs.'."\n"
- ."\n"
- .'> This parameter is returned only if the ChargeResourceMode parameter of the delivery group to which the app instance belongs is set to Node.'."\n",
- 'type' => 'string',
- 'example' => 'i-bp13********',
- ],
- 'ChargeType' => [
- 'description' => 'The billing method of the app instance. Valid values:'."\n"
- ."\n"
- .'* **PrePaid**: subscription.'."\n"
- .'* **PostPaid**: pay-as-you-go'."\n"
- ."\n"
- .'> This parameter is returned only if the ChargeResourceMode parameter of the delivery group to which the app instance belongs is set to Node.'."\n",
+ 'NodeInstanceType' => [
+ 'description' => 'The ID of the resource specification type.',
+ 'enumValueTitles' => [],
'type' => 'string',
- 'enumValueTitles' => [
- 'PostPaid' => '',
- 'PrePaid' => '',
- ],
- 'example' => 'PostPaid',
+ 'example' => 'appstreaming.vgpu.4c8g.2g',
+ 'title' => '',
],
- 'NetworkInterfaceId' => [
+ 'NodeInstanceTypeFamily' => [
+ 'description' => 'The resource specification family.',
+ 'enumValueTitles' => ['appstreaming.general' => '无影-通用型', 'appstreaming.vgpu' => '无影-图形型'],
'type' => 'string',
+ 'example' => 'appstreaming.vgpu',
+ 'title' => '',
],
+ 'Cpu' => ['description' => 'The number of vCPUs.', 'type' => 'string', 'example' => '4', 'title' => ''],
+ 'Gpu' => ['description' => 'The number of GPUs.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ 'Memory' => ['description' => 'The memory size. Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '8192', 'title' => ''],
+ 'GpuMemory' => ['description' => 'The GPU memory size. Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '8192', 'title' => ''],
+ 'MaxCapacity' => ['description' => 'The maximum number of concurrent sessions, which is the number of sessions that can be simultaneously connected to a single resource. If too many sessions are connected simultaneously, the application experience may degrade. The valid values vary depending on the resource specification. The valid values for each resource specification are as follows:'."\n"
+ ."\n"
+ .'- appstreaming.general.2c4g: 1'."\n"
+ .'- appstreaming.general.4c8g: 1 to 2'."\n"
+ .'- appstreaming.general.8c16g: 1 to 4'."\n"
+ .'- appstreaming.vgpu.8c16g.4g: 1 to 4'."\n"
+ .'- appstreaming.vgpu.8c31g.16g: 1 to 4'."\n"
+ .'- appstreaming.vgpu.14c93g.12g: 1 to 7'."\n"
+ .'- appstreaming.vgpu.4c10g.2gt4: 1 to 2'."\n"
+ .'- appstreaming.vgpu.4c16g.2ga10: 1 to 2'."\n"
+ .'- appstreaming.vgpu.8c16g.4g: 1 to 4'."\n"
+ .'- appstreaming.vgpu.8c31g.16g: 1 to 4'."\n"
+ .'- appstreaming.vgpu.8c16g.4gt4: 1 to 4'."\n"
+ .'- appstreaming.vgpu.8c32g.4ga10: 1 to 4'."\n"
+ .'- appstreaming.vgpu.12c46g.11g28: 1 to 6'."\n"
+ .'- appstreaming.vgpu.14c93g.12g: 1 to 7'."\n"
+ .'- appstreaming.vgpu.16c32g.8g: 1 to 8'."\n"
+ .'- appstreaming.vgpu.16c62g.8ga10: 1 to 8.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'NodeTypeName' => ['description' => 'The name of the resource specification.', 'type' => 'string', 'example' => '无影-通用型_4核8G', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 18,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"AppInstanceModels\\": [\\n {\\n \\"AppInstanceId\\": \\"ai-8dl7dzchklmka****\\",\\n \\"AppInstanceGroupId\\": \\"aig-dk8p95irqfst9****\\",\\n \\"Status\\": \\"BOUND\\",\\n \\"MainEthPublicIp\\": \\"10.13.13.211\\",\\n \\"NetworkInterfaceIp\\": \\"\\",\\n \\"GmtCreate\\": \\"2023-03-07T20:29:19.000+08:00\\",\\n \\"GmtModified\\": \\"2023-03-07T20:29:19.000+08:00\\",\\n \\"SessionStatus\\": \\"connect\\",\\n \\"BindInfo\\": {\\n \\"EndUserId\\": \\"app.test\\",\\n \\"UsageDuration\\": 2000\\n },\\n \\"NodeId\\": \\"i-bp13********\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"NetworkInterfaceId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListAppInstances',
- ],
- 'DeleteAppInstances' => [
- 'summary' => 'Deletes an application instance.',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => 'Query resource specifications',
+ 'summary' => 'Queries the resource specifications available for selection when creating a delivery group.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeInstanceType'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListNodeInstanceType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 6,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"NodeInstanceTypeModels\\": [\\n {\\n \\"NodeInstanceType\\": \\"appstreaming.vgpu.4c8g.2g\\",\\n \\"NodeInstanceTypeFamily\\": \\"appstreaming.vgpu\\",\\n \\"Cpu\\": \\"4\\",\\n \\"Gpu\\": \\"2\\",\\n \\"Memory\\": 8192,\\n \\"GpuMemory\\": 8192,\\n \\"MaxCapacity\\": 4,\\n \\"NodeTypeName\\": \\"无影-通用型_4核8G\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListNodes' => [
+ 'summary' => 'Queries the list of resource nodes.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '265984',
+ 'abilityTreeNodes' => ['FEATUREappstreamingEP3FXS'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The number of query results per page. Valid values: 1 to 200.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The page number of the query results to display, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-53fvrq1oanz6c****', 'title' => ''],
+ ],
+ [
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
'example' => 'CloudApp',
+ 'title' => '',
],
],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'PerPageSize' => ['description' => 'The page size of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'ToPage' => ['description' => 'The page number of the currently returned data.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Count' => ['description' => 'The total number of entries that can be returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'NodeModels' => [
+ 'description' => 'The list of resource nodes.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeId' => ['description' => 'The resource node ID.'."\n"
+ .'> This parameter is returned only when the billing mode of the delivery group is per-resource billing (ChargeResourceMode=Node).', 'type' => 'string', 'example' => 'i-bp13********', 'title' => ''],
+ 'ChargeType' => [
+ 'description' => 'The billing type of the resource node.'."\n"
+ ."\n"
+ .'> This parameter is returned only when the billing mode of the delivery group is per-resource billing (ChargeResourceMode=Node).',
+ 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go.', 'PrePaid' => 'subscription.'],
+ 'type' => 'string',
+ 'example' => 'PostPaid',
+ 'title' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PerPageSize\\": 10,\\n \\"ToPage\\": 1,\\n \\"Count\\": 100,\\n \\"NodeModels\\": [\\n {\\n \\"NodeId\\": \\"i-bp13********\\",\\n \\"ChargeType\\": \\"PostPaid\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query resource node list',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListNodes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListOtaTask' => [
+ 'summary' => 'Queries the history of over-the-air updates.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The number of query results per page. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The page number of the query results to display.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
[
'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the delivery group. You can call the [listAppInstanceGroup](~~428506~~) operation to obtain the ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
+ 'schema' => ['title' => '', 'description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-53fvrq1oanz6c****'],
],
[
- 'name' => 'AppInstanceIds',
+ 'name' => 'OtaType',
'in' => 'formData',
- 'style' => 'repeatList',
'schema' => [
- 'description' => 'The IDs of application instances.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the application instance.'."\n"
- ."\n"
- .'> This parameter is available only for specific customers.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ai-gbuea*****',
- ],
+ 'title' => '',
+ 'description' => 'The type of the over-the-air update task.',
+ 'enumValueTitles' => ['Fota' => 'Wuying system component update.'],
+ 'type' => 'string',
'required' => true,
- 'maxItems' => 100,
- 'minItems' => 1,
+ 'enum' => ['Fota', 'ImageUpdate', 'AppUpdate'],
+ 'example' => 'Fota',
],
],
],
@@ -7869,75 +7898,70 @@
200 => [
'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'DeleteAppInstanceModels' => [
- 'description' => 'The data returned.'."\n",
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'TotalCount' => ['description' => 'The total number of over-the-air update tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''],
+ 'PageSize' => ['title' => '', 'description' => 'The number of query results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['title' => '', 'description' => 'The page number of the query results to display.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TaskList' => [
+ 'title' => '',
+ 'description' => 'The list of over-the-air update tasks.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The over-the-air update task.',
'type' => 'object',
'properties' => [
- 'AppInstanceId' => [
- 'description' => 'The ID of the application instance.'."\n",
- 'type' => 'string',
- 'example' => 'ai-gbuea*****'."\n",
- ],
- 'Success' => [
- 'description' => 'Specifies whether the application instance is deleted.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => 'The error code.'."\n",
- 'type' => 'string',
- 'example' => 'InvalidParameter.ProductType',
- ],
- 'Message' => [
- 'description' => 'The error message.'."\n",
+ 'OtaVersion' => ['title' => '', 'description' => 'The OTA version.', 'type' => 'string', 'example' => '0.0.1-R-20220708.110604'],
+ 'TaskDisplayStatus' => [
+ 'title' => '',
+ 'description' => 'The task status.',
+ 'enumValueTitles' => ['FAILED' => 'Update failed.', 'RUNNING' => 'Update in progress.', 'TERMINATED' => 'Update stopped.', 'PART_FINISHED' => 'Update partially succeeded.', 'STANDBY' => 'Waiting for update.', 'FINISHED' => 'Update succeeded.'],
'type' => 'string',
- 'example' => 'The parameter ProductType is invalid.',
+ 'enum' => ['STANDBY', 'RUNNING', 'FAILED', 'TERMINATED', 'FINISHED', 'PART_FINISHED'],
+ 'example' => 'RUNNING',
],
+ 'TaskStartTime' => ['title' => '', 'description' => 'The task start time in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2022-08-04T14:36:00+08:00'],
+ 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'ota-be7jzm29wrrz5****'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Query over-the-air update history',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOtaTask'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DeleteAppInstanceModels\\": [\\n {\\n \\"AppInstanceId\\": \\"ai-gbuea*****\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'DeleteAppInstances',
- 'description' => 'Only application instances that are in the Initializing or Idle state can be deleted. The operation can be called only by specific customers.'."\n",
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 6,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TaskList\\": [\\n {\\n \\"OtaVersion\\": \\"0.0.1-R-20220708.110604\\",\\n \\"TaskDisplayStatus\\": \\"RUNNING\\",\\n \\"TaskStartTime\\": \\"2022-08-04T14:36:00+08:00\\",\\n \\"TaskId\\": \\"ota-be7jzm29wrrz5****\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListPersistentAppInstances' => [
- 'summary' => 'Queries app instances of the persistent session type in a delivery group.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Queries the list of persistent session application instances in a delivery group.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7950,9 +7974,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '268317',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -7961,979 +7983,837 @@
'name' => 'ProductType',
'in' => 'query',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n"
- .'* CloudBrowser: Cloud-based Browser'."\n"
- .'* AndroidCloud: Cloud Phone'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'cloud application.', 'CloudBrowser' => 'cloud browser.', 'AndroidCloud' => 'cloud phone.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- 'CloudBrowser' => '',
- 'AndroidCloud' => '',
- ],
'example' => 'CloudApp',
+ 'title' => '',
],
],
[
'name' => 'AppInstanceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-0bxls9m9arax6****',
- ],
+ 'schema' => ['description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-0bxls9m9arax6****', 'title' => ''],
],
[
'name' => 'AppInstancePersistentIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The IDs of the persistent sessions.'."\n",
+ 'description' => 'The list of persistent session IDs.',
'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the persistent session.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'p-0cc7s3mw2fg4j****',
- ],
+ 'items' => ['description' => 'The persistent session ID.', 'type' => 'string', 'required' => true, 'example' => 'p-0cc7s3mw2fg4j****', 'title' => ''],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. The value cannot be greater than **100**. Default value: **20**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
- ],
+ 'schema' => ['description' => 'The number of query results per page. Maximum value: **100**. Default value: **20**.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Pages start from page **1**. Default value: **1**.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The page number of the query results to display. Minimum value: **1**. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response body.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '15',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of query results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the query results currently displayed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PersistentAppInstanceModels' => [
- 'description' => 'The app instances of the persistent session type.'."\n",
+ 'description' => 'The list of persistent session application instances.',
'type' => 'array',
'items' => [
- 'description' => 'The app instance of the persistent session type.'."\n",
+ 'description' => 'The persistent session application instance information.',
'type' => 'object',
'properties' => [
- 'AppInstancePersistentId' => [
- 'description' => 'The ID of the app instance of the persistent session type.'."\n",
- 'type' => 'string',
- 'example' => 'p-0cc7s3mw2fg4j****',
- ],
- 'AppInstancePersistentName' => [
- 'description' => 'The name of the app instance of the persistent session type.'."\n",
- 'type' => 'string',
- 'example' => 'test-persistent-name',
- ],
+ 'AppInstancePersistentId' => ['description' => 'The persistent session ID.', 'type' => 'string', 'example' => 'p-0cc7s3mw2fg4j****', 'title' => ''],
+ 'AppInstancePersistentName' => ['description' => 'The name of the persistent session application instance.', 'type' => 'string', 'example' => 'test-persistent-name', 'title' => ''],
'AppInstancePersistentStatus' => [
- 'description' => 'The status of the app instance of the persistent session type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* STARTING'."\n"
- .'* RUNNING'."\n"
- .'* STOPPED'."\n"
- .'* UNAVAILABLE'."\n"
- .'* DELETING'."\n"
- .'* PENDING'."\n"
- .'* STOPPING'."\n"
- .'* DELETED'."\n"
- .'* REBUILDING'."\n",
+ 'description' => 'The instance status of the persistent session application.',
+ 'enumValueTitles' => ['STARTING' => 'starting.', 'RUNNING' => 'running.', 'STOPPED' => 'stopped.', 'UNAVAILABLE' => 'unavailable.', 'DELETING' => 'deleting.', 'PENDING' => 'creating.', 'STOPPING' => 'stopping.', 'DELETED' => 'deleted.', 'REBUILDING' => 'resetting.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'STARTING' => '',
- 'RUNNING' => '',
- 'STOPPED' => '',
- 'UNAVAILABLE' => '',
- 'DELETING' => '',
- 'PENDING' => '',
- 'STOPPING' => '',
- 'DELETED' => '',
- 'REBUILDING' => '',
- ],
'example' => 'RUNNING',
+ 'title' => '',
],
- 'AppInstanceGroupId' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'aig-0bxls9m9arax6****',
- ],
- 'AppInstanceId' => [
- 'description' => 'The ID of the app instance.'."\n",
- 'type' => 'string',
- 'example' => 'ai-azn3kmwruh1vl****',
- ],
+ 'AppInstanceGroupId' => ['description' => 'The delivery group ID.', 'type' => 'string', 'example' => 'aig-0bxls9m9arax6****', 'title' => ''],
+ 'AppInstanceId' => ['description' => 'The application instance ID.', 'type' => 'string', 'example' => 'ai-azn3kmwruh1vl****', 'title' => ''],
'AppInstanceStatus' => [
- 'description' => 'The status of the app instance.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* INIT: The app instance is being initialized.'."\n"
- .'* STARTING: The app instance is being started.'."\n"
- .'* CLOSING: The app instance is being stopped.'."\n"
- .'* CLOSED: The app instance is closed.'."\n"
- .'* RUNNING: The app instance is running.'."\n"
- .'* idle: The app instance is idle.'."\n"
- .'* BOUND: The app instance is bound to an app instance group.'."\n"
- .'* UNAVAILABLE: The app instance is unavailable.'."\n"
- .'* DELETED: The app instance is deleted.'."\n",
+ 'description' => 'The application instance status.',
+ 'enumValueTitles' => ['INIT' => 'initializing.', 'STARTING' => 'application starting.', 'CLOSING' => 'application stopping.', 'CLOSED' => 'application closed.', 'RUNNING' => 'application running.', 'IDLE' => 'idle.', 'BOUND' => 'bound.', 'UNAVAILABLE' => 'unavailable.', 'DELETED' => 'deleted.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'INIT' => '',
- 'STARTING' => '',
- 'CLOSING' => '',
- 'CLOSED' => '',
- 'RUNNING' => '',
- 'IDLE' => '',
- 'BOUND' => '',
- 'UNAVAILABLE' => '',
- 'DELETED' => '',
- ],
'example' => 'RUNNING',
+ 'title' => '',
],
- 'GmtCreate' => [
- 'description' => 'The time when the app instance was created.'."\n",
- 'type' => 'string',
- 'example' => '2025-03-13T03:22:18.000+00:00',
- ],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-03-13T03:22:18.000+00:00', 'title' => ''],
'AuthorizedUsers' => [
- 'description' => 'The authorized users.'."\n",
+ 'description' => 'The list of authorized usernames.',
'type' => 'array',
- 'items' => [
- 'description' => 'The name of the authorized user.'."\n",
- 'type' => 'string',
- 'example' => 'user-001',
- ],
+ 'items' => ['description' => 'The authorized username.', 'type' => 'string', 'example' => 'user-001', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PersistentAppInstanceModels\\": [\\n {\\n \\"AppInstancePersistentId\\": \\"p-0cc7s3mw2fg4j****\\",\\n \\"AppInstancePersistentName\\": \\"test-persistent-name\\",\\n \\"AppInstancePersistentStatus\\": \\"RUNNING\\",\\n \\"AppInstanceGroupId\\": \\"aig-0bxls9m9arax6****\\",\\n \\"AppInstanceId\\": \\"ai-azn3kmwruh1vl****\\",\\n \\"AppInstanceStatus\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2025-03-13T03:22:18.000+00:00\\",\\n \\"AuthorizedUsers\\": [\\n \\"user-001\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListPersistentAppInstances',
- ],
- 'GetConnectionTicket' => [
- 'summary' => 'Queries the credential that is used to connect to App Streaming.',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => 'Query persistent session application instances',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListPersistentAppInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListRegions' => [
+ 'summary' => 'Queries the regions supported by WUYING Cloud Application.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '169756',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ProductType',
- 'in' => 'formData',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n"
- .'* AndroidCloud: Cloud Phone'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- 'AndroidCloud' => '',
- ],
+ 'required' => false,
'example' => 'CloudApp',
+ 'title' => '',
],
],
[
- 'name' => 'EndUserId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the convenience account.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'alice',
- ],
+ 'name' => 'BizSource',
+ 'in' => 'query',
+ 'schema' => ['description' => '> This parameter is not publicly available.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
- [
- 'name' => 'BizRegionId',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The region ID.'."\n"
- ."\n"
- .'> If you configure this parameter, the system assigns application instances only among the delivery groups that reside in the specified region.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cn-shenzhen' => 'cn-shenzhen',
- 'cn-beijing' => 'cn-beijing',
- 'cn-shanghai' => 'cn-shanghai',
- 'cn-zhangjiakou' => 'cn-zhangjiakou',
- 'cn-hangzhou' => 'cn-hangzhou',
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'RegionModels' => [
+ 'description' => 'The list of region IDs.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The region ID.',
+ 'type' => 'object',
+ 'properties' => [
+ 'regionId' => [
+ 'description' => 'The region ID.',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
+ ],
+ ],
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The task ID.'."\n"
- ."\n"
- .'> This parameter is required for calls other than the first call to this operation. You can use this parameter to query the task status and connection credential.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '28778acb-a469-4bc0-8e0f****',
+ 'example' => '',
],
],
- [
- 'name' => 'AppId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The application ID.'."\n"
- ."\n"
- .'> This parameter is required for the first call to this operation and optional for subsequent calls to the operation.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ca-e4s0puhmwi7v****',
- ],
+ ],
+ 'title' => 'Query supported regions',
+ 'description' => '> The regions returned by this operation are not necessarily all available regions. For information about available regions, see [Supported regions](~~426036~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'],
],
+ ],
+ 'ramActions' => [
[
- 'name' => 'AppVersion',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The application version. If you configure this parameter, only an application of the specified version is started. If you do not configure this parameter, an application of a random authorized version is started.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.0',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListRegions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"RegionModels\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListTagCloudResources' => [
+ 'summary' => 'Queries the tag list of one or more specified cloud resources.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'AppStartParam',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The parameters that are configured to start the application. For information about how to obtain these parameters, see [Obtain parameters configured to install and start an application](~~426045~~).',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/q /n',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '266102',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'EnvironmentConfig',
+ 'name' => 'ResourceType',
'in' => 'formData',
'schema' => [
- 'title' => '环境配置。',
- 'description' => 'The environment configuration.'."\n",
+ 'title' => '',
+ 'description' => 'The cloud resource type.',
+ 'enumValueTitles' => ['AppId' => 'application ID.', 'WyId' => 'unique ID of the Wuying user.', 'AppInstanceGroupId' => 'delivery group ID.', 'AliUid' => 'tenant ID.'],
'type' => 'string',
- 'required' => false,
+ 'required' => true,
+ 'example' => 'AppInstanceGroupId',
],
],
[
- 'name' => 'AppInstanceGroupIdList',
+ 'name' => 'ResourceIds',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The delivery groups.'."\n"
- ."\n"
- .'> * If you configure this parameter, the system assigns application instances only among the specified authorized delivery groups. '."\n"
- .'> * This parameter is required if you configure `AppInstanceId` or `AppInstancePersistentId`.',
+ 'title' => '',
+ 'description' => 'The list of resource IDs. A maximum of 50 resource IDs are supported. You do not need to specify this parameter when the resource type is tenant ID.',
'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aig-4xz0oy8x4ipyv****',
- ],
+ 'items' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 1, 'example' => 'aig-001'],
'required' => false,
- 'maxItems' => 100,
+ 'maxItems' => 50,
+ 'minItems' => 0,
+ 'example' => '',
],
],
[
- 'name' => 'AppInstancePersistentId',
+ 'name' => 'Scope',
'in' => 'formData',
'schema' => [
- 'description' => 'The ID of the persistent session.'."\n",
+ 'title' => '',
+ 'description' => 'The tag type.',
+ 'enumValueTitles' => ['All' => 'all tags [default value].', 'Custom' => 'custom tag.', 'System' => 'system tag.'],
'type' => 'string',
+ 'example' => 'Custom',
+ 'maxLength' => 20,
+ 'minLength' => 0,
+ 'enum' => ['Custom', 'System', 'All'],
'required' => false,
- 'example' => 'p-0bxls9m3cl7s****',
],
],
[
- 'name' => 'AppInstanceId',
+ 'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the application instance.'."\n"
- ."\n"
- .'> * If you configure this parameter, the system attempts to assign only the specified application instance.'."\n"
- .'> * If you configure this parameter, you must also configure `AppInstanceGroupIdList` and the number of delivery groups specified by `AppInstanceGroupIdList` must be 1.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ai-1rznfnrvsa99d****',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.'."\n"
+ .'Maximum value: 1000. Default value: 50.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'example' => '50', 'default' => '50', 'required' => false],
],
[
- 'name' => 'AccessType',
+ 'name' => 'NextToken',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The token for the next query.', 'type' => 'string', 'required' => false, 'example' => 'ptnJAAAAAAAxNzE5OTEwNQ=='],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '接入类型,不传表示两种都显示。'."\n"
- .'取值范围:'."\n"
- .'互联网:INTERNET'."\n"
- .'专线:VPC',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'INTERNET',
- 'maxLength' => 10,
- 'minLength' => 0,
- 'default' => 'INTERNET',
- 'enum' => [
- 'INTERNET',
- 'VPC',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'NextToken' => ['title' => '', 'description' => 'The token that determines whether the next query exists based on the NextToken value.', 'type' => 'string', 'example' => 'AAAAAYRHtOLVQzCYj17y+OP7LZRrUJaF4rnBGQkWwMiVHlLZBB1w3Us37CVvhvyM0TXavA=='],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '15'],
+ 'ResourceTags' => [
+ 'title' => '',
+ 'description' => 'The list of tags bound to the resources.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The tag information bound to the resource.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => [
+ 'title' => '',
+ 'description' => 'The cloud resource type.',
+ 'enumValueTitles' => ['AppId' => 'application ID.', 'WyId' => 'unique ID of the Wuying user.', 'AppInstanceGroupId' => 'delivery group ID.', 'AliUid' => 'tenant ID.'],
+ 'type' => 'string',
+ 'example' => 'AppInstanceGroupId',
+ ],
+ 'ResourceId' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'example' => 'aig-0001'],
+ 'Tags' => [
+ 'title' => '',
+ 'description' => 'The list of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The tag information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'Resolution'],
+ 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => '1080p'],
+ 'Scope' => [
+ 'title' => '',
+ 'description' => 'The tag type.',
+ 'enumValueTitles' => ['Custom' => 'custom tag.', 'System' => 'system tag.'],
+ 'type' => 'string',
+ 'example' => 'Custom',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'Service unavailable. Please try again later.', 'description' => 'Service unavailable. Please try again later.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"AAAAAYRHtOLVQzCYj17y+OP7LZRrUJaF4rnBGQkWwMiVHlLZBB1w3Us37CVvhvyM0TXavA==\\",\\n \\"TotalCount\\": 15,\\n \\"ResourceTags\\": [\\n {\\n \\"ResourceType\\": \\"AppInstanceGroupId\\",\\n \\"ResourceId\\": \\"aig-0001\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Resolution\\",\\n \\"Value\\": \\"1080p\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query tags of cloud resources',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'AppPolicyId',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListTagCloudResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
+ ],
+ 'ListTenantConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'TaskStatus' => [
- 'description' => 'The task status.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Finished: The task is complete.'."\n"
- .'* Failed: The task failed.'."\n"
- .'* Running: The task is being executed.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Finished' => '',
- 'Failed' => '',
- 'Running' => '',
- ],
- 'example' => 'Running',
- ],
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'string',
- 'example' => 'f3d1b31c-605e-4d04-a896****',
- ],
- 'BizRegionId' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'Ticket' => [
- 'description' => 'The credential that is used to connect to App Streaming.'."\n"
- ."\n"
- .'> This parameter is displayed for calls other than the first call to this operation.'."\n",
- 'type' => 'string',
- 'example' => 'DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****',
- ],
- 'AppInstanceGroupId' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'aig-53fvrq1oan****',
- ],
- 'AppInstancePersistentId' => [
- 'description' => 'The ID of the persistent session.'."\n",
- 'type' => 'string',
- 'example' => 'p-0bxls9m3cl7s****',
- ],
- 'AppInstanceId' => [
- 'description' => 'The ID of the application instance.'."\n",
- 'type' => 'string',
- 'example' => 'ai-7ybdeiyoeh5e****',
- ],
- 'OsType' => [
- 'description' => 'The operating system.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* Windows: the Windows operating system'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Windows' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ 'TenantConfigModel' => [
+ 'description' => 'The user configuration information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppInstanceGroupExpireRemind' => [
+ 'description' => 'Indicates whether resource expiration reminders are enabled. Valid values:'."\n"
+ ."\n"
+ .'- true: Enabled.'."\n"
+ .'- false: Not enabled.',
+ 'enumValueTitles' => ['true' => 'Enabled.', 'false' => 'Not enabled.'],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ 'MultiSessionSupportType' => [
+ 'type' => 'string',
+ 'example' => 'None',
+ 'maxLength' => 16,
+ 'minLength' => 0,
+ 'default' => 'None',
+ 'enum' => ['All', 'Specific', 'None'],
+ 'description' => '',
+ 'title' => '',
+ ],
+ 'MultiSessionSupportedRegions' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
],
- 'example' => 'Windows',
- ],
- 'TenantId' => [
- 'description' => 'The ID of the Alibaba Cloud account.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '148871678899****',
- ],
- 'AvatarId' => [
- 'title' => '分身ID。',
- 'description' => 'The avatar ID.'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"Running\\",\\n \\"TaskId\\": \\"f3d1b31c-605e-4d04-a896****\\",\\n \\"BizRegionId\\": \\"cn-hangzhou\\",\\n \\"Ticket\\": \\"DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****\\",\\n \\"AppInstanceGroupId\\": \\"aig-53fvrq1oan****\\",\\n \\"AppInstancePersistentId\\": \\"p-0bxls9m3cl7s****\\",\\n \\"AppInstanceId\\": \\"ai-7ybdeiyoeh5e****\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"TenantId\\": 0,\\n \\"AvatarId\\": \\"\\"\\n}","type":"json"}]',
- 'title' => 'GetConnectionTicket',
- 'description' => 'You must call this operation at least twice to obtain a connection credential.'."\n"
- ."\n"
- .'The first time you call this operation, the system assigns an application instance to the specified convenience account and then starts the application. In this case, the ID of the started task, which is indicated by `TaskID`, is returned.'."\n"
- ."\n"
- .'In subsequent calls, you must configure `TaskID` to query whether the task is completed. If the value of `TaskStatus` in the response is `Finished`, the connection credential, which is indicated by `Ticket`, is returned.'."\n",
- ],
- 'Unbind' => [
- 'summary' => 'Unbinds a user and a session.',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => 'Query administrator account configuration information',
+ 'summary' => 'Queries the configuration information of an administrator account, such as whether resource expiration reminders are enabled.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTenantConfig'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListTenantConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TenantConfigModel\\": {\\n \\"AppInstanceGroupExpireRemind\\": true,\\n \\"MultiSessionSupportType\\": \\"None\\",\\n \\"MultiSessionSupportedRegions\\": [\\n \\"\\"\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ListWuyingServer' => [
+ 'summary' => 'Queries the list of workstations.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'ProductType',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '100', 'default' => '20', 'required' => false],
],
[
- 'name' => 'EndUserId',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The username.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'alice',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false],
],
[
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'ProductType',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the delivery group. You can call the [GetConnectionTicket](~~GetConnectionTicket~~) operation to obtain the ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
+ 'schema' => ['title' => '', 'type' => 'string', 'example' => 'wuying_server', 'description' => ''],
],
[
- 'name' => 'AppInstancePersistentId',
+ 'name' => 'BizType',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the persistent session. You can call the [GetConnectionTicket](~~GetConnectionTicket~~) operation to obtain the ID.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'p-0bxls9m3cl7s****',
- ],
+ 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''],
],
[
- 'name' => 'AppInstanceId',
+ 'name' => 'WuyingServerNameOrId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The session ID. You can call the [GetConnectionTicket](~~GetConnectionTicket~~) operation to obtain the ID.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ai-d297eyf83g5ni****',
- ],
+ 'schema' => ['title' => '', 'description' => 'The workstation name or workstation ID.', 'type' => 'string', 'example' => 'exampleServerName', 'required' => false],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'WuyingServerIdList',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- ],
+ 'description' => 'The list of workstation IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The workstation ID.', 'type' => 'string', 'required' => false, 'example' => 'ws-0bydg****2lwi', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => 'aig-bp1234567890abcde',
],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'Unbind',
- ],
- 'ListBindInfo' => [
- 'summary' => 'Queries the bindings between users and resources.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'ServerInstanceType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The workstation instance type.', 'type' => 'string', 'example' => 'eds.proworkstation_flagship_elite.32c64g.48g1x', 'required' => false],
],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '262111',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingV87T4P',
+ [
+ 'name' => 'ImageId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The image ID.', 'type' => 'string', 'example' => 'img-bp13mu****', 'required' => false],
],
- ],
- 'parameters' => [
[
- 'name' => 'UserIdList',
+ 'name' => 'BizRegionId',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The user IDs. You can specify 1 to 100 IDs.'."\n"
- ."\n"
- .'> If you specify this parameter, only the bindings of the specified users are returned.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The user ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Alice',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'required' => false],
],
[
- 'name' => 'WyIdList',
+ 'name' => 'OfficeSiteId',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The IDs of the Alibaba Cloud Workspace users. You can specify 1 to 100 IDs.'."\n"
- ."\n"
- .'> If you specify this parameter, only the bindings of the specified Alibaba Cloud Workspace users are returned.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the Alibaba Cloud Workspace user.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2ca6f5a93536****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['title' => '', 'description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-172301****', 'required' => false],
],
[
- 'name' => 'AppInstanceGroupIdList',
+ 'name' => 'ChargeType',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The IDs of the delivery groups. You can specify 1 to 100 IDs.'."\n"
- ."\n"
- .'> If you specify this parameter, only the bindings of the specified delivery groups are returned.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aig-4xz0oy8x4ipyv****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['title' => '', 'description' => 'The billing type.', 'type' => 'string', 'example' => 'PrePaid', 'required' => false],
],
[
- 'name' => 'AppInstanceIdList',
+ 'name' => 'VirtualNodePoolId',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The IDs of app instances. You can specify 1 to 100 IDs.'."\n"
- ."\n"
- .'> If you specify this parameter, only the bindings of the specified app instances are returned.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the app instance.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ai-azn3kmwruh1vl****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['title' => '', 'description' => 'The virtual node pool ID.', 'type' => 'string', 'example' => 'vnp-bp1234567890abcde', 'required' => false],
],
[
- 'name' => 'AppIdList',
+ 'name' => 'AddVirtualNodePoolStatusList',
'in' => 'formData',
- 'style' => 'repeatList',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'The app IDs. You can specify 1 to 100 IDs.'."\n"
- ."\n"
- .'> If you specify this parameter, only the bindings of the specified apps are returned.'."\n",
'type' => 'array',
- 'items' => [
- 'description' => 'The app ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ca-fq738or6vd854****',
- ],
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'required' => false,
- 'maxItems' => 100,
+ 'title' => '',
+ 'example' => 'Added',
+ 'description' => 'The list of statuses for joining a virtual node pool.',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Status',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The number of entries per page. The value cannot be greater than `100`. Default value: `20`. We recommend that you specify this parameter.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '20',
- ],
+ 'schema' => ['title' => '', 'description' => 'The workstation status.', 'type' => 'string', 'example' => 'RUNNING', 'required' => false],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'Users',
'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'The page number. Default value: `1`. We recommend that you specify this parameter.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
+ 'title' => '',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'example' => 'user1',
+ 'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'AD2D0761-1FE5-549D-B169-D3F8D19C****',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '15',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'BindInfoModels' => [
- 'description' => 'The bindings.'."\n",
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '15'],
+ 'PageSize' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'WuyingServerList' => [
+ 'description' => 'The list of workstation information.',
'type' => 'array',
'items' => [
- 'description' => 'The binding.'."\n",
'type' => 'object',
'properties' => [
- 'AppId' => [
- 'description' => 'The app ID.'."\n",
- 'type' => 'string',
- 'example' => 'ca-fq738or6vd854****',
+ 'AliUid' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123456', 'description' => ''],
+ 'WuyingServerId' => ['title' => '', 'description' => 'The workstation ID.', 'type' => 'string', 'example' => 'ws-0byd****8wn2lwi'],
+ 'WuyingServerName' => ['title' => '', 'description' => 'The workstation name.', 'type' => 'string', 'example' => 'exampleServerName'],
+ 'Status' => ['title' => '', 'description' => 'The workstation status.', 'type' => 'string', 'example' => 'RUNNING'],
+ 'ServerInstanceTypeInfo' => [
+ 'description' => 'The instance type information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ServerInstanceType' => ['title' => '', 'description' => 'The workstation instance type.', 'type' => 'string', 'example' => 'eds.proworkstation_flagship_elite_ne.96c384g.192g4x'],
+ 'Cpu' => ['title' => '', 'description' => 'The number of vCPUs.', 'type' => 'string', 'example' => '96'],
+ 'Memory' => ['title' => '', 'description' => 'The memory size. Unit: MB.', 'type' => 'integer', 'format' => 'int32', 'example' => '393,216'],
+ 'Gpu' => ['title' => '', 'description' => 'The number of GPUs.', 'type' => 'string', 'example' => '4'],
+ 'GpuMemory' => ['title' => '', 'description' => 'The GPU memory size. Unit: MB.', 'type' => 'integer', 'format' => 'int32', 'example' => '196,608'],
+ 'GpuSpec' => ['title' => '', 'type' => 'string', 'example' => 'NVIDIA T4', 'description' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'AppVersion' => [
- 'description' => 'The app version.'."\n",
- 'type' => 'string',
- 'example' => '1.0',
+ 'SystemDiskSize' => ['title' => '', 'description' => 'The system cloud disk size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'SystemDiskCategory' => ['title' => '', 'description' => 'The system cloud disk type.', 'type' => 'string', 'example' => 'cloud_auto'],
+ 'SystemDiskPerformanceLevel' => ['title' => '', 'description' => 'The performance level of the system cloud disk.', 'type' => 'string', 'example' => 'PL0'],
+ 'DataDisk' => [
+ 'description' => 'The list of data cloud disks.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data cloud disk information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataDiskSize' => ['title' => '', 'description' => 'The data cloud disk size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'DataDiskCategory' => ['title' => '', 'description' => 'The data cloud disk type.', 'type' => 'string', 'example' => 'cloud_auto'],
+ 'DataDiskPerformanceLevel' => ['title' => '', 'description' => 'The performance level of the data cloud disk.', 'type' => 'string', 'example' => 'PL0'],
+ 'DataDiskId' => ['title' => '', 'type' => 'string', 'example' => 'd-bp1234567890abcde', 'description' => ''],
+ 'DataDiskNo' => ['title' => '', 'type' => 'string', 'example' => '1', 'description' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'RegionId' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-shanghai',
+ 'ImageId' => ['title' => '', 'description' => 'The image ID.', 'type' => 'string', 'example' => 'imgc-06****oagaev'],
+ 'ImageName' => ['title' => '', 'description' => 'The image name.', 'type' => 'string', 'example' => 'Alibaba Cloud Linux 3.2104 LTS 64位'],
+ 'OsType' => ['title' => '', 'description' => 'The operating system type.', 'type' => 'string', 'example' => 'Linux'],
+ 'BizRegionId' => ['title' => '', 'description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'OfficeSiteId' => ['title' => '', 'description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-1b****ayv2'],
+ 'OfficeSiteName' => ['title' => '', 'description' => 'The office network name.', 'type' => 'string', 'example' => 'exampleOfficeSite'],
+ 'OfficeSiteType' => ['title' => '', 'description' => 'The office network type.', 'type' => 'string', 'example' => 'SIMPLE'],
+ 'NetworkInterfaceIp' => ['title' => '', 'description' => 'The internal IP address.', 'type' => 'string', 'example' => '10.80.21.149'],
+ 'ChargeType' => ['title' => '', 'description' => 'The billing method.', 'type' => 'string', 'example' => 'PrePaid'],
+ 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-08-02T16:52:11.000+00:00'],
+ 'ExpiredTime' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'string', 'example' => '2025-09-03T16:00:00.000+00:00'],
+ 'VirtualNodePoolId' => ['title' => '', 'description' => 'The virtual node pool ID.', 'type' => 'string', 'example' => 'vnp-bp1234567890abcde'],
+ 'AddVirtualNodePoolStatus' => ['title' => '', 'description' => 'The status of joining a virtual node pool.', 'type' => 'string', 'example' => 'Added'],
+ 'SubPayType' => ['title' => '', 'type' => 'string', 'example' => 'spot', 'description' => ''],
+ 'MaxPrice' => ['title' => '', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'description' => ''],
+ 'VirtualKubeletIp' => ['title' => '', 'type' => 'string', 'example' => '10.0.0.100', 'description' => ''],
+ 'ResourceSessionStatus' => ['title' => '', 'type' => 'string', 'example' => 'Connected', 'description' => ''],
+ 'Bandwidth' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'description' => ''],
+ 'FotaVersion' => ['title' => '', 'type' => 'string', 'example' => '2.0.0', 'description' => ''],
+ 'TimerGroupId' => ['title' => '', 'type' => 'string', 'example' => 'tg-bp1234567890abcde', 'description' => ''],
+ 'SystemDiskId' => ['title' => '', 'type' => 'string', 'example' => 'd-bp1234567890abcde', 'description' => ''],
+ 'InstanceInfoList' => [
+ 'description' => 'The list of workstation instance information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'p-0ceitx****c5'],
+ 'NetworkInterfaceId' => ['title' => '', 'description' => 'The network interface controller (NIC) ID.', 'type' => 'string', 'example' => 'eni-uf65b****dfnt3wb'],
+ ],
+ 'title' => '',
+ 'description' => 'The instance information.',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'UserId' => [
- 'description' => 'The user ID.'."\n",
- 'type' => 'string',
- 'example' => 'Alice',
+ 'SecurityGroupIds' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'description' => 'The list of security group IDs.',
+ 'example' => '',
],
- 'WyId' => [
- 'description' => 'The ID of the Alibaba Cloud Workspace user.'."\n",
- 'type' => 'string',
- 'example' => '2ca6f5a93536****',
+ 'Users' => [
+ 'title' => '',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'example' => '',
],
- 'AccountType' => [
- 'description' => 'The account type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* ad: Active Directory (AD) account'."\n"
- .'* simple: convenience account'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'ad' => 'ad',
- 'simple' => 'simple',
+ 'Sessions' => [
+ 'title' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceSessionStartTime' => ['title' => '', 'type' => 'string', 'example' => '2026-01-01T08:00:00Z', 'description' => ''],
+ 'UserId' => ['title' => '', 'type' => 'string', 'example' => 'user1', 'description' => ''],
+ ],
+ 'description' => '',
+ 'example' => '',
],
- 'example' => 'simple',
- ],
- 'AppInstanceGroupId' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'aig-0abxhr6ce35w8****',
+ 'description' => '',
+ 'example' => '',
],
- 'AppInstanceId' => [
- 'description' => 'The ID of the app instance.'."\n",
- 'type' => 'string',
- 'example' => 'ai-83oe276fre4l3****',
+ 'PolicyGroupIdList' => [
+ 'title' => '',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'example' => '',
],
- 'ProductType' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n"
- .'* CloudBrowser: Cloud-based Browser'."\n"
- .'* AndroidCloud: Cloud Phone'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'CloudApp' => 'CloudApp',
- 'CloudBrowser' => 'CloudBrowser',
- 'AndroidCloud' => 'AndroidCloud',
+ 'VkVersion' => ['title' => '', 'type' => 'string', 'example' => '1.0.0', 'description' => ''],
+ 'VkUpgradeNeeded' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''],
+ 'EniPrivateIpAddressQuantity' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'description' => ''],
+ 'PrivateIpSets' => [
+ 'title' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'PrivateIpAddress' => ['title' => '', 'type' => 'string', 'example' => '10.0.0.1', 'description' => ''],
+ 'Primary' => ['title' => '', 'type' => 'boolean', 'example' => 'true', 'description' => ''],
+ ],
+ 'description' => '',
+ 'example' => '',
],
- 'example' => 'CloudApp',
+ 'description' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169-D3F8D19C****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"BindInfoModels\\": [\\n {\\n \\"AppId\\": \\"ca-fq738or6vd854****\\",\\n \\"AppVersion\\": \\"1.0\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"UserId\\": \\"Alice\\",\\n \\"WyId\\": \\"2ca6f5a93536****\\",\\n \\"AccountType\\": \\"simple\\",\\n \\"AppInstanceGroupId\\": \\"aig-0abxhr6ce35w8****\\",\\n \\"AppInstanceId\\": \\"ai-83oe276fre4l3****\\",\\n \\"ProductType\\": \\"CloudApp\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListBindInfo',
- ],
- 'CreateImageFromAppInstanceGroup' => [
- 'summary' => 'Creates a new image by debugging the delivery group.',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => 'Query workstations',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"WuyingServerList\\": [\\n {\\n \\"AliUid\\": 1234567890123456,\\n \\"WuyingServerId\\": \\"ws-0byd****8wn2lwi\\",\\n \\"WuyingServerName\\": \\"exampleServerName\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ServerInstanceTypeInfo\\": {\\n \\"ServerInstanceType\\": \\"eds.proworkstation_flagship_elite_ne.96c384g.192g4x\\",\\n \\"Cpu\\": \\"96\\",\\n \\"Memory\\": 0,\\n \\"Gpu\\": \\"4\\",\\n \\"GpuMemory\\": 0,\\n \\"GpuSpec\\": \\"NVIDIA T4\\"\\n },\\n \\"SystemDiskSize\\": 100,\\n \\"SystemDiskCategory\\": \\"cloud_auto\\",\\n \\"SystemDiskPerformanceLevel\\": \\"PL0\\",\\n \\"DataDisk\\": [\\n {\\n \\"DataDiskSize\\": 200,\\n \\"DataDiskCategory\\": \\"cloud_auto\\",\\n \\"DataDiskPerformanceLevel\\": \\"PL0\\",\\n \\"DataDiskId\\": \\"d-bp1234567890abcde\\",\\n \\"DataDiskNo\\": \\"1\\"\\n }\\n ],\\n \\"ImageId\\": \\"imgc-06****oagaev\\",\\n \\"ImageName\\": \\"Alibaba Cloud Linux 3.2104 LTS 64位\\",\\n \\"OsType\\": \\"Linux\\",\\n \\"BizRegionId\\": \\"cn-hangzhou\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-1b****ayv2\\",\\n \\"OfficeSiteName\\": \\"exampleOfficeSite\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"NetworkInterfaceIp\\": \\"10.80.21.149\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"CreateTime\\": \\"2025-08-02T16:52:11.000+00:00\\",\\n \\"ExpiredTime\\": \\"2025-09-03T16:00:00.000+00:00\\",\\n \\"VirtualNodePoolId\\": \\"vnp-bp1234567890abcde\\",\\n \\"AddVirtualNodePoolStatus\\": \\"Added\\",\\n \\"SubPayType\\": \\"spot\\",\\n \\"MaxPrice\\": 0.5,\\n \\"VirtualKubeletIp\\": \\"10.0.0.100\\",\\n \\"ResourceSessionStatus\\": \\"Connected\\",\\n \\"Bandwidth\\": 10,\\n \\"FotaVersion\\": \\"2.0.0\\",\\n \\"TimerGroupId\\": \\"tg-bp1234567890abcde\\",\\n \\"SystemDiskId\\": \\"d-bp1234567890abcde\\",\\n \\"InstanceInfoList\\": [\\n {\\n \\"InstanceId\\": \\"p-0ceitx****c5\\",\\n \\"NetworkInterfaceId\\": \\"eni-uf65b****dfnt3wb\\"\\n }\\n ],\\n \\"SecurityGroupIds\\": [\\n \\"\\"\\n ],\\n \\"Users\\": [\\n \\"\\"\\n ],\\n \\"Sessions\\": [\\n {\\n \\"ResourceSessionStartTime\\": \\"2026-01-01T08:00:00Z\\",\\n \\"UserId\\": \\"user1\\"\\n }\\n ],\\n \\"PolicyGroupIdList\\": [\\n \\"\\"\\n ],\\n \\"VkVersion\\": \\"1.0.0\\",\\n \\"VkUpgradeNeeded\\": false,\\n \\"EniPrivateIpAddressQuantity\\": 10,\\n \\"PrivateIpSets\\": [\\n {\\n \\"PrivateIpAddress\\": \\"10.0.0.1\\",\\n \\"Primary\\": true\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'LogOffAllSessionsInAppInstanceGroup' => [
+ 'summary' => 'Logs off all sessions in a pay-as-you-go delivery group that has scheduled auto scaling policies enabled.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
+ 'title' => '',
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'Wuying Cloud Application'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
'example' => 'CloudApp',
],
],
[
- 'name' => 'AppCenterImageName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The image name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_name',
- ],
- ],
- [
'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the delivery group. You can call the [ListAppInstanceGroup](~~428506~~) operation to obtain the ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
+ 'schema' => ['title' => '', 'description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The collection of returned information.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'ImageId' => [
- 'description' => 'The image ID.'."\n",
- 'type' => 'string',
- 'example' => 'img-bp13mu****',
- ],
+ 'Code' => ['description' => 'The error code returned when an error occurs.', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"ImageId\\": \\"img-bp13mu****\\"\\n}","type":"json"}]',
- 'title' => 'CreateImageFromAppInstanceGroup',
- ],
- 'GetDebugAppInstance' => [
- 'summary' => 'Queries information that is used to debug an application instance.',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => 'Log off all sessions in a delivery group',
+ 'description' => '> This operation is applicable only to pay-as-you-go resource delivery groups that have scheduled auto scaling policies enabled, and can be called successfully only outside the scaling time periods configured in the scheduled auto scaling policies.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LogOffAllSessionsInAppInstanceGroup'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:LogOffAllSessionsInAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyAppInstanceGroupAttribute' => [
+ 'summary' => 'Modifies the General Policy of a delivery group, including the number of concurrent sessions and the session retention duration after disconnection.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8941,2383 +8821,2096 @@
],
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '134213',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
'name' => 'ProductType',
- 'in' => 'formData',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The product type.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* CloudApp: App Streaming'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
'example' => 'CloudApp',
+ 'title' => '',
],
],
[
'name' => 'AppInstanceGroupId',
- 'in' => 'formData',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppInstanceGroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The delivery group name.', 'type' => 'string', 'required' => false, 'example' => '办公应用', 'title' => ''],
+ ],
+ [
+ 'name' => 'SessionTimeout',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The session retention duration after disconnection, in minutes. After an end user session is disconnected, the session is retained for the specified duration before being logged off. Set this parameter to `-1` to retain the session indefinitely. Valid values: -1 and 3 to 300. Default value: `15`.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '300', 'required' => false, 'example' => '15', 'title' => ''],
+ ],
+ [
+ 'name' => 'NodePool',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The ID of the delivery group. You can call the `listAppInstanceGroup` operation to obtain the ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
+ 'description' => 'The resource group object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodePoolId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-ew7va2g1wl3vm****', 'title' => ''],
+ 'NodeCapacity' => ['description' => 'The number of concurrent sessions, which is the number of sessions that can be simultaneously connected to a single resource. Too many simultaneous sessions may degrade the application experience. The valid value range varies by resource specification. You can call the ListNodeInstanceType operation to query the valid value range for each resource specification.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'StoragePolicy',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The storage policy.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'AppInstanceGroupId' => [
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
- 'AppInstanceId' => [
- 'description' => 'The ID of the application instance.'."\n",
- 'type' => 'string',
- 'example' => 'ai-7ybdeiyoeh5e****',
- ],
- 'AppId' => [
- 'description' => 'The application ID.'."\n",
- 'type' => 'string',
- 'example' => '__DEBUG_APP',
- ],
- 'UserId' => [
- 'description' => 'The user ID.'."\n",
- 'type' => 'string',
- 'example' => '__debug__',
+ 'StorageTypeList' => [
+ 'description' => 'The list of storage types.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The storage type.',
+ 'enumValueTitles' => ['OFF' => 'disabled.', 'PDS' => 'Drive and Photo Service.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PDS',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'AuthCode' => [
- 'description' => 'The authorization code. This authorization code is valid for 3 minutes and can be used only once, regardless of whether the authentication succeeds. If multiple authentication codes are generated for a user, only the latest authentication code takes effect.'."\n",
- 'type' => 'string',
- 'example' => 'e4e169bea1cc48e8afac53**********',
+ 'UserProfileFollow' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProfileFollowSwitch' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ 'FileSystemId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'AppVersion' => [
- 'description' => 'The ID of the application version.'."\n",
- 'type' => 'string',
- 'example' => '1.1',
+ 'UserProfile' => [
+ 'description' => 'The user data roaming configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserProfileSwitch' => [
+ 'description' => 'Specifies whether to enable user data roaming.',
+ 'enumValueTitles' => ['true' => 'Enabled.', 'false' => 'Disabled.'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
+ ],
+ 'FileSystemId' => ['description' => 'The ID of the user data storage system (NAS ID).', 'type' => 'string', 'required' => false, 'example' => '06ae94****', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AppInstanceGroupId\\": \\"aig-9ciijz60n4xsv****\\",\\n \\"AppInstanceId\\": \\"ai-7ybdeiyoeh5e****\\",\\n \\"AppId\\": \\"__DEBUG_APP\\",\\n \\"UserId\\": \\"__debug__\\",\\n \\"AuthCode\\": \\"e4e169bea1cc48e8afac53**********\\",\\n \\"AppVersion\\": \\"1.1\\"\\n}","type":"json"}]',
- 'title' => 'GetDebugAppInstance',
- 'responseParamsDescription' => 'You can concatenate a URL to obtain the connection information based on the response parameters. Example:'."\n"
- ."\n"
- .'`<https://wuying.aliyun.com/appMyBank>?AppId=__DEBUG_APP&AppVersion=1.0&AppInstanceGroupId=aig-5wfetbb7aovy8****&Env=online&AppInstanceId=ai-c7ruhxqww38ws****&AuthCode=acv2j%2BqjU3GAIBVOz33KxdcVyHJ58Dc2N2GC3ZpWNu9Q3zX84cxbNJcPX5enF%2BPePBEgBHxvF28QQcUOjgMk5tHgQKbe%2FUXbIDfg83vN7C3XMzkXo8ByHepfSLQwFLdP4S83zA327ugaB1w1pNnDwhbSvkfRmTA3JOc%2FNEqNs6w%2FePg5NmS4bRhodpYkb4wL****`'."\n"
- ."\n"
- .'> Replace `<https://wuying.aliyun.com/appMyBank>` based on your actual business.'."\n",
- ],
- 'ListOtaTask' => [
- 'summary' => 'Queries the information about over-the-air (OTA) update tasks.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'PageSize',
+ 'name' => 'SecurityPolicy',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '每页数量',
- 'description' => 'The number of entries to return on each page. Valid values: 1 to 100.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
+ 'description' => 'The security policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SkipUserAuthCheck' => [
+ 'description' => 'Specifies whether to skip user authorization verification.',
+ 'enumValueTitles' => ['true' => 'Skip verification.', 'false' => 'Perform verification. [Default].'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
+ ],
+ 'ResetAfterUnbind' => [
+ 'description' => 'Specifies whether to reset after unbinding.',
+ 'enumValueTitles' => ['true' => 'Reset.', 'false' => 'Do not reset.'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'PreOpenMode',
'in' => 'formData',
'schema' => [
- 'title' => '页码',
- 'description' => 'The page number of the page to return.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
+ 'description' => 'The pre-open mode.',
+ 'enumValueTitles' => ['SINGLE_APP' => 'pre-open a single application.', 'OFF' => 'disable pre-open [Default].'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'OFF',
+ 'title' => '',
],
],
[
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'PreOpenAppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '实例组id',
- 'description' => 'The ID of the delivery group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-53fvrq1oanz6c****',
- ],
+ 'schema' => ['description' => 'The AppId of the pre-open application. If the PreOpenMode parameter is set to `SINGLE_APP`, PreOpenAppId cannot be an empty string.', 'type' => 'string', 'required' => false, 'example' => 'ca-b2ronxxd****'."\n", 'title' => ''],
],
[
- 'name' => 'OtaType',
+ 'name' => 'PerSessionPerApp',
'in' => 'formData',
'schema' => [
- 'title' => 'ota类型,取值:'."\n"
- .'Fota : agent组件更新'."\n"
- .'ImageUpdate : 镜像更新'."\n"
- .'AppUpdate : 应用更新',
- 'description' => 'The type of the OTA update task.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Fota: update of the system components of Alibaba Cloud Workspace'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'Fota' => '',
- ],
- 'example' => 'Fota',
- 'enum' => [
- 'Fota',
- 'ImageUpdate',
- 'AppUpdate',
- ],
+ 'description' => 'Specifies whether to allow only one application per session.'."\n"
+ .'- If enabled, opening multiple applications within a delivery group allocates a separate session for each application, consuming more sessions.',
+ 'enumValueTitles' => ['true' => 'Enabled.', 'false' => 'Disabled.'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
],
],
- ],
- 'responses' => [
- 200 => [
- 'headers' => [],
+ [
+ 'name' => 'Network',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The network configuration.'."\n"
+ ."\n"
+ .'> To use this parameter, submit a ticket.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of OTA update tasks.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'PageSize' => [
- 'title' => '每页数量',
- 'description' => 'The number of entries on each page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'title' => '页码',
- 'description' => 'The page number of the returned page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TaskList' => [
- 'title' => 'AppInstanceGroupModels',
- 'description' => 'The OTA update tasks.'."\n",
+ 'DomainRules' => [
+ 'description' => 'The domain name rule configurations.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The domain name rule.',
'type' => 'object',
'properties' => [
- 'OtaVersion' => [
- 'title' => 'ota版本,格式举例:0.0.1-R-20220708.110604',
- 'description' => 'The OTA version.'."\n",
- 'type' => 'string',
- 'example' => '0.0.1-R-20220708.110604',
- ],
- 'TaskDisplayStatus' => [
- 'title' => '任务展示状态',
- 'description' => 'The task status.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* FAILED'."\n"
- .'* RUNNING'."\n"
- .'* TERMINATED'."\n"
- .'* PART_FINISHED'."\n"
- .'* STANDBY'."\n"
- .'* FINISHED'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'FAILED' => '',
- 'RUNNING' => '',
- 'TERMINATED' => '',
- 'PART_FINISHED' => '',
- 'STANDBY' => '',
- 'FINISHED' => '',
- ],
- 'example' => 'RUNNING',
- 'enum' => [
- 'STANDBY',
- 'RUNNING',
- 'FAILED',
- 'TERMINATED',
- 'FINISHED',
- 'PART_FINISHED',
- ],
- ],
- 'TaskStartTime' => [
- 'title' => '任务开始时间,ISO-8601格式',
- 'description' => 'The start time of the OTA update task. The time follows the ISO 8601 standard.'."\n",
- 'type' => 'string',
- 'format' => 'iso8601',
- 'example' => '2022-08-04T14:36:00+08:00',
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => 'The task ID.'."\n",
+ 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'required' => false, 'example' => 'www.example.com', 'title' => ''],
+ 'Policy' => [
+ 'description' => 'The policy value.',
+ 'enumValueTitles' => ['allow' => 'Allow access.', 'block' => 'Block access.'],
'type' => 'string',
- 'example' => 'ota-be7jzm29wrrz5****',
+ 'required' => false,
+ 'example' => 'block',
+ 'title' => '',
],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 6,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TaskList\\": [\\n {\\n \\"OtaVersion\\": \\"0.0.1-R-20220708.110604\\",\\n \\"TaskDisplayStatus\\": \\"RUNNING\\",\\n \\"TaskStartTime\\": \\"2022-08-04T14:36:00+08:00\\",\\n \\"TaskId\\": \\"ota-be7jzm29wrrz5****\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListOtaTask',
- ],
- 'GetOtaTaskByTaskId' => [
- 'summary' => 'Queries the details of an over-the-air (OTA) update task, including the available versions and version description.',
- 'methods' => [
- 'get',
- 'post',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Code' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Modify General Policy of a delivery group',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAppInstanceGroupAttribute'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyAppInstanceGroupAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyAppPolicy' => [
+ 'summary' => 'Modifies the display policy of a delivery group, including settings such as frame rate, resolution, and protocol type.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'TaskId',
- 'in' => 'formData',
+ 'name' => 'ProductType',
+ 'in' => 'query',
'schema' => [
- 'title' => 'ota任务id',
- 'description' => 'The ID of the OTA update task. You can call the [ListAppInstanceGroup](~~428506~~) operation to obtain the ID.'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
'required' => true,
- 'example' => 'ota-be7jzm29wrrz5****',
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'AppPolicyId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-ee2znjktwgxu2****', 'title' => ''],
+ ],
+ [
+ 'name' => 'VideoPolicy',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The display policy.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => 'The error code.'."\n",
- 'type' => 'string',
- 'example' => 'OtaTask.Running',
+ 'FrameRate' => [
+ 'description' => 'The frame rate (FPS).',
+ 'enumValueTitles' => [30 => '30 FPS', 60 => '60 FPS'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '60',
+ 'title' => '',
],
- 'Message' => [
- 'title' => '提示',
- 'description' => 'The error message.'."\n",
- 'type' => 'string',
- 'example' => 'The task is running and cannot be sumitted.',
+ 'TerminalResolutionAdaptive' => [
+ 'description' => 'Specifies whether to use adaptive resolution.'."\n"
+ ."\n"
+ .'- `true`: The session resolution follows changes in the terminal display area. In this case, SessionResolutionWidth and SessionResolutionHeight specify the maximum resolution values.'."\n"
+ ."\n"
+ .'- `false`: The session resolution does not follow changes in the terminal display area. In this case, the resolution is fixed to the values of SessionResolutionWidth and SessionResolutionHeight.',
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'title' => '',
],
- 'ReleaseNote' => [
- 'title' => '版本说明',
- 'description' => 'The version description.'."\n",
+ 'SessionResolutionWidth' => ['description' => 'The width of the resolution, in pixels.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1920', 'title' => ''],
+ 'SessionResolutionHeight' => ['description' => 'The height of the resolution, in pixels.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1080', 'title' => ''],
+ 'StreamingMode' => [
+ 'description' => 'The streaming mode. This parameter is used together with the Webrtc parameter to specify the protocol type.'."\n"
+ ."\n"
+ .'- Webrtc=`true` and StreamingMode=`video`: WebRTC stream.'."\n"
+ .'- Webrtc=`false` and StreamingMode=`video`: video stream.'."\n"
+ .'- Webrtc=`false` and StreamingMode=`mix`: mixed stream.',
+ 'enumValueTitles' => ['video' => 'video stream.', 'mix' => 'mixed stream.'],
'type' => 'string',
- 'example' => '',
+ 'required' => false,
+ 'example' => 'video',
+ 'title' => '',
],
- 'OtaVersion' => [
- 'title' => '版本号',
- 'description' => 'The OTA version.'."\n",
- 'type' => 'string',
- 'example' => '0.0.1-R-20220708.110604',
+ 'Webrtc' => [
+ 'description' => 'Specifies whether to enable WebRTC. This parameter is used together with the StreamingMode parameter to specify the protocol type.'."\n"
+ ."\n"
+ .'- Webrtc=`true` and StreamingMode=`video`: WebRTC stream.'."\n"
+ .'- Webrtc=`false` and StreamingMode=`video`: video stream.'."\n"
+ .'- Webrtc=`false` and StreamingMode=`mix`: mixed stream.',
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'title' => '',
],
- 'TaskStartTime' => [
- 'title' => '任务执行时间,ISO-8601格式',
- 'description' => 'The execution time of the OTA update task. The time follows the ISO 8601 standard.'."\n",
+ 'VisualQualityStrategy' => [
+ 'description' => 'The visual quality strategy.',
+ 'enumValueTitles' => ['adaptive' => 'adaptive.', 'smooth' => 'smoothness first.', 'quality' => 'quality first.'],
'type' => 'string',
- 'format' => 'iso8601',
- 'example' => '2022-08-04T14:36:00+08:00',
+ 'required' => false,
+ 'example' => 'smooth',
+ 'title' => '',
],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"OtaTask.Running\\",\\n \\"Message\\": \\"The task is running and cannot be sumitted.\\",\\n \\"ReleaseNote\\": \\"测试升级\\",\\n \\"OtaVersion\\": \\"0.0.1-R-20220708.110604\\",\\n \\"TaskStartTime\\": \\"2022-08-04T14:36:00+08:00\\"\\n}","type":"json"}]',
- 'title' => 'GetOtaTaskByTaskId',
- ],
- 'ApproveOtaTask' => [
- 'summary' => 'Sets the execution time of an over-the-air (OTA) update task.',
- 'methods' => [
- 'get',
- 'post',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Modify delivery group display policy',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAppPolicy'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyAppPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyBrowserInstanceGroup' => [
+ 'summary' => 'Modifies the attributes of a Wuying Cloud Browser.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219753',
+ 'abilityTreeNodes' => ['FEATUREappstreaming4BR4QS', 'FEATUREappstreamingKE839Q', 'FEATUREappstreaming50MBS2'],
],
'parameters' => [
[
- 'name' => 'AppInstanceGroupId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '实例组id',
- 'description' => 'The ID of the delivery group. You can call the [ListAppInstanceGroup](~~428506~~) operation to obtain the ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
+ 'name' => 'BrowserInstanceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the cloud browser to modify.', 'type' => 'string', 'required' => true, 'example' => 'big-0bz55ixxxxx9xi9w9', 'title' => ''],
],
[
- 'name' => 'BizRegionId',
+ 'name' => 'CloudBrowserName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求发起者所在地域',
- 'description' => 'The ID of the region where the delivery group resides. You can call the [ListRegions](~~428500~~) operation to query the list of regions supported by App Streaming.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The name of the cloud browser.', 'type' => 'string', 'required' => false, 'example' => 'BrowserTest', 'title' => ''],
],
[
- 'name' => 'TaskId',
+ 'name' => 'Network',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'ota任务id',
- 'description' => 'The ID of the OTA update task. You can call the [ListAppInstanceGroup](~~428506~~) operation to obtain the ID.'."\n"
- ."\n"
- .'> Each successful call to the `ApproveOtaTask` operation causes a value change of this parameter.`` Before you call this operation, call the `ListAppInstanceGroup` operation again to obtain the latest value of this parameter.``'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ota-be7jzm29wrrz5****',
+ 'description' => 'The network configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessRestriction' => [
+ 'description' => 'The access restriction type.',
+ 'enumValueTitles' => ['ALLOW_LIST' => 'allowlist mode.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ALLOW_LIST',
+ 'title' => '',
+ ],
+ 'RestrictedURLs' => [
+ 'description' => 'The restricted domain name configurations.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The associated domain name restriction.',
+ 'type' => 'object',
+ 'properties' => [
+ 'URL' => ['description' => 'The domain name.', 'type' => 'string', 'required' => false, 'example' => 'aliyun.com', 'title' => ''],
+ 'RestrictedURLId' => ['description' => 'The ID of the domain name configuration. This parameter is required only for modification.', 'type' => 'string', 'required' => false, 'example' => 'ru-12345', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RemoveRestrictedURLIds' => [
+ 'description' => 'The list of domain names to remove.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the domain name configuration.', 'type' => 'string', 'required' => false, 'example' => 'ru-12345', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RestrictedURLsFilePath' => ['title' => '', 'type' => 'string', 'example' => 'cn-hangzhou/aig_upm/xxx/temp/BrowserRestrictionUrls/URL白名单模版.csv', 'description' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'OtaType',
- 'in' => 'formData',
+ 'name' => 'Policy',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => 'ota类型,取值:'."\n"
- .'Fota : agent组件更新'."\n"
- .'ImageUpdate : 镜像更新'."\n"
- .'AppUpdate : 应用更新',
- 'description' => 'The type of the OTA update task.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Fota: update of the system components of Alibaba Cloud Workspace'."\n"
- .'* AppUpdate'."\n"
- .'* ImageUpdate'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'Fota' => '',
- ],
- 'example' => 'Fota',
- 'enum' => [
- 'Fota',
- 'ImageUpdate',
- 'AppUpdate',
+ 'description' => 'The access policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ClipboardPolicy' => [
+ 'description' => 'The clipboard policy settings.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Clipboard' => [
+ 'description' => 'The clipboard policy.',
+ 'enumValueTitles' => ['read' => 'allows copy and paste from local to cloud browser.', 'readwrite' => 'allows bidirectional copy and paste.', 'write' => 'allows copy and paste from cloud browser to local.', 'off' => 'disables bidirectional copy and paste.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'off',
+ 'title' => '',
+ ],
+ 'ClipboardScope' => [
+ 'description' => 'The clipboard control scope.',
+ 'enumValueTitles' => ['grained' => 'fine-grained control.', 'global' => 'global control.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'global',
+ 'title' => '',
+ ],
+ 'TextClipboard' => [
+ 'description' => 'The text clipboard policy.',
+ 'enumValueTitles' => ['read' => 'allows copy and paste from local to cloud browser.', 'readwrite' => 'allows bidirectional copy and paste.', 'write' => 'allows copy and paste from cloud browser to local.', 'off' => 'disables bidirectional copy and paste.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'off',
+ 'title' => '',
+ ],
+ 'RichTextClipboard' => [
+ 'description' => 'The rich text clipboard policy.',
+ 'enumValueTitles' => ['read' => 'allows copy and paste from local to cloud browser.', 'readwrite' => 'allows bidirectional copy and paste.', 'write' => 'allows copy and paste from cloud browser to local.', 'off' => 'disables bidirectional copy and paste.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'off',
+ 'title' => '',
+ ],
+ 'FileClipboard' => [
+ 'description' => 'The file clipboard policy.',
+ 'enumValueTitles' => ['read' => 'allows copy and paste from local to cloud browser.', 'readwrite' => 'allows bidirectional copy and paste.', 'write' => 'allows copy and paste from cloud browser to local.', 'off' => 'disables bidirectional copy and paste.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'off',
+ 'title' => '',
+ ],
+ 'ClipboardReadLimit' => ['description' => 'The maximum length for clipboard read operations.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
+ 'ClipboardWriteLimit' => ['description' => 'The maximum length for clipboard write operations.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
+ 'ClipboardSizeUnit' => ['title' => '', 'type' => 'string', 'example' => 'B', 'description' => ''],
+ 'RichTextClipboardLimit' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''],
+ 'RichTextClipboardSizeUnit' => ['title' => '', 'type' => 'string', 'example' => 'B', 'description' => ''],
+ 'TextClipboardWriteLimit' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''],
+ 'TextClipboardWriteSizeUnit' => [
+ 'title' => '',
+ 'type' => 'string',
+ 'example' => 'KB',
+ 'default' => 'KB',
+ 'enum' => ['B', 'KB'],
+ 'description' => '',
+ ],
+ 'TextClipboardReadLimit' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''],
+ 'TextClipboardReadSizeUnit' => [
+ 'title' => '',
+ 'type' => 'string',
+ 'example' => 'KB',
+ 'default' => 'KB',
+ 'enum' => ['B', 'KB'],
+ 'description' => '',
+ ],
+ 'RichTextClipboardWriteLimit' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''],
+ 'RichTextClipboardWriteSizeUnit' => [
+ 'title' => '',
+ 'type' => 'string',
+ 'example' => 'KB',
+ 'default' => 'KB',
+ 'enum' => ['B', 'KB'],
+ 'description' => '',
+ ],
+ 'RichTextClipboardReadLimit' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''],
+ 'RichTextClipboardReadSizeUnit' => [
+ 'title' => '',
+ 'type' => 'string',
+ 'example' => 'KB',
+ 'default' => 'KB',
+ 'enum' => ['B', 'KB'],
+ 'description' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'VideoPolicy' => [
+ 'description' => 'The display policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'FrameRate' => ['description' => 'The frame rate.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'WatermarkPolicy' => [
+ 'description' => 'The watermark configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WatermarkSwitch' => [
+ 'description' => 'Specifies whether to enable the watermark.',
+ 'enumValueTitles' => ['off' => 'disabled.', 'on' => 'enabled.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'off',
+ 'title' => '',
+ ],
+ 'WatermarkTypes' => [
+ 'description' => 'The list of watermark types.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The watermark type.',
+ 'enumValueTitles' => ['EndUserId' => 'convenience account ID.', 'ClientTime' => 'system time.', 'InstanceGroup' => 'browser group ID.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'EndUserId',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'PolicyId' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'example' => 'pg-12345', 'title' => ''],
+ 'PolicyVersion' => [
+ 'description' => 'The policy version.',
+ 'enumValueTitles' => ['Center' => 'central policy.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Center',
+ 'title' => '',
+ ],
+ 'DisconnectKeepSession' => [
+ 'description' => 'The data retention policy for sessions after disconnection.',
+ 'enumValueTitles' => ['customTime' => 'custom time.', 'persistent' => 'never release.'],
+ 'type' => 'string',
+ 'title' => '',
+ 'example' => 'customTime',
+ 'required' => false,
+ ],
+ 'DisconnectKeepSessionTime' => ['description' => 'The session retention duration after disconnection.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15', 'title' => ''],
+ 'Html5FileTransfer' => ['description' => 'The file transfer policy for the web client.', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''],
+ 'NoOperationDisconnect' => ['title' => '', 'description' => 'The policy for disconnecting sessions after no operation.', 'type' => 'string', 'example' => 'on', 'required' => false],
+ 'NoOperationDisconnectTime' => ['title' => '', 'description' => 'The idle timeout period before disconnection, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false],
+ 'FileManager' => [
+ 'title' => '',
+ 'type' => 'string',
+ 'example' => 'off',
+ 'default' => 'off',
+ 'enum' => ['on', 'off'],
+ 'description' => '',
+ ],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'StartTime',
- 'in' => 'formData',
+ 'name' => 'Timers',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '开始时间,iso8601格式',
- 'description' => 'The start time of the OTA update task. The time follows the ISO 8601 standard.'."\n",
- 'type' => 'string',
- 'format' => 'iso8601',
- 'required' => true,
- 'example' => '2022-08-04T14:36:00+08:00',
+ 'description' => 'The timers.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The associated scheduled task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TimerType' => [
+ 'description' => 'The timer type.',
+ 'enumValueTitles' => ['SESSION_TIMEOUT' => '连接断开会话释放超时时间。'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SESSION_TIMEOUT',
+ 'title' => '',
+ ],
+ 'Interval' => ['description' => 'The interval.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'BrowserConfig',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The browser configuration.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'Homepage' => ['description' => 'The homepage.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''],
+ 'BrowserParam' => ['description' => 'The startup parameters.', 'type' => 'string', 'required' => false, 'example' => '--incognito', 'title' => ''],
+ 'Bookmarks' => [
+ 'description' => 'The bookmarks.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The associated bookmark details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'BookmarkId' => ['description' => 'The bookmark ID. This parameter is required only for modification.', 'type' => 'string', 'required' => false, 'example' => 'bm-12345', 'title' => ''],
+ 'BookmarkName' => ['description' => 'The bookmark name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
+ 'BookmarkURL' => ['description' => 'The bookmark URL.', 'type' => 'string', 'required' => true, 'example' => 'https://www.aliyun.com', 'title' => ''],
+ 'BookmarkFolder' => ['description' => 'The folder to which the bookmark belongs.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'Code' => [
- 'description' => 'The execution result. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n",
- 'type' => 'string',
- 'example' => 'OtaTask.Running',
+ 'RemoveBookmarks' => [
+ 'description' => 'The list of bookmarks to remove.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the bookmark to remove.', 'type' => 'string', 'required' => false, 'example' => 'bm-12345', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'Message' => [
- 'description' => 'The error message. If the value of `Code` is `success`, this parameter is not returned.'."\n",
- 'type' => 'string',
- 'example' => 'The task is running and cannot be sumitted.',
+ 'BookmarksFilePath' => ['title' => '', 'type' => 'string', 'example' => 'cn-hangzhou/aig_upm/xxx/temp/BrowserBookmarks/浏览器书签模版.csv', 'description' => ''],
+ 'CookiesSync' => ['title' => '', 'type' => 'boolean', 'default' => 'false', 'description' => '', 'example' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'StoragePolicy',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserProfile' => [
+ 'title' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserProfileSwitch' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'example' => '',
],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"OtaTask.Running\\",\\n \\"Message\\": \\"The task is running and cannot be sumitted.\\"\\n}","type":"json"}]',
- 'title' => 'ApproveOtaTask',
- ],
- 'ListTenantConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'MaxAmount',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'description' => ''],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'PlainResult<ListAliUserPropertyModel>',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'TenantConfigModel' => [
- 'description' => 'The user configurations.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'AppInstanceGroupExpireRemind' => [
- 'description' => 'Indicates whether the resource expiration reminder feature is enabled.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'true',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TenantConfigModel\\": {\\n \\"AppInstanceGroupExpireRemind\\": true\\n }\\n}","type":"json"}]',
- 'title' => 'ListTenantConfig',
- 'summary' => 'Queries the configurations of the administrator account, such as whether the resource expiration reminder feature is enabled.',
- ],
- 'ModifyTenantConfig' => [
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Modify cloud browser',
+ 'description' => 'Modifies the attributes of a Wuying Cloud Browser.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'http',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyNodePoolAmount' => [
+ 'summary' => 'Upgrades the number of nodes in a subscription delivery group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '263378',
+ 'abilityTreeNodes' => ['FEATUREappstreamingU1TTUH'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'AppInstanceGroupExpireRemind',
+ 'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'description' => 'Specifies whether to enable the resource expiration reminder feature.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
+ 'title' => '',
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Workspace.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'CloudApp',
+ ],
+ ],
+ [
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****'],
+ ],
+ [
+ 'name' => 'NodePool',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The node pool specification change parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeAmount' => ['title' => '', 'description' => 'The total number of subscription nodes after the upgrade.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ 'PrePaidNodeAmountModifyMode' => [
+ 'title' => '',
+ 'description' => 'The modification mode for subscription nodes.',
+ 'enumValueTitles' => ['EXPAND_FROM_POST_PAID_EXPLICIT' => 'converting specified pay-as-you-go nodes.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'EXPAND_FROM_POST_PAID_EXPLICIT',
+ ],
+ 'PrePaidNodeAmountModifyNodeIds' => [
+ 'title' => '',
+ 'description' => 'The list of nodes whose billing type is to be changed.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The node whose billing type is to be changed.', 'type' => 'string', 'required' => false, 'example' => 'i-fgssxxx', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
],
- 'example' => 'true',
+ 'required' => true,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Data' => [
+ 'description' => 'The response data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '23429322113****', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'ModifyTenantConfig',
- 'summary' => 'Modifies the configurations of the administrator account, such as whether to enable the resource expiration reminder feature.',
- ],
- 'ListTagCloudResources' => [
- 'summary' => 'Queries the tags added to one or more cloud resources.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"23429322113****\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Upgrade/Downgrade nodes in a resource node pool',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyNodePoolAmount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyNodePoolAttribute' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '266102',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'title' => '资源类型。取值范围:'."\n"
- .'AliUid:租户 '."\n"
- .'AppId:应用ID'."\n"
- .'AppInstanceGroupId:交付组'."\n"
- .'WyId:用户',
- 'description' => 'The type of the cloud resource.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* AppId: app ID.'."\n"
- .'* WyId: Alibaba Cloud Workspace user ID.'."\n"
- .'* AppInstanceGroupId: delivery group ID.'."\n"
- .'* AliUid: tenant ID.'."\n",
+ 'title' => '',
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'AppId' => '',
- 'WyId' => '',
- 'AppInstanceGroupId' => '',
- 'AliUid' => '',
- ],
- 'example' => 'AppInstanceGroupId',
- ],
- ],
- [
- 'name' => 'ResourceIds',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '资源ID列表,最多支持50个。'."\n"
- .'资源类型为租户的时候不需要指定。',
- 'description' => 'The resource IDs. You can specify up to 50 resource IDs. You do not need to specify this parameter if you set ResourceType to AliUid.'."\n",
- 'type' => 'array',
- 'items' => [
- 'title' => '资源ID。',
- 'description' => 'The resource ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-001',
- 'maxLength' => 64,
- 'minLength' => 1,
- ],
'required' => false,
- 'maxItems' => 50,
- 'minItems' => 0,
+ 'example' => 'CloudApp',
],
],
[
- 'name' => 'Scope',
+ 'name' => 'PoolId',
'in' => 'formData',
- 'schema' => [
- 'title' => '标签类型。取值范围:'."\n"
- .'Custom:自定义标签。'."\n"
- .'System:系统标签。'."\n"
- .'All:全部标签。'."\n"
- .'默认值:All。',
- 'description' => 'The tag type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* All (default): all tags.'."\n"
- .'* Custom: custom tag.'."\n"
- .'* System: system tag.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'All' => '',
- 'Custom' => '',
- 'System' => '',
- ],
- 'example' => 'Custom',
- 'maxLength' => 20,
- 'minLength' => 0,
- 'enum' => [
- 'Custom',
- 'System',
- 'All',
- ],
- ],
+ 'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-ew7va2g1wl3vm****'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'NodeCapacity',
'in' => 'formData',
- 'schema' => [
- 'title' => '分页时每页显示的数据行数。'."\n"
- .'最大值:1000。默认值:50。',
- 'description' => 'The number of entries per page. Maximum value: 1000. Default value: 50.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '50',
- 'default' => '50',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of concurrent sessions, which is the number of sessions that can be simultaneously connected to a single resource. If too many sessions are connected simultaneously, the application experience may degrade. The valid values vary depending on the resource specification. The valid values for each resource specification are as follows:'."\n"
+ ."\n"
+ .'- appstreaming.general.4c8g: 1 to 2.'."\n"
+ .'- appstreaming.general.8c16g: 1 to 4.'."\n"
+ .'- appstreaming.vgpu.8c16g.4g: 1 to 4.'."\n"
+ .'- appstreaming.vgpu.8c31g.16g: 1 to 4.'."\n"
+ .'- appstreaming.vgpu.14c93g.12g: 1 to 6.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'NodePoolStrategy',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '下一个查询开始的 Token。',
- 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ptnJAAAAAAAxNzE5OTEwNQ==',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The automatic scaling policy of the delivery group.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'NextToken' => [
- 'title' => '根据NextToken判断是否具备下一个查询开始的 Token。',
- 'description' => 'Indicates whether the next query is required.'."\n",
+ 'StrategyType' => [
+ 'title' => '',
+ 'description' => 'The scaling mode.'."\n"
+ ."\n"
+ .'> '."\n"
+ .'- `NODE_FIXED` (fixed quantity): Applicable to subscription and pay-as-you-go resources.'."\n"
+ .'- `NODE_SCALING_BY_USAGE` (automatic scaling): Applicable to subscription and pay-as-you-go resources.'."\n"
+ .'- `NODE_SCALING_BY_SCHEDULE` (scheduled scaling): Applicable only to pay-as-you-go resources.',
+ 'enumValueTitles' => ['NODE_FIXED' => 'Fixed quantity (no elastic scaling).', 'NODE_SCALING_BY_SCHEDULE' => 'Scheduled scaling.', 'NODE_SCALING_BY_USAGE' => 'Automatic scaling.'],
'type' => 'string',
- 'example' => 'AAAAAYRHtOLVQzCYj17y+OP7LZRrUJaF4rnBGQkWwMiVHlLZBB1w3Us37CVvhvyM0TXavA==',
- ],
- 'TotalCount' => [
- 'title' => '总数。',
- 'description' => 'The total number of entries.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '15',
+ 'required' => false,
+ 'example' => 'NODE_FIXED',
],
- 'ResourceTags' => [
- 'title' => '资源绑定的标签信息列表。',
- 'description' => 'The tags added to the cloud resources.'."\n",
+ 'NodeAmount' => ['description' => 'The number of purchased resources. Valid values: 1 to 100.'."\n"
+ ."\n"
+ .'> '."\n"
+ .'- If the resources are subscription resources, this parameter cannot be modified.'."\n"
+ .'- If the resources are pay-as-you-go resources, this parameter can be modified when the scaling mode (`StrategyType`) is set to fixed quantity (`NODE_FIXED`) or automatic scaling (`NODE_SCALING_BY_USAGE`).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ 'MaxScalingAmount' => ['title' => '', 'description' => 'The maximum number of resources that can be created during scale-out. This parameter is required when `StrategyType` is set to `NODE_SCALING_BY_USAGE`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'MaxIdleAppInstanceAmount' => ['description' => 'The maximum number of idle sessions. When this value is specified, automatic scale-out is triggered only when the session usage exceeds `ScalingUsageThreshold` and the number of idle sessions in the current delivery group is less than `MaxIdleAppInstanceAmount`. Otherwise, the idle sessions in the delivery group are considered sufficient, and no automatic scale-out is performed. This parameter can be used to flexibly control elastic scale-out behavior and reduce costs.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''],
+ 'ScalingStep' => ['title' => '', 'description' => 'The number of resources created per scale-out operation. Valid values: 1 to 10. This parameter is required when `StrategyType` is set to `NODE_SCALING_BY_USAGE`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ 'ScalingUsageThreshold' => ['title' => '', 'description' => 'The upper threshold of session usage (%). Automatic scale-out is triggered when the session usage exceeds this threshold. The session usage is calculated by using the following formula: `Session usage = Current sessions ÷ (Total resources × Concurrent sessions per resource) × 100%`. This parameter is required when `StrategyType` is set to `NODE_SCALING_BY_USAGE`. Valid values: 0 to 100. Default value: 85.', 'type' => 'string', 'required' => false, 'example' => '85'],
+ 'ScalingDownAfterIdleMinutes' => ['title' => '', 'description' => 'The maximum duration (in minutes) that a resource without session connections is retained. When no sessions are connected to a resource, a countdown starts based on the duration specified here. The resource is scaled in when the countdown ends. Valid values: 5 to 120. Default value: 5. The following exceptions apply:'."\n"
+ ."\n"
+ .'- If scale-in would trigger automatic scale-out again, the scale-in is not performed to avoid repeated scale-in and scale-out operations.'."\n"
+ .'- If automatic scale-out is triggered by an increase in sessions during this period, the resource is not scaled in as originally planned, and the countdown restarts.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
+ 'StrategyEnableDate' => ['description' => 'The date when the policy takes effect. Format: yyyy-MM-dd. The date must be equal to or later than the current date. This parameter is required when `StrategyType` (scaling mode) is set to `NODE_SCALING_BY_SCHEDULE` (scheduled scaling).', 'type' => 'string', 'required' => false, 'example' => '2023-01-05', 'title' => ''],
+ 'StrategyDisableDate' => ['description' => 'The date when the policy expires. Format: yyyy-MM-dd. The interval between the expiration date and the effective date must be between 7 days and 1 year, inclusive. This parameter is required when `StrategyType` (scaling mode) is set to `NODE_SCALING_BY_SCHEDULE` (scheduled scaling).', 'type' => 'string', 'required' => false, 'example' => '2023-01-19', 'title' => ''],
+ 'WarmUp' => ['description' => 'Specifies whether to enable the resource prefetch policy. This parameter is required when `StrategyType` (scaling mode) is set to `NODE_SCALING_BY_SCHEDULE` (scheduled scaling).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'RecurrenceSchedules' => [
+ 'description' => 'The list of policy execution cycles. This parameter is required when `StrategyType` (scaling mode) is set to `NODE_SCALING_BY_SCHEDULE` (scheduled scaling).',
'type' => 'array',
'items' => [
- 'title' => '资源绑定的标签信息。',
- 'description' => 'The tag added to the cloud resource.'."\n",
+ 'description' => 'The policy execution cycle.',
'type' => 'object',
'properties' => [
- 'ResourceType' => [
- 'title' => '资源类型。取值范围:'."\n"
- .'AliUid:租户 '."\n"
- .'AppId:应用ID'."\n"
- .'AppInstanceGroupId:交付组'."\n"
- .'WyId:用户',
- 'description' => 'The type of the cloud resource.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* AppId: app ID.'."\n"
- .'* WyId: Alibaba Cloud Workspace user ID.'."\n"
- .'* AppInstanceGroupId: delivery group ID.'."\n"
- .'* AliUid: tenant ID.'."\n",
+ 'RecurrenceType' => [
+ 'description' => 'The type of the policy execution cycle. You must specify both `RecurrenceType` and `RecurrenceValues`.',
+ 'enumValueTitles' => ['weekly' => 'weekly (the scheduled task is executed on specified days of each week).'],
'type' => 'string',
- 'enumValueTitles' => [
- 'AppId' => '',
- 'WyId' => '',
- 'AppInstanceGroupId' => '',
- 'AliUid' => '',
- ],
- 'example' => 'AppInstanceGroupId',
+ 'required' => false,
+ 'example' => 'weekly',
+ 'title' => '',
],
- 'ResourceId' => [
- 'title' => '资源ID。',
- 'description' => 'The resource ID.'."\n",
- 'type' => 'string',
- 'example' => 'aig-0001',
+ 'RecurrenceValues' => [
+ 'description' => 'The list of values for the policy execution cycle.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The value of the policy execution cycle.',
+ 'enumValueTitles' => [1 => 'Monday.', 'Tuesday.', 'Wednesday.', 'Thursday.', 'Friday.', 'Saturday.', 'Sunday.'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 7,
+ 'title' => '',
+ 'example' => '',
],
- 'Tags' => [
- 'title' => '标签信息列表。',
- 'description' => 'The tags.'."\n",
+ 'TimerPeriods' => [
+ 'description' => 'The list of time periods for the policy execution cycle. Requirements for time period settings:'."\n"
+ ."\n"
+ .'- You can add up to three time periods.'."\n"
+ .'- Time periods must not overlap.'."\n"
+ .'- The interval between time periods must be at least 5 minutes.'."\n"
+ .'- Each time period must be at least 15 minutes long.'."\n"
+ .'- All time periods combined must not span across days.',
'type' => 'array',
'items' => [
- 'title' => '标签信息。',
- 'description' => 'The tag.'."\n",
+ 'description' => 'The time period of the policy execution cycle.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签键',
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'example' => 'Resolution',
- ],
- 'Value' => [
- 'title' => '标签值',
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'example' => '1080p',
- ],
- 'Scope' => [
- 'title' => '标签类型。取值范围:'."\n"
- .'Custom:自定义标签。'."\n"
- .'System:系统标签。',
- 'description' => 'The tag type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Custom: custom tag.'."\n"
- .'* System: system tag.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Custom' => '',
- 'System' => '',
- ],
- 'example' => 'Custom',
- ],
+ 'StartTime' => ['description' => 'The start time. Format: HH:mm.', 'type' => 'string', 'required' => false, 'example' => '12:00', 'title' => ''],
+ 'EndTime' => ['description' => 'The end time. Format: HH:mm.', 'type' => 'string', 'required' => false, 'example' => '15:00', 'title' => ''],
+ 'Amount' => ['description' => 'The resource count.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => false,
+ 'maxItems' => 5,
+ 'title' => '',
+ 'example' => '',
],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => false,
+ 'maxItems' => 7,
+ 'title' => '',
+ 'example' => '',
],
],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'BizRegionId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The region ID of the delivery group. For more information about supported regions, see [Limits](~~426036~~).',
+ 'enumValueTitles' => ['cn-shanghai' => 'China (Shanghai).', 'cn-hangzhou' => 'China (Hangzhou).'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'Service unavailable. Please try again later.',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ 'Code' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => 'InvalidParameter.PoolId', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'The parameter PoolId is invalid.', 'title' => ''],
+ ],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Modify delivery group scaling mode',
+ 'summary' => 'Modifies the scaling mode of a delivery group, including fixed quantity (no elastic scaling), scheduled scaling, and automatic scaling.',
+ 'description' => 'You can configure the scaling pattern for WUYING Cloud Application resources in Settings:'."\n"
+ ."\n"
+ .'- Fixed quantity: Elastic scaling is not used.'."\n"
+ .'- Automatic scaling: Automatically scales resources based on the number of connected sessions and the idle duration without session connections.'."\n"
+ .'- Scheduled scaling: Executes resource scaling during specified time periods on specified dates.'."\n"
+ ."\n"
+ .'Before using this operation, make sure that you fully understand the [billing method and pricing](~~426039~~) of WUYING Cloud Application.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyNodePoolAttribute'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"AAAAAYRHtOLVQzCYj17y+OP7LZRrUJaF4rnBGQkWwMiVHlLZBB1w3Us37CVvhvyM0TXavA==\\",\\n \\"TotalCount\\": 15,\\n \\"ResourceTags\\": [\\n {\\n \\"ResourceType\\": \\"AppInstanceGroupId\\",\\n \\"ResourceId\\": \\"aig-0001\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Resolution\\",\\n \\"Value\\": \\"1080p\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListTagCloudResources',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyNodePoolAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.PoolId\\",\\n \\"Message\\": \\"The parameter PoolId is invalid.\\"\\n}","type":"json"}]',
],
- 'TagCloudResources' => [
- 'summary' => 'Creates and adds tags to cloud resources and updates the values of existing cloud resource tags.',
- 'methods' => [
- 'post',
- 'get',
+ 'ModifyTenantConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'AppInstanceGroupExpireRemind',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable resource expiration reminders.',
+ 'enumValueTitles' => ['true' => 'Enabled.', 'false' => 'Disabled.'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'title' => 'Modify administrator account configuration',
+ 'summary' => 'Modifies the configuration of an administrator account, such as whether to enable resource expiration reminders.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTenantConfig'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyTenantConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyWuyingServerAttribute' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '266104',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'ProductType',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源类型。取值范围:'."\n"
- .'AliUid:租户 '."\n"
- .'AppId:应用ID'."\n"
- .'AppInstanceGroupId:交付组'."\n"
- .'WyId:用户',
- 'description' => 'The type of the cloud resource.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* CenterImageId: center image ID.'."\n"
- .'* AppId: app ID.'."\n"
- .'* WyId: Alibaba Cloud Workspace user ID.'."\n"
- .'* AppInstanceGroupId: delivery group ID.'."\n"
- .'* AliUid: tenant ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CenterImageId' => '',
- 'AppId' => '',
- 'WyId' => '',
- 'AppInstanceGroupId' => '',
- 'AliUid' => '',
- ],
- 'example' => 'AppInstanceGroupId',
- 'maxLength' => 30,
- 'minLength' => 1,
- 'enum' => [
- 'AliUid',
- 'AppId',
- 'AppInstanceGroupId',
- 'WyId',
- 'CenterImageId',
- ],
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
- 'name' => 'ResourceIds',
+ 'name' => 'WuyingServerId',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '资源ID列表,最多支持50个'."\n"
- .'资源类型为租户的时候不需要指定。',
- 'description' => 'The resource IDs. You can specify up to 50 resource IDs. You do not need to specify this parameter if you set ResourceType to AliUid.'."\n",
- 'type' => 'array',
- 'items' => [
- 'title' => '资源ID',
- 'description' => 'The resource ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-0002',
- 'maxLength' => 64,
- 'minLength' => 1,
- ],
- 'required' => false,
- 'maxItems' => 50,
- 'minItems' => 0,
- ],
+ 'schema' => ['description' => 'The ID of the cloud graphics workstation.', 'type' => 'string', 'required' => false, 'example' => 'ws-0bw2f11****dial', 'title' => ''],
],
[
- 'name' => 'Tags',
+ 'name' => 'WuyingServerName',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '自定义(Custom+指定范围的System)标签列表,最多支持10个'."\n"
- .'● 标签键长度范围:1~128 个字符。'."\n"
- .'● 标签值长度范围:1~128 个字符。'."\n"
- .'● 区分大小写。'."\n"
- .'● 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键,则对应的标签值会更新为新值。',
- 'description' => 'The tags that you want to remove from the cloud resources. System and custom tags are supported.'."\n"
- ."\n"
- .'* Valid values for system tags:'."\n"
- ."\n"
- .' * `System/Scheduler/GRAYSCALE`: canary tags.'."\n"
- .' * `System/Scheduler/STOP_NEW_USER_CONNECTION`: tags used to stop new users bound to the delivery group from establishing a connection.'."\n"
- ."\n"
- .'* You can create up to 20 custom tags.'."\n"
- ."\n"
- .'> Each tag key on a resource can have only one tag value. If you create a tag that has the same key as an existing tag, the value of the existing tag is overwritten.'."\n",
- 'type' => 'array',
- 'items' => [
- 'title' => '标签信息。',
- 'description' => 'The tag of the model.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签键。',
- 'description' => 'The key of a tag. The value must be 1 to 128 characters in length and is case-sensitive. The name must be 1 to 128 characters in length.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Resolution',
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
- 'Value' => [
- 'title' => '标签值。',
- 'description' => 'The value of a tag. The value must be 1 to 128 characters in length and is case-sensitive. The name must be 1 to 128 characters in length.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '720p',
- 'maxLength' => 256,
- 'minLength' => 0,
- ],
- ],
- 'required' => true,
- ],
- 'required' => true,
- 'maxItems' => 20,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => 'The name of the cloud graphics workstation.', 'type' => 'string', 'required' => false, 'example' => 'exampleServerName', 'title' => ''],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The logon password of the cloud graphics workstation.', 'type' => 'string', 'required' => false, 'example' => 'yourPassword', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'FailedResources' => [
- 'title' => '失败的资源与标签信息列表。',
- 'description' => 'The cloud resources on which the operation failed and the corresponding tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'title' => '失败的资源与标签信息。',
- 'description' => 'The cloud resource on which the operation failed and the corresponding tag.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'ResourceType' => [
- 'title' => '资源类型。取值范围:'."\n"
- .'AliUid:租户 '."\n"
- .'AppId:应用ID'."\n"
- .'AppInstanceGroupId:交付组'."\n"
- .'WyId:用户',
- 'description' => 'The type of the cloud resource.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* CenterImageId: center image ID.'."\n"
- .'* AppId: app ID.'."\n"
- .'* WyId: Alibaba Cloud Workspace user ID.'."\n"
- .'* AppInstanceGroupId: delivery group ID.'."\n"
- .'* AliUid: tenant ID.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'CenterImageId' => '',
- 'AppId' => '',
- 'WyId' => '',
- 'AppInstanceGroupId' => '',
- 'AliUid' => '',
- ],
- 'example' => 'AppInstanceGroupId',
- ],
- 'ResourceId' => [
- 'title' => '资源ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'aig-001',
- ],
- 'Tags' => [
- 'title' => '失败的标签信息列表。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '失败的标签信息。',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签键。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'System/Scheduler/STOP_NEW_USER_CONNECTION',
- ],
- 'Value' => [
- 'title' => '标签值。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Scope' => [
- 'title' => '标签类型。取值范围:'."\n"
- .'Custom:自定义标签。'."\n"
- .'System:系统标签。',
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Custom' => '',
- 'System' => '',
- ],
- 'example' => 'System',
- ],
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误码。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TAG_KEY_DUPLICATED',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Duplicate tag keys exist.',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'Service unavailable. Please try again later.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Modify cloud graphics workstation properties',
+ 'summary' => 'Modifies the properties of a cloud graphics workstation.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyWuyingServerAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FailedResources\\": [\\n {\\n \\"ResourceType\\": \\"AppInstanceGroupId\\",\\n \\"ResourceId\\": \\"aig-001\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"System/Scheduler/STOP_NEW_USER_CONNECTION\\",\\n \\"Value\\": \\"true\\",\\n \\"Scope\\": \\"System\\"\\n }\\n ],\\n \\"Code\\": \\"TAG_KEY_DUPLICATED\\",\\n \\"Message\\": \\"Duplicate tag keys exist.\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'TagCloudResources',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
- 'UntagCloudResources' => [
- 'summary' => 'Removes tags from cloud resources.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'PageListAppInstanceGroupUser' => [
+ 'summary' => 'Performs a paged query on allocated users added to a delivery group.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '266118',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingV87T4P'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'maxItems' => 100, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'title' => '资源类型。取值范围:'."\n"
- .'AliUid:租户 '."\n"
- .'AppId:应用ID'."\n"
- .'AppInstanceGroupId:交付组'."\n"
- .'WyId:用户',
- 'description' => 'The type of the resource from which you want to remove tags.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* AppId: app ID.'."\n"
- .'* WyId: Alibaba Cloud Workspace user ID.'."\n"
- .'* AppInstanceGroupId: delivery group ID.'."\n"
- .'* AliUid: tenant ID.',
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud App'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'AppId' => '',
- 'WyId' => '',
- 'AppInstanceGroupId' => '',
- 'AliUid' => '',
- ],
- 'example' => 'AppInstanceGroupId',
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
[
- 'name' => 'ResourceIds',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '资源ID列表,最多支持50个'."\n"
- .'资源类型为租户的时候不需要指定。',
- 'description' => 'The resource IDs. You can specify up to 50 resource IDs. You do not need to specify this parameter if you set ResourceType to AliUid.'."\n",
- 'type' => 'array',
- 'items' => [
- 'title' => '资源ID',
- 'description' => 'The resource ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-0009',
- 'maxLength' => 64,
- 'minLength' => 1,
- ],
- 'required' => false,
- 'maxItems' => 50,
- 'minItems' => 0,
- ],
+ 'schema' => ['description' => 'The number of query results per page. The value cannot exceed `100`. Specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'TagKeys',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '自定义(Custom+指定范围的System)标签键列表,最多支持10个',
- 'description' => 'The tags that you want to remove from the cloud resources. System and custom tags are supported. You can specify up to 10 tags.'."\n"
- ."\n"
- .'Valid values for system tags:'."\n"
- ."\n"
- .'* `System/Scheduler/GRAYSCALE`: canary tags.'."\n"
- .'* `System/Scheduler/STOP_NEW_USER_CONNECTION`: tags used to stop new users bound to the delivery group from establishing a connection.'."\n",
- 'type' => 'array',
- 'items' => [
- 'title' => '标签键',
- 'description' => 'The tag key. The value must be 1 to 128 characters in length and is case-sensitive.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'System/Scheduler/GRAYSCALE',
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
- 'required' => true,
- 'maxItems' => 20,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => 'The page number of the query results to display. Specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'E25FC620-6B6F-12D2-A992-AD8727DC****',
- ],
- 'FailedResources' => [
- 'title' => '失败的资源与标签信息列表。',
- 'description' => 'The cloud resources whose tags failed to be removed and the corresponding tags.'."\n",
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Users' => [
+ 'description' => 'The queried users.',
'type' => 'array',
- 'items' => [
- 'title' => '失败的资源与标签信息。',
- 'description' => 'The cloud resource whose tag failed to be removed and the corresponding tag.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'ResourceType' => [
- 'title' => '资源类型。'."\n"
- .'● 租户 AliUid'."\n"
- .'● 应用ID AppId'."\n"
- .'● 交付组 AppInstanceGroupId'."\n"
- .'● 用户 WyId',
- 'description' => 'The type of the cloud resource.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* AppId: app ID.'."\n"
- .'* WyId: Alibaba Cloud Workspace user ID.'."\n"
- .'* AppInstanceGroupId: delivery group ID.'."\n"
- .'* AliUid: tenant ID.',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'AppId' => '',
- 'WyId' => '',
- 'AppInstanceGroupId' => '',
- 'AliUid' => '',
- ],
- 'example' => 'AppInstanceGroupId',
- ],
- 'ResourceId' => [
- 'title' => '资源ID。',
- 'description' => 'The resource IDs.'."\n",
- 'type' => 'string',
- 'example' => 'aig-00000001',
- ],
- 'Tags' => [
- 'title' => '失败的标签信息列表。',
- 'description' => 'The tags that failed to be removed from the cloud resources.'."\n",
- 'type' => 'array',
- 'items' => [
- 'title' => '失败的标签信息。',
- 'description' => 'The tag that failed to be removed from the cloud resource.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签键。',
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'example' => 'Resolution',
- ],
- 'Scope' => [
- 'title' => '标签类型。取值范围:'."\n"
- .'Custom:自定义标签。'."\n"
- .'System:系统标签。',
- 'description' => 'The tag type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Custom: custom tag.'."\n"
- .'* System: system tag.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Custom' => '',
- 'System' => '',
- ],
- 'example' => 'Custom',
- ],
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误码。',
- 'description' => 'The error code.'."\n",
- 'type' => 'string',
- 'example' => 'UNTAG_RESOURCE_FAILED',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => 'The error message.'."\n",
- 'type' => 'string',
- 'example' => 'Failed to untag resource.',
- ],
- ],
- ],
+ 'items' => ['description' => 'The queried username.', 'type' => 'string', 'example' => 'username1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'Service unavailable. Please try again later.',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query allocated users of a delivery group with paging',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PageListAppInstanceGroupUser'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:PageListAppInstanceGroupUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25FC620-6B6F-12D2-A992-AD8727DC****\\",\\n \\"FailedResources\\": [\\n {\\n \\"ResourceType\\": \\"AppInstanceGroupId\\",\\n \\"ResourceId\\": \\"aig-00000001\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Resolution\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"Code\\": \\"UNTAG_RESOURCE_FAILED\\",\\n \\"Message\\": \\"Failed to untag resource.\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'UntagCloudResources',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Users\\": [\\n \\"username1\\"\\n ]\\n}","type":"json"}]',
],
- 'DescribeWuyingServerEipInfo' => [
- 'summary' => 'Queries the Elastic IP Addresses (EIPs) of workstations.',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RemoveResourceGroupModelTemplate' => [
+ 'summary' => 'Removes model groups from a resource group.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'WuyingServerId',
+ 'name' => 'ModelTemplateId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the workstation.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ws-0bw2f11****dial',
- ],
+ 'schema' => ['title' => '', 'description' => 'The model group ID.', 'type' => 'string', 'required' => true, 'example' => 'mt-xxxx'],
],
[
- 'name' => 'Isp',
+ 'name' => 'ResourceGroupIds',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The Internet service provider (ISP). Valid values:'."\n"
- ."\n"
- .'* ChinaMobile: China Mobile'."\n"
- .'* ChinaTelecom: China Telecom'."\n"
- .'* ChinaUnicom: China Unicom'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ChinaTelecom',
+ 'title' => '',
+ 'description' => 'The list of resource group IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => true, 'example' => 'rg-xxxx', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'title' => '',
+ 'description' => 'The request result.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'EipInfoModel' => [
- 'description' => 'The information about the associated EIP.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'NetworkInterfaceId' => [
- 'description' => 'The ID of the elastic network interface (ENI).'."\n",
- 'type' => 'string',
- 'example' => 'eni-bp174p2xxxxxbyh02ix',
- ],
- 'IpAddress' => [
- 'description' => 'The public IP address.'."\n",
- 'type' => 'string',
- 'example' => '171.xxx.xxx.221',
- ],
- 'ServerPortRange' => [
- 'description' => 'The port range.'."\n",
- 'type' => 'string',
- 'example' => '6606/6607',
- ],
- 'EipId' => [
- 'type' => 'string',
+ 'Data' => [
+ 'description' => 'The removal results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The response data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxx'],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '', 'description' => 'The error code returned if the operation fails.', 'type' => 'string', 'example' => 'InvalidParameter.resourceGroupIds'],
+ 'Message' => ['title' => '', 'description' => 'The error message returned if the operation fails.', 'type' => 'string', 'example' => 'The parameter resourceGroupIds is invalid.'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '6'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"EipInfoModel\\": {\\n \\"NetworkInterfaceId\\": \\"eni-bp174p2xxxxxbyh02ix\\",\\n \\"IpAddress\\": \\"171.xxx.xxx.221\\",\\n \\"ServerPortRange\\": \\"6606/6607\\",\\n \\"EipId\\": \\"\\"\\n }\\n}","type":"json"}]',
- 'title' => 'DescribeWuyingServerEipInfo',
- ],
- 'CreateWuyingServer' => [
- 'summary' => 'Create one or more workstations.',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Remove model groups from a resource group',
+ 'description' => 'You can authorize model groups for resources that belong to Agent runtimes such as JVS Computer, OpenClaw, and Hermes Agent in the WUYING Agent Management Center. The model groups serve as inference engines for Agents to execute tasks within the resource group.'."\n"
+ ."\n"
+ .'When an Agent runtime has its own model group configured and the resource group it belongs to also has a model group configured, the model group bound to the resource group takes effect. The resource group setting takes priority over the Agent runtime setting.'."\n"
+ ."\n"
+ .'When you remove the model group from the resource group to which an Agent runtime belongs, the model group configured on the Agent runtime itself automatically takes effect.'."\n"
+ ."\n"
+ .'Before calling this operation, make sure that you are familiar with the operations and usage of the WUYING Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RemoveResourceGroupModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg-xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidParameter.resourceGroupIds\\",\\n \\"Message\\": \\"The parameter resourceGroupIds is invalid.\\"\\n }\\n ],\\n \\"TotalCount\\": 6,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'RemoveRuntimeChannel' => [
+ 'summary' => 'Removes a third-party channel configuration from an agent runtime.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingU1TTUH',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'WuyingServerName',
+ 'name' => 'RuntimeType',
'in' => 'formData',
'schema' => [
- 'description' => 'The name of the workstation. The numeric suffix is automatically added when multiple workstations are created.'."\n",
+ 'title' => '',
+ 'description' => 'The runtime type.',
+ 'enumValueTitles' => ['CloudDesktop' => 'cloud computer.'],
'type' => 'string',
- 'required' => false,
- 'example' => 'exampleServerName',
+ 'required' => true,
+ 'example' => 'CloudDesktop',
],
],
[
- 'name' => 'Amount',
+ 'name' => 'RuntimeIds',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'Quantity.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ 'title' => '',
+ 'description' => 'The list of agent runtime IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The agent runtime ID. The ID mappings are as follows:'."\n"
+ ."\n"
+ .'- JVS Computer: the JVS Computer ID, in the format of jvs-xxxx.'."\n"
+ .'- OpenClaw: the cloud computer ID, in the format of ecd-xxxx.'."\n"
+ .'- Hermes Agent: the Hermes Agent ID, in the format of jvs-xxxx.', 'type' => 'string', 'required' => true, 'example' => 'jvs-xxxx', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ 'example' => '',
],
],
[
- 'name' => 'ServerInstanceType',
+ 'name' => 'AgentPlatform',
'in' => 'formData',
'schema' => [
- 'description' => 'Workstation specifications.'."\n",
+ 'description' => 'The agent platform.',
+ 'enumValueTitles' => ['ENTERPRISE' => 'Enterprise edition.', 'ENTERPRISE_JVS' => 'Enterprise edition JVS Computer or Enterprise edition Hermes Agent.'],
'type' => 'string',
'required' => false,
- 'example' => 'eds.proworkstation_flagship_elite_ne.96c384g.192g4x',
+ 'example' => 'ENTERPRISE',
+ 'title' => '',
],
],
[
- 'name' => 'SystemDiskSize',
+ 'name' => 'AgentProvider',
'in' => 'formData',
'schema' => [
- 'description' => 'The size of the system disk. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
+ 'title' => '',
+ 'description' => 'The agent provider.',
+ 'enumValueTitles' => ['OpenClaw' => 'OpenClaw'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OpenClaw',
],
],
[
- 'name' => 'SystemDiskCategory',
+ 'name' => 'Code',
'in' => 'formData',
'schema' => [
- 'description' => 'The system disk category.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* cloud_auto.'."\n",
+ 'title' => '',
+ 'description' => 'The channel code.',
+ 'enumValueTitles' => ['dingtalk-connector' => 'DingTalk.', 'wechat' => 'WeChat.', 'feishu' => 'Lark.', 'qqbot' => 'QQ', 'wecom' => 'WeCom.'],
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cloud_auto' => 'cloud_auto',
- ],
- 'example' => 'cloud_auto',
+ 'required' => true,
+ 'example' => 'dingtalk-connector',
],
],
- [
- 'name' => 'SystemDiskPerformanceLevel',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The performance level (PL) of the system disk.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PL0',
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Remove a third-party channel configuration from an agent runtime',
+ 'description' => 'You can call this operation to remove a specific third-party channel configuration from an agent runtime such as JVS Computer, OpenClaw, or Hermes Agent in the Wuying Agent Management Center. After the configuration is removed, the agent can no longer use the third-party channel for conversations.'."\n"
+ ."\n"
+ .'Before calling this operation, make sure that you are familiar with the operations and usage of the Wuying Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'DataDisk',
- 'in' => 'formData',
- 'style' => 'flat',
- 'schema' => [
- 'description' => 'The list of data disks.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about the data disk.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'DataDiskSize' => [
- 'description' => 'The data disk size.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
- 'DataDiskCategory' => [
- 'description' => 'The data disk category.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* cloud_auto.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cloud_auto' => 'cloud_auto',
- ],
- 'example' => 'cloud_auto',
- ],
- 'DataDiskPerformanceLevel' => [
- 'description' => 'The PL of the data disk.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PL0',
- ],
- ],
- 'required' => false,
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RemoveRuntimeChannel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'RemoveRuntimeModelTemplate' => [
+ 'summary' => 'Removes model groups from Agent runtime resources.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ImageId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the image.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'img-bp13mu****',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [
[
- 'name' => 'BizRegionId',
+ 'name' => 'RuntimeType',
'in' => 'formData',
'schema' => [
- 'description' => 'Region.'."\n",
+ 'title' => '',
+ 'description' => 'The Agent runtime type.',
+ 'enumValueTitles' => ['CloudDesktop' => 'cloud computer.'],
'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'required' => true,
+ 'example' => 'CloudDesktop',
],
],
[
- 'name' => 'OfficeSiteId',
+ 'name' => 'RuntimeIds',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The office network IDs.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou+dir-643067****',
+ 'title' => '',
+ 'description' => 'The list of Agent runtime IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The Agent runtime ID. The ID mapping is as follows:'."\n"
+ ."\n"
+ .'- JVS Computer: JVS Computer ID, in the format of jvs-xxxx.'."\n"
+ .'- OpenClaw: cloud computer ID, in the format of ecd-xxxx.'."\n"
+ .'- Hermes Agent: Hermes Agent ID, in the format of jvs-xxxx.', 'type' => 'string', 'required' => true, 'example' => 'jvs-xxxxxx', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ 'example' => '',
],
],
[
- 'name' => 'Password',
+ 'name' => 'ModelTemplateId',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The model group ID.', 'type' => 'string', 'required' => true, 'example' => 'mt-xxxxxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'Workstation login password.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'YourPassword123',
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The list of removal results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The result of a single removal operation.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuntimeId' => ['title' => '', 'description' => 'The Agent runtime ID. The ID mapping is as follows:'."\n"
+ ."\n"
+ .'- JVS Computer: JVS Computer ID, in the format of jvs-xxxx.'."\n"
+ .'- OpenClaw: cloud computer ID, in the format of ecd-xxxx.'."\n"
+ .'- Hermes Agent: Hermes Agent ID, in the format of jvs-xxxx.', 'type' => 'string', 'example' => 'jvs-xxxxx'],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '', 'description' => 'The error code returned if the operation fails.', 'type' => 'string', 'example' => 'Runtime.NotFound'],
+ 'Message' => ['title' => '', 'description' => 'The error message returned if the operation fails.', 'type' => 'string', 'example' => 'The runtime is not found.'],
+ 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned if the operation fails.', 'type' => 'integer', 'format' => 'int32', 'example' => '404'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Remove model groups from agent runtime resources',
+ 'description' => 'You can remove model groups from Agent runtime resources such as JVS Computer, OpenClaw, and Hermes Agent in the Wuying Agent Management Center. When an Agent runtime resource needs to switch to a different model group, call this operation first to remove the authorization relationship between the Agent runtime resource and the existing model group.'."\n"
+ ."\n"
+ .'Make sure that you are familiar with the operations and usage of the Wuying Agent Management Center before calling this operation.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ChargeType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The billing method.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* PrePaid: subscription'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'PrePaid' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RemoveRuntimeModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'example' => 'PrePaid',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"RuntimeId\\": \\"jvs-xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Runtime.NotFound\\",\\n \\"Message\\": \\"The runtime is not found.\\",\\n \\"HttpStatusCode\\": 404\\n }\\n ],\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'RenewAppInstanceGroup' => [
+ 'summary' => 'Renews a delivery group.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Period',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The subscription period.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREappstreamingU1TTUH'],
+ ],
+ 'parameters' => [
[
- 'name' => 'PeriodUnit',
- 'in' => 'formData',
+ 'name' => 'ProductType',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The time unit.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Month'."\n"
- .'* Year'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'Cloud application of WUYING Workspace.'],
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Month' => '',
- 'Year' => '',
- ],
- 'example' => 'Month',
+ 'required' => true,
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
[
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The promotion ID. You can obtain this value by calling the [GetResourcePrice](~~428503~~) operation.', 'type' => 'string', 'required' => false, 'example' => '17440009****', 'title' => ''],
+ ],
+ [
'name' => 'AutoPay',
- 'in' => 'formData',
+ 'in' => 'query',
'schema' => [
- 'description' => 'Auto payment.'."\n",
+ 'description' => 'Specifies whether to enable automatic payment.',
+ 'enumValueTitles' => ['true' => 'Automatic payment is enabled.', 'false' => 'Manual payment is required. This is the default value.'],
'type' => 'boolean',
'required' => false,
'example' => 'false',
+ 'title' => '',
],
],
[
- 'name' => 'AutoRenew',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Auto-renewal.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The numeric part of the resource purchase duration. This parameter is used together with PeriodUnit to specify the complete purchase duration.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'PromotionId',
- 'in' => 'formData',
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The ID of the discount.'."\n"
+ 'description' => 'The unit part of the resource purchase duration. This parameter is used together with Period to specify the complete purchase duration. Valid combinations of Period and PeriodUnit:'."\n"
."\n"
- .'> If PromotionId is set, it will try to apply the corresponding discount.'."\n",
+ .'- 1 Week (1 week)'."\n"
+ .'- 1 Month (1 month)'."\n"
+ .'- 2 Month (2 months)'."\n"
+ .'- 3 Month (3 months)'."\n"
+ .'- 6 Month (6 months)'."\n"
+ .'- 1 Year (1 year)'."\n"
+ .'- 2 Year (2 years)'."\n"
+ .'- 3 Year (3 years)'."\n"
+ ."\n"
+ .'> This parameter is case-sensitive. For example, `Week` is valid, but `week` is invalid. If the request parameters do not match the combinations listed above, such as `2 Week`, the call to this operation succeeds, but an error occurs during the order placement phase.',
+ 'enumValueTitles' => ['Month' => 'month.', 'Year' => 'year.', 'Week' => 'week.'],
'type' => 'string',
- 'required' => false,
- 'example' => '17440009****',
+ 'required' => true,
+ 'example' => 'Week',
+ 'title' => '',
],
],
[
- 'name' => 'VSwitchIds',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The list of office network vSwitches.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The vSwitch IDs.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-55vk6****5vatze7jg',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the delivery group.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
],
[
- 'name' => 'VirtualNodePoolId',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vnp-0b************gyw',
- ],
+ 'name' => 'RenewMode',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
- 'name' => 'NetworkStrategyType',
- 'in' => 'formData',
+ 'name' => 'RenewAmount',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'RenewNodes',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The type of the network policy (in invitational preview).'."\n",
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'required' => false,
- 'example' => 'DirectIp',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'Bandwidth',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'bandwidth value, the NetworkStrategyType is valid for DirectIp. Unit: Mbps, range 2~100'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '2',
- 'example' => '10',
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Code' => ['description' => 'The error code returned if the call failed.', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '123456****', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Renew a delivery group',
+ 'description' => 'Before you call this operation, make sure that you are familiar with the [Billable methods and pricing](~~426039~~) of WUYING Workspace.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewAppInstanceGroup'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'IdempotenceToken',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '幂等性令牌,确保操作唯一性',
- 'description' => 'Idempotence token to ensure operation uniqueness'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '6a1b8c3d',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RenewAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"OrderId\\": \\"123456****\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n}","type":"json"}]',
+ ],
+ 'RenewWuyingServer' => [
+ 'summary' => 'Renews a workstation.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ServerPortRange',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'WuyingServerId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The workstation ID.', 'type' => 'string', 'required' => false, 'example' => 'ws-0bw2f11****dial', 'title' => ''],
],
[
- 'name' => 'SavingPlanId',
+ 'name' => 'Period',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The renewal duration.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'HostName',
+ 'name' => 'PeriodUnit',
'in' => 'formData',
'schema' => [
+ 'description' => 'The unit of the renewal duration.',
+ 'enumValueTitles' => ['Month' => 'month.', 'Year' => 'year.'],
'type' => 'string',
+ 'required' => false,
+ 'example' => 'Month'."\n",
+ 'title' => '',
],
],
[
- 'name' => 'SubPayType',
+ 'name' => 'AutoPay',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'Specifies whether to enable automatic payment.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
- 'name' => 'MaxPrice',
+ 'name' => 'PromotionId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
+ 'schema' => ['description' => 'The discount ID.', 'type' => 'string', 'required' => false, 'example' => '17440009****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response to the request.'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Data' => [
- 'description' => 'The response data.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'OrderId' => [
- 'description' => 'The order ID.'."\n",
- 'type' => 'string',
- 'example' => '23429322113****',
- ],
- 'WuyingServerIdList' => [
- 'description' => 'The list of workstation IDs.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the workstation.'."\n",
- 'type' => 'string',
- 'example' => 'ws-0byd****2lwi',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '23977848****97', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"23429322113****\\",\\n \\"WuyingServerIdList\\": [\\n \\"ws-0byd****2lwi\\"\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'CreateWuyingServer',
- 'description' => '1. Project is equivalent to the Resource Configuration module of the Cloud Flow console'."\n"
- ."\n"
- .'2. If there are multiple versions behind the input parameter ContentId:'."\n"
- ."\n"
- .' **'."\n"
- ."\n"
- .' **Note** The default version is used.'."\n"
- ."\n"
- .' Bind simultaneously'."\n"
- ."\n"
- .'3. You can call the current interface only if the default version of Content is available.'."\n",
- ],
- 'ListWuyingServer' => [
- 'summary' => 'Queries the list of workstations.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Renew a workstation',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RenewWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OrderId\\": \\"23977848****97\\"\\n}","type":"json"}]',
+ ],
+ 'RestartWuyingServer' => [
+ 'summary' => 'Restarts a workstation.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingEP3FXS'],
],
'parameters' => [
[
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '分页大小',
- 'description' => 'The number of records per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '100',
- 'default' => '20',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '页码',
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
'name' => 'ProductType',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'BizType',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- [
- 'name' => 'WuyingServerNameOrId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '研发主机名称',
- 'description' => 'The workstation name or workstation ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'exampleServerName',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'WuyingServerIdList',
'in' => 'formData',
'style' => 'flat',
'schema' => [
- 'description' => 'The list of workstation IDs.'."\n",
+ 'description' => 'The list of workstation IDs.',
'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the workstation.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ws-0bydg****2lwi',
- ],
+ 'items' => ['description' => 'The workstation ID.', 'type' => 'string', 'required' => false, 'example' => 'ws-0byd****n2lwi', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'ServerInstanceType',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '规格',
- 'description' => 'Workstation specifications.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eds.proworkstation_flagship_elite.32c64g.48g1x',
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Restart a workstation',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ImageId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '镜像ID',
- 'description' => 'The image ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'img-bp13mu****',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RestartWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'StartTaskForDistributeImage' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'BizRegionId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '地域',
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'AK' => [],
],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '219723',
+ 'abilityTreeNodes' => ['FEATUREappstreamingSH8DGI'],
+ ],
+ 'parameters' => [
[
- 'name' => 'OfficeSiteId',
+ 'name' => 'ImageId',
'in' => 'formData',
- 'schema' => [
- 'title' => '工作区ID',
- 'description' => 'The office network IDs.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou+dir-172301****',
- ],
+ 'schema' => ['title' => '', 'description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'imgc-07jyldnd9i*****'],
],
[
- 'name' => 'ChargeType',
+ 'name' => 'VersionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '付费类型',
- 'description' => 'The billing method of the Internet access package.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PrePaid',
- ],
+ 'schema' => ['title' => '', 'description' => 'The image version ID. If this parameter is not specified, the latest image version is used.', 'type' => 'string', 'required' => false, 'example' => 'iv-07jyldnd9i****'],
],
[
- 'name' => 'VirtualNodePoolId',
+ 'name' => 'RetryType',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '', 'description' => 'This parameter is not publicly available.', 'type' => 'string', 'required' => false, 'example' => 'RETRY'],
],
[
- 'name' => 'AddVirtualNodePoolStatusList',
+ 'name' => 'DestinationRegionList',
'in' => 'formData',
- 'style' => 'flat',
+ 'style' => 'repeatList',
'schema' => [
+ 'description' => 'The list of destination regions to which the image is copied.',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'items' => ['description' => 'The Alibaba Cloud region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Status',
+ 'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'title' => '状态',
- 'description' => 'The status of the workstation.'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudDesktop' => 'WUYING Workspace.', 'CloudApp' => 'WUYING CloudApp.', 'WuyingServer' => 'WUYING Workstation.'],
'type' => 'string',
'required' => false,
- 'example' => 'RUNNING',
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
[
- 'name' => 'Users',
+ 'name' => 'SourceRegion',
'in' => 'formData',
- 'style' => 'flat',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
+ 'schema' => ['description' => 'The source region from which the image is copied. If this parameter is not specified, a random region is selected.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response struct.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'TotalCount' => [
- 'title' => '总量',
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '15',
- ],
- 'PageSize' => [
- 'title' => '分页大小',
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'title' => '页码',
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'WuyingServerList' => [
- 'description' => 'The list of workstation information.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'AliUid' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'WuyingServerId' => [
- 'description' => 'The ID of the workstation.'."\n",
- 'type' => 'string',
- 'example' => 'ws-0byd****8wn2lwi',
- ],
- 'WuyingServerName' => [
- 'description' => 'The name of the workstation.'."\n",
- 'type' => 'string',
- 'example' => 'exampleServerName',
- ],
- 'Status' => [
- 'description' => 'The status of the workstation.'."\n",
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'ServerInstanceTypeInfo' => [
- 'description' => 'The specifications.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'ServerInstanceType' => [
- 'description' => 'Workstation specifications.'."\n",
- 'type' => 'string',
- 'example' => 'eds.proworkstation_flagship_elite_ne.96c384g.192g4x',
- ],
- 'Cpu' => [
- 'description' => 'The number of vCPUs.'."\n",
- 'type' => 'string',
- 'example' => '96',
- ],
- 'Memory' => [
- 'description' => 'The memory size. Unit: MB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '393,216',
- ],
- 'Gpu' => [
- 'description' => 'The number of GPUs.'."\n",
- 'type' => 'string',
- 'example' => '4',
- ],
- 'GpuMemory' => [
- 'description' => 'The memory size. Unit: MB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '196,608',
- ],
- 'GpuSpec' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'SystemDiskSize' => [
- 'description' => 'The size of the system disk. Unit: GiB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'SystemDiskCategory' => [
- 'description' => 'The type of the system disk.'."\n",
- 'type' => 'string',
- 'example' => 'cloud_auto',
- ],
- 'SystemDiskPerformanceLevel' => [
- 'description' => 'The performance level (PL) of the system disk.'."\n",
- 'type' => 'string',
- 'example' => 'PL0',
- ],
- 'DataDisk' => [
- 'description' => 'The data disks.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about the data disk.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'DataDiskSize' => [
- 'description' => 'The size of the data disk. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'DataDiskCategory' => [
- 'description' => 'The category of data disk.'."\n",
- 'type' => 'string',
- 'example' => 'cloud_auto',
- ],
- 'DataDiskPerformanceLevel' => [
- 'description' => 'The PL of the data disk.'."\n",
- 'type' => 'string',
- 'example' => 'PL0',
- ],
- 'DataDiskId' => [
- 'type' => 'string',
- ],
- 'DataDiskNo' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'ImageId' => [
- 'description' => 'The ID of the custom image.'."\n",
- 'type' => 'string',
- 'example' => 'imgc-06****oagaev',
- ],
- 'ImageName' => [
- 'description' => 'The image name.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'OsType' => [
- 'description' => 'The OS type.'."\n",
- 'type' => 'string',
- 'example' => 'Linux',
- ],
- 'BizRegionId' => [
- 'description' => 'Region.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'OfficeSiteId' => [
- 'description' => 'The ID of the office network.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou+dir-1b****ayv2',
- ],
- 'OfficeSiteName' => [
- 'description' => 'The office network name.'."\n",
- 'type' => 'string',
- 'example' => 'exampleOfficeSite',
- ],
- 'OfficeSiteType' => [
- 'description' => 'The type of the office network.'."\n",
- 'type' => 'string',
- 'example' => 'SIMPLE',
- ],
- 'NetworkInterfaceIp' => [
- 'description' => 'The private IP address.'."\n",
- 'type' => 'string',
- 'example' => '10.80.21.149',
- ],
- 'ChargeType' => [
- 'description' => 'The billing method.'."\n",
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'CreateTime' => [
- 'description' => 'The time when the storage resource was created.'."\n",
- 'type' => 'string',
- 'example' => '2025-08-02T16:52:11.000+00:00',
- ],
- 'ExpiredTime' => [
- 'description' => 'The time when the subscription instance expires.'."\n",
- 'type' => 'string',
- 'example' => '2025-09-03T16:00:00.000+00:00',
- ],
- 'VirtualNodePoolId' => [
- 'type' => 'string',
- ],
- 'AddVirtualNodePoolStatus' => [
- 'type' => 'string',
- ],
- 'SubPayType' => [
- 'type' => 'string',
- ],
- 'MaxPrice' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'VirtualKubeletIp' => [
- 'type' => 'string',
- ],
- 'ResourceSessionStatus' => [
- 'type' => 'string',
- ],
- 'Bandwidth' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'FotaVersion' => [
- 'type' => 'string',
- ],
- 'TimerGroupId' => [
- 'title' => '定时任务ID。',
- 'type' => 'string',
- ],
- 'SystemDiskId' => [
- 'type' => 'string',
- ],
- 'InstanceInfoList' => [
- 'description' => 'The list of information about the workstation instance.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => 'The ID of the instance.'."\n",
- 'type' => 'string',
- 'example' => 'p-0ceitx****c5',
- ],
- 'NetworkInterfaceId' => [
- 'description' => 'The ID of the ENI.'."\n",
- 'type' => 'string',
- 'example' => 'eni-uf65b****dfnt3wb',
- ],
- ],
- 'description' => '',
- ],
- ],
- 'SecurityGroupIds' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'Users' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'Sessions' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ResourceSessionStartTime' => [
- 'type' => 'string',
- ],
- 'UserId' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'PolicyGroupIdList' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'description' => '',
- ],
- ],
+ 'Data' => ['description' => 'The ID of the image copy task.', 'type' => 'string', 'example' => 'tid-06xnr5lyp77e7****', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '419F31B9-1FDF-5644-ABA3-D00026FA****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Instance.NotFound', 'errorMessage' => 'The instance is not found.', 'description' => 'The instance is not found.'],
+ ['errorCode' => 'DesktopInstance.NotFound', 'errorMessage' => 'The cloud computer instance does not exist.', 'description' => 'The cloud computer instance does not exist.'],
+ ['errorCode' => 'Instance.ImageUnsupported', 'errorMessage' => 'A non-centralized image does not support this type of operation.', 'description' => 'A non-centralized image does not support this type of operation.'],
+ ['errorCode' => 'Instance.PhysicalNodeNotExist', 'errorMessage' => 'The instance physical node does not exist.', 'description' => 'The physical node of this instance does not exist.'],
+ ['errorCode' => 'ImageCreateByInstance.TaskExist', 'errorMessage' => 'The image task of instance creation already exists.', 'description' => 'The image task of instance creation already exists.'],
+ ['errorCode' => 'ExceedBuilderQuota', 'errorMessage' => 'The maximum number of builders is reached.', 'description' => 'The maximum number of builders is reached.'],
+ ['errorCode' => 'InvalidBaseImage.NotConfigured', 'errorMessage' => 'Configuration required for Vhd/Container images.', 'description' => 'Configuration required for Vhd/Container images.'],
+ ['errorCode' => 'CreateDesktopImageRecord.Failed', 'errorMessage' => 'Create cloud computer image failed.', 'description' => 'Failed to create the cloud computer image.'],
+ ['errorCode' => 'Image.NotExist', 'errorMessage' => 'The image does not exist.', 'description' => 'The image does not exist.'],
+ ['errorCode' => 'ImageRegionDistribute.NotAllow', 'errorMessage' => 'This image cannot be distributed.', 'description' => 'This image cannot be distributed.'],
+ ['errorCode' => 'ImageUpdateFailed.NotAllow', 'errorMessage' => 'The image is not allowed to be modified.', 'description' => 'The image is not allowed to be modified.'],
+ ['errorCode' => 'ImageUpdateSharedImageFailed.NotAllow', 'errorMessage' => 'The shared image is not allowed to be modified.', 'description' => 'The shared image is not allowed to be modified.'],
+ ['errorCode' => 'ParentImageRegionDistribute.NotExist', 'errorMessage' => 'The target distribution region of the parent image does not exist.', 'description' => 'The target distribution region of the parent image does not exist.'],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error.', 'description' => ''],
+ ['errorCode' => 'ImageDistribute.TargetDistributeRegionListEmpty', 'errorMessage' => 'The target distribution region list is empty.', 'description' => 'The target distribution region list is empty.'],
+ ['errorCode' => 'ImageDistribute.ImageNotSupport', 'errorMessage' => 'The image does not support region distribution.', 'description' => 'The image does not support region distribution. E.g. encrypted images.'],
+ ['errorCode' => 'ImageDistribute.RepeatedDistribution', 'errorMessage' => 'This image has been distributed to this region.', 'description' => 'This image has been distributed to this region.'],
+ ['errorCode' => 'ImageDistribute.Undistributed', 'errorMessage' => 'The image has not been distributed to any region.', 'description' => 'The image has not been distributed to any region.'],
+ ['errorCode' => 'ImageRegion.NotConfigured', 'errorMessage' => 'The image does not have any region configuration.', 'description' => 'The image does not have any region configuration.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Initiate image cross-region copy task',
+ 'summary' => 'Initiates a task to copy an image to other regions.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:StartTaskForDistributeImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 15,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"WuyingServerList\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"WuyingServerId\\": \\"ws-0byd****8wn2lwi\\",\\n \\"WuyingServerName\\": \\"exampleServerName\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ServerInstanceTypeInfo\\": {\\n \\"ServerInstanceType\\": \\"eds.proworkstation_flagship_elite_ne.96c384g.192g4x\\",\\n \\"Cpu\\": \\"96\\",\\n \\"Memory\\": 0,\\n \\"Gpu\\": \\"4\\",\\n \\"GpuMemory\\": 0,\\n \\"GpuSpec\\": \\"\\"\\n },\\n \\"SystemDiskSize\\": 100,\\n \\"SystemDiskCategory\\": \\"cloud_auto\\",\\n \\"SystemDiskPerformanceLevel\\": \\"PL0\\",\\n \\"DataDisk\\": [\\n {\\n \\"DataDiskSize\\": 200,\\n \\"DataDiskCategory\\": \\"cloud_auto\\",\\n \\"DataDiskPerformanceLevel\\": \\"PL0\\",\\n \\"DataDiskId\\": \\"\\",\\n \\"DataDiskNo\\": \\"\\"\\n }\\n ],\\n \\"ImageId\\": \\"imgc-06****oagaev\\",\\n \\"ImageName\\": \\"Alibaba Cloud Linux 3.2104 LTS 64位\\",\\n \\"OsType\\": \\"Linux\\",\\n \\"BizRegionId\\": \\"cn-hangzhou\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-1b****ayv2\\",\\n \\"OfficeSiteName\\": \\"exampleOfficeSite\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"NetworkInterfaceIp\\": \\"10.80.21.149\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"CreateTime\\": \\"2025-08-02T16:52:11.000+00:00\\",\\n \\"ExpiredTime\\": \\"2025-09-03T16:00:00.000+00:00\\",\\n \\"VirtualNodePoolId\\": \\"\\",\\n \\"AddVirtualNodePoolStatus\\": \\"\\",\\n \\"SubPayType\\": \\"\\",\\n \\"MaxPrice\\": 0,\\n \\"VirtualKubeletIp\\": \\"\\",\\n \\"ResourceSessionStatus\\": \\"\\",\\n \\"Bandwidth\\": 0,\\n \\"FotaVersion\\": \\"\\",\\n \\"TimerGroupId\\": \\"\\",\\n \\"SystemDiskId\\": \\"\\",\\n \\"InstanceInfoList\\": [\\n {\\n \\"InstanceId\\": \\"p-0ceitx****c5\\",\\n \\"NetworkInterfaceId\\": \\"eni-uf65b****dfnt3wb\\"\\n }\\n ],\\n \\"SecurityGroupIds\\": [\\n \\"\\"\\n ],\\n \\"Users\\": [\\n \\"\\"\\n ],\\n \\"Sessions\\": [\\n {\\n \\"ResourceSessionStartTime\\": \\"\\",\\n \\"UserId\\": \\"\\"\\n }\\n ],\\n \\"PolicyGroupIdList\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListWuyingServer',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"tid-06xnr5lyp77e7****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"419F31B9-1FDF-5644-ABA3-D00026FA****\\"\\n}","type":"json"}]',
],
'StartWuyingServer' => [
- 'summary' => 'Start the workstation.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11329,71 +10922,71 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingEP3FXS',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingEP3FXS'],
],
'parameters' => [
[
'name' => 'ProductType',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'WuyingServerIdList',
'in' => 'formData',
'style' => 'flat',
'schema' => [
- 'description' => 'The list of workstation IDs.'."\n",
+ 'description' => 'The list of workstation IDs.',
'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the workstation.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ws-0bydg****2lwi',
- ],
+ 'items' => ['description' => 'The workstation ID.', 'type' => 'string', 'required' => false, 'example' => 'ws-0bydg****2lwi', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
+ 'title' => 'Start a workstation',
+ 'summary' => 'Starts a workstation.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:StartWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'StartWuyingServer',
],
'StopWuyingServer' => [
- 'summary' => 'Stops the workstation.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Stops a workstation.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11405,51 +10998,39 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingEP3FXS',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingEP3FXS'],
],
'parameters' => [
[
'name' => 'ProductType',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'WuyingServerIdList',
'in' => 'formData',
'style' => 'flat',
'schema' => [
- 'description' => 'The list of workstation IDs.'."\n",
+ 'description' => 'The list of workstation IDs.',
'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the workstation.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ws-0byd****wn2lwi',
- ],
+ 'items' => ['description' => 'The workstation ID.', 'type' => 'string', 'required' => false, 'example' => 'ws-0byd****wn2lwi', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'Force',
'in' => 'formData',
'schema' => [
- 'title' => '强制重启',
- 'description' => 'Force restart.'."\n"
- ."\n"
- .'Valid values:'."\n"
+ 'title' => '',
+ 'description' => 'Specifies whether to forcibly restart the workstation. Valid values:'."\n"
."\n"
- .'* True.'."\n"
- .'* False'."\n",
+ .'- True: forcibly restart'."\n"
+ .'- False: do not forcibly restart.',
+ 'enumValueTitles' => ['True' => 'Forcible.', 'False' => 'Not forcible.'],
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'True' => '',
- 'False' => '',
- ],
'example' => 'True',
],
],
@@ -11457,114 +11038,216 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'AD2D0761-1FE5-549D-B169******',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AD2D0761-1FE5-549D-B169******'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\"\\n}","type":"json"}]',
- 'title' => 'StopWuyingServer',
- ],
- 'RestartWuyingServer' => [
- 'summary' => 'Restarts the workstation.',
- 'methods' => [
- 'post',
+ 'title' => 'Stop a workstation',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:StopWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\"\\n}","type":"json"}]',
+ ],
+ 'TagCloudResources' => [
+ 'summary' => 'Creates and attaches tags to cloud resources. If a tag already exists on a resource, the tag value is updated.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingEP3FXS',
- ],
+ 'abilityTreeCode' => '266104',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ProductType',
+ 'name' => 'ResourceType',
'in' => 'formData',
'schema' => [
+ 'title' => '',
+ 'description' => 'The cloud resource type.',
+ 'enumValueTitles' => ['CenterImageId' => 'center image ID.', 'AppId' => 'application ID.', 'WyId' => 'unique ID of the Wuying user.', 'AppInstanceGroupId' => 'delivery group ID.', 'AliUid' => 'tenant ID.'],
'type' => 'string',
+ 'required' => true,
+ 'maxLength' => 30,
+ 'minLength' => 1,
+ 'enum' => ['AliUid', 'AppId', 'AppInstanceGroupId', 'WyId', 'CenterImageId'],
+ 'example' => 'AppInstanceGroupId',
],
],
[
- 'name' => 'WuyingServerIdList',
+ 'name' => 'ResourceIds',
'in' => 'formData',
- 'style' => 'flat',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The list of resource IDs. A maximum of 50 resource IDs are supported. You do not need to specify this parameter when the resource type is tenant ID.',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 1, 'example' => 'aig-0002'],
+ 'required' => false,
+ 'maxItems' => 50,
+ 'minItems' => 0,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The list of workstation IDs.'."\n",
+ 'title' => '',
+ 'description' => 'The list of tags. System tags and custom tags are supported.'."\n"
+ ."\n"
+ .'- System tag enumeration values:'."\n"
+ .' - `System/Scheduler/GRAYSCALE`: canary release tag'."\n"
+ .' - `System/Scheduler/STOP_NEW_USER_CONNECTION`: tag that prevents new user connections from being established for the delivery group'."\n"
+ ."\n"
+ .'- Custom tags: A maximum of 20 custom tags can be created.'."\n"
+ ."\n"
+ .'> Each tag key on the same resource can have only one tag value. If you add a tag key that already exists, the corresponding tag value is updated to the new value.',
'type' => 'array',
'items' => [
- 'description' => 'The ID of the workstation.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ws-0byd****n2lwi',
+ 'title' => '',
+ 'description' => 'The tag information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '', 'description' => 'The tag key. This parameter is case-sensitive. The tag key must be 1 to 128 characters in length.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'Resolution'],
+ 'Value' => ['title' => '', 'description' => 'The tag value. This parameter is case-sensitive. The tag value must be 1 to 128 characters in length.', 'type' => 'string', 'required' => true, 'maxLength' => 256, 'minLength' => 0, 'example' => '720p'],
+ ],
+ 'required' => true,
+ 'example' => '',
],
- 'required' => false,
+ 'required' => true,
+ 'maxItems' => 20,
+ 'minItems' => 1,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'FailedResources' => [
+ 'title' => '',
+ 'description' => 'The list of failed resources and tag information.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The failed resource and tag information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => [
+ 'title' => '',
+ 'description' => 'The cloud resource type.',
+ 'enumValueTitles' => ['CenterImageId' => 'center image ID.', 'AppId' => 'application ID.', 'WyId' => 'unique ID of the Wuying user.', 'AppInstanceGroupId' => 'delivery group ID.', 'AliUid' => 'tenant ID.'],
+ 'type' => 'string',
+ 'example' => 'AppInstanceGroupId',
+ ],
+ 'ResourceId' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'example' => 'aig-001'],
+ 'Tags' => [
+ 'title' => '',
+ 'description' => 'The list of failed tag information.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The failed tag information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'System/Scheduler/STOP_NEW_USER_CONNECTION'],
+ 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'true'],
+ 'Scope' => [
+ 'title' => '',
+ 'description' => 'The tag type.',
+ 'enumValueTitles' => ['Custom' => 'custom tag.', 'System' => 'system tag.'],
+ 'type' => 'string',
+ 'example' => 'System',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'TAG_KEY_DUPLICATED'],
+ 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'Duplicate tag keys exist.'],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'Service unavailable. Please try again later.', 'description' => 'Service unavailable. Please try again later.'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'RestartWuyingServer',
- ],
- 'ModifyWuyingServerAttribute' => [
- 'summary' => 'Modify workstation properties.',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FailedResources\\": [\\n {\\n \\"ResourceType\\": \\"AppInstanceGroupId\\",\\n \\"ResourceId\\": \\"aig-001\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"System/Scheduler/STOP_NEW_USER_CONNECTION\\",\\n \\"Value\\": \\"true\\",\\n \\"Scope\\": \\"System\\"\\n }\\n ],\\n \\"Code\\": \\"TAG_KEY_DUPLICATED\\",\\n \\"Message\\": \\"Duplicate tag keys exist.\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Create and attach tags to cloud resources',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:TagCloudResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UnassignWuyingServerPrivateAddresses' => [
+ 'summary' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11576,174 +11259,136 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingU1TTUH'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ProductType',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- [
'name' => 'WuyingServerId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the workstation.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ws-0bw2f11****dial',
- ],
- ],
- [
- 'name' => 'WuyingServerName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'exampleServerName',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'example' => 'aig-bp1234567890abcde', 'title' => '', 'description' => ''],
],
[
- 'name' => 'Password',
+ 'name' => 'PrivateIpAddresses',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'Workstation login password.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'yourPassword',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'example' => '10.0.0.2', 'title' => '', 'description' => '', 'required' => false],
+ 'required' => true,
+ 'example' => '["10.0.0.2","10.0.0.3"]',
+ 'maxItems' => 50,
+ 'title' => '',
+ 'description' => '',
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
+ 'RequestId' => ['type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => '', 'description' => ''],
],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'ModifyWuyingServerAttribute',
],
- 'UpdateWuyingServerImage' => [
- 'summary' => 'Updates the workstation image.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'Unbind' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingDG81PX',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'description' => 'The product type. Set this parameter to WuyingServer.'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING CloudApp.'],
'type' => 'string',
- 'required' => false,
- 'example' => 'WuyingServer',
+ 'required' => true,
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
[
- 'name' => 'WuyingServerId',
+ 'name' => 'EndUserId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the workstation.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ws-0bw2f11****dial',
- ],
+ 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''],
],
[
- 'name' => 'ImageId',
+ 'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The image ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'imgc-0aae4rgk9****6e8p',
- ],
+ 'schema' => ['description' => 'The delivery group ID. You can call the [GetConnectionTicket](~~609336~~) operation to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppInstancePersistentId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The persistent session ID. You can call the [GetConnectionTicket](~~609336~~) operation to obtain the ID.', 'type' => 'string', 'required' => false, 'example' => 'p-0bxls9m3cl7s****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppInstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The session ID. You can call the [GetConnectionTicket](~~609336~~) operation to obtain the ID.', 'type' => 'string', 'required' => false, 'example' => 'ai-d297eyf83g5ni****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response elements.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'TaskId' => [
- 'description' => 'The ID of the update task.'."\n",
- 'type' => 'string',
- 'example' => 'ota-be7jzm29wrrz5****',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Unbind a user from a session',
+ 'summary' => 'Unbinds a user from a session.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Unbind'],
+ ],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:Unbind',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskId\\": \\"ota-be7jzm29wrrz5****\\"\\n}","type":"json"}]',
- 'title' => 'UpdateWuyingServerImage',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
- 'RenewWuyingServer' => [
- 'summary' => 'Renew one workstation.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UntagCloudResources' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11753,137 +11398,191 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '266118',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'WuyingServerId',
+ 'name' => 'ResourceType',
'in' => 'formData',
'schema' => [
- 'description' => 'The ID of the workstation.'."\n",
+ 'title' => '',
+ 'description' => 'The resource type.',
+ 'enumValueTitles' => ['AppId' => 'application ID.', 'WyId' => 'unique ID of a Wuying user.', 'AppInstanceGroupId' => 'delivery group ID.', 'AliUid' => 'tenant ID.'],
'type' => 'string',
- 'required' => false,
- 'example' => 'ws-0bw2f11****dial',
+ 'required' => true,
+ 'example' => 'AppInstanceGroupId',
],
],
[
- 'name' => 'Period',
+ 'name' => 'ResourceIds',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The renewal duration.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'The list of resource IDs. A maximum of 50 resource IDs are supported. You do not need to specify this parameter when the resource type is tenant ID.',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 1, 'example' => 'aig-0009'],
'required' => false,
- 'example' => '1',
+ 'maxItems' => 50,
+ 'minItems' => 0,
+ 'example' => '',
],
],
[
- 'name' => 'PeriodUnit',
+ 'name' => 'TagKeys',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The unit of the renewal time.'."\n"
+ 'title' => '',
+ 'description' => 'The list of tags. System tags and custom tags are supported. You can specify up to 10 tags.'."\n"
."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Month: month.'."\n"
- .'* Year: year.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Month' => '',
- 'Year' => '',
- ],
- 'example' => 'Month'."\n",
- ],
- ],
- [
- 'name' => 'AutoPay',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Automatic payment.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'PromotionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The discount ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '17440009****',
+ .'Valid values of system tags:'."\n"
+ .'- `System/Scheduler/GRAYSCALE`: canary release tag'."\n"
+ .'- `System/Scheduler/STOP_NEW_USER_CONNECTION`: tag that prevents newly bound users in a delivery group from establishing connections.',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => 'The tag key. This parameter is case-sensitive. Length: 1 to 128 characters.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'System/Scheduler/GRAYSCALE'],
+ 'required' => true,
+ 'maxItems' => 20,
+ 'minItems' => 1,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'OrderId' => [
- 'description' => 'The order ID.'."\n",
- 'type' => 'string',
- 'example' => '23977848****97',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E25FC620-6B6F-12D2-A992-AD8727DC****'],
+ 'FailedResources' => [
+ 'title' => '',
+ 'description' => 'The list of failed resources and tag information.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The failed resource and tag information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => [
+ 'title' => '',
+ 'description' => 'The cloud resource type.',
+ 'enumValueTitles' => ['AppId' => 'application ID.', 'WyId' => 'unique ID of a Wuying user.', 'AppInstanceGroupId' => 'delivery group ID.', 'AliUid' => 'tenant ID.'],
+ 'type' => 'string',
+ 'example' => 'AppInstanceGroupId',
+ ],
+ 'ResourceId' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'example' => 'aig-00000001'],
+ 'Tags' => [
+ 'title' => '',
+ 'description' => 'The list of failed tag information.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The failed tag information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'Resolution'],
+ 'Scope' => [
+ 'title' => '',
+ 'description' => 'The tag type.',
+ 'enumValueTitles' => ['Custom' => 'custom tag.', 'System' => 'system tag.'],
+ 'type' => 'string',
+ 'example' => 'Custom',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNTAG_RESOURCE_FAILED'],
+ 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'Failed to untag resource.'],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'Service unavailable. Please try again later.', 'description' => 'Service unavailable. Please try again later.'],
+ ],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Unbind tags from cloud resources',
+ 'summary' => 'Unbinds tags from cloud resources in a unified manner.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OrderId\\": \\"23977848****97\\"\\n}","type":"json"}]',
- 'title' => 'RenewWuyingServer',
- ],
- 'DeleteWuyingServer' => [
- 'summary' => '删除工作站',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UntagCloudResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25FC620-6B6F-12D2-A992-AD8727DC****\\",\\n \\"FailedResources\\": [\\n {\\n \\"ResourceType\\": \\"AppInstanceGroupId\\",\\n \\"ResourceId\\": \\"aig-00000001\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Resolution\\",\\n \\"Scope\\": \\"Custom\\"\\n }\\n ],\\n \\"Code\\": \\"UNTAG_RESOURCE_FAILED\\",\\n \\"Message\\": \\"Failed to untag resource.\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'UpdateAppInstanceGroupImage' => [
+ 'summary' => 'Updates the image of a delivery group.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingKER98U',
- ],
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'WuyingServerId',
- 'in' => 'formData',
+ 'name' => 'ProductType',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The ID of the workstation.'."\n",
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'WUYING Cloud Application.'],
'type' => 'string',
'required' => true,
- 'example' => 'ws-0bw2f11****dial',
- 'maxItems' => 100,
+ 'example' => 'CloudApp',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'AppInstanceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The delivery group ID.', 'type' => 'string', 'required' => true, 'example' => 'aig-9ciijz60n4xsv****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppCenterImageId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The application image ID. You can obtain this ID from the Image Management page in the WUYING Cloud Application console.', 'type' => 'string', 'required' => true, 'example' => 'img-8z4nztpaqvay4****', 'title' => ''],
+ ],
+ [
+ 'name' => 'BizRegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID of the delivery group. For more information about supported regions, see [Limits](~~426036~~).',
+ 'enumValueTitles' => ['cn-shanghai' => 'China (Shanghai).', 'cn-hangzhou' => 'China (Hangzhou).'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
],
],
],
@@ -11891,37 +11590,46 @@
200 => [
'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Code' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => 'InvalidParameter.ProductType', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'The parameter ProductType is invalid.', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteWuyingServer',
- 'description' => 'Deletes a workstation.'."\n",
- ],
- 'ModifyBrowserInstanceGroup' => [
- 'summary' => 'Modifies the properties of the cloud browser.',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => 'Update delivery group image',
+ 'description' => '><warning>After the image update starts, sessions of end users who are accessing cloud applications will be disconnected. Proceed with caution to avoid data loss for end users.></warning>'."\n"
+ ."\n"
+ .'> After the update is published, changes typically take about 2 minutes to take effect on the end user side.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAppInstanceGroupImage'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UpdateAppInstanceGroupImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidParameter.ProductType\\",\\n \\"Message\\": \\"The parameter ProductType is invalid.\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateModelProviderTemplate' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11933,477 +11641,1504 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219753',
- 'abilityTreeNodes' => [
- 'FEATUREappstreaming4BR4QS',
- 'FEATUREappstreamingKE839Q',
- 'FEATUREappstreaming50MBS2',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
],
'parameters' => [
[
- 'name' => 'BrowserInstanceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the cloud browser to be modified.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'big-0bz55ixxxxx9xi9w9',
- ],
+ 'name' => 'ProviderTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the model provider template.', 'type' => 'string', 'required' => true, 'example' => 'mpt-xxxx'],
],
[
- 'name' => 'CloudBrowserName',
+ 'name' => 'Name',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The name of the cloud browser.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BrowserTest',
- ],
+ 'schema' => ['title' => '', 'description' => 'The name of the model provider template.', 'type' => 'string', 'required' => false, 'example' => '阿里云百炼'],
],
[
- 'name' => 'Network',
+ 'name' => 'Description',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The description of the model provider template.', 'type' => 'string', 'required' => false, 'example' => '阿里云百炼服务商'],
+ ],
+ [
+ 'name' => 'Config',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => 'The network configurations.'."\n",
+ 'description' => 'The model provider configuration.',
'type' => 'object',
'properties' => [
- 'AccessRestriction' => [
- 'description' => 'The type of the access control list.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* ALLOW_LIST: The whitelist.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ALLOW_LIST' => '',
- ],
- 'example' => 'ALLOW_LIST',
- ],
- 'RestrictedURLs' => [
- 'description' => 'The domain restriction configurations.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The restricted domain names.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'URL' => [
- 'description' => 'The restricted domain name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aliyun.com',
- ],
- 'RestrictedURLId' => [
- 'description' => 'The ID of the domain name. This parameter is required only when you want to modify the domain restriction configuration.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ru-12345',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'RemoveRestrictedURLIds' => [
- 'description' => 'The domain names to be removed.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the domain name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ru-12345',
- ],
- 'required' => false,
- ],
+ 'BaseUrl' => ['description' => 'The base URL of the model service API.', 'type' => 'string', 'required' => false, 'example' => 'https://dashscope.aliyuncs.com/compatible-mode/v1', 'title' => ''],
+ 'ApiKey' => ['description' => 'The API key of the model service, which is used for authentication. The key is encrypted after it is created.', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxxxxxxxxxxxxxxxxxx', 'title' => ''],
+ 'ApiType' => ['description' => 'The API protocol type.', 'type' => 'string', 'required' => false, 'example' => 'openai-completions', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Policy',
- 'in' => 'query',
- 'style' => 'json',
+ 'name' => 'EnableWuyingProxy',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Specifies whether to enable the Wuying security gateway proxy.',
+ 'enumValueTitles' => ['true' => 'yes.', 'false' => 'no.'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The access policy.'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'ClipboardPolicy' => [
- 'description' => 'The settings related to clipboard control.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Clipboard' => [
- 'description' => 'The clipboard policy.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* read: Allows copying from the local device to the cloud browser.'."\n"
- .'* readwrite: Allows copying in both directions.'."\n"
- .'* write: Allows copying from the cloud browser to the local device.'."\n"
- .'* off: Blocks copying in both directions.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'read' => '',
- 'readwrite' => '',
- 'write' => '',
- 'off' => '',
- ],
- 'example' => 'off',
- ],
- 'ClipboardScope' => [
- 'description' => 'The clipboard control scope.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* grained: fine-grained control'."\n"
- .'* global: global control'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'grained' => '',
- 'global' => '',
- ],
- 'example' => 'global',
- ],
- 'TextClipboard' => [
- 'description' => 'The text clipboard policy.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* read: Allows copying from the local device to the cloud browser.'."\n"
- .'* readwrite: Allows copying in both directions.'."\n"
- .'* write: Allows copying from the cloud browser to the local device.'."\n"
- .'* off: Blocks copying in both directions.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'read' => '',
- 'readwrite' => '',
- 'write' => '',
- 'off' => '',
- ],
- 'example' => 'off',
- ],
- 'RichTextClipboard' => [
- 'description' => 'The rich text clipboard policy.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* read: Allows copying from the local device to the cloud browser.'."\n"
- .'* readwrite: Allows copying in both directions.'."\n"
- .'* write: Allows copying from the cloud browser to the local device.'."\n"
- .'* off: Blocks copying in both directions.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'read' => '',
- 'readwrite' => '',
- 'write' => '',
- 'off' => '',
- ],
- 'example' => 'off',
- ],
- 'FileClipboard' => [
- 'description' => 'The file clipboard policy.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* read: Allows copying from the local device to the cloud browser.'."\n"
- .'* readwrite: Allows copying in both directions.'."\n"
- .'* write: Allows copying from the cloud browser to the local device.'."\n"
- .'* off: Blocks copying in both directions.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'read' => '',
- 'readwrite' => '',
- 'write' => '',
- 'off' => '',
- ],
- 'example' => 'off',
- ],
- 'ClipboardReadLimit' => [
- 'description' => 'The maximum number of characters allowed when copying from the clipboard.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1000',
- ],
- 'ClipboardWriteLimit' => [
- 'description' => 'The maximum number of characters allowed when copying to the clipboard.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1000',
- ],
- 'ClipboardSizeUnit' => [
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- ],
- 'VideoPolicy' => [
- 'description' => 'The display policy.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'FrameRate' => [
- 'description' => 'The frame rate.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '60',
- ],
- ],
- 'required' => false,
- ],
- 'WatermarkPolicy' => [
- 'description' => 'The watermark configuration.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'WatermarkSwitch' => [
- 'description' => 'Specifies whether to enable the watermark.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* off'."\n"
- .'* on'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'off' => '',
- 'on' => '',
- ],
- 'example' => 'off',
- ],
- 'WatermarkTypes' => [
- 'description' => 'The watermark types.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The watermark type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* EndUserId: convenience account ID'."\n"
- .'* ClientTime: the system time'."\n"
- .'* InstanceGroup: browser group ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'EndUserId' => '',
- 'ClientTime' => '',
- 'InstanceGroup' => '',
- ],
- 'example' => 'EndUserId',
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'PolicyId' => [
- 'description' => 'The ID of the policy.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pg-12345',
- ],
- 'PolicyVersion' => [
- 'description' => 'The policy version.'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* Center: center policy'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Center' => '',
- ],
- 'example' => 'Center',
- ],
- 'DisconnectKeepSession' => [
- 'description' => 'Defines what happens to a session when a user disconnects.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* customTime: The session will be terminated after a custom-defined timeout.'."\n"
- .'* persistent: The session will never be automatically terminated..'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'customTime' => '',
- 'persistent' => '',
- ],
- 'example' => 'customTime',
- ],
- 'DisconnectKeepSessionTime' => [
- 'description' => 'The session persistence duration.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '15',
- ],
- 'Html5FileTransfer' => [
- 'description' => 'The file transfer policy on the web client.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'off',
- ],
- 'NoOperationDisconnect' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'NoOperationDisconnectTime' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
],
- 'required' => false,
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Update model provider template',
+ 'description' => 'You can update a model provider template that has been created in the Wuying Agent Management Center, including the template name, description, model service connection configuration, and Wuying security proxy switch. Partial field updates are supported. You only need to pass in the fields that you want to modify.'."\n"
+ ."\n"
+ .'Before you call this operation, make sure that you are familiar with the operations and usage of the Wuying Agent Management Center.',
+ 'summary' => 'Updates a model provider template.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Timers',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The timer.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The associated scheduled task.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'TimerType' => [
- 'description' => 'The timer type:'."\n"
- ."\n"
- .'Valid value:'."\n"
- ."\n"
- .'* SESSION_TIMEOUT: Defines the timeout period before a disconnected session is terminated.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'SESSION_TIMEOUT' => '',
- ],
- 'example' => 'SESSION_TIMEOUT',
- ],
- 'Interval' => [
- 'description' => 'The interval.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '15',
- ],
- ],
- 'required' => false,
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UpdateModelProviderTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateModelTemplate' => [
+ 'summary' => 'Updates a model template.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'BrowserConfig',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ModelTemplateId',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['title' => '', 'description' => 'The model group ID.', 'type' => 'string', 'required' => true, 'example' => 'mt-xxxx'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The template group name.', 'type' => 'string', 'required' => false, 'example' => 'model-template-001'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The template group description.', 'type' => 'string', 'required' => false, 'example' => '测试模型分组'],
+ ],
+ [
+ 'name' => 'Config',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The model group configuration JSON object. You can use this field to modify the default model. The configuration format varies depending on the agent provider (AgentProvider):'."\n"
+ ."\n"
+ .'- **OpenClaw / AgenticComputer scenarios:**'."\n"
+ .'Set the default model by using the `defaults.model.primary` field. The format is `ProviderName/ModelCode`.'."\n"
+ ."\n"
+ .'- **HermesAgent scenarios:**'."\n"
+ .'Specify the provider name by using `model.provider` and the model code by using `model.default`.'."\n"
+ ."\n"
+ .'> :'."\n"
+ .'> - When you modify the default model, the system checks whether the specified provider and model code already exist in the model group.', 'type' => 'string', 'required' => false, 'example' => 'OpenClaw:'."\n"
+ .'{"defaults":{"model":{"primary":"bailian/qwen3.5-plus"}}}'."\n"
+ ."\n"
+ .'HermesAgent:'."\n"
+ .'{"model":{"provider":"bailian","default":"qwen3.5-plus"}}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The browser settings.'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'Homepage' => [
- 'description' => 'The home page.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://www.aliyun.com',
- ],
- 'BrowserParam' => [
- 'description' => 'The startup parameter.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '--incognito',
- ],
- 'Bookmarks' => [
- 'description' => 'The bookmark.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The description of the associated bookmark.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'BookmarkId' => [
- 'description' => 'The ID of the bookmark. This parameter needs to be specified only to modify the bookmark.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bm-12345',
- ],
- 'BookmarkName' => [
- 'description' => 'The name of the bookmark.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
- 'BookmarkURL' => [
- 'description' => 'The URL of the bookmark.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://www.aliyun.com',
- ],
- 'BookmarkFolder' => [
- 'description' => 'The folder where the bookmark is located.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'RemoveBookmarks' => [
- 'description' => 'The removed bookmarks.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The IDs of the removed bookmarks.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bm-12345',
- ],
- 'required' => false,
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Update a model group',
+ 'description' => 'You can update a model group that has been created in the Wuying Agent Management Center, including the group name, description, and model configuration information. You can modify the default model of a model group by updating the Config field. The updated configuration automatically takes effect on associated cloud desktops.'."\n"
+ ."\n"
+ .'Before using this operation, make sure that you are familiar with the operations and usage of the Wuying Agent Management Center.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UpdateModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateWuyingServerImage' => [
+ 'summary' => 'Updates a workstation image.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingDG81PX'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProductType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The product type. Set this parameter to WuyingServer.', 'type' => 'string', 'required' => false, 'example' => 'WuyingServer', 'title' => ''],
+ ],
+ [
+ 'name' => 'WuyingServerId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The workstation ID.', 'type' => 'string', 'required' => false, 'example' => 'ws-0bw2f11****dial', 'title' => ''],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'imgc-0aae4rgk9****6e8p', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request'."\n",
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'TaskId' => ['description' => 'The update task ID.', 'type' => 'string', 'example' => 'ota-be7jzm29wrrz5****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => 'ModifyBrowserInstanceGroup',
- 'description' => 'Modifies the properties of the cloud browser.'."\n",
+ 'title' => 'Update a workstation image',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UpdateWuyingServerImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskId\\": \\"ota-be7jzm29wrrz5****\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com',
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'appstream-center.cn-shanghai.aliyuncs.com', 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com', 'vpc' => 'appstream-center-intl.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'appstream-center.ap-southeast-1.aliyuncs.com', 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com', 'vpc' => 'appstream-center-intl.vpc-proxy.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AddRemoveAccountIsSame', 'message' => 'The same account is to be added and to be removed at the same time.', 'http_code' => 400, 'description' => 'The same account is to be added and to be removed at the same time.'],
+ ['code' => 'AppCenterImageId.Missing', 'message' => 'The AppCenter ImageId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppCenterImageInfo.NotFound', 'message' => 'The AppCenter ImageInfo is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppDeploymentInfo.NotFound', 'message' => 'The AppDeploymentInfo is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstallation.StartFailed', 'message' => 'Start app installation failed.', 'http_code' => 400, 'description' => 'Failed to start the app installation.'],
+ ['code' => 'AppInstallationStatus.IsFailed', 'message' => 'App installation failed.', 'http_code' => 400, 'description' => 'The app installation status is failed.'],
+ ['code' => 'AppInstanceGroupAttributeModify.Failed', 'message' => 'Failed to modify the delivery group attribute.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupIdIsNull', 'message' => 'The AppInstanceGroupId is null.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupImageCreate.Failed', 'message' => 'Failed to create an image from the debugging app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupNotFound', 'message' => 'The AppInstanceGroup is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupNotFound', 'message' => 'The specified AppInstanceGroup not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppType.ValueNotSupported', 'message' => 'The category of the app is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AuthorizeFailed', 'message' => 'Authorize failed, please check your EndUserId and Password.', 'http_code' => 400, 'description' => 'Invalid username or password.'],
+ ['code' => 'BillingItem.InsertFailure', 'message' => 'Failed to insert the billing item.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'BizTypeNotMatch', 'message' => 'The bizType and image do not match.', 'http_code' => 400, 'description' => 'The bizType and image do not match.'],
+ ['code' => 'BuilderImage.StartTaskFailed', 'message' => 'Failed to start the builder image task.', 'http_code' => 400, 'description' => 'Failed to start the builder image task.'],
+ ['code' => 'CallBack.PayOrderCallbackFailed', 'message' => 'Failed to lock the order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CashBookInsufficient', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CheckStock.Failed', 'message' => 'Failed to check the stock.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ConnectLdapServer.Failed', 'message' => 'Failed to connect to the LDAP server. Please check the configuration.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CreateAppInstanceGroup.Failed', 'message' => 'Failed to create the app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CreateDesktopImageRecord.Failed', 'message' => 'Create cloud computer image failed.', 'http_code' => 400, 'description' => 'Failed to create the cloud computer image.'],
+ ['code' => 'DeleteTemplate.Failed', 'message' => 'Delete template failed.', 'http_code' => 400, 'description' => 'Failed to delete the template.'],
+ ['code' => 'DesktopInstance.NotFound', 'message' => 'The cloud computer instance does not exist.', 'http_code' => 400, 'description' => 'The cloud computer instance does not exist.'],
+ ['code' => 'ExceedAddAccountQuota', 'message' => 'The maximum number of account addition is reached.', 'http_code' => 400, 'description' => 'The maximum number of account addition is reached.'],
+ ['code' => 'ExceedAppAuthUserQuota', 'message' => 'The authorized user quota of the app is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedAppInstanceGroupQuota', 'message' => 'The app instance group quota is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedBuilderQuota', 'message' => 'The maximum number of builders is reached.', 'http_code' => 400, 'description' => 'The maximum number of builders is reached.'],
+ ['code' => 'ExceedImageQuota', 'message' => 'The maximum number of images is reached.', 'http_code' => 400, 'description' => 'The maximum number of images is reached.'],
+ ['code' => 'ExceedPoolNodeAmountQuota', 'message' => 'The pool node amount quota is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedRemoveAccountQuota', 'message' => 'The maximum number of account removal is reached.', 'http_code' => 400, 'description' => 'The maximum number of account removal is reached.'],
+ ['code' => 'Forbidden.NoPermission', 'message' => 'You are not authorized to access this page.', 'http_code' => 403, 'description' => 'You are not authorized to access this page.'],
+ ['code' => 'ForbiddenNoRealNameAuthentication', 'message' => 'Operation failed. The user has not completed the real-name authentication.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ForbiddenNoRealNameAuthentication', 'message' => 'Forbidden by user real name authentication status.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'GetLoginTokenError', 'message' => 'Failed to get the login token.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Image.CreateModeInvalid', 'message' => 'The creation mode of this task is invalid.', 'http_code' => 400, 'description' => 'The creation mode of this task is invalid.'],
+ ['code' => 'Image.NotExist', 'message' => 'The image does not exist.', 'http_code' => 400, 'description' => 'The image does not exist.'],
+ ['code' => 'ImageCreateByInstance.TaskExist', 'message' => 'The image task of instance creation already exists.', 'http_code' => 400, 'description' => 'The image task of instance creation already exists.'],
+ ['code' => 'ImageDeleteFailed.HasSharedImage', 'message' => 'The shared image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllow', 'message' => 'The image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllowCommunityParent', 'message' => 'The parent image of a community image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The parent image of a community image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllowSharedImage', 'message' => 'The shared image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be deleted.'],
+ ['code' => 'ImageDistribute.ImageNotSupport', 'message' => 'The image does not support region distribution.', 'http_code' => 400, 'description' => 'The image does not support region distribution. E.g. encrypted images.'],
+ ['code' => 'ImageDistribute.RepeatedDistribution', 'message' => 'This image has been distributed to this region.', 'http_code' => 400, 'description' => 'This image has been distributed to this region.'],
+ ['code' => 'ImageDistribute.TargetDistributeRegionListEmpty', 'message' => 'The target distribution region list is empty.', 'http_code' => 400, 'description' => 'The target distribution region list is empty.'],
+ ['code' => 'ImageDistribute.Undistributed', 'message' => 'The image has not been distributed to any region.', 'http_code' => 400, 'description' => 'The image has not been distributed to any region.'],
+ ['code' => 'ImageIsNull', 'message' => 'The image does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ImageNotAllowDelete', 'message' => 'The image cannot be deleted, because shared cloud computers already exist.', 'http_code' => 400, 'description' => 'The image cannot be deleted, because shared cloud computers already exist.'],
+ ['code' => 'ImageRegion.NotConfigured', 'message' => 'The image does not have any region configuration.', 'http_code' => 400, 'description' => 'The image does not have any region configuration.'],
+ ['code' => 'ImageRegionDistribute.NotAllow', 'message' => 'This image cannot be distributed.', 'http_code' => 400, 'description' => 'This image cannot be distributed.'],
+ ['code' => 'ImageStatus.Error', 'message' => 'The image status is error.', 'http_code' => 400, 'description' => 'The image status is error.'],
+ ['code' => 'ImageStatus.ValueNotSupported', 'message' => 'The image status is not supported for creating a delivery group.', 'http_code' => 400, 'description' => 'You cannot create a delivery group in the current image status.'],
+ ['code' => 'ImageTask.Failed', 'message' => 'Start image task failed.', 'http_code' => 400, 'description' => 'Failed to start the image task.'],
+ ['code' => 'ImageUpdateFailed.NotAllow', 'message' => 'The image is not allowed to be modified.', 'http_code' => 400, 'description' => 'The image is not allowed to be modified.'],
+ ['code' => 'ImageUpdateSharedImageFailed.NotAllow', 'message' => 'The shared image is not allowed to be modified.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be modified.'],
+ ['code' => 'Instance.ImageUnsupported', 'message' => 'A non-centralized image does not support this type of operation.', 'http_code' => 400, 'description' => 'A non-centralized image does not support this type of operation.'],
+ ['code' => 'Instance.NotFound', 'message' => 'The instance is not found.', 'http_code' => 400, 'description' => 'The instance is not found.'],
+ ['code' => 'Instance.PhysicalNodeNotExist', 'message' => 'The instance physical node does not exist.', 'http_code' => 400, 'description' => 'The physical node of this instance does not exist.'],
+ ['code' => 'InternalError', 'message' => 'Internal error.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InternalError.TicketGenInternalError', 'message' => 'An error occurred while generating a ticket.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAliUid.Missing', 'message' => 'The AliUid is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAliUid.Missing', 'message' => 'The specified parameter AliUid is missing.', 'http_code' => 400, 'description' => 'The specified parameter AliUid is missing.'],
+ ['code' => 'InvalidAliUid.NotFound', 'message' => 'The AliUid is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAmount.Invalid', 'message' => 'The Amount is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.Missing', 'message' => 'The AppId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.NotFound', 'message' => 'The AppId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotContainThisAPP', 'message' => 'The app instance group does not contain this app.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotFound', 'message' => 'The app instance group is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotFound', 'message' => 'The AppInstanceGroupId %s is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NullAppInstanceGroup', 'message' => 'The app instance group is null.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NullOrNotPublishedStatus', 'message' => 'The app instance group does not exist or is not published.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.StatusInvalid', 'message' => 'The app instance group status is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.Unauthorized', 'message' => 'Unauthorized to use this app.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupAction.IllegalAction', 'message' => 'The action against the app instance group is not allowed.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupId.Missing', 'message' => 'The AppInstanceGroupId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupName.Missing', 'message' => 'The AppInstanceGroupName is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupSpecItem.NotFound', 'message' => 'The app instance group spec item is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceId.NotFound', 'message' => 'The AppInstanceId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceState', 'message' => 'The app instance state is invalid.', 'http_code' => 200, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.Invalid', 'message' => 'The AppInstanceType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.Missing', 'message' => 'The AppInstanceType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.NotFound', 'message' => 'The app instance type is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppVersion.Missing', 'message' => 'The AppVersion is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBaseImage.InvalidStatus', 'message' => 'Invalid base image status.', 'http_code' => 400, 'description' => 'The status of the base image is invalid.'],
+ ['code' => 'InvalidBaseImage.NotConfigured', 'message' => 'Configuration required for Vhd/Container images.', 'http_code' => 400, 'description' => 'Configuration required for Vhd/Container images.'],
+ ['code' => 'InvalidBaseImage.NotFound', 'message' => 'Base image not found.', 'http_code' => 400, 'description' => 'The base image is not found.'],
+ ['code' => 'InvalidBaseImage.NotSystemImage', 'message' => 'Base image is not system image.', 'http_code' => 400, 'description' => 'The base image is not a system image.'],
+ ['code' => 'InvalidBaseImageVersion.NotOnline', 'message' => 'Base image version is not online.', 'http_code' => 400, 'description' => 'The base image is not of an available online version.'],
+ ['code' => 'InvalidBindRelationship.NotFound', 'message' => 'The bind relationship is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBindStage.Missing', 'message' => 'The BindStage is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBindStrategy.NotFound', 'message' => 'The bind strategy is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBizType', 'message' => 'The bizType parameter is invalid.', 'http_code' => 400, 'description' => 'The bizType parameter is invalid.'],
+ ['code' => 'InvalidBrowserInstanceGroup.NotFound', 'message' => 'The browser instance group is not found.', 'http_code' => 400, 'description' => 'The cloud browser does not exist, please confirm and try again'],
+ ['code' => 'InvalidBundle.NotFound', 'message' => 'The request bundle does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidChargeType.Missing', 'message' => 'The ChargeType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidChargeType.ValueNotSupported', 'message' => 'The ChargeType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDataDiskSize.SmallerThanParent', 'message' => 'Sub-image data disk size is smaller than the parent image.', 'http_code' => 400, 'description' => 'Sub-image data disk size is smaller than the parent image.'],
+ ['code' => 'InvalidDomainId.NotFound', 'message' => 'The DomainId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDriveId.NotFound', 'message' => 'The DriveId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidEndUserId.Missing', 'message' => 'The EndUserId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidEndUserIds.ValueNotSupported', 'message' => 'The EndUserIds is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidExternalFileId.NotFound', 'message' => 'The ExternalFileId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwAddress.NotFound', 'message' => 'The gateway address is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwParam.NotFound', 'message' => 'A parameter error occurred while generating the gateway token.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwToken.ValueTooLong', 'message' => 'The GWToken is too long.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidImageConfig.RegionInvalid', 'message' => 'The region configuration of this image is invalid.', 'http_code' => 400, 'description' => 'The region configuration of this image is invalid.'],
+ ['code' => 'InvalidImageId.Invalid', 'message' => 'The specified parameter imageId is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidImageOperation.Failed', 'message' => 'Invalid image operation.', 'http_code' => 400, 'description' => 'Image operation failed.'],
+ ['code' => 'InvalidImageOperation.ImageIsCreating', 'message' => 'Failed to operation the image, it is creating.', 'http_code' => 400, 'description' => 'Failed to operation the image, it is creating.'],
+ ['code' => 'InvalidImagePackageType.Unsupported', 'message' => 'Unsupported image package type.', 'http_code' => 400, 'description' => 'This package type is not supported.'],
+ ['code' => 'InvalidInstanceId.Missing', 'message' => 'The InstanceId is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidLoginToken.Missing', 'message' => 'The LoginToken is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNextToken', 'message' => 'The NextToken is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNodeInstanceType.NotFound', 'message' => 'The node instance type is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNodeInstanceType.NotSupportOsType', 'message' => 'The node instance type does not support images with this OS type.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrder.CommodityCodeNotMatch', 'message' => 'No CommodityCode matches this order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrder.CommodityCodeNotMatch', 'message' => 'No commodityCode matched for this order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrderId.NotFound', 'message' => 'The order is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrderId.NotFound', 'message' => 'The specified order is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOsType.ValueNotSupported', 'message' => 'The operation system type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.%s', 'message' => 'The parameter %s is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.AddAccount/RemoveAccount', 'message' => 'The tenant ID to be added or removed is invalid.', 'http_code' => 400, 'description' => 'The tenant ID to be added or removed is invalid.'],
+ ['code' => 'InvalidParameter.ImageId', 'message' => 'The image ID is invalid.', 'http_code' => 400, 'description' => 'The image ID is invalid.'],
+ ['code' => 'InvalidParameter.SystemDiskSize', 'message' => 'The system disk size is invalid.', 'http_code' => 400, 'description' => 'The system disk size is invalid.'],
+ ['code' => 'InvalidParentImage.AlreadyHasCommunityImage', 'message' => 'The parent image already has a community image.', 'http_code' => 400, 'description' => 'This image cannot be published to the community because it is already published.'],
+ ['code' => 'InvalidParentImage.ImageTypeIsNotUserImage', 'message' => 'Invalid operation. The parent image is not a user image.', 'http_code' => 400, 'description' => 'Invalid operation. The parent image is not a user image.'],
+ ['code' => 'InvalidParentImage.InvalidStatus', 'message' => 'Invalid parent image status.', 'http_code' => 400, 'description' => 'The status of the parent image is invalid.'],
+ ['code' => 'InvalidParentImage.NotFound', 'message' => 'Parent image not found.', 'http_code' => 400, 'description' => 'The parent image is not found.'],
+ ['code' => 'InvalidPeriod.Invalid', 'message' => 'The Period is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriod.Missing', 'message' => 'The Period is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriodUnit.Missing', 'message' => 'The PeriodUnit is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriodUnit.ValueNotSupported', 'message' => 'The PeriodUnit is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.Invalid', 'message' => 'The ProductType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.Missing', 'message' => 'The ProductType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.ValueNotSupported', 'message' => 'The ProductType is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.ConfigError', 'message' => 'The region configuration is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.Missing', 'message' => 'The Region is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.NotFound', 'message' => 'The region is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.NotMatch', 'message' => 'The region does not match the current environment.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegionBind.NotFound', 'message' => 'The AppRegionBind is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegionId.NotFound', 'message' => 'The RegionId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidResourcePool.NotFound', 'message' => 'The resource pool is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidResponse.Missing', 'message' => 'The response body is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSessionId.Missing', 'message' => 'The SessionId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSourceImage.ImageTypeCannotBeShared', 'message' => 'Source image cannot be shared.', 'http_code' => 400, 'description' => 'This type of source image cannot be shared.'],
+ ['code' => 'InvalidSourceImage.StatusNotAvailable', 'message' => 'Invalid source image status.', 'http_code' => 400, 'description' => 'The status of the source image is invalid.'],
+ ['code' => 'InvalidSpecId.Missing', 'message' => 'The SpecId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStorageType.NotFound', 'message' => 'The StorageType is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.ChargeTypeNotSupported', 'message' => 'The charge type is not supported for the given strategy.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Invalid', 'message' => 'The StrategyConfig is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Invalid', 'message' => 'The policy configuration is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Missing', 'message' => 'The StrategyConfig is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.NotFound', 'message' => 'The StrategyConfig is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyParam.Invalid', 'message' => 'The StrategyParam is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyType.ValueNotSupported', 'message' => 'The strategy type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyType.ValueNotSupported', 'message' => 'The policy type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSubAppType.ValueNotSupported', 'message' => 'The sub-category of the app is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSystemDiskSize.SmallerThanParent', 'message' => 'Sub-image system disk size is smaller than the parent image.', 'http_code' => 400, 'description' => 'Sub-image system disk size is smaller than the parent image.'],
+ ['code' => 'InvalidTargetAliUid.TargetShareImageAlreadyExist', 'message' => 'Target shared image already exists.', 'http_code' => 400, 'description' => 'The target shared image already exists.'],
+ ['code' => 'InvalidTaskId.NotFound', 'message' => 'The TaskId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidTemplate.NotFound', 'message' => 'Template not found.', 'http_code' => 400, 'description' => 'The template is not found.'],
+ ['code' => 'InvalidUserId.NotFound', 'message' => 'The UserId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'LogOffAllSession.Failed', 'message' => 'Failed to log off all sessions in the delivery group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter', 'message' => 'There is a missing parameter.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter.AppIdAndAppVersion', 'message' => 'The AppId and AppVersion are missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter.RegionId', 'message' => 'The RegionId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'nvalidStrategyConfig.NotFound', 'message' => 'The policy configuration is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OperationDenied.NoStock', 'message' => 'The operation is denied, because the instance stock is unavailable.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.Canceled', 'message' => 'The task has been cancelled.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.NotFound', 'message' => 'The ota task is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.Running', 'message' => 'The task is running and cannot be sumitted.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTaskNotifyRegion.Error', 'message' => 'The unit manager failed to receive the OTA upgrade job.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParentImage.NotExist', 'message' => 'The parent image does not exist.', 'http_code' => 400, 'description' => 'The parent image does not exist.'],
+ ['code' => 'ParentImageRegionDistribute.NotExist', 'message' => 'The target distribution region of the parent image does not exist.', 'http_code' => 400, 'description' => 'The target distribution region of the parent image does not exist.'],
+ ['code' => 'ProductTypeInvalid', 'message' => 'The ProductType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ProductTypeNotMatch', 'message' => 'The productType and image do not match.', 'http_code' => 400, 'description' => 'The productType and image do not match.'],
+ ['code' => 'QueryTemplate.Failed', 'message' => 'Query template failed.', 'http_code' => 400, 'description' => 'Failed to query the template.'],
+ ['code' => 'RegionUnBind.Fail', 'message' => 'Failed to unbind.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ServiceUnavailable', 'message' => 'Service unavailable. Please try again later.', 'http_code' => 500, 'description' => 'Service unavailable. Please try again later.'],
+ ['code' => 'StockError.InvalidResourceRequest', 'message' => 'Your request cannot be processed currently due to an error. Please try again later.', 'http_code' => 500, 'description' => 'The inventory check failed and the system is temporarily unable to process your request. Please try again later.'],
+ ['code' => 'StockError.NoStock', 'message' => 'The selected specification is out of stock. Please try again later or select other specifications.', 'http_code' => 400, 'description' => 'The selected specification is out of stock. Please try again later or select other specifications.'],
+ ['code' => 'StorageLock.Exist', 'message' => 'The storage lock exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLock.NotFound', 'message' => 'The storage lock is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockProperties.NotMatch', 'message' => 'The storage lock properties do not match.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockUnitResponse.Empty', 'message' => 'The storage lock unit is found empty.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockUnlockLevel.Error', 'message' => 'An unlock level error occurred while unlocking the storage lock.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Task.ResourceReleased', 'message' => 'Cannot retry because task resource is released.', 'http_code' => 400, 'description' => 'Cannot retry because the resource for builder task is released.'],
+ ['code' => 'TaskType.Invalid', 'message' => 'Invalid task type.', 'http_code' => 400, 'description' => 'Invalid task type.'],
+ ['code' => 'TryBind.AppRegionBindLockFailed', 'message' => 'Failed to lock the app and region bind.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoBindContext', 'message' => 'Failed to bind, because there is no bind context.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoCandidateAppInstanceGroup', 'message' => 'Failed to bind, because there is no candidate app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoSupportedApp', 'message' => 'Failed to bind, because there is no supported app for this file extension.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.BindExistingAppInstanceFail', 'message' => 'Failed to bind existing app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.NoCandidateAppInstance', 'message' => 'Failed to bind, because there is no candidate app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.NoIdleAppInstance', 'message' => 'Failed to bind, because there is no idle app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.TicketIsNull', 'message' => 'Failed to bind, because a null ticket is returned.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'UpdateImage.Failed', 'message' => 'Failed to update the image.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'UpdateRegion.NotSupport', 'message' => 'The distributed regions of vhd or container images cannot be modified.', 'http_code' => 400, 'description' => 'The distributed regions of vhd or container images cannot be modified.'],
+ ['code' => 'UserIdentifier.NotFound', 'message' => 'This username does not exist. Please check if it is correct.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppInstances'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTenantConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppInstanceGroup'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAppPolicy'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeInstanceType'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppInstanceGroup'],
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionTicket'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PageListAppInstanceGroupUser'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceRenewPrice'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewAppInstanceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAppInstanceGroupAttribute'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageFromAppInstanceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppInstanceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAppInstanceGroupImage'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppInstanceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOtaTask'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyNodePoolAttribute'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTenantConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LogOffAllSessionsInAppInstanceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourcePrice'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDebugAppInstance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AuthorizeInstanceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOtaTaskByTaskId'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApproveOtaTask'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppInstances'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Unbind'],
],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com',
+ ],
+ 'ram' => [
+ 'productCode' => 'AppStreaming',
+ 'productName' => 'App Streaming',
+ 'ramCodes' => ['appstreaming', 'ecd'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'UpdateModelTemplate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UpdateModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UnassignWuyingServerPrivateAddresses',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UnassignWuyingServerPrivateAddresses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ApproveOtaTask',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyAppInstanceGroupAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyNodePoolAmount',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyNodePoolAmount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWuyingServer',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateWuyingServerImage',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UpdateWuyingServerImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDesktopAgentRuntime',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListDesktopAgentRuntime',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveResourceGroupModelTemplate',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RemoveResourceGroupModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PageListAppInstanceGroupUser',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:PageListAppInstanceGroupUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AssignWuyingServerPrivateAddresses',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:AssignWuyingServerPrivateAddresses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeliverToUserSls',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeliverToUserSls',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAppInstanceGroup',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BatchCreateLlmTemplates',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:BatchCreateLlmTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveRuntimeModelTemplate',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RemoveRuntimeModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListLlmTemplates',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListLlmTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteLlmTemplate',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteLlmTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ConfigRuntimeChannel',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ConfigRuntimeChannel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWuyingServer',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetResourceRenewPrice',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetResourceRenewPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteModelProviderTemplate',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteModelProviderTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTenantConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListTenantConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AuthorizeInstanceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:AuthorizeInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAppInstances',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteAppInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAppInstanceGroup',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyBrowserInstanceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListModelProviderTemplates',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListModelProviderTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAppInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListAppInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAuthorizedUserGroups',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListAuthorizedUserGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListNodeInstanceType',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListNodeInstanceType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeWuyingServerEipInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DescribeWuyingServerEipInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListModelTemplateResourceGroup',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListModelTemplateResourceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListOtaTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateModelProviderTemplate',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateModelProviderTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyAppInstanceGroupAttribute',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyAppInstanceGroupAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteModelTemplate',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteImage',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ConfigRuntimeModelTemplate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ConfigRuntimeModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListNodes',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListNodes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRegions',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListRegions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetOtaTaskByTaskId',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyAppInstanceGroupAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UntagCloudResources',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UntagCloudResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListPersistentAppInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListPersistentAppInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetResourcePrice',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetResourcePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Unbind',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:Unbind',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RenewAppInstanceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RenewAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyNodePoolAttribute',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyNodePoolAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RenewWuyingServer',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RenewWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWuyingServer',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetModelProviderTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetModelProviderTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartWuyingServer',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:StartWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAppInstanceGroup',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateImageByInstance',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateImageByInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRuntimeChannel',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetRuntimeChannel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateAppInstanceGroupImage',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UpdateAppInstanceGroupImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateModelProviderTemplate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:UpdateModelProviderTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTagCloudResources',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListTagCloudResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TagCloudResources',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:TagCloudResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetConnectionTicket',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetConnectionTicket',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ConfigResourceGroupModelTemplate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ConfigResourceGroupModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListImage',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartTaskForDistributeImage',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:StartTaskForDistributeImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListModelTemplates',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListModelTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListModelProviderEndpoints',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListModelProviderEndpoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyAppPolicy',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyAppPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListBindInfo',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ListBindInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeWuyingServer',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DescribeWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'LogOffAllSessionsInAppInstanceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:LogOffAllSessionsInAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopWuyingServer',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:StopWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDebugAppInstance',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetDebugAppInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyWuyingServerAttribute',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyWuyingServerAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateModelTemplate',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateModelTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateImageFromAppInstanceGroup',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'appstreaming:CreateImageFromAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveRuntimeChannel',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RemoveRuntimeChannel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRuntimeModelConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'appstreaming:GetRuntimeModelConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyTenantConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:ModifyTenantConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAppInstanceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:DeleteAppInstanceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RestartWuyingServer',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'appstreaming:RestartWuyingServer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AppStreaming', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];
diff --git a/data/en_us/appstream-center/2021-09-03/api-docs.php b/data/en_us/appstream-center/2021-09-03/api-docs.php
index 16079a0..a19e785 100644
--- a/data/en_us/appstream-center/2021-09-03/api-docs.php
+++ b/data/en_us/appstream-center/2021-09-03/api-docs.php
@@ -1,35 +1,14 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'appstream-center',
- 'version' => '2021-09-03',
- ],
- 'directories' => [
- 'GetConnectionTicket',
- 'ListPublishedAppInfo',
- 'ListRunningApps',
- 'Unbind',
- 'StopApp',
- 'StartAppResources',
- 'StopAppResources',
- 'RestartAppResources',
- 'ResetAppResources',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'appstream-center', 'version' => '2021-09-03'],
+ 'directories' => ['ListPublishedAppInfo', 'ListRunningApps', 'StopApp', 'StartAppResources', 'StopAppResources', 'RestartAppResources', 'ResetAppResources', 'GetConnectionTicket', 'Unbind'],
'components' => [
'schemas' => [],
],
'apis' => [
'GetConnectionTicket' => [
- 'summary' => 'Queries the credential used to connect to an app instance.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
@@ -42,9 +21,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '82371',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingBC1NTD',
- ],
+ 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -53,415 +30,298 @@
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'description' => '',
- 'enumValueTitles' => [
- 'CloudGame' => '',
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
- 'required' => true,
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudGame' => 'A cloud game.', 'CloudApp' => 'A cloud application.'],
'type' => 'string',
+ 'required' => true,
+ 'example' => 'CloudApp',
+ 'title' => '',
],
],
[
'name' => 'BizRegionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'cn-hangzhou',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The region ID.'."\n"
+ ."\n"
+ .'> If you specify this parameter, the service allocates an app instance only from app instance groups in the specified region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'LoginToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'v1c4e2ef03d620f0f6cb41634196161219054e12d8aa5a13deb9ed14eebb76d674559115ad2e27a57f6820c1fd33e0ca36',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The login token. Obtain the token by calling the `GetLoginToken` or `GetStsToken` operation.', 'type' => 'string', 'required' => false, 'example' => 'v2c4e2ef03d62******', 'title' => ''],
],
[
'name' => 'EndUserId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'test.test',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The username of the convenience account.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''],
],
[
'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '09e2b2e6-3181-4c84-9539-6fc9f1c3199e',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The session ID. Obtain this ID by calling the `GetLoginToken` or `GetStsToken` operation. Use this parameter with `LoginToken`.', 'type' => 'string', 'required' => false, 'example' => '09e2b2e6-3181******', 'title' => ''],
],
[
'name' => 'LoginRegionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'cn-hangzhou',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The region ID of the user\'s workspace.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Uuid',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'A8B35215993FBF283F28D617975204C4',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The unique ID of the login device.', 'type' => 'string', 'required' => false, 'example' => 'A8B35215993FBF283F28D61******', 'title' => ''],
],
[
'name' => 'ClientId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'f2463208-ec89-4309-8e8c-8b17acdcab93',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The client ID.', 'type' => 'string', 'required' => false, 'example' => 'f2463208-ec89-4309-8e8c-8b1******', 'title' => ''],
],
[
'name' => 'ClientType',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端类型。',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'Client type.', 'description' => 'The client type.', 'type' => 'string', 'required' => false, 'example' => 'html5'],
],
[
'name' => 'ClientOS',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'windows_"Windows 10 Enterprise LTSC 2019" 10.0 (Build 17763)',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The operating system of the client.', 'type' => 'string', 'required' => false, 'example' => 'windows_"Windows 10 Enterprise LTSC 2019" 10.0 (Build 17763)', 'title' => ''],
],
[
'name' => 'ClientVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '2.0.1-D-20211008.101607',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The client version.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-D-20211008.101607', 'title' => ''],
],
[
'name' => 'ClientIp',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '22.21.2.21',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The IP address of the client.', 'type' => 'string', 'required' => false, 'example' => '22.21.*.*', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '6f41731b-7091-4954-80c8-1d1e0b3ebb48',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The task ID.'."\n"
+ ."\n"
+ .'> This parameter is required for all calls after the initial call. Use it to query the task status and retrieve the connection ticket.', 'type' => 'string', 'required' => false, 'example' => '6f41731b-7091-4******', 'title' => ''],
],
[
'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'aig-bw1o1gcwvd3e1ipeu',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The app instance group ID.'."\n"
+ ."\n"
+ .'> - If you specify this parameter, the service allocates an app instance only from the specified and authorized app instance group.'."\n"
+ .'>'."\n"
+ .'> - This parameter is required if you specify the `AppInstanceId` parameter.', 'type' => 'string', 'required' => false, 'example' => 'aig-bw1o1gcwv******', 'title' => ''],
],
[
'name' => 'AppInstanceId',
'in' => 'formData',
- 'schema' => [
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The app instance ID.'."\n"
+ ."\n"
+ .'> - If you specify this parameter, the system attempts to allocate only the specified app instance.'."\n"
+ .'>'."\n"
+ .'> - If you specify this parameter, you must also specify the `AppInstanceGroupId` parameter.', 'type' => 'string', 'required' => false, 'example' => 'ai-ij4a6kd4bn2******', 'title' => ''],
],
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'ca-etn4zizgaezo9gis9',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The application ID.'."\n"
+ ."\n"
+ .'> This parameter is required for the initial call and optional for subsequent calls.', 'type' => 'string', 'required' => false, 'example' => 'ca-etn4zizga******', 'title' => ''],
],
[
'name' => 'AppVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '1.0.0.1',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The application version.', 'type' => 'string', 'required' => false, 'example' => '1.0.1', 'title' => ''],
],
[
'name' => 'Param',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '/home/test/test.jpg',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The application startup parameters.', 'type' => 'string', 'required' => false, 'example' => '/q /n'."\n", 'title' => ''],
],
[
'name' => 'TenantId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '1126819517152528',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The tenant ID, which is the Alibaba Cloud account UID.', 'type' => 'string', 'required' => false, 'example' => '1126819517******', 'title' => ''],
],
[
'name' => 'ResourceId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The resource ID.'."\n"
+ ."\n"
+ .'> The required value depends on the target resource. For a cloud phone, use the persistent session ID. For a cloud browser, use the cloud browser ID. For a cloud application, the required ID depends on the authorization mode: use the application ID for application-based authorization, the app instance group ID for group-based authorization, or the persistent session ID for session-based authorization.', 'type' => 'string', 'required' => false, 'example' => 'p-0cdr5c9kl******', 'title' => ''],
],
[
'name' => 'ConnectionProperties',
'in' => 'formData',
- 'schema' => [
- 'title' => '建连属性。',
- 'type' => 'string',
- ],
+ 'schema' => ['title' => 'Connection properties. ', 'description' => 'The connection properties, in JSON format.'."\n"
+ .'The following parameters are supported:'."\n"
+ ."\n"
+ .'- `authMode`: The authorization mode. This value must match the authorization mode of the app instance group. Valid values: `App` (application-based authorization), `AppInstanceGroup` (app instance group-based authorization), and `Session` (persistent session-based authorization).'."\n"
+ ."\n"
+ .'- `appInstanceGroupScheduleTags`: The scheduling tags of the app instance group. You can filter resources based on multiple key-value pairs. Tag pairs are combined by using a logical AND. A key is required, but the value can be empty. Example: `[{"key":"Resolution","value":"720p"},{"key":"Name"}]`'."\n"
+ ."\n"
+ .'- `appInstanceGroupIds`: A list of app instance group IDs.'."\n"
+ ."\n"
+ .'- `appInstancePersistentId`: The ID of the persistent session.'."\n"
+ ."\n"
+ .'- `avatarId`: The user avatar ID. Default value: `default`. This parameter allows a user to be allocated multiple session instances.'."\n"
+ ."\n"
+ .'> When connecting to a cloud phone, set this parameter to `{"authMode":"Session"}`.', 'type' => 'string', 'required' => false, 'example' => '{"authMode":"Session"}'],
],
[
'name' => 'EnvironmentConfig',
'in' => 'formData',
- 'schema' => [
- 'title' => '环境配置。',
- 'type' => 'string',
- ],
+ 'schema' => ['title' => 'Environment configuration. ', 'description' => 'The environment configuration.', 'type' => 'string', 'required' => false, 'example' => '{"screenWidth":2560,"screenHeight":1564}'],
],
[
'name' => 'AutoConnectInQueue',
'in' => 'formData',
'schema' => [
+ 'description' => 'Specifies whether to automatically connect upon reaching the front of the queue.'."\n"
+ ."\n"
+ .'> This parameter is not yet available.',
+ 'enumValueTitles' => ['true' => 'Auto-connect', 'false' => 'Connect manually'],
'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'title' => '',
],
],
[
'name' => 'AccessType',
'in' => 'formData',
'schema' => [
- 'title' => '接入类型,不传表示两种都显示。'."\n"
- .'取值范围:'."\n"
- .'互联网:INTERNET'."\n"
- .'专线:VPC',
+ 'title' => 'Access type. If not specified, both types are displayed. '."\n"
+ .'Valid values: '."\n"
+ .'the Internet: INTERNET '."\n"
+ .'leased line: VPC',
+ 'description' => 'The access type. If you omit this parameter, the call returns resources of both access types. Valid values: `INTERNET` (internet) and `VPC` (private connection).',
'type' => 'string',
'example' => 'INTERNET',
'maxLength' => 10,
'minLength' => 0,
'default' => 'INTERNET',
- 'enum' => [
- 'INTERNET',
- 'VPC',
- ],
+ 'enum' => ['INTERNET', 'VPC'],
+ 'required' => false,
],
],
[
'name' => 'AppPolicyId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'example' => 'pg-0clfzcy0adpcf****', 'title' => ''],
+ ],
+ [
+ 'name' => 'RequireUuidValidation',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'boolean', 'required' => false, 'example' => 'true', 'description' => '', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response object.',
'properties' => [
- 'RequestId' => [
- 'description' => 'Id of the request',
- 'example' => 'AD2D0761-1FE5-549D-B169-D3F8D19C6CDD',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'Ticket' => [
- 'description' => '',
- 'example' => 'n7n9bqZlPrvgUOPSJzfdb$89jWwlVISgrchpY0tOfVYGBBcdoPoH39PVHK63fQTEM14kzajQdWAnHTnSicc35W_eI2LbTSGKquKukwcU7opRwmInhtQH*mlmsZQ3ByOLYVmqI*1hFESs0',
- 'type' => 'string',
- ],
- 'TaskId' => [
- 'description' => '',
- 'example' => 'f3d1b31c-605e-4d04-a896-015fc9fc03b4',
- 'type' => 'string',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AD2D0761-1FE5-549D-B169******'],
+ 'Ticket' => ['description' => 'The connection ticket.', 'type' => 'string', 'example' => 'n7n9bqZlPrvgUOPY0tOfVYGBBcdoPoH3******', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'f3d1b31c-605e-******', 'title' => ''],
'TaskStatus' => [
- 'description' => '',
- 'enumValueTitles' => [
- 'Finished' => '',
- 'Failed' => '',
- 'Running' => '',
- ],
- 'example' => 'Running',
- 'type' => 'string',
- ],
- 'RetryTimes' => [
- 'description' => '',
- 'example' => '3',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => 'InternalError.TicketGenInternalError',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'reenter app instance failed',
- 'type' => 'string',
- ],
- 'AppInstanceGroupId' => [
- 'description' => '',
- 'example' => 'aig-53fvrq1oanz6cxzi3',
- 'type' => 'string',
- ],
- 'AppInstancePersistentId' => [
- 'type' => 'string',
- ],
- 'AppInstanceId' => [
- 'description' => '',
- 'example' => 'ai-gc1gemx6vpa6vlync',
+ 'description' => 'The task status.',
+ 'enumValueTitles' => ['Finished' => 'The task is complete.', 'Failed' => 'The task failed.', 'Running' => 'The task is in progress.'],
'type' => 'string',
+ 'example' => 'Running',
+ 'title' => '',
],
+ 'RetryTimes' => ['description' => 'The retry count.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InternalError.TicketGenInternalError', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'reenter app instance failed', 'title' => ''],
+ 'AppInstanceGroupId' => ['description' => 'The ID of the app instance group.', 'type' => 'string', 'example' => 'aig-53fvrq1oa******', 'title' => ''],
+ 'AppInstancePersistentId' => ['description' => 'The ID of the persistent session.', 'type' => 'string', 'example' => 'p-0cdr5c9kl******', 'title' => ''],
+ 'AppInstanceId' => ['description' => 'The ID of the app instance.', 'type' => 'string', 'example' => 'ai-gc1gemx6vp******', 'title' => ''],
'OsType' => [
- 'description' => '',
- 'enumValueTitles' => [
- 'Linux' => 'Linux',
- 'Windows' => 'Windows',
- 'Android' => 'Android',
- ],
- 'example' => 'Windows',
+ 'description' => 'The operating system type.',
+ 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows', 'Android' => 'Android'],
'type' => 'string',
+ 'example' => 'Windows',
+ 'title' => '',
],
- 'RegionId' => [
- 'description' => '',
- 'example' => 'cn-hangzhou',
- 'type' => 'string',
- ],
- 'LoginToken' => [
- 'description' => '',
- 'example' => 'v15418e331d8d068c29411646996786785303b8f61fd880aeaa50c5b584443cd9e65cc7eec72acdaad0a844666a3b26dab',
- 'type' => 'string',
- ],
- 'TenantId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'RegionId' => ['description' => 'The region ID of the app instance group.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'LoginToken' => ['description' => 'The login token.', 'type' => 'string', 'example' => 'v2c4e2ef03d62******'."\n", 'title' => ''],
+ 'TenantId' => ['description' => 'The ID of the tenant, which is the unique identifier (UID) of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'example' => '1126819517******', 'title' => ''],
'Policy' => [
+ 'description' => 'The session policy.',
'type' => 'object',
'properties' => [
'ResolutionAdaptive' => [
+ 'description' => 'Indicates whether adaptive resolution is enabled.'."\n"
+ ."\n"
+ .'> - If set to `true`, the session resolution adapts to the client\'s display area, up to the maximums defined by `ResolutionWidth` and `ResolutionHeight`.'."\n"
+ .'>'."\n"
+ .'> - If set to `false`, the session resolution is fixed to the values defined by `ResolutionWidth` and `ResolutionHeight`.',
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'string',
+ 'example' => 'true',
+ 'title' => '',
],
- 'ResolutionWidth' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ResolutionHeight' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'ResolutionWidth' => ['description' => 'The width of the resolution, in pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '1920'."\n", 'title' => ''],
+ 'ResolutionHeight' => ['description' => 'The height of the resolution, in pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'BindQueueInfo' => [
+ 'description' => 'The queue information.'."\n"
+ ."\n"
+ .'> This parameter is not yet available.',
'type' => 'object',
'properties' => [
- 'RequestKey' => [
- 'type' => 'string',
- ],
- 'TargetId' => [
- 'type' => 'string',
- ],
+ 'RequestKey' => ['description' => 'The key for the queue request.', 'type' => 'string', 'example' => 'alice******', 'title' => ''],
+ 'TargetId' => ['description' => 'The queue ID.', 'type' => 'string', 'example' => 'aig-53fvrq1oa******'."\n", 'title' => ''],
'QueueStatus' => [
+ 'description' => 'Your status in the queue.',
+ 'enumValueTitles' => ['Ready' => 'You are at the front of the queue.', 'Waiting' => 'You are waiting in the queue.'],
'type' => 'string',
+ 'example' => 'Waiting',
+ 'title' => '',
],
- 'ReadyTimeout' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Rank' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'WaitTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'RemainingTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'ReadyTimeout' => ['description' => 'The time limit, in seconds, for connecting manually after you reach the front of the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''],
+ 'Rank' => ['description' => 'Your position in the queue.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'WaitTime' => ['description' => 'The time, in seconds, you have been waiting in the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'RemainingTime' => ['description' => 'The estimated remaining wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'AvatarId' => [
- 'title' => '分身ID。',
- 'type' => 'string',
- 'example' => 'abc',
- 'default' => 'default',
- ],
- 'NextPollIntervalMs' => [
- 'title' => '下一次轮询间隔,单位为ms,为空则为1000ms。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '500',
- 'default' => '1000',
- ],
+ 'AvatarId' => ['title' => 'Avatar ID.', 'description' => 'The avatar ID.', 'type' => 'string', 'example' => 'abc', 'default' => 'default'],
+ 'NextPollIntervalMs' => ['title' => 'Next polling interval, in milliseconds. If empty, the default value is 1000 ms.', 'description' => 'The next polling interval, in milliseconds. If this parameter is not returned, the default interval is 1,000 ms.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'default' => '1000'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Obtain application connection credentials',
+ 'summary' => 'Retrieve the connection credentials for the cloud application.',
+ 'description' => 'Getting a Ticket can be time-consuming, so you may need to call this API multiple times to retrieve it.'."\n"
+ ."\n"
+ .'1. The initial call allocates an application instance to the specified convenience account and starts the application. This call returns a task ID (`TaskId`).'."\n"
+ ."\n"
+ .'2. For subsequent calls, pass the TaskId to query the task status. When the returned `TaskStatus` is `Finished`, the call also returns the `Ticket`.'."\n"
+ ."\n"
+ .'> - If the startup process is fast enough, the initial call may also return the `Ticket`.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionTicket'],
+ ],
],
+ 'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\",\\n \\"Ticket\\": \\"n7n9bqZlPrvgUOPY0tOfVYGBBcdoPoH3******\\",\\n \\"TaskId\\": \\"f3d1b31c-605e-******\\",\\n \\"TaskStatus\\": \\"Running\\",\\n \\"RetryTimes\\": 3,\\n \\"Code\\": \\"InternalError.TicketGenInternalError\\",\\n \\"Message\\": \\"reenter app instance failed\\",\\n \\"AppInstanceGroupId\\": \\"aig-53fvrq1oa******\\",\\n \\"AppInstancePersistentId\\": \\"p-0cdr5c9kl******\\",\\n \\"AppInstanceId\\": \\"ai-gc1gemx6vp******\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LoginToken\\": \\"v2c4e2ef03d62******\\\\n\\",\\n \\"TenantId\\": 0,\\n \\"Policy\\": {\\n \\"ResolutionAdaptive\\": \\"true\\",\\n \\"ResolutionWidth\\": 1920,\\n \\"ResolutionHeight\\": 1080\\n },\\n \\"BindQueueInfo\\": {\\n \\"RequestKey\\": \\"alice******\\",\\n \\"TargetId\\": \\"aig-53fvrq1oa******\\\\n\\",\\n \\"QueueStatus\\": \\"Waiting\\",\\n \\"ReadyTimeout\\": 120,\\n \\"Rank\\": 1,\\n \\"WaitTime\\": 100,\\n \\"RemainingTime\\": 100\\n },\\n \\"AvatarId\\": \\"abc\\",\\n \\"NextPollIntervalMs\\": 500\\n}","type":"json"}]',
- 'title' => 'GetConnectionTicket',
],
'ListPublishedAppInfo' => [
- 'summary' => 'Queries information about published apps.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Lists information about published applications.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
@@ -474,255 +334,171 @@
[
'name' => 'ClientId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '17b38aaa-761f-44c5-9862-2ad0f5025d15',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'A unique ID generated by the client.', 'type' => 'string', 'required' => false, 'example' => '17b38aaa-761f-44c5-9862-2ad0f5025d15', 'title' => ''],
],
[
'name' => 'LoginToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'v189fa78c1aff77a0483b16497517322299131027b85bb84bbdc0871988ce8296d8fd891e2fdeaded3bd75f81f639acee8',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'A login credential. Get it by calling the GetLoginToken operation. Or refresh it by calling RefreshLoginToken after logging in. The response includes LoginToken.', 'type' => 'string', 'required' => false, 'example' => 'v189fa78c1aff77a0483b16497517322299131027b85bb84bbdc0871988ce8296d8fd891e2fdeaded3bd75f81f639acee8', 'title' => ''],
],
[
'name' => 'EndUserId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'test.test',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'A convenience account username.', 'type' => 'string', 'required' => false, 'example' => 'test.test', 'title' => ''],
],
[
'name' => 'SessionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'A session ID. Get it by calling the GetLoginToken operation. The response includes SessionId.', 'type' => 'string', 'required' => false, 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03', 'title' => ''],
],
[
'name' => 'ClientOS',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The client operating system.', 'type' => 'string', 'required' => false, 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)', 'title' => ''],
],
[
'name' => 'ClientVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '2.0.1-D-20211008.101607'."\n",
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The client version.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-D-20211008.101607'."\n", 'title' => ''],
],
[
'name' => 'ClientIp',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '125.80.132.13',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The client IP address.', 'type' => 'string', 'required' => false, 'example' => '125.80.132.13', 'title' => ''],
],
[
'name' => 'ProductType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'CloudApp',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The product type. Set this to `CloudApp` for WUYING AppStreaming.', 'type' => 'string', 'required' => false, 'example' => 'CloudApp', 'title' => ''],
],
[
'name' => 'BizRegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'cn-hangzhou',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The region ID of the delivery group. For a list of supported regions, see [Limits](https://help.aliyun.com/document_detail/426036.html).', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'LoginRegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'cn-shanghai',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The region ID of appstream-center.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''],
],
[
'name' => 'CategoryType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The level 1 category of the application. Valid values:'."\n"
+ ."\n"
+ .'- 0: Cloud application'."\n"
+ ."\n"
+ .'- 1: Cloud game', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'CategoryId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The level 2 category of the application. Valid values:'."\n"
+ ."\n"
+ .'- 1: All applications'."\n"
+ ."\n"
+ .'- 2: Design software'."\n"
+ ."\n"
+ .'- 3: Programming and development'."\n"
+ ."\n"
+ .'- 4: Office essentials'."\n"
+ ."\n"
+ .'- 5: Input method'."\n"
+ ."\n"
+ .'- 6: Images and video'."\n"
+ ."\n"
+ .'- 7: System tools'."\n"
+ ."\n"
+ .'- 8: Browser', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'Microsoft Word',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The application name. Use this parameter to perform a fuzzy search by application name.', 'type' => 'string', 'required' => false, 'example' => 'Microsoft Word', 'title' => ''],
],
[
'name' => 'OrderParam',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'default' => 'APP_NAME',
- ],
+ 'schema' => ['type' => 'string', 'default' => 'APP_NAME', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'SortType',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'default' => 'DESC',
- ],
+ 'schema' => ['type' => 'string', 'default' => 'DESC', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'properties' => [
- 'RequestId' => [
- 'description' => 'Id of the request',
- 'example' => 'DB70F8FE-63A3-587B-8560-CEC258E8B944',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'NextToken' => [
- 'description' => '',
- 'example' => '2NVfhLfgy5b3J5iJyoLQ6x4EULMg1hbhgB9NfnvdK9oj5zwxd17j4TuQkZze3RvhEvBinZYjknujF3Q1M',
- 'type' => 'string',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DB70F8FE-63A3-587B-8560-CEC258E8B944'],
+ 'NextToken' => ['description' => 'The token used to start the next query.', 'type' => 'string', 'example' => '2NVfhLfgy5b3J5iJyoLQ6x4EULMg1hbhgB9NfnvdK9oj5zwxd17j4TuQkZze3RvhEvBinZYjknujF3Q1M', 'title' => ''],
'AppModels' => [
- 'description' => 'appModels',
+ 'description' => 'The list of application models.',
'items' => [
'properties' => [
- 'AppId' => [
- 'description' => '',
- 'example' => 'ca-fxwp4koyr5y2sp4mz',
- 'type' => 'string',
- ],
- 'AppName' => [
- 'description' => '',
- 'example' => 'Microsoft Word',
- 'type' => 'string',
- ],
- 'AppVersion' => [
- 'description' => '',
- 'example' => 'R2021a',
- 'type' => 'string',
- ],
- 'AppVersionName' => [
- 'description' => '',
- 'example' => 'v1.0',
- 'type' => 'string',
- ],
- 'IconUrl' => [
- 'description' => '',
- 'example' => 'https://app-streaming-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/1973619010349344/1634523814270_Matlab.png',
- 'type' => 'string',
- ],
- 'IsAuth' => [
- 'description' => '',
- 'example' => 'True',
- 'type' => 'boolean',
- ],
- 'UsedInSession' => [
- 'description' => '',
- 'example' => 'True',
- 'type' => 'boolean',
- ],
- 'AppCenterImageId' => [
- 'description' => '',
- 'example' => 'img-f37nddbjc1lje14st',
- 'type' => 'string',
- ],
- 'CategoryType' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'CategoryId' => [
- 'description' => '',
- 'example' => '2',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'AppThemeColor' => [
- 'type' => 'string',
- ],
- 'AuthTime' => [
- 'type' => 'string',
- ],
+ 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'ca-fxwp4koyr5y2sp4mz', 'title' => ''],
+ 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'Microsoft Word', 'title' => ''],
+ 'AppVersion' => ['description' => 'The application version number.', 'type' => 'string', 'example' => 'R2021a', 'title' => ''],
+ 'AppVersionName' => ['description' => 'The application version name.', 'type' => 'string', 'example' => 'v1.0', 'title' => ''],
+ 'IconUrl' => ['description' => 'The URL of the application icon.', 'type' => 'string', 'example' => 'https://app-streaming-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/1973619010349344/1634523814270_Matlab.png', 'title' => ''],
+ 'IsAuth' => ['description' => 'Indicates whether the user has permission. Returns true.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'UsedInSession' => ['description' => 'Indicates whether the application is in use.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'AppCenterImageId' => ['description' => 'The application image ID. Get it from the Image Management page in the WUYING AppStreaming console.', 'type' => 'string', 'example' => 'img-f37nddbjc1lje14st', 'title' => ''],
+ 'CategoryType' => ['description' => 'The level 1 category of the application. Valid values:'."\n"
+ ."\n"
+ .'- 0: Cloud application'."\n"
+ ."\n"
+ .'- 1: Cloud game', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'CategoryId' => ['description' => 'The level 2 category of the application. Valid values:'."\n"
+ ."\n"
+ .'- 1: All applications'."\n"
+ ."\n"
+ .'- 2: Design software'."\n"
+ ."\n"
+ .'- 3: Programming and development'."\n"
+ ."\n"
+ .'- 4: Office essentials'."\n"
+ ."\n"
+ .'- 5: Input method'."\n"
+ ."\n"
+ .'- 6: Images and video'."\n"
+ ."\n"
+ .'- 7: System tools'."\n"
+ ."\n"
+ .'- 8: Browser', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'AppThemeColor' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AuthTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'title' => 'appModels',
'type' => 'array',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB70F8FE-63A3-587B-8560-CEC258E8B944\\",\\n \\"NextToken\\": \\"2NVfhLfgy5b3J5iJyoLQ6x4EULMg1hbhgB9NfnvdK9oj5zwxd17j4TuQkZze3RvhEvBinZYjknujF3Q1M\\",\\n \\"AppModels\\": [\\n {\\n \\"AppId\\": \\"ca-fxwp4koyr5y2sp4mz\\",\\n \\"AppName\\": \\"Microsoft Word\\",\\n \\"AppVersion\\": \\"R2021a\\",\\n \\"AppVersionName\\": \\"v1.0\\",\\n \\"IconUrl\\": \\"https://app-streaming-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/1973619010349344/1634523814270_Matlab.png\\",\\n \\"IsAuth\\": true,\\n \\"UsedInSession\\": true,\\n \\"AppCenterImageId\\": \\"img-f37nddbjc1lje14st\\",\\n \\"CategoryType\\": 1,\\n \\"CategoryId\\": 2,\\n \\"AppThemeColor\\": \\"\\",\\n \\"AuthTime\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListPublishedAppInfo',
+ 'title' => 'Query the list of published applications',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'ListRunningApps' => [
- 'summary' => 'Queries running apps.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Lists running applications.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
@@ -734,229 +510,127 @@
[
'name' => 'ClientId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '370b56f8-2812-4b6c-bfa6-2560791cad88',
- ],
+ 'schema' => ['description' => 'A unique ID generated by the client.', 'type' => 'string', 'required' => false, 'example' => '370b56f8-2812-4b6c-bfa6-2560791cad88', 'title' => ''],
],
[
'name' => 'LoginToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1124500957832f30b3e716406562071655aa43b2a723ed2be0837815483d54e025db13ba5469f06f2410d0efc4d302e36',
- ],
+ 'schema' => ['description' => 'A login credential. Get it by calling the GetLoginToken operation. Or refresh it by calling RefreshLoginToken after logging in. This parameter is returned as LoginToken.', 'type' => 'string', 'required' => false, 'example' => 'v1124500957832f30b3e716406562071655aa43b2a723ed2be0837815483d54e025db13ba5469f06f2410d0efc4d302e36', 'title' => ''],
],
[
'name' => 'EndUserId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test.test',
- ],
+ 'schema' => ['description' => 'The username of a convenience account.', 'type' => 'string', 'required' => false, 'example' => 'test.test', 'title' => ''],
],
[
'name' => 'SessionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae97764',
- ],
+ 'schema' => ['description' => 'A session ID. Get it by calling the GetLoginToken operation. This parameter is returned as SessionId.', 'type' => 'string', 'required' => false, 'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae97764', 'title' => ''],
],
[
'name' => 'ClientOS',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 18363)',
- ],
+ 'schema' => ['description' => 'The operating system of the client.', 'type' => 'string', 'required' => false, 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 18363)', 'title' => ''],
],
[
'name' => 'ClientVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.1.0-R-20220512.175656',
- ],
+ 'schema' => ['description' => 'The version of the client.', 'type' => 'string', 'required' => false, 'example' => '0.1.0-R-20220512.175656', 'title' => ''],
],
[
'name' => 'ClientIp',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '22.21.2.32',
- ],
+ 'schema' => ['description' => 'The IP address of the client.', 'type' => 'string', 'required' => false, 'example' => '22.21.2.32', 'title' => ''],
],
[
'name' => 'ProductType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The type of product. Valid value: `CloudApp`. This value indicates WUYING AppStreaming.',
+ 'enumValueTitles' => ['CloudApp' => 'Cloud application'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
'example' => 'CloudApp',
+ 'title' => '',
],
],
[
'name' => 'BizRegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the delivery group.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'TenantId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1735953493960828',
- ],
+ 'schema' => ['description' => 'The tenant ID. Get it by calling the GetLoginToken operation. This parameter is returned as TenantId.', 'type' => 'string', 'required' => false, 'example' => '1735953493960828', 'title' => ''],
],
[
'name' => 'LoginRegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID where you log in.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Uuid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '470E8C12AB78CE9C3F6627DD0409E51D',
- ],
+ 'schema' => ['description' => 'The UUID of the device used for login.', 'type' => 'string', 'required' => false, 'example' => '470E8C12AB78CE9C3F6627DD0409E51D', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2DC3521C-3820-5EA5-9A9A-00BB7AF4E8E5',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '2DC3521C-3820-5EA5-9A9A-00BB7AF4E8E5'],
'RunningCloudApps' => [
'title' => 'appModels',
- 'description' => '',
+ 'description' => 'A list of running cloud applications.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Information about a running cloud application.',
'type' => 'object',
'properties' => [
- 'AppId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ca-dln05y44ze6esfl8x',
- ],
- 'AppName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alihealth-keeper',
- ],
- 'AppVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '11.1',
- ],
- 'AppVersionName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test1.0',
- ],
- 'IconUrl' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://app-icon-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/187465/18_bf1.jpg',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'AppInstanceGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'aig-dk8p95irk9xs5xi6a',
- ],
- 'AppInstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ai-gc1gemx6vpa6vlync',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1642748400',
- ],
- 'Duration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '87',
- ],
+ 'AppId' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => 'ca-dln05y44ze6esfl8x', 'title' => ''],
+ 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'alihealth-keeper', 'title' => ''],
+ 'AppVersion' => ['description' => 'The version of the application.', 'type' => 'string', 'example' => '11.1', 'title' => ''],
+ 'AppVersionName' => ['description' => 'The version name of the application.', 'type' => 'string', 'example' => 'test1.0', 'title' => ''],
+ 'IconUrl' => ['description' => 'The URL of the application icon.', 'type' => 'string', 'example' => 'https://app-icon-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/187465/18_bf1.jpg', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID where the cloud application runs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'AppInstanceGroupId' => ['description' => 'The ID of the delivery group.', 'type' => 'string', 'example' => 'aig-dk8p95irk9xs5xi6a', 'title' => ''],
+ 'AppInstanceId' => ['description' => 'The ID of the application instance.', 'type' => 'string', 'example' => 'ai-gc1gemx6vpa6vlync', 'title' => ''],
+ 'StartTime' => ['description' => 'The time when the application started.', 'type' => 'string', 'example' => '1642748400', 'title' => ''],
+ 'Duration' => ['description' => 'The runtime of the cloud application instance, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '87', 'title' => ''],
'OsType' => [
- 'description' => '',
+ 'description' => 'The OS type of the platform where the instance runs.',
+ 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows', 'Android' => 'Android'],
'type' => 'string',
- 'enumValueTitles' => [
- 'Linux' => 'Linux',
- 'Windows' => 'Windows',
- 'Android' => 'Android',
- ],
'example' => 'Windows',
+ 'title' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DC3521C-3820-5EA5-9A9A-00BB7AF4E8E5\\",\\n \\"RunningCloudApps\\": [\\n {\\n \\"AppId\\": \\"ca-dln05y44ze6esfl8x\\",\\n \\"AppName\\": \\"alihealth-keeper\\",\\n \\"AppVersion\\": \\"11.1\\",\\n \\"AppVersionName\\": \\"test1.0\\",\\n \\"IconUrl\\": \\"https://app-icon-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/187465/18_bf1.jpg\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AppInstanceGroupId\\": \\"aig-dk8p95irk9xs5xi6a\\",\\n \\"AppInstanceId\\": \\"ai-gc1gemx6vpa6vlync\\",\\n \\"StartTime\\": \\"1642748400\\",\\n \\"Duration\\": 87,\\n \\"OsType\\": \\"Windows\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListRunningApps',
- ],
- 'Unbind' => [
- 'summary' => 'Unbinds an app instance from a user.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Query the List of running applications',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'ResetAppResources' => [
+ 'summary' => 'Resets application resources.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
@@ -964,153 +638,88 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREappstreamingEP3FXS',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ProductType',
+ 'name' => 'BizRegionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CloudApp',
- ],
+ 'schema' => ['description' => 'ID of the business region.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'LoginToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-e1l4kqqykxt4uzdx9',
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v285fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****'],
],
[
- 'name' => 'AppInstanceId',
+ 'name' => 'EndUserId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'Username.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'user01'],
],
[
- 'name' => 'AppId',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ca-fxwp4koxs8hopi94e',
- ],
+ 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03'],
],
[
- 'name' => 'EndUserId',
+ 'name' => 'LoginRegionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test.test',
- ],
+ 'schema' => ['description' => 'Region ID used when logging in from the corporate network.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientOS',
+ 'name' => 'Uuid',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 19041)',
- ],
+ 'schema' => ['description' => 'Client UUID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2943802884B27030B6759F9132B2****'],
],
[
'name' => 'ClientId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7',
- ],
+ 'schema' => ['description' => 'Client ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'."\n"],
],
[
- 'name' => 'ClientVersion',
+ 'name' => 'ClientOS',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2.0.1-D-20220303.171122',
- ],
+ 'schema' => ['description' => 'Client operating system.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 22631)'],
],
[
- 'name' => 'ClientIp',
+ 'name' => 'ClientVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '139.129.223.122',
- ],
+ 'schema' => ['description' => 'Client version.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '7.7.0-R-20241217.092056'],
],
[
- 'name' => 'LoginToken',
+ 'name' => 'ClientIp',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v1e9c8e83d83ea11270871640059145702bde8c5be8c6b9a854ffb6a43bd2673c19a5551c83800724e024f488dbfb0b247',
- ],
+ 'schema' => ['description' => 'Client IP address.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.2.3.4'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'description' => '',
+ 'description' => 'Product type.',
+ 'enumValueTitles' => ['CloudApp' => 'Cloud application', 'CloudBrowser' => 'Cloud browser', 'AndroidCloud' => 'Cloud phone'],
'type' => 'string',
'required' => true,
- 'example' => '11040139-4fb4-4b35-9b44-6c07c746a43e',
- ],
- ],
- [
- 'name' => 'TenantId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1569416393841402',
+ 'title' => '',
+ 'example' => 'AndroidCloud',
],
],
[
- 'name' => 'LoginRegionId',
+ 'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['description' => 'Resource group ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aig-9ciijz60n4xsv****'],
],
[
- 'name' => 'AppInstancePersistentId',
+ 'name' => 'ResourceIds',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '持久会话ID。',
- 'type' => 'string',
- 'example' => 'p-xxxxx',
+ 'title' => '',
+ 'description' => 'List of resource IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Resource ID. For cloud phones, provide the persistent session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'p-00001'],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ 'example' => '',
],
],
],
@@ -1118,304 +727,152 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '6EBD4046-2202-5FBD-8595-4B631F0C484B',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Code' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'InvalidAppInstanceGroup.NotFound', 'title' => ''],
+ 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The app instance group is not found.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call succeeded. true: succeeded. false: failed.', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'Reset application resources',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EBD4046-2202-5FBD-8595-4B631F0C484B\\"\\n}","type":"json"}]',
- 'title' => 'Unbind',
],
- 'StopApp' => [
- 'summary' => 'Stops a specific app.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RestartAppResources' => [
+ 'summary' => 'Restart application resources.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'BizRegionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '实例组id',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aig-89ibriac2wudyph38',
- ],
+ 'schema' => ['description' => 'Business region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'AppInstanceId',
+ 'name' => 'LoginToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '实例id',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ai-d297eyf83g5niwnjl',
- ],
+ 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v1124500957832f30b3e716406562071655aa43b2a723ed2be0837815483d54e025db13ba5469f06f2410d0efc4d302e36'],
],
[
- 'name' => 'AppId',
+ 'name' => 'EndUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用id',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ca-fxwp4koywsglzvvex',
- ],
+ 'schema' => ['description' => 'Username.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'user001'],
],
[
- 'name' => 'ProductType',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品线',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- ],
- 'example' => 'CloudApp',
- ],
+ 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03'],
],
[
- 'name' => 'ForceStop',
+ 'name' => 'LoginRegionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '强制停止',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '',
- 'false' => '',
- ],
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'Region ID when logging on to the office network.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ApiType',
+ 'name' => 'Uuid',
'in' => 'formData',
- 'schema' => [
- 'title' => 'AdminAPI, InnerAPI, AnonymousUserAPI',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'AnonymousUserAPI' => 'AnonymousUserAPI',
- ],
- 'example' => 'AnonymousUserAPI',
- ],
+ 'schema' => ['description' => 'Client UUID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2943802884B27030B6759F9132B2****'],
],
[
'name' => 'ClientId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '91b79184-51d0-42ad-8475-78cae95b0aa6',
- ],
- ],
- [
- 'name' => 'LoginToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d330e',
- ],
- ],
- [
- 'name' => 'EndUserId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test.test',
- ],
- ],
- [
- 'name' => 'SessionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '597e869d-ea14-4b83-9490-714f68bfe935',
- ],
+ 'schema' => ['description' => 'Client ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7'],
],
[
'name' => 'ClientOS',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 19042)',
- ],
+ 'schema' => ['description' => 'Client operating system.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)'],
],
[
'name' => 'ClientVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3.1.1-R-20211022.144255',
- ],
+ 'schema' => ['description' => 'Client version.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '7.5.3-RS-20241127.131156'],
],
[
'name' => 'ClientIp',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '22.21.2.79',
- ],
- ],
- [
- 'name' => 'BizRegionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'Client IP.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.2.3.4'],
],
[
- 'name' => 'LoginRegionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientChannel',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'pc' => 'pc',
- 'web' => 'web',
- 'mobile' => 'mobile',
- ],
- 'example' => 'pc',
- ],
- ],
- [
- 'name' => 'Uuid',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2943802884B27030B6759F9132B26903',
- ],
- ],
- [
- 'name' => 'WyId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ac3cb49059261898',
- ],
- ],
- [
- 'name' => 'IdpId',
+ 'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'description' => '',
+ 'description' => 'Product type.',
+ 'enumValueTitles' => ['CloudApp' => 'Cloud application', 'CloudBrowser' => 'Cloud browser', 'AndroidCloud' => 'Cloud phone'],
'type' => 'string',
- 'required' => false,
- 'example' => 'idp-9ie5smicnct2xodn2',
+ 'required' => true,
+ 'title' => '',
+ 'example' => 'AndroidCloud',
],
],
[
- 'name' => 'AliUid',
+ 'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1924794279035094',
- ],
+ 'schema' => ['description' => 'Resource group ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aig-53fvrq1oanz6c****'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ResourceIds',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'title' => '',
+ 'description' => 'Resource ID list.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Resource ID. For cloud phones, enter the persistent session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'p-00001'],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'BaseResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '83A9075B-C646-59A9-8232-CAE41AF4B9E3',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Code' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'InvalidAppInstanceGroup.NotFound', 'title' => ''],
+ 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The app instance group is not found.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. true: The call was successful. false: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"83A9075B-C646-59A9-8232-CAE41AF4B9E3\\"\\n}","type":"json"}]',
- 'title' => 'StopApp',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'Restart Application Resource ',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'StartAppResources' => [
- 'summary' => 'Starts app resources.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Start application resources.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
@@ -1423,167 +880,88 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'BizRegionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务地域ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'Business region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'LoginToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '登录Token。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****',
- ],
+ 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****'],
],
[
'name' => 'EndUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户名。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testUser01',
- ],
+ 'schema' => ['description' => 'Username.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'testUser01'],
],
[
'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '会话ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae9****',
- ],
+ 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae9****'],
],
[
'name' => 'LoginRegionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '工作区登录时候的地域ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID when logging on to the office network.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Uuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端Uuid。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2943802884B27030B6759F9132B2****',
- ],
+ 'schema' => ['description' => 'Client UUID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2943802884B27030B6759F9132B2****'],
],
[
'name' => 'ClientId',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eac19bef-1e45-4190-a03a-4ea74b69****',
- ],
+ 'schema' => ['description' => 'Client ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'eac19bef-1e45-4190-a03a-4ea74b69****'],
],
[
'name' => 'ClientOS',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端操作系统。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 22631)',
- ],
+ 'schema' => ['description' => 'Client operating system.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 22631)'],
],
[
'name' => 'ClientVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端版本。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7.5.1-R-20240903.163046',
- ],
+ 'schema' => ['description' => 'Client version.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '7.5.1-R-20240903.163046'],
],
[
'name' => 'ClientIp',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端IP。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.2.3.4',
- ],
+ 'schema' => ['description' => 'Client IP.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.2.3.4'],
],
[
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'title' => '产品类型。',
- 'description' => '',
+ 'description' => 'Product type.',
+ 'enumValueTitles' => ['CloudApp' => 'Cloud application', 'CloudBrowser' => 'Cloud browser', 'AndroidCloud' => 'Cloud phone'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- 'CloudBrowser' => '',
- 'AndroidCloud' => '',
- ],
+ 'title' => '',
'example' => 'AndroidCloud',
],
],
[
'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源组ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
+ 'schema' => ['description' => 'Resource group ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aig-9ciijz60n4xsv****'],
],
[
'name' => 'ResourceIds',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'title' => '资源ID列表。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Resource ID list.',
'type' => 'array',
- 'items' => [
- 'title' => '资源ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'p-0000001',
- ],
+ 'items' => ['description' => 'Resource ID. For cloud phones, enter the persistent session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'p-0000001'],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
+ 'example' => '',
],
],
],
@@ -1591,269 +969,198 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InvalidAppInstanceGroup.NotFound',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The app instance group is not found.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Code' => ['description' => 'Error code when an error occurs.', 'type' => 'string', 'example' => 'InvalidAppInstanceGroup.NotFound', 'title' => ''],
+ 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The app instance group is not found.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
- 'title' => 'StartAppResources',
- ],
- 'StopAppResources' => [
- 'summary' => 'Stops app resources.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Start application resources',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'StopApp' => [
+ 'summary' => 'Stops the specified application.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'BizRegionId',
+ 'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务地域ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'Delivery group ID. Obtain this ID by calling the ListRunningApps interface. Parameter: AppInstanceGroupId.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'aig-89ibriac2wudyph38'],
],
[
- 'name' => 'LoginToken',
+ 'name' => 'AppInstanceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '登录Token。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v12369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70****',
- ],
+ 'schema' => ['description' => 'Instance ID. Obtain this ID by calling the ListRunningApps interface. Parameter: AppInstanceId.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ai-d297eyf83g5niwnjl'],
],
[
- 'name' => 'EndUserId',
+ 'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户名。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testUser',
- ],
+ 'schema' => ['description' => 'Application ID. Obtain this ID by calling the ListRunningApps interface. Parameter: AppId.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ca-fxwp4koywsglzvvex'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'title' => '会话ID。',
- 'description' => '',
+ 'description' => 'Product type. The only valid value is `CloudApp`, which represents WUYING AppStreaming.',
+ 'enumValueTitles' => ['CloudApp' => 'Cloud application'],
'type' => 'string',
- 'required' => true,
- 'example' => '597e869d-ea14-4b83-9490-714f68bfe935',
+ 'title' => '',
+ 'required' => false,
+ 'example' => 'CloudApp',
],
],
[
- 'name' => 'LoginRegionId',
+ 'name' => 'ForceStop',
'in' => 'formData',
'schema' => [
- 'title' => '工作区登录时候的地域ID。',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Force stop.',
+ 'enumValueTitles' => ['true' => 'Force stop', 'false' => 'Do not force stop'],
+ 'type' => 'boolean',
+ 'title' => '',
'required' => false,
- 'example' => 'cn-hangzhou',
+ 'example' => 'false',
],
],
[
- 'name' => 'Uuid',
+ 'name' => 'ApiType',
'in' => 'formData',
'schema' => [
- 'title' => '客户端Uuid。',
- 'description' => '',
+ 'title' => 'AdminAPI, InnerAPI, AnonymousUserAPI',
+ 'description' => 'Interface type. The only valid value is AnonymousUserAPI, which indicates a client call interface.',
+ 'enumValueTitles' => ['AnonymousUserAPI' => 'AnonymousUserAPI'],
'type' => 'string',
'required' => false,
- 'example' => 'C50973691A6D2BE23F2CDD73B85B****',
+ 'example' => 'AnonymousUserAPI',
],
],
[
'name' => 'ClientId',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7',
- ],
+ 'schema' => ['description' => 'Unique ID generated by the client.', 'type' => 'string', 'required' => false, 'example' => '91b79184-51d0-42ad-8475-78cae95b0aa6', 'title' => ''],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Login credential. Obtain this credential by calling the GetLoginToken interface to log on, or by calling the RefreshLoginToken update interface after logging on. Return parameter: LoginToken.', 'type' => 'string', 'required' => false, 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d330e', 'title' => ''],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Convenience account username.', 'type' => 'string', 'required' => false, 'example' => 'test.test', 'title' => ''],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Session ID. Obtain this ID by calling the GetLoginToken login interface. Return parameter: SessionId.', 'type' => 'string', 'required' => false, 'example' => '597e869d-ea14-4b83-9490-714f68bfe935', 'title' => ''],
],
[
'name' => 'ClientOS',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端操作系统。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 19042)',
- ],
+ 'schema' => ['description' => 'Client operating system.', 'type' => 'string', 'required' => false, 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 19042)', 'title' => ''],
],
[
'name' => 'ClientVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端版本。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7.2.0-R-20241008.110000',
- ],
+ 'schema' => ['description' => 'Client version.', 'type' => 'string', 'required' => false, 'example' => '3.1.1-R-20211022.144255', 'title' => ''],
],
[
'name' => 'ClientIp',
'in' => 'formData',
+ 'schema' => ['description' => 'Client IP address.', 'type' => 'string', 'required' => false, 'example' => '22.21.2.79', 'title' => ''],
+ ],
+ [
+ 'name' => 'BizRegionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Region ID of the delivery group. Obtain this ID by calling the ListRunningApps interface. Parameter: RegionId.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'LoginRegionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Login region ID. This is the workspace region ID selected by the user during log on.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientChannel',
+ 'in' => 'formData',
'schema' => [
- 'title' => '客户端IP。',
- 'description' => '',
+ 'description' => 'App client channel. Use this channel to distinguish between different applications.',
+ 'enumValueTitles' => ['pc' => 'pc', 'web' => 'web', 'mobile' => 'mobile'],
'type' => 'string',
'required' => false,
- 'example' => '1.2.3.4',
+ 'example' => 'pc',
+ 'title' => '',
],
],
[
- 'name' => 'ProductType',
+ 'name' => 'Uuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品类型。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- 'CloudBrowser' => '',
- 'AndroidCloud' => '',
- ],
- 'example' => 'AndroidCloud',
- ],
+ 'schema' => ['description' => 'Device UUID.', 'type' => 'string', 'required' => false, 'example' => '2943802884B27030B6759F9132B26903', 'title' => ''],
],
[
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'WyId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源组ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
+ 'schema' => ['description' => 'WUYING user ID. Obtain this ID by calling the GetLoginToken login interface. Return parameter: WyId.', 'type' => 'string', 'required' => false, 'example' => 'ac3cb49059261898', 'title' => ''],
],
[
- 'name' => 'ResourceIds',
+ 'name' => 'IdpId',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '资源ID列表。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '资源ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'p-00001',
- ],
- 'required' => true,
- 'maxItems' => 100,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => 'Login authentication service ID. Obtain this ID by calling the FindIdpListByLoginName interface.', 'type' => 'string', 'required' => false, 'example' => 'idp-9ie5smicnct2xodn2', 'title' => ''],
+ ],
+ [
+ 'name' => 'AliUid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Tenant ID. Obtain this ID by calling the GetLoginToken login interface. Return parameter: TenantId.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1924794279035094', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Region ID of the delivery group. Obtain this ID by calling the ListRunningApps interface. Parameter: RegionId.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '829444D6-9FD3-5C65-A570-065975537647',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InvalidAppInstanceGroup.NotFound',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The app instance group is not found.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '83A9075B-C646-59A9-8232-CAE41AF4B9E3', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"83A9075B-C646-59A9-8232-CAE41AF4B9E3\\"\\n}","type":"json"}]',
+ 'title' => 'Stop Application',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"829444D6-9FD3-5C65-A570-065975537647\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
- 'title' => 'StopAppResources',
],
- 'RestartAppResources' => [
- 'summary' => 'Restarts app resources.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StopAppResources' => [
+ 'summary' => 'Shuts down application resources.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
@@ -1861,167 +1168,88 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'BizRegionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务地域ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The business region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'LoginToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '登录Token。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v1124500957832f30b3e716406562071655aa43b2a723ed2be0837815483d54e025db13ba5469f06f2410d0efc4d302e36',
- ],
+ 'schema' => ['description' => 'The logon token.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v12369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70****'],
],
[
'name' => 'EndUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户名。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user001',
- ],
+ 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'testUser'],
],
[
'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '会话ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03',
- ],
+ 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '597e869d-ea14-4b83-9490-714f68bfe935'],
],
[
'name' => 'LoginRegionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '工作区登录时候的地域ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID for office network logon.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Uuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端Uuid。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2943802884B27030B6759F9132B2****',
- ],
+ 'schema' => ['description' => 'The UUID of the client.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'C50973691A6D2BE23F2CDD73B85B****'],
],
[
'name' => 'ClientId',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7',
- ],
+ 'schema' => ['description' => 'The client ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7'],
],
[
'name' => 'ClientOS',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端操作系统。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)',
- ],
+ 'schema' => ['description' => 'The operating system of the client.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 19042)'],
],
[
'name' => 'ClientVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端版本。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7.5.3-RS-20241127.131156',
- ],
+ 'schema' => ['description' => 'The version of the client.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '7.2.0-R-20241008.110000'],
],
[
'name' => 'ClientIp',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端IP。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.2.3.4',
- ],
+ 'schema' => ['description' => 'The IP address of the client.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.2.3.4'],
],
[
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
- 'title' => '产品类型。',
- 'description' => '',
+ 'description' => 'The product type.',
+ 'enumValueTitles' => ['CloudApp' => 'Cloud App', 'CloudBrowser' => 'Cloud Browser', 'AndroidCloud' => 'Cloud Phone'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- 'CloudBrowser' => '',
- 'AndroidCloud' => '',
- ],
+ 'title' => '',
'example' => 'AndroidCloud',
],
],
[
'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源组ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-53fvrq1oanz6c****',
- ],
+ 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aig-9ciijz60n4xsv****'],
],
[
'name' => 'ResourceIds',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'title' => '资源ID列表。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'A list of resource IDs.',
'type' => 'array',
- 'items' => [
- 'title' => '资源ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'p-00001',
- ],
+ 'items' => ['description' => 'The resource ID. For Cloud Phone, pass the persistent session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'p-00001'],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
+ 'example' => '',
],
],
],
@@ -2029,50 +1257,31 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InvalidAppInstanceGroup.NotFound',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The app instance group is not found.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '829444D6-9FD3-5C65-A570-065975537647'],
+ 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidAppInstanceGroup.NotFound', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The app instance group is not found.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\` indicates success, and \\`false\\` indicates failure.', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"829444D6-9FD3-5C65-A570-065975537647\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'Shut down application resources',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
- 'title' => 'RestartAppResources',
],
- 'ResetAppResources' => [
- 'summary' => 'Resets app resources.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'Unbind' => [
+ 'summary' => 'Unbinds an application instance from a user.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
@@ -2084,213 +1293,329 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREappstreamingEP3FXS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'BizRegionId',
+ 'name' => 'ProductType',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务地域ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The product type. The value must be `CloudApp`, which indicates a cloud application product.', 'type' => 'string', 'required' => true, 'example' => 'CloudApp', 'title' => ''],
],
[
- 'name' => 'LoginToken',
+ 'name' => 'AppInstanceGroupId',
'in' => 'formData',
- 'schema' => [
- 'title' => '登录Token。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v285fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****',
- ],
+ 'schema' => ['description' => 'The ID of the application instance group.', 'type' => 'string', 'required' => true, 'maxItems' => 100, 'example' => 'aig-e1l4kqqykxt4uzdx9', 'title' => ''],
],
[
- 'name' => 'EndUserId',
+ 'name' => 'AppInstanceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户名。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user01',
- ],
+ 'schema' => ['description' => 'The ID of the application instance.', 'type' => 'string', 'required' => false, 'example' => 'ai-azn3kmwruh1vl****', 'title' => ''],
],
[
- 'name' => 'SessionId',
+ 'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '会话ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03',
- ],
+ 'schema' => ['description' => 'The ID of the application.'."\n"
+ .'Obtain this ID by calling the ListPublishedAppInfo operation.', 'type' => 'string', 'required' => false, 'example' => 'ca-fxwp4koxs8hopi94e', 'title' => ''],
],
[
- 'name' => 'LoginRegionId',
+ 'name' => 'EndUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '工作区登录时候的地域ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The username of the convenience account.', 'type' => 'string', 'required' => false, 'example' => 'test.test', 'title' => ''],
],
[
- 'name' => 'Uuid',
+ 'name' => 'ClientOS',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端Uuid。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2943802884B27030B6759F9132B2****',
- ],
+ 'schema' => ['description' => 'The operating system of the client.', 'type' => 'string', 'required' => false, 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 19041)', 'title' => ''],
],
[
'name' => 'ClientId',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'."\n",
- ],
+ 'schema' => ['description' => 'The unique ID that is generated by the client.', 'type' => 'string', 'required' => false, 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7', 'title' => ''],
],
[
- 'name' => 'ClientOS',
+ 'name' => 'ClientVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端操作系统。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 22631)',
- ],
+ 'schema' => ['description' => 'The version number of the client.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-D-20220303.171122', 'title' => ''],
],
[
- 'name' => 'ClientVersion',
+ 'name' => 'ClientIp',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端版本。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7.7.0-R-20241217.092056',
- ],
+ 'schema' => ['description' => 'The IP address of the client.', 'type' => 'string', 'required' => false, 'example' => '139.129.223.122', 'title' => ''],
],
[
- 'name' => 'ClientIp',
+ 'name' => 'LoginToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户端IP。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.2.3.4',
- ],
+ 'schema' => ['description' => 'The logon token.'."\n"
+ .'Obtain this token by calling the GetLoginToken operation. You can also refresh the token by calling the RefreshLoginToken operation. The token is the value of the returned \\`LoginToken\\` parameter.', 'type' => 'string', 'required' => true, 'example' => 'v1e9c8e83d83ea11270871640059145702bde8c5be8c6b9a854ffb6a43bd2673c19a5551c83800724e024f488dbfb0b247', 'title' => ''],
],
[
- 'name' => 'ProductType',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品类型。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'CloudApp' => '',
- 'CloudBrowser' => '',
- 'AndroidCloud' => '',
- ],
- 'example' => 'AndroidCloud',
- ],
+ 'schema' => ['description' => 'The session ID.'."\n"
+ .'Obtain this ID by calling the GetLoginToken operation. The ID is the value of the returned \\`SessionId\\` parameter.', 'type' => 'string', 'required' => true, 'example' => '11040139-4fb4-4b35-9b44-6c07c746a43e', 'title' => ''],
],
[
- 'name' => 'AppInstanceGroupId',
+ 'name' => 'TenantId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源组ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aig-9ciijz60n4xsv****',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ .'Obtain this ID by calling the GetLoginToken operation. The ID is the value of the returned \\`TenantId\\` parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1569416393841402', 'title' => ''],
],
[
- 'name' => 'ResourceIds',
+ 'name' => 'LoginRegionId',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '资源ID列表。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '资源ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'p-00001',
- ],
- 'required' => true,
- 'maxItems' => 100,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => 'The region ID of AppStream Center.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppInstancePersistentId',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Persistent session ID.', 'description' => 'The ID of the persistent session.', 'type' => 'string', 'example' => 'p-xxxxx', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InvalidAppInstanceGroup.NotFound',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The app instance group is not found.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6EBD4046-2202-5FBD-8595-4B631F0C484B'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EBD4046-2202-5FBD-8595-4B631F0C484B\\"\\n}","type":"json"}]',
+ 'title' => 'Detach Application Instance',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
- 'title' => 'ResetAppResources',
+ 'ramActions' => [],
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com',
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'appstream-center.cn-shanghai.aliyuncs.com', 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com', 'vpc' => 'appstream-center-intl.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'appstream-center.ap-southeast-1.aliyuncs.com', 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com', 'vpc' => 'appstream-center-intl.vpc-proxy.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AddRemoveAccountIsSame', 'message' => 'The same account is to be added and to be removed at the same time.', 'http_code' => 400, 'description' => 'The same account is to be added and to be removed at the same time.'],
+ ['code' => 'AppCenterImageId.Missing', 'message' => 'The AppCenter ImageId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppCenterImageInfo.NotFound', 'message' => 'The AppCenter ImageInfo is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppDeploymentInfo.NotFound', 'message' => 'The AppDeploymentInfo is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstallation.StartFailed', 'message' => 'Start app installation failed.', 'http_code' => 400, 'description' => 'Failed to start the app installation.'],
+ ['code' => 'AppInstallationStatus.IsFailed', 'message' => 'App installation failed.', 'http_code' => 400, 'description' => 'The app installation status is failed.'],
+ ['code' => 'AppInstanceGroupAttributeModify.Failed', 'message' => 'Failed to modify the delivery group attribute.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupIdIsNull', 'message' => 'The AppInstanceGroupId is null.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupImageCreate.Failed', 'message' => 'Failed to create an image from the debugging app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupNotFound', 'message' => 'The AppInstanceGroup is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppInstanceGroupNotFound', 'message' => 'The specified AppInstanceGroup not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AppType.ValueNotSupported', 'message' => 'The category of the app is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AuthorizeFailed', 'message' => 'Authorize failed, please check your EndUserId and Password.', 'http_code' => 400, 'description' => 'Invalid username or password.'],
+ ['code' => 'BillingItem.InsertFailure', 'message' => 'Failed to insert the billing item.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'BizTypeNotMatch', 'message' => 'The bizType and image do not match.', 'http_code' => 400, 'description' => 'The bizType and image do not match.'],
+ ['code' => 'BuilderImage.StartTaskFailed', 'message' => 'Failed to start the builder image task.', 'http_code' => 400, 'description' => 'Failed to start the builder image task.'],
+ ['code' => 'CallBack.PayOrderCallbackFailed', 'message' => 'Failed to lock the order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CashBookInsufficient', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CheckStock.Failed', 'message' => 'Failed to check the stock.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ConnectLdapServer.Failed', 'message' => 'Failed to connect to the LDAP server. Please check the configuration.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CreateAppInstanceGroup.Failed', 'message' => 'Failed to create the app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CreateDesktopImageRecord.Failed', 'message' => 'Create cloud computer image failed.', 'http_code' => 400, 'description' => 'Failed to create the cloud computer image.'],
+ ['code' => 'DeleteTemplate.Failed', 'message' => 'Delete template failed.', 'http_code' => 400, 'description' => 'Failed to delete the template.'],
+ ['code' => 'DesktopInstance.NotFound', 'message' => 'The cloud computer instance does not exist.', 'http_code' => 400, 'description' => 'The cloud computer instance does not exist.'],
+ ['code' => 'ExceedAddAccountQuota', 'message' => 'The maximum number of account addition is reached.', 'http_code' => 400, 'description' => 'The maximum number of account addition is reached.'],
+ ['code' => 'ExceedAppAuthUserQuota', 'message' => 'The authorized user quota of the app is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedAppInstanceGroupQuota', 'message' => 'The app instance group quota is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedBuilderQuota', 'message' => 'The maximum number of builders is reached.', 'http_code' => 400, 'description' => 'The maximum number of builders is reached.'],
+ ['code' => 'ExceedImageQuota', 'message' => 'The maximum number of images is reached.', 'http_code' => 400, 'description' => 'The maximum number of images is reached.'],
+ ['code' => 'ExceedPoolNodeAmountQuota', 'message' => 'The pool node amount quota is exceeded.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExceedRemoveAccountQuota', 'message' => 'The maximum number of account removal is reached.', 'http_code' => 400, 'description' => 'The maximum number of account removal is reached.'],
+ ['code' => 'Forbidden.NoPermission', 'message' => 'You are not authorized to access this page.', 'http_code' => 403, 'description' => 'You are not authorized to access this page.'],
+ ['code' => 'ForbiddenNoRealNameAuthentication', 'message' => 'Operation failed. The user has not completed the real-name authentication.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ForbiddenNoRealNameAuthentication', 'message' => 'Forbidden by user real name authentication status.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'GetLoginTokenError', 'message' => 'Failed to get the login token.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Image.CreateModeInvalid', 'message' => 'The creation mode of this task is invalid.', 'http_code' => 400, 'description' => 'The creation mode of this task is invalid.'],
+ ['code' => 'Image.NotExist', 'message' => 'The image does not exist.', 'http_code' => 400, 'description' => 'The image does not exist.'],
+ ['code' => 'ImageCreateByInstance.TaskExist', 'message' => 'The image task of instance creation already exists.', 'http_code' => 400, 'description' => 'The image task of instance creation already exists.'],
+ ['code' => 'ImageDeleteFailed.HasSharedImage', 'message' => 'The shared image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllow', 'message' => 'The image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllowCommunityParent', 'message' => 'The parent image of a community image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The parent image of a community image is not allowed to be deleted.'],
+ ['code' => 'ImageDeleteFailed.NotAllowSharedImage', 'message' => 'The shared image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be deleted.'],
+ ['code' => 'ImageDistribute.ImageNotSupport', 'message' => 'The image does not support region distribution.', 'http_code' => 400, 'description' => 'The image does not support region distribution. E.g. encrypted images.'],
+ ['code' => 'ImageDistribute.RepeatedDistribution', 'message' => 'This image has been distributed to this region.', 'http_code' => 400, 'description' => 'This image has been distributed to this region.'],
+ ['code' => 'ImageDistribute.TargetDistributeRegionListEmpty', 'message' => 'The target distribution region list is empty.', 'http_code' => 400, 'description' => 'The target distribution region list is empty.'],
+ ['code' => 'ImageDistribute.Undistributed', 'message' => 'The image has not been distributed to any region.', 'http_code' => 400, 'description' => 'The image has not been distributed to any region.'],
+ ['code' => 'ImageIsNull', 'message' => 'The image does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ImageNotAllowDelete', 'message' => 'The image cannot be deleted, because shared cloud computers already exist.', 'http_code' => 400, 'description' => 'The image cannot be deleted, because shared cloud computers already exist.'],
+ ['code' => 'ImageRegion.NotConfigured', 'message' => 'The image does not have any region configuration.', 'http_code' => 400, 'description' => 'The image does not have any region configuration.'],
+ ['code' => 'ImageRegionDistribute.NotAllow', 'message' => 'This image cannot be distributed.', 'http_code' => 400, 'description' => 'This image cannot be distributed.'],
+ ['code' => 'ImageStatus.Error', 'message' => 'The image status is error.', 'http_code' => 400, 'description' => 'The image status is error.'],
+ ['code' => 'ImageStatus.ValueNotSupported', 'message' => 'The image status is not supported for creating a delivery group.', 'http_code' => 400, 'description' => 'You cannot create a delivery group in the current image status.'],
+ ['code' => 'ImageTask.Failed', 'message' => 'Start image task failed.', 'http_code' => 400, 'description' => 'Failed to start the image task.'],
+ ['code' => 'ImageUpdateFailed.NotAllow', 'message' => 'The image is not allowed to be modified.', 'http_code' => 400, 'description' => 'The image is not allowed to be modified.'],
+ ['code' => 'ImageUpdateSharedImageFailed.NotAllow', 'message' => 'The shared image is not allowed to be modified.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be modified.'],
+ ['code' => 'Instance.ImageUnsupported', 'message' => 'A non-centralized image does not support this type of operation.', 'http_code' => 400, 'description' => 'A non-centralized image does not support this type of operation.'],
+ ['code' => 'Instance.NotFound', 'message' => 'The instance is not found.', 'http_code' => 400, 'description' => 'The instance is not found.'],
+ ['code' => 'Instance.PhysicalNodeNotExist', 'message' => 'The instance physical node does not exist.', 'http_code' => 400, 'description' => 'The physical node of this instance does not exist.'],
+ ['code' => 'InternalError', 'message' => 'Internal error.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InternalError.TicketGenInternalError', 'message' => 'An error occurred while generating a ticket.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAliUid.Missing', 'message' => 'The AliUid is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAliUid.Missing', 'message' => 'The specified parameter AliUid is missing.', 'http_code' => 400, 'description' => 'The specified parameter AliUid is missing.'],
+ ['code' => 'InvalidAliUid.NotFound', 'message' => 'The AliUid is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAmount.Invalid', 'message' => 'The Amount is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.Missing', 'message' => 'The AppId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppId.NotFound', 'message' => 'The AppId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotContainThisAPP', 'message' => 'The app instance group does not contain this app.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotFound', 'message' => 'The app instance group is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NotFound', 'message' => 'The AppInstanceGroupId %s is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NullAppInstanceGroup', 'message' => 'The app instance group is null.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.NullOrNotPublishedStatus', 'message' => 'The app instance group does not exist or is not published.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.StatusInvalid', 'message' => 'The app instance group status is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroup.Unauthorized', 'message' => 'Unauthorized to use this app.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupAction.IllegalAction', 'message' => 'The action against the app instance group is not allowed.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupId.Missing', 'message' => 'The AppInstanceGroupId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupName.Missing', 'message' => 'The AppInstanceGroupName is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceGroupSpecItem.NotFound', 'message' => 'The app instance group spec item is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceId.NotFound', 'message' => 'The AppInstanceId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceState', 'message' => 'The app instance state is invalid.', 'http_code' => 200, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.Invalid', 'message' => 'The AppInstanceType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.Missing', 'message' => 'The AppInstanceType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppInstanceType.NotFound', 'message' => 'The app instance type is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAppVersion.Missing', 'message' => 'The AppVersion is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBaseImage.InvalidStatus', 'message' => 'Invalid base image status.', 'http_code' => 400, 'description' => 'The status of the base image is invalid.'],
+ ['code' => 'InvalidBaseImage.NotConfigured', 'message' => 'Configuration required for Vhd/Container images.', 'http_code' => 400, 'description' => 'Configuration required for Vhd/Container images.'],
+ ['code' => 'InvalidBaseImage.NotFound', 'message' => 'Base image not found.', 'http_code' => 400, 'description' => 'The base image is not found.'],
+ ['code' => 'InvalidBaseImage.NotSystemImage', 'message' => 'Base image is not system image.', 'http_code' => 400, 'description' => 'The base image is not a system image.'],
+ ['code' => 'InvalidBaseImageVersion.NotOnline', 'message' => 'Base image version is not online.', 'http_code' => 400, 'description' => 'The base image is not of an available online version.'],
+ ['code' => 'InvalidBindRelationship.NotFound', 'message' => 'The bind relationship is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBindStage.Missing', 'message' => 'The BindStage is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBindStrategy.NotFound', 'message' => 'The bind strategy is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidBizType', 'message' => 'The bizType parameter is invalid.', 'http_code' => 400, 'description' => 'The bizType parameter is invalid.'],
+ ['code' => 'InvalidBrowserInstanceGroup.NotFound', 'message' => 'The browser instance group is not found.', 'http_code' => 400, 'description' => 'The cloud browser does not exist, please confirm and try again'],
+ ['code' => 'InvalidBundle.NotFound', 'message' => 'The request bundle does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidChargeType.Missing', 'message' => 'The ChargeType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidChargeType.ValueNotSupported', 'message' => 'The ChargeType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDataDiskSize.SmallerThanParent', 'message' => 'Sub-image data disk size is smaller than the parent image.', 'http_code' => 400, 'description' => 'Sub-image data disk size is smaller than the parent image.'],
+ ['code' => 'InvalidDomainId.NotFound', 'message' => 'The DomainId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDriveId.NotFound', 'message' => 'The DriveId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidEndUserId.Missing', 'message' => 'The EndUserId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidEndUserIds.ValueNotSupported', 'message' => 'The EndUserIds is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidExternalFileId.NotFound', 'message' => 'The ExternalFileId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwAddress.NotFound', 'message' => 'The gateway address is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwParam.NotFound', 'message' => 'A parameter error occurred while generating the gateway token.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGwToken.ValueTooLong', 'message' => 'The GWToken is too long.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidImageConfig.RegionInvalid', 'message' => 'The region configuration of this image is invalid.', 'http_code' => 400, 'description' => 'The region configuration of this image is invalid.'],
+ ['code' => 'InvalidImageId.Invalid', 'message' => 'The specified parameter imageId is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidImageOperation.Failed', 'message' => 'Invalid image operation.', 'http_code' => 400, 'description' => 'Image operation failed.'],
+ ['code' => 'InvalidImageOperation.ImageIsCreating', 'message' => 'Failed to operation the image, it is creating.', 'http_code' => 400, 'description' => 'Failed to operation the image, it is creating.'],
+ ['code' => 'InvalidImagePackageType.Unsupported', 'message' => 'Unsupported image package type.', 'http_code' => 400, 'description' => 'This package type is not supported.'],
+ ['code' => 'InvalidInstanceId.Missing', 'message' => 'The InstanceId is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidLoginToken.Missing', 'message' => 'The LoginToken is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNextToken', 'message' => 'The NextToken is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNodeInstanceType.NotFound', 'message' => 'The node instance type is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidNodeInstanceType.NotSupportOsType', 'message' => 'The node instance type does not support images with this OS type.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrder.CommodityCodeNotMatch', 'message' => 'No CommodityCode matches this order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrder.CommodityCodeNotMatch', 'message' => 'No commodityCode matched for this order.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrderId.NotFound', 'message' => 'The order is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOrderId.NotFound', 'message' => 'The specified order is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidOsType.ValueNotSupported', 'message' => 'The operation system type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.%s', 'message' => 'The parameter %s is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter.AddAccount/RemoveAccount', 'message' => 'The tenant ID to be added or removed is invalid.', 'http_code' => 400, 'description' => 'The tenant ID to be added or removed is invalid.'],
+ ['code' => 'InvalidParameter.ImageId', 'message' => 'The image ID is invalid.', 'http_code' => 400, 'description' => 'The image ID is invalid.'],
+ ['code' => 'InvalidParameter.SystemDiskSize', 'message' => 'The system disk size is invalid.', 'http_code' => 400, 'description' => 'The system disk size is invalid.'],
+ ['code' => 'InvalidParentImage.AlreadyHasCommunityImage', 'message' => 'The parent image already has a community image.', 'http_code' => 400, 'description' => 'This image cannot be published to the community because it is already published.'],
+ ['code' => 'InvalidParentImage.ImageTypeIsNotUserImage', 'message' => 'Invalid operation. The parent image is not a user image.', 'http_code' => 400, 'description' => 'Invalid operation. The parent image is not a user image.'],
+ ['code' => 'InvalidParentImage.InvalidStatus', 'message' => 'Invalid parent image status.', 'http_code' => 400, 'description' => 'The status of the parent image is invalid.'],
+ ['code' => 'InvalidParentImage.NotFound', 'message' => 'Parent image not found.', 'http_code' => 400, 'description' => 'The parent image is not found.'],
+ ['code' => 'InvalidPeriod.Invalid', 'message' => 'The Period is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriod.Missing', 'message' => 'The Period is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriodUnit.Missing', 'message' => 'The PeriodUnit is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriodUnit.ValueNotSupported', 'message' => 'The PeriodUnit is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.Invalid', 'message' => 'The ProductType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.Missing', 'message' => 'The ProductType is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProductType.ValueNotSupported', 'message' => 'The ProductType is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.ConfigError', 'message' => 'The region configuration is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.Missing', 'message' => 'The Region is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.NotFound', 'message' => 'The region is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegion.NotMatch', 'message' => 'The region does not match the current environment.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegionBind.NotFound', 'message' => 'The AppRegionBind is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRegionId.NotFound', 'message' => 'The RegionId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidResourcePool.NotFound', 'message' => 'The resource pool is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidResponse.Missing', 'message' => 'The response body is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSessionId.Missing', 'message' => 'The SessionId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSourceImage.ImageTypeCannotBeShared', 'message' => 'Source image cannot be shared.', 'http_code' => 400, 'description' => 'This type of source image cannot be shared.'],
+ ['code' => 'InvalidSourceImage.StatusNotAvailable', 'message' => 'Invalid source image status.', 'http_code' => 400, 'description' => 'The status of the source image is invalid.'],
+ ['code' => 'InvalidSpecId.Missing', 'message' => 'The SpecId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStorageType.NotFound', 'message' => 'The StorageType is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.ChargeTypeNotSupported', 'message' => 'The charge type is not supported for the given strategy.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Invalid', 'message' => 'The StrategyConfig is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Invalid', 'message' => 'The policy configuration is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.Missing', 'message' => 'The StrategyConfig is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyConfig.NotFound', 'message' => 'The StrategyConfig is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyParam.Invalid', 'message' => 'The StrategyParam is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyType.ValueNotSupported', 'message' => 'The strategy type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidStrategyType.ValueNotSupported', 'message' => 'The policy type is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSubAppType.ValueNotSupported', 'message' => 'The sub-category of the app is not supported.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSystemDiskSize.SmallerThanParent', 'message' => 'Sub-image system disk size is smaller than the parent image.', 'http_code' => 400, 'description' => 'Sub-image system disk size is smaller than the parent image.'],
+ ['code' => 'InvalidTargetAliUid.TargetShareImageAlreadyExist', 'message' => 'Target shared image already exists.', 'http_code' => 400, 'description' => 'The target shared image already exists.'],
+ ['code' => 'InvalidTaskId.NotFound', 'message' => 'The TaskId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidTemplate.NotFound', 'message' => 'Template not found.', 'http_code' => 400, 'description' => 'The template is not found.'],
+ ['code' => 'InvalidUserId.NotFound', 'message' => 'The UserId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'LogOffAllSession.Failed', 'message' => 'Failed to log off all sessions in the delivery group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter', 'message' => 'There is a missing parameter.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter.AppIdAndAppVersion', 'message' => 'The AppId and AppVersion are missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter.RegionId', 'message' => 'The RegionId is missing.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'nvalidStrategyConfig.NotFound', 'message' => 'The policy configuration is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OperationDenied.NoStock', 'message' => 'The operation is denied, because the instance stock is unavailable.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.Canceled', 'message' => 'The task has been cancelled.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.NotFound', 'message' => 'The ota task is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTask.Running', 'message' => 'The task is running and cannot be sumitted.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OtaTaskNotifyRegion.Error', 'message' => 'The unit manager failed to receive the OTA upgrade job.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ParentImage.NotExist', 'message' => 'The parent image does not exist.', 'http_code' => 400, 'description' => 'The parent image does not exist.'],
+ ['code' => 'ParentImageRegionDistribute.NotExist', 'message' => 'The target distribution region of the parent image does not exist.', 'http_code' => 400, 'description' => 'The target distribution region of the parent image does not exist.'],
+ ['code' => 'ProductTypeInvalid', 'message' => 'The ProductType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ProductTypeNotMatch', 'message' => 'The productType and image do not match.', 'http_code' => 400, 'description' => 'The productType and image do not match.'],
+ ['code' => 'QueryTemplate.Failed', 'message' => 'Query template failed.', 'http_code' => 400, 'description' => 'Failed to query the template.'],
+ ['code' => 'RegionUnBind.Fail', 'message' => 'Failed to unbind.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ServiceUnavailable', 'message' => 'Service unavailable. Please try again later.', 'http_code' => 500, 'description' => 'Service unavailable. Please try again later.'],
+ ['code' => 'StockError.InvalidResourceRequest', 'message' => 'Your request cannot be processed currently due to an error. Please try again later.', 'http_code' => 500, 'description' => 'The inventory check failed and the system is temporarily unable to process your request. Please try again later.'],
+ ['code' => 'StockError.NoStock', 'message' => 'The selected specification is out of stock. Please try again later or select other specifications.', 'http_code' => 400, 'description' => 'The selected specification is out of stock. Please try again later or select other specifications.'],
+ ['code' => 'StorageLock.Exist', 'message' => 'The storage lock exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLock.NotFound', 'message' => 'The storage lock is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockProperties.NotMatch', 'message' => 'The storage lock properties do not match.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockUnitResponse.Empty', 'message' => 'The storage lock unit is found empty.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StorageLockUnlockLevel.Error', 'message' => 'An unlock level error occurred while unlocking the storage lock.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Task.ResourceReleased', 'message' => 'Cannot retry because task resource is released.', 'http_code' => 400, 'description' => 'Cannot retry because the resource for builder task is released.'],
+ ['code' => 'TaskType.Invalid', 'message' => 'Invalid task type.', 'http_code' => 400, 'description' => 'Invalid task type.'],
+ ['code' => 'TryBind.AppRegionBindLockFailed', 'message' => 'Failed to lock the app and region bind.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoBindContext', 'message' => 'Failed to bind, because there is no bind context.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoCandidateAppInstanceGroup', 'message' => 'Failed to bind, because there is no candidate app instance group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryBind.NoSupportedApp', 'message' => 'Failed to bind, because there is no supported app for this file extension.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.BindExistingAppInstanceFail', 'message' => 'Failed to bind existing app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.NoCandidateAppInstance', 'message' => 'Failed to bind, because there is no candidate app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.NoIdleAppInstance', 'message' => 'Failed to bind, because there is no idle app instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'TryRegionBind.TicketIsNull', 'message' => 'Failed to bind, because a null ticket is returned.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'UpdateImage.Failed', 'message' => 'Failed to update the image.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'UpdateRegion.NotSupport', 'message' => 'The distributed regions of vhd or container images cannot be modified.', 'http_code' => 400, 'description' => 'The distributed regions of vhd or container images cannot be modified.'],
+ ['code' => 'UserIdentifier.NotFound', 'message' => 'This username does not exist. Please check if it is correct.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionTicket'],
],
],
+ 'ram' => [
+ 'productCode' => 'AppStreaming',
+ 'productName' => 'App Streaming',
+ 'ramCodes' => ['appstreaming', 'ecd'],
+ 'ramLevel' => 'SERVICE',
+ 'ramConditions' => [],
+ 'ramActions' => [],
+ 'resourceTypes' => [],
+ ],
];