summaryrefslogtreecommitdiff
path: root/data/en_us/swas-open/2020-06-01/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/swas-open/2020-06-01/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/swas-open/2020-06-01/api-docs.php')
-rw-r--r--data/en_us/swas-open/2020-06-01/api-docs.php19836
1 files changed, 9129 insertions, 10707 deletions
diff --git a/data/en_us/swas-open/2020-06-01/api-docs.php b/data/en_us/swas-open/2020-06-01/api-docs.php
index 7f7ca50..5181371 100644
--- a/data/en_us/swas-open/2020-06-01/api-docs.php
+++ b/data/en_us/swas-open/2020-06-01/api-docs.php
@@ -1,202 +1,75 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'SWAS-OPEN',
- 'version' => '2020-06-01',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'SWAS-OPEN', 'version' => '2020-06-01'],
'directories' => [
[
- 'id' => 100883,
- 'title' => 'Instances',
+ 'children' => ['UpdateInstanceAttribute', 'ModifyInstanceVncPassword', 'ListInstancePlansModification', 'ListInstancesTrafficPackages', 'DescribeInstancePasswordsSetting', 'InstallCloudMonitorAgent', 'DescribeCloudMonitorAgentStatuses', 'DescribeSecurityAgentStatus', 'UpgradeInstance', 'ResetSystem'],
'type' => 'directory',
- 'children' => [
- 'CreateInstances',
- 'StartInstance',
- 'StartInstances',
- 'ListInstanceStatus',
- 'StopInstance',
- 'StopInstances',
- 'UpdateInstanceAttribute',
- 'ListInstances',
- 'LoginInstance',
- 'DescribeInstanceVncUrl',
- 'ModifyInstanceVncPassword',
- 'ListInstancePlansModification',
- 'ListInstancesTrafficPackages',
- 'DescribeInstancePasswordsSetting',
- 'InstallCloudMonitorAgent',
- 'DescribeCloudMonitorAgentStatuses',
- 'DescribeMonitorData',
- 'DescribeSecurityAgentStatus',
- 'RebootInstance',
- 'RebootInstances',
- 'UpgradeInstance',
- 'RenewInstance',
- 'ResetSystem',
- ],
+ 'title' => 'Instances',
],
[
- 'id' => 183180,
- 'title' => 'Key Pairs',
+ 'children' => ['CreateInstanceKeyPair', 'UploadInstanceKeyPair', 'DescribeInstanceKeyPair', 'ListKeyPairs', 'DeleteInstanceKeyPair'],
'type' => 'directory',
- 'children' => [
- 'CreateInstanceKeyPair',
- 'CreateKeyPair',
- 'UploadInstanceKeyPair',
- 'ImportKeyPair',
- 'DescribeInstanceKeyPair',
- 'ListKeyPairs',
- 'AttachKeyPair',
- 'DetachKeyPair',
- 'DeleteInstanceKeyPair',
- 'DeleteKeyPairs',
- ],
+ 'title' => 'Key pairs',
],
[
- 'id' => 193202,
- 'title' => 'Firewall Template',
+ 'children' => ['CreateFirewallTemplate', 'ApplyFirewallTemplate', 'ModifyFirewallTemplate', 'DescribeFirewallTemplateApplyResults', 'DescribeFirewallTemplateRulesApplyResult', 'DeleteFirewallTemplateRules', 'DeleteFirewallTemplates'],
'type' => 'directory',
- 'children' => [
- 'CreateFirewallTemplate',
- 'DescribeFirewallTemplates',
- 'CreateFirewallTemplateRules',
- 'ApplyFirewallTemplate',
- 'ModifyFirewallTemplate',
- 'DescribeFirewallTemplateApplyResults',
- 'DescribeFirewallTemplateRulesApplyResult',
- 'DeleteFirewallTemplateRules',
- 'DeleteFirewallTemplates',
- ],
+ 'title' => 'Firewall templates',
],
[
- 'id' => 100895,
- 'title' => 'Firewalls',
+ 'children' => ['CreateFirewallRule', 'CreateFirewallRules', 'ListFirewallRules', 'ModifyFirewallRule', 'EnableFirewallRule', 'DisableFirewallRule', 'DeleteFirewallRule'],
'type' => 'directory',
- 'children' => [
- 'DeleteFirewallRules',
- 'CreateFirewallRule',
- 'CreateFirewallRules',
- 'ListFirewallRules',
- 'ModifyFirewallRule',
- 'EnableFirewallRule',
- 'DisableFirewallRule',
- 'DeleteFirewallRule',
- ],
+ 'title' => 'Firewalls',
],
[
- 'id' => 100899,
- 'title' => 'Snapshots',
+ 'children' => ['ListSnapshots', 'UpdateSnapshotAttribute', 'DeleteSnapshots'],
'type' => 'directory',
- 'children' => [
- 'CreateSnapshot',
- 'ListSnapshots',
- 'UpdateSnapshotAttribute',
- 'DeleteSnapshot',
- 'DeleteSnapshots',
- ],
+ 'title' => 'Snapshots',
],
[
- 'id' => 100903,
- 'title' => 'Disks',
+ 'children' => ['UpdateDiskAttribute', 'ListDisks'],
'type' => 'directory',
- 'children' => [
- 'UpdateDiskAttribute',
- 'ListDisks',
- 'ResetDisk',
- ],
+ 'title' => 'Cloud disks',
],
[
- 'id' => 100879,
- 'title' => 'Custom Images',
+ 'children' => ['ListCustomImages', 'ModifyImageShareStatus', 'AddCustomImageShareAccount', 'ListCustomImageShareAccounts', 'DeleteCustomImage', 'DeleteCustomImages'],
'type' => 'directory',
- 'children' => [
- 'CreateCustomImage',
- 'ListCustomImages',
- 'ModifyImageShareStatus',
- 'AddCustomImageShareAccount',
- 'ListCustomImageShareAccounts',
- 'ListCustomImageShareAccounts',
- 'RemoveCustomImageShareAccount',
- 'DeleteCustomImage',
- 'DeleteCustomImages',
- ],
+ 'title' => 'Custom images',
],
[
- 'id' => 182900,
- 'title' => 'Command Assistant',
+ 'children' => ['DescribeCloudAssistantAttributes'],
'type' => 'directory',
- 'children' => [
- 'DescribeCloudAssistantAttributes',
- 'UpdateCommandAttribute',
- 'InvokeCommand',
- 'DescribeCommands',
- 'DescribeCommandInvocations',
- 'DeleteCommand',
- 'CreateCommand',
- 'StartTerminalSession',
- 'InstallCloudAssistant',
- 'DescribeCloudAssistantStatus',
- 'DescribeInvocationResult',
- 'RunCommand',
- 'DescribeInvocations',
- ],
+ 'title' => 'Command assistant',
],
[
- 'id' => 182906,
- 'title' => 'Simple Application Database Service',
+ 'children' => ['ModifyDatabaseInstanceParameter', 'StopDatabaseInstance', 'StartDatabaseInstance', 'ModifyDatabaseInstanceDescription', 'DescribeDatabaseSlowLogRecords', 'DescribeDatabaseErrorLogs', 'DescribeDatabaseInstanceMetricData', 'DescribeDatabaseInstanceParameters', 'DescribeDatabaseInstances', 'AllocatePublicConnection', 'RestartDatabaseInstance', 'ResetDatabaseAccountPassword', 'ReleasePublicConnection'],
'type' => 'directory',
- 'children' => [
- 'ModifyDatabaseInstanceParameter',
- 'StopDatabaseInstance',
- 'StartDatabaseInstance',
- 'ModifyDatabaseInstanceDescription',
- 'DescribeDatabaseSlowLogRecords',
- 'DescribeDatabaseErrorLogs',
- 'DescribeDatabaseInstanceMetricData',
- 'DescribeDatabaseInstanceParameters',
- 'DescribeDatabaseInstances',
- 'AllocatePublicConnection',
- 'RestartDatabaseInstance',
- 'ResetDatabaseAccountPassword',
- 'ReleasePublicConnection',
- ],
+ 'title' => 'Lightweight database service',
],
[
- 'id' => 184258,
- 'title' => 'Tag',
+ 'children' => ['ListPlans'],
'type' => 'directory',
- 'children' => [
- 'TagResources',
- 'ListTagResources',
- 'UntagResources',
- ],
+ 'title' => 'Other resources',
],
[
- 'id' => 100906,
- 'title' => 'Other resources',
- 'type' => 'directory',
'children' => [
- 'ListRegions',
- 'ListImages',
- 'ListPlans',
+ 'AttachKeyPair', 'CreateCommand', 'CreateCustomImage', 'CreateFirewallTemplateRules', 'CreateInstances', 'CreateKeyPair', 'CreateOrder', 'CreateSnapshot', 'DeleteCommand', 'DeleteFirewallRules', 'DeleteKeyPairs', 'DeleteSnapshot', 'DescribeCloudAssistantStatus', 'DescribeCommandInvocations', 'DescribeCommands', 'DescribeFirewallTemplates', 'DescribeInstanceVncUrl', 'DescribeInvocationResult', 'DescribeInvocations', 'DescribeMonitorData',
+ 'DescribePrice', 'DetachKeyPair', 'ImportKeyPair', 'InstallCloudAssistant', 'InvokeCommand', 'ListImages', 'ListInstanceStatus', 'ListInstances', 'ListRegions', 'ListTagResources', 'LoginInstance', 'RebootInstance', 'RebootInstances', 'RemoveCustomImageShareAccount', 'RenewInstance', 'ResetDisk', 'RunCommand', 'StartInstance', 'StartInstances', 'StartTerminalSession',
+ 'StopInstance', 'StopInstances', 'TagResources', 'UntagResources', 'UpdateCommandAttribute',
],
+ 'title' => 'Others',
+ 'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateInstances' => [
- 'summary' => 'Creates subscription simple application servers.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddCustomImageShareAccount' => [
+ 'summary' => 'Shares a custom image with other Alibaba Cloud accounts in the same region to quickly deploy the same environment configurations for multiple simple application servers at a time. This improves deployment efficiency.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -205,409 +78,201 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREswasB80AJY',
- 'FEATUREswasUPXVQ5',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '227269',
+ 'abilityTreeNodes' => ['FEATUREswasJBABCT'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
- ],
- [
- 'name' => 'ImageId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The image ID. You can call the [ListImages](~~189313~~) operation to query the available images in the specified region.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'e2c9c365024a44369c9b955a998a****',
- ],
- ],
- [
- 'name' => 'PlanId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The plan ID. You can call the [ListPlans](~~189314~~) operation to query all plans provided by Simple Application Server in the specified region.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'swas.s1.c1m1s40b3t05',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The subscription period of the servers. Unit: months. Valid values: 1, 3, 6, 12, 24, and 36.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '36',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'AutoRenew',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n"
- ."\n"
- .'Default value: false.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'AutoRenewPeriod',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The auto-renewal period. This parameter is required only when you set `AutoRenew` to true. Unit: month. Valid values: 1, 3, 6, 12, 24, and 36.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '36',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'DataDiskSize',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The size of the data disk that is attached to the server. Unit: GB. Valid values: 0 to 16380. The value must be an integral multiple of 20.'."\n"
- ."\n"
- .'* A value of 0 indicates that no data disk is attached.'."\n"
- .'* If the disk included in the specified plan is a standard SSD, the data disk must be 20 GB or larger in size.'."\n"
- ."\n"
- .'Default value: 0.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '16380',
- 'minimum' => '0',
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
- 'name' => 'Amount',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of simple application servers that you want to create. Valid values: 1 to 20.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The ID of the custom image.', 'type' => 'string', 'required' => true, 'example' => 'm-saacssasc****', 'title' => ''],
],
[
- 'name' => 'ChargeType',
+ 'name' => 'Account',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The billing method of the simple application servers. Set the value to PrePaid, which indicates the subscription billing method.'."\n"
+ 'description' => 'The IDs of the Alibaba Cloud accounts with which you want to share the custom image.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the Alibaba Cloud account with which you want to share the custom image.'."\n"
."\n"
- .'Default value: PrePaid.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PrePaid',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
+ .'> You can share a custom image with a maximum of 10 Alibaba Cloud accounts at a time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '125111425233****', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE',
- ],
- 'InstanceIds' => [
- 'description' => 'The IDs of the simple application servers.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => '3a658ca270df4df39f22e289b338****',
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ExceedAccountQuota',
- 'errorMessage' => 'The accumulated instance amounts including this order have exceeded the quota of the account.',
- ],
- [
- 'errorCode' => 'NotEnoughStock',
- 'errorMessage' => 'The stock is insufficient.',
- ],
- [
- 'errorCode' => 'PlatformNotMatch',
- 'errorMessage' => 'The platform of specified ImageId and PlanId does not match.',
- ],
- [
- 'errorCode' => 'InvalidPeriod.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Period is invalid.',
- ],
- [
- 'errorCode' => 'InvalidDataDiskSize.ValueNotSupported',
- 'errorMessage' => 'The specified parameter DataDiskSize is invalid.',
- ],
- [
- 'errorCode' => 'InvalidAmount.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Amount is invalid.',
- ],
- [
- 'errorCode' => 'InvalidChargeType.ValueNotSupported',
- 'errorMessage' => 'The specified parameter ChargeType is invalid.',
- ],
- [
- 'errorCode' => 'InvalidAutoRenewPeriod.ValueNotSupported',
- 'errorMessage' => 'The specified parameter AutoRenewPeriod is invalid.',
- ],
- [
- 'errorCode' => 'InvalidPlanIdSize.ValueNotSupported',
- 'errorMessage' => 'The system disk size in the specified planId does not support the image.',
- ],
- [
- 'errorCode' => 'InvalidPlanMemorySize.ValueNotSupported',
- 'errorMessage' => 'The memory size in the specified planId does not support the image.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'PaymentFailed',
- 'errorMessage' => 'Payment failed. Please check your account balance.',
- ],
- [
- 'errorCode' => 'InvalidInstance.UnPaidOrder',
- 'errorMessage' => 'The specified Instance has an unpaid order.',
- ],
- [
- 'errorCode' => 'InvalidParam',
- 'errorMessage' => 'The specified parameter value is invalid.',
- ],
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'AddCustomImageShareAccount',
+ 'description' => '- Before you share a custom image, make sure that all sensitive data and files are removed from the image.'."\n"
+ ."\n"
+ .'- The IDs of the Alibaba Cloud accounts with which you want to share the image is obtained. Move the pointer over the profile in the upper-right corner of the Simple Application Server console. In the card that appears, if Main Account is displayed, the showed account ID is the Alibaba Cloud account ID.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidImageId.NotFound',
- 'errorMessage' => 'The specified ImageId does not exist.',
- ],
- [
- 'errorCode' => 'InvalidPlanId.NotFound',
- 'errorMessage' => 'The specified PlanId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
- [
- 'errorCode' => 'NotEnoughUpgradeStock',
- 'errorMessage' => 'The upgrade stock is insufficient.',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:AddCustomImageShareAccount',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E1FEE\\",\\n \\"InstanceIds\\": [\\n \\"3a658ca270df4df39f22e289b338****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateInstancesResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E1FEE</RequestId>\\n <InstanceIds>3a658ca270df4df39f22e289b338****</InstanceIds>\\n</CreateInstancesResponse>","errorExample":""}]',
- 'title' => 'CreateInstances',
- 'description' => '* Before you call this operation, we recommend that you understand the billing rules of Simple Application Server. For more information, see [Billable items](~~58623~~).'."\n"
- ."\n"
- .'> If you have coupons in your Alibaba Cloud account, the coupons are preferentially used to pay for the simple application servers.'."\n"
- ."\n"
- .'* You can create a maximum of 50 simple application servers in a region for an Alibaba Cloud account.'."\n"
- .'* When you call this operation to create simple application servers, make sure that the balance in your account is sufficient to pay for the servers. If the balance in your account is insufficient, the servers cannot be created.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
],
- 'StartInstance' => [
- 'summary' => 'Starts a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AllocatePublicConnection' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '20472',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The region ID of the lightweight database instance. You can call [ListRegions](~~2361076~~) to view supported regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the lightweight database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'A client-generated token to ensure the idempotence of the request. The token must be unique for each request, contain only ASCII characters, and not exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PublicConnection' => ['description' => 'The public connection.', 'type' => 'string', 'example' => 'db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com', 'title' => ''],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus',
- 'errorMessage' => 'The state of the current instance does not support this operation.',
- ],
+ 'title' => 'AllocatePublicConnection',
+ 'summary' => 'Allocates a public connection.',
+ 'description' => 'By default, a lightweight database instance does not have a public connection. To access the database from a lightweight container service or DMS over the internet, you must allocate a public connection.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-22T03:40:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AllocatePublicConnection'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:AllocatePublicConnection',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
- 'title' => 'StartInstance',
- 'description' => 'You can call this operation to start a simple application server that is in the Stopped state.'."\n",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PublicConnection\\": \\"db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com\\"\\n}","type":"json"}]',
],
- 'StartInstances' => [
- 'summary' => 'Starts simple application servers.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ApplyFirewallTemplate' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
+ 'abilityTreeCode' => '219675',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
+ ],
+ [
+ 'name' => 'FirewallTemplateId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the firewall template.', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
],
[
'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).'."\n",
- 'type' => 'string',
+ 'description' => 'The IDs of the simple application servers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the simple application server. A maximum of 10 server IDs are supported.', 'type' => 'string', 'required' => true, 'example' => 'd9e781ff8a8f49ee812796f12799****', 'title' => ''],
'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -616,100 +281,85 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
+ 'TaskId' => ['description' => 'The ID of the execution to apply the template.', 'type' => 'string', 'example' => 'aft-ikgt0bynitvs3****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'title' => 'ApplyFirewallTemplate',
+ 'summary' => 'Uses a firewall template to apply firewall rules to multiple simple application servers at a time. This improves your efficiency of setting firewall rules.',
+ 'description' => 'If the port range, protocol, and source IP address of a firewall rule in a firewall template are the same as the port range, protocol, and source IP address of an existing rule, the new rule overwrites the existing rule regardless of whether the existing rule is enabled or disabled.',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-12T06:36:03.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ApplyFirewallTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\"\\n}","type":"json"}]',
- 'title' => 'StartInstances',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"TaskId\\": \\"aft-ikgt0bynitvs3****\\"\\n}","type":"json"}]',
],
- 'ListInstanceStatus' => [
- 'summary' => 'Queries the status of simple application servers.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AttachKeyPair' => [
+ 'summary' => 'Binds a key pair to simple application servers.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '219076',
+ 'abilityTreeNodes' => ['FEATUREswas9IJLCU'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
+ 'description' => 'The IDs of simple application servers. You can specify a maximum of 50 IDs of simple application servers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the simple application server to which you want to bind the SSH key pair. You can specify a maximum of 50 IDs of simple application servers.', 'type' => 'string', 'required' => false, 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The name of the key pair that you want to bind to the simple application server. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with http\\:// or https\\://.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
@@ -717,188 +367,233 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'InstanceStatuses' => [
- 'description' => 'The ID of the simple application server.'."\n",
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of simple application servers to which the key pair is bound.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'FailCount' => ['description' => 'The total number of simple application servers to which the key pair failed to be bound.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Results' => [
+ 'title' => '',
+ 'description' => 'The request results.',
'type' => 'array',
'items' => [
- 'description' => 'The status information of the instances.'."\n",
+ 'description' => 'The operation results.',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => 'The status of the simple application server. Valid values:'."\n"
- ."\n"
- .'* Pending'."\n"
- .'* Starting'."\n"
- .'* Running'."\n"
- .'* Stopping'."\n"
- .'* Stopped'."\n"
- .'* Resetting'."\n"
- .'* Upgrading'."\n"
- .'* Disabled'."\n",
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'a9a6474b935d41bcb531250bb5d****',
- ],
+ 'Code' => ['description' => 'The HTTP status code.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'success'],
+ 'Success' => ['description' => 'Indicates whether the key pair is bound to the simple application server successfully. Valid values:'."\n"
+ ."\n"
+ .'- true'."\n"
+ ."\n"
+ .'- false', 'type' => 'string', 'title' => '', 'example' => 'true'],
+ 'InstanceId' => ['description' => 'The simple application server ID.', 'type' => 'string', 'title' => '', 'example' => 'aa6e71ddb35c46679bc4753d6219d604'],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- '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',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '54',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified Instance Id does not exist.', 'description' => 'The specified instance ID does not exist.'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceStatuses\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"InstanceId\\": \\"a9a6474b935d41bcb531250bb5d****\\"\\n }\\n ],\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 54\\n}","type":"json"}]',
- 'title' => 'ListInstanceStatus',
- ],
- 'StopInstance' => [
- 'summary' => 'Stops a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'AttachKeyPair',
+ 'description' => 'You can bind only one key pair to a simple application server in the Simple Application Server console. If a simple application server has a key pair bound, the new key pair overwrites the original key pair.',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-28T05:40:57.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:AttachKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"TotalCount\\": 2,\\n \\"FailCount\\": 2,\\n \\"Results\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": \\"true\\",\\n \\"InstanceId\\": \\"aa6e71ddb35c46679bc4753d6219d604\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'CreateCommand' => [
+ 'summary' => 'Creates a Cloud Assistant command.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '20473',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
+ 'abilityTreeCode' => '184909',
+ 'abilityTreeNodes' => ['FEATUREswasWZKIOQ'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '创建类接口，不涉及越权等场景',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The region ID. Call [ListRegions](~~189315~~) to query the available regions.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The name of the command. All character sets are supported. The name can be up to 128 characters long.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testName'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the command. All character sets are supported. The description can be up to 512 characters long.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The language type of the command. Valid values:'."\n"
+ ."\n"
+ .'- RunBatScript: Bat commands for Windows instances.'."\n"
+ ."\n"
+ .'- RunPowerShellScript: PowerShell commands for Windows instances.'."\n"
+ ."\n"
+ .'- RunShellScript: Shell commands for Linux instances.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'RunShellScript'],
+ ],
+ [
+ 'name' => 'CommandContent',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The content of the command. Note the following:'."\n"
+ ."\n"
+ .'- Set `EnableParameter` to \\`true\\` to enable custom parameters in the command content.'."\n"
+ ."\n"
+ .'- Define custom parameters in the \\`{{}}\\` format. Spaces and line feeds before and after parameter names within \\`{{}}\\` are ignored.'."\n"
+ ."\n"
+ .'- You can define up to 20 custom parameters.'."\n"
+ ."\n"
+ .'- Custom parameter names can contain letters, digits, hyphens (-), and underscores (\\_). The names are case-insensitive.'."\n"
+ ."\n"
+ .'- A single custom parameter name cannot exceed 64 bytes in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ifconfig -s'],
+ ],
+ [
+ 'name' => 'WorkingDir',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The directory where the command is run on the ECS instance.'."\n"
+ ."\n"
+ .'Default values:'."\n"
+ ."\n"
+ .'- For Linux instances: The home directory of the \\`root\\` user, which is the `/root` directory.'."\n"
+ ."\n"
+ .'- For Windows instances: The directory where the Cloud Assistant client process is located, such as `C:\\Windows\\System32`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '/root/'],
+ ],
+ [
+ 'name' => 'Timeout',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The timeout period for the command to run on the server instance, in seconds.'."\n"
+ ."\n"
+ .'When a command task times out, Cloud Assistant forcibly stops the task process. The timeout period must be between 10 and 86,400 seconds (24 hours).'."\n"
+ ."\n"
+ .'Default value: 60.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '60'],
+ ],
+ [
+ 'name' => 'EnableParameter',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to use custom parameters in the command.'."\n"
+ ."\n"
+ .'Default value: false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
+ 'description' => 'The tags. You can add up to 20 tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of tag N to add to the command. Valid values of N: 1 to 20.'."\n"
+ ."\n"
+ .'The tag key cannot be an empty string. It can be up to 64 characters in length and cannot start with \\`aliyun\\` or \\`acs:\\`. It cannot contain \\`http\\://\\` or \\`https\\://\\`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'TestKey'],
+ 'Value' => ['description' => 'The value of tag N to add to the command. Valid values of N: 1 to 20.'."\n"
+ ."\n"
+ .'The tag value can be an empty string. It can be up to 64 characters in length and cannot contain \\`http\\://\\` or \\`https\\://\\`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'TestValue'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-aek2bti7cf7****'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4****'],
+ 'CommandId' => ['description' => 'The command ID.', 'type' => 'string', 'title' => '', 'example' => 'c-sh02yh0932w****'],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus',
- 'errorMessage' => 'The state of the current instance does not support this operation.',
- ],
+ 'title' => 'CreateCommand',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-29T02:22:21.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-02-20T03:36:58.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCommand'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateCommand',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","errorExample":""},{"type":"xml","example":"<StopInstanceResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n</StopInstanceResponse>","errorExample":""}]',
- 'title' => 'StopInstance',
- 'description' => 'You can stop a simple application server that you do not use for the time being.'."\n"
- ."\n"
- .'> Stopping a simple application server may interrupt your business. We recommend that you perform this operation during off-peak hours.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\",\\n \\"CommandId\\": \\"c-sh02yh0932w****\\"\\n}","type":"json"}]',
],
- 'StopInstances' => [
- 'summary' => 'Stops simple application servers.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateCustomImage' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -907,101 +602,167 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '65793',
+ 'abilityTreeNodes' => ['FEATUREswas5OS8L3'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the database. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'ForceStop',
+ 'name' => 'ImageName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the custom image. The name must be 2 to 128 characters in length, and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter or a digit. This parameter is empty by default.', 'type' => 'string', 'required' => true, 'example' => 'customImage-test', 'title' => ''],
+ ],
+ [
+ 'name' => 'SystemSnapshotId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the system disk snapshot.', 'type' => 'string', 'required' => false, 'example' => 's-acscasca****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the custom image.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataSnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the data disk snapshot.', 'type' => 'string', 'required' => false, 'example' => 's-acscasca****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'Specifies whether to forcibly stop the servers.'."\n"
- ."\n"
- .'* **true**: forcibly stops the servers.'."\n"
- .'* **false**: normally stops the servers. This is the default value.'."\n",
- 'type' => 'boolean',
+ 'description' => 'The tags that you want to add to the custom image. You can specify up to 20 tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags of the custom image.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of tag N that you want to add to the custom image. Valid values of N: 1 to 20.'."\n"
+ ."\n"
+ .'The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain http\\:// or https\\://. The tag key cannot start with acs: or aliyun.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The value of tag N that you want to add to the custom image. Valid values of N: 1 to 20.'."\n"
+ ."\n"
+ .'The tag value can be an empty string. The tag value can be up to 64 characters in length and cannot contain http\\:// or https\\://.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => 'true',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', 'title' => ''],
+ 'ImageId' => ['description' => 'The custom image ID.', 'type' => 'string', 'example' => 'm-csaascsaccscs****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
+ 400 => [
+ ['errorCode' => 'InvalidParam.DataSnapshotIdNotFound', 'errorMessage' => 'The specified parameter dataSnapshotId is not found.', 'description' => ''],
+ ['errorCode' => 'InvalidParam.SystemSnapshotIdNotFound', 'errorMessage' => 'The specified parameter systemSnapshotId is not found.', 'description' => ''],
+ ['errorCode' => 'InvalidParam.IllegalImageName', 'errorMessage' => 'The specified parameter imageName is illegal.', 'description' => 'The specified image name is invalid.'],
+ ['errorCode' => 'ImageNameAlreadyExist', 'errorMessage' => 'The image name already exists.', 'description' => 'The specified image name already exists.'],
+ ['errorCode' => 'CustomImageQuotaLimit', 'errorMessage' => 'The maximum number of custom image in this region is exceeded.', 'description' => 'The maximum number of custom images within this region has been reached.'],
+ ['errorCode' => 'InvalidParam.SystemSnapshotIdNotSupport', 'errorMessage' => 'You cannot create custom images in the specified parameter system snapshotId.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The state of the current instance does not support this operation.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2DE174B-7196-5778-A00D-6EA2601B****\\"\\n}","type":"json"}]',
- 'title' => 'StopInstances',
- ],
- 'UpdateInstanceAttribute' => [
- 'summary' => 'Modifies the information of a simple application server, including the server name and the password that you use to log on to the server.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'CreateCustomImage',
+ 'summary' => 'Creates a custom image based on a snapshot of a simple application server.',
+ 'description' => 'A custom image is created from a snapshot of a simple application server. You can use a custom image to create multiple simple application servers that have the same configurations. You can also share custom images to ECS and use the shared images to create ECS instances or replace the OSs of existing ECS instances. For more information about custom images, see [Overview of custom images](~~199375~~).'."\n"
+ ."\n"
+ .'You must create a system disk snapshot of a simple application server before you create a custom image based on the snapshot. For more information, see [CreateSnapshot](~~190452~~).'."\n"
+ ."\n"
+ .'> If you need the data on the data disk of a simple application server when you create a custom image, create a snapshot for the data disk first.'."\n"
+ ."\n"
+ .'Before you create a custom image, take note of the following items:'."\n"
+ ."\n"
+ .'- The custom image and the corresponding simple application server must reside in the same region.'."\n"
+ ."\n"
+ .'- The maximum number of custom images that you can create is 3 times the number of simple application servers that you have, but cannot exceed 15.'."\n"
+ ."\n"
+ .'- You can directly create a custom image only based on the system disk snapshot of a simple application server. If you want a custom image to contain the data on the data disk of the simple application server, you must select a data disk snapshot in addition to a system disk snapshot when you create the custom image.'."\n"
+ ."\n"
+ .'- If a simple application server is released due to expiration or refunds, the custom images that are created based on the server are also released.'."\n"
+ ."\n"
+ .'- Resetting the system or changing the image of a simple application server clears the disk data on the server. Back up the data as needed.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-08T02:10:31.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-05-29T02:22:21.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-04-17T05:48:56.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-02-20T03:36:58.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-10-27T07:02:06.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-10-27T07:02:06.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCustomImage'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateCustomImage',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"ImageId\\": \\"m-csaascsaccscs****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateFirewallRule' => [
+ 'summary' => 'Creates a firewall rule for a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1010,71 +771,52 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas28FLWX',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '20456',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'Password',
+ 'name' => 'RuleProtocol',
'in' => 'query',
- 'schema' => [
- 'description' => 'The new password of the simple application server. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported:'."\n"
- ."\n"
- .' ()`~!@#$%^&*-_+=|{}[]:;\'<>,.?/'."\n"
- ."\n"
- .'For Windows instances, the password cannot start with a forward slash (/).'."\n"
- ."\n"
- .'> For security reasons, we recommend that you use HTTPS to send requests if `Password` is specified.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test123!',
- ],
+ 'schema' => ['description' => 'The transport layer protocol. Valid values:'."\n"
+ ."\n"
+ .'- TCP'."\n"
+ ."\n"
+ .'- UDP'."\n"
+ ."\n"
+ .'- TCP+UDP'."\n"
+ ."\n"
+ .'- ICMP', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TCP', 'title' => ''],
],
[
- 'name' => 'InstanceName',
+ 'name' => 'Port',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the simple application server. The name must be 2 to 50 characters in length. It can contain letters, digits, underscores (\\_), and hyphens (-). It must start with a letter or digit. Domain names are supported.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-InstanceName',
- ],
+ 'schema' => ['description' => 'The port range.'."\n"
+ ."\n"
+ .'- When the transport layer protocol is TCP and/or UDP, the port range is 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: 1024/1055, which specifies the port range from 1024 to 1055.'."\n"
+ ."\n"
+ .'- When the transport layer protocol is ICMP, the port range is -1/-1, which indicates all ports.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3306/3306', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The remarks of the firewall rule.', 'type' => 'string', 'required' => false, 'example' => 'TEST', 'title' => ''],
],
],
'responses' => [
@@ -1082,174 +824,119 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'FirewallId' => ['description' => 'The ID of the firewall rule.', 'type' => 'string', 'example' => '8007e18c61024aafbd776d52d0****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidPassword.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Password is invalid.',
- ],
- [
- 'errorCode' => 'InvalidInstanceName.ValueNotSupported',
- 'errorMessage' => 'The specified parameter InstanceName is invalid.',
- ],
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ ['errorCode' => 'InvalidProtocol.ValueNotSupported', 'errorMessage' => 'The specified parameter Protocol is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidPort.ValueNotSupported', 'errorMessage' => 'The specified parameter Port is invalid.', 'description' => ''],
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
],
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
+ 403 => [
+ ['errorCode' => 'FirewallRuleLimitExceed', 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.', 'description' => ''],
+ ['errorCode' => 'FirewallRuleAlreadyExist', 'errorMessage' => 'The specified Rule already exist', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'CreateFirewallRule',
+ 'description' => 'Firewalls serve to control network access to simple application servers and isolate security domains in the cloud. By default, SSH port 22, HTTP port 80, and HTTPS port 443 are enabled for simple application servers. Other ports are disabled. You can add firewall rules to enable more ports.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateFirewallRule'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateFirewallRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateInstanceAttributeResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n</UpdateInstanceAttributeResponse>","errorExample":""}]',
- 'title' => 'UpdateInstanceAttribute',
- 'description' => '## [](#)Usage notes'."\n"
- ."\n"
- .'After you change the password of a simple application server, you must restart the server by calling the [RebootInstance](~~190443~~) operation for the new password to take effect.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"FirewallId\\": \\"8007e18c61024aafbd776d52d0****\\"\\n}","type":"json"}]',
'extraInfo' => ' ',
],
- 'ListInstances' => [
- 'summary' => 'Queries the information about simple application servers in a region.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateFirewallRules' => [
+ 'summary' => 'Creates multiple firewall rules for a simple application server at a time.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '20464',
- 'abilityTreeNodes' => [
- 'FEATUREswas8F6GI9',
- ],
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'InstanceIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).'."\n"
- ."\n"
- .'> If you specify both `InstanceIds` and `PublicIpAddresses`, make sure that the specified IDs and the specified public IP addresses belong to the same simple application servers. Otherwise, an empty result is returned.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
- ],
- [
- 'name' => 'ChargeType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The billing method of the simple application servers. Set the value to PrePaid, which indicates the subscription billing method.'."\n"
- ."\n"
- .'Default value: PrePaid.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PrePaid',
- ],
- ],
- [
- 'name' => 'PublicIpAddresses',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The public IP addresses of the simple application servers. The value can be a JSON array that consists of up to 100 IP addresses. Separate multiple IP addresses with commas (,).'."\n"
- ."\n"
- .'> If you specify both `InstanceIds` and `PublicIpAddresses`, make sure that the specified IDs and the specified public IP addresses belong to the same simple application servers. Otherwise, an empty result is returned.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["42.1.**.**", "42.2.**.**"]',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Maximum value: 100.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The client token.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'Status',
+ 'name' => 'FirewallRules',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The status of the simple application servers. Valid values:'."\n"
- ."\n"
- .'* Pending'."\n"
- .'* Starting'."\n"
- .'* Running'."\n"
- .'* Stopping'."\n"
- .'* Stopped'."\n"
- .'* Resetting'."\n"
- .'* Upgrading'."\n"
- .'* Disabled'."\n",
- 'type' => 'string',
+ 'description' => 'Details about the firewall rules.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Details about the firewall rules.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleProtocol' => ['description' => 'The transport layer protocol. Valid values:'."\n"
+ ."\n"
+ .'- TCP'."\n"
+ ."\n"
+ .'- UDP'."\n"
+ ."\n"
+ .'- TCP+UDP'."\n"
+ ."\n"
+ .'- ICMP', 'type' => 'string', 'required' => false, 'example' => 'TCP', 'title' => ''],
+ 'Port' => ['description' => 'The port number.'."\n"
+ ."\n"
+ .'- When the transport layer protocol is TCP and/or UDP, the port number range is 1 to 65535. Specify a port range in the format of \\<Start port number>/\\<End port number>. Example: 1/200.'."\n"
+ ."\n"
+ .'- When the transport layer protocol is ICMP, the port number range is -1/-1, which indicates all ports.', 'type' => 'string', 'required' => false, 'example' => '3306', 'title' => ''],
+ 'SourceCidrIp' => ['description' => 'The IP address or CIDR block that is allowed in the firewall rule.', 'type' => 'string', 'required' => false, 'example' => '47.101.XX.XX', 'title' => ''],
+ 'Remark' => ['description' => 'The description of the firewall rule.', 'type' => 'string', 'example' => 'Custom firewall rule', 'required' => false, 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => 'Running',
+ 'title' => '',
+ 'example' => '',
],
],
[
@@ -1257,597 +944,165 @@
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The tags that are added to the simple application servers.'."\n",
+ 'description' => 'The tags that you want to add to the firewall. You can specify up to 20 tags.',
'type' => 'array',
'items' => [
- 'description' => 'The tag to add to the resource.',
+ 'description' => 'The tags of the firewall rule.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The tag key of the simple application servers. A tag key can be 1 to 64 characters in length. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'Value' => [
- 'description' => 'The tag value of the simple application servers. A tag value can be 1 to 64 characters in length. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '01',
- ],
+ 'Key' => ['description' => 'The tag key. Valid values of N: 1 to 20.'."\n"
+ ."\n"
+ .'The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain http\\:// or https\\://. The tag key cannot start with acs: or aliyun.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value. Valid values of N: 1 to 20.'."\n"
+ ."\n"
+ .'The tag value can be an empty string. The tag value can be up to 64 characters in length and cannot contain http\\:// or https\\://.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the resource group to which the simple application servers belong.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
- ],
- [
- 'name' => 'InstanceName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the simple application server. Fuzzy search with the asterisk (\\*) wildcard is supported.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'PlanType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The category of the instance plan. Valid values:'."\n"
- ."\n"
- .'* NORMAL: a general-purpose plan.'."\n"
- .'* CAPACITY: a larger-storage plan.'."\n"
- .'* PREVIOUS: a previous generation plan.'."\n"
- .'* MULTI_IP: a multiple-IP plan.'."\n"
- .'* INTERNATIONAL: an international plan.'."\n"
- ."\n"
- .'> For more information, see [Instance families](~~2861773~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NORMAL',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of response.'."\n",
'type' => 'object',
'properties' => [
- 'Instances' => [
- 'description' => 'Details about the queried simple application servers.'."\n",
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'FirewallRuleIds' => [
+ 'description' => 'The IDs of the firewall rules that you created.',
'type' => 'array',
- 'items' => [
- 'description' => 'Details about the simple application server.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => 'The status of the simple application server. Valid values:'."\n"
- ."\n"
- .'* Pending: The server is being prepared.'."\n"
- .'* Starting: The server is being started.'."\n"
- .'* Running: The server is running.'."\n"
- .'* Stopping: The server is being stopped.'."\n"
- .'* Stopped: The server is stopped.'."\n"
- .'* Resetting: The server is being reset.'."\n"
- .'* Upgrading: The server is being upgraded.'."\n"
- .'* Disabled: The server is not available.'."\n",
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'CreationTime' => [
- 'description' => 'The time when the simple application server was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2021-03-08T05:31:06Z',
- ],
- 'InnerIpAddress' => [
- 'description' => 'The private IP address of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => '172.26.XX.XX',
- ],
- 'ChargeType' => [
- 'description' => 'The billing method of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- 'PlanId' => [
- 'description' => 'The ID of the instance plan.'."\n",
- 'type' => 'string',
- 'example' => 'swas.s2.c2m2s50b4t08',
- ],
- 'PublicIpAddress' => [
- 'description' => 'The public IP address.'."\n",
- 'type' => 'string',
- 'example' => '42.1.XX.XX',
- ],
- 'RegionId' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'ExpiredTime' => [
- 'description' => 'The time when the simple application server expires. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2021-05-08T16:00:00Z',
- ],
- 'InstanceName' => [
- 'description' => 'The name of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'test-InstanceName',
- ],
- 'BusinessStatus' => [
- 'description' => 'The status of the server. Valid values:'."\n"
- ."\n"
- .'* Normal: The server is normal.'."\n"
- .'* Expired: The server expires.'."\n"
- .'* Overdue: The payment of the server is overdue.'."\n",
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- 'DdosStatus' => [
- 'description' => 'The DDoS protection status of the server. Valid values:'."\n"
- ."\n"
- .'* Normal: The DDoS protection status of the server is normal.'."\n"
- .'* BlackHole: The server is in blackhole filtering.'."\n"
- .'* Defense: The server is being scrubbed.'."\n",
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- 'ImageId' => [
- 'description' => 'The ID of the image.'."\n",
- 'type' => 'string',
- 'example' => 'fe9c66133a9d4688872869726b52****',
- ],
- 'DisableReason' => [
- 'description' => 'The reason why the server is disabled. Valid values:'."\n"
- ."\n"
- .'* FINANCIAL: The server is locked due to overdue payments.'."\n"
- .'* SECURITY: The server is locked for security reasons.'."\n"
- .'* EXPIRED: The server is expired.'."\n",
- 'type' => 'string',
- 'example' => 'EXPIRED',
- ],
- 'Combination' => [
- 'description' => 'Indicates whether the simple application server uses a bundle plan.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CombinationInstanceId' => [
- 'description' => 'The ID of the simple application server that uses a bundle plan.'."\n",
- 'type' => 'string',
- 'example' => 'com-f6c9a22****45b5b8de68ad608af1ba',
- ],
- 'Uuid' => [
- 'description' => 'The universally unique identifier (UUID) of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => '41f30524-5df7-49c9-9c6e-32****489001',
- ],
- 'ResourceSpec' => [
- 'description' => 'The specifications of the resources on the simple application server.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'DiskCategory' => [
- 'description' => 'The category of the disk. Valid values:'."\n"
- ."\n"
- .'* ESSD: enhanced SSD (ESSD) of PL0'."\n"
- .'* SSD: standard SSD'."\n"
- .'* CLOUD_EFFICIENCY: ultra disk'."\n",
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'Cpu' => [
- 'description' => 'The number of vCPUs of the simple application server.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Bandwidth' => [
- 'description' => 'The bandwidth. Unit: Mbit/s.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'DiskSize' => [
- 'description' => 'The size of the disk. Unit: GiB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '60',
- ],
- 'Memory' => [
- 'description' => 'The size of the memory. Unit: GiB.'."\n",
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '2',
- ],
- 'Flow' => [
- 'description' => 'The amount of the traffic.'."\n"
- ."\n"
- .'* A value of 0 indicates the traffic amount of a bandwidth-based simple application server.'."\n"
- .'* A non-zero value indicates the traffic amount of a data transfer plan-based simple application server.'."\n",
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '818',
- ],
- ],
- ],
- 'Image' => [
- 'description' => 'The description of the image.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'OsType' => [
- 'description' => 'The OS.'."\n",
- 'type' => 'string',
- 'example' => 'windows',
- ],
- 'ImageName' => [
- 'description' => 'The name of the image.'."\n",
- 'type' => 'string',
- 'example' => 'test-custom-1686536882356',
- ],
- 'ImageVersion' => [
- 'description' => 'The image tag.'."\n",
- 'type' => 'string',
- 'example' => 'V3.5',
- ],
- 'ImageType' => [
- 'description' => 'The type of the image. Valid values:'."\n"
- ."\n"
- .'* system'."\n"
- .'* app'."\n"
- .'* custom'."\n",
- 'type' => 'string',
- 'example' => 'system',
- ],
- 'ImageIconUrl' => [
- 'description' => 'The URL of the image icon.'."\n",
- 'type' => 'string',
- 'example' => 'https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg',
- ],
- 'ImageContact' => [
- 'description' => 'The image provider.'."\n",
- 'type' => 'string',
- 'example' => 'https://selfs****e.console.aliyun.com/ticket/createIndex',
- ],
- ],
- ],
- 'Tags' => [
- 'description' => 'The tags that are added to the simple application server.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tags.',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- ],
- ],
- ],
- 'Disks' => [
- 'description' => 'The information about the disks on the simple application server.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about the disk.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'CreationTime' => [
- 'description' => 'The time when the simple application server was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2023-02-24T02:20:10Z',
- ],
- 'Status' => [
- 'description' => 'The status of the disk. Valid values:'."\n"
- ."\n"
- .'* ReIniting: The disk is being initialized.'."\n"
- .'* Creating: The disk is being created.'."\n"
- .'* In_use: The disk is in use.'."\n"
- .'* Available: The disk can be attached.'."\n"
- .'* Attaching: The disk is being attached.'."\n"
- .'* Detaching: The disk is being detached.'."\n",
- 'type' => 'string',
- 'example' => 'In_use',
- ],
- 'Device' => [
- 'description' => 'The device name of the disk after the disk is attached to the simple application server.'."\n",
- 'type' => 'string',
- 'example' => '/dev/xvda',
- ],
- 'Size' => [
- 'description' => 'The size of the disk. Unit: GiB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'DiskName' => [
- 'description' => 'The disk name.'."\n",
- 'type' => 'string',
- 'example' => 'SystemDisk',
- ],
- 'DiskChargeType' => [
- 'description' => 'The billing method of the disk.'."\n",
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'DiskType' => [
- 'description' => 'The type of the disk. Valid values:'."\n"
- ."\n"
- .'* system: system disk.'."\n"
- .'* data: data disk.'."\n",
- 'type' => 'string',
- 'example' => 'system',
- ],
- 'Category' => [
- 'description' => 'The category of the disk. Valid values:'."\n"
- ."\n"
- .'* ESSD: ESSD of PL0'."\n"
- .'* SSD: standard SSD'."\n"
- .'* CLOUD_EFFICIENCY: an ultra disk.'."\n",
- 'type' => 'string',
- 'example' => 'ESSD',
- ],
- 'DiskId' => [
- 'description' => 'The disk ID.'."\n",
- 'type' => 'string',
- 'example' => 'd-bp14wq0149cpp2x****',
- ],
- 'RegionId' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'Remark' => [
- 'description' => 'The remarks of the disk.'."\n",
- 'type' => 'string',
- 'example' => 'remark',
- ],
- 'DiskTags' => [
- 'description' => 'The tags that are added to the disk.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tags of the disk.',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- ],
- ],
- ],
- 'ResourceGroupId' => [
- 'description' => 'The ID of the resource group to which the disk belongs.'."\n",
- 'type' => 'string',
- 'example' => 'rg-aek2bti7cf7****'."\n",
- ],
- ],
- ],
- ],
- 'ResourceGroupId' => [
- 'description' => 'The ID of the resource group to which the server belongs.'."\n",
- 'type' => 'string',
- 'example' => 'rg-aekz7jmhg5s****',
- ],
- 'NetworkAttributes' => [
- 'description' => 'Details of the network.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'Details of the network.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'PublicIpAddress' => [
- 'description' => 'The public IP address.'."\n",
- 'type' => 'string',
- 'example' => '116.62.XX.XX',
- ],
- 'PrivateIpAddress' => [
- 'description' => 'The private IP address.'."\n",
- 'type' => 'string',
- 'example' => '72.25.XX.XX',
- ],
- 'PeakBandwidth' => [
- 'description' => 'The bandwidth. Unit: Mbit/s.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'PublicIpDdosStatus' => [
- 'description' => 'The DDos protection status of the public IP address.'."\n",
- 'type' => 'string',
- 'example' => 'normal',
- ],
- ],
- ],
- ],
- 'PlanType' => [
- 'description' => 'The category of the instance plan. Valid values:'."\n"
- ."\n"
- .'* NORMAL: a general-purpose plan.'."\n"
- .'* CAPACITY: a larger-storage plan.'."\n"
- .'* PREVIOUS: a previous generation plan.'."\n"
- .'* MULTI_IP: a multiple-IP plan.'."\n"
- .'* INTERNATIONAL: an international plan.'."\n"
- ."\n"
- .'> For more information, see [Instance families](~~2861773~~).'."\n",
- 'type' => 'string',
- 'example' => 'NORMAL',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- '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',
+ 'items' => ['description' => 'The ID of the firewall rule that you created.', 'type' => 'string', 'example' => '1a16263ab0f541288312a15fa64280de', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidChargeType.ValueNotSupported',
- 'errorMessage' => 'The specified parameter ChargeType is invalid.',
- ],
- [
- 'errorCode' => 'InvalidPublicIpAddresses.ValueNotSupported',
- 'errorMessage' => 'The specified parameter PublicIpAddresses is invalid.',
- ],
+ ['errorCode' => 'InvalidProtocol.ValueNotSupported', 'errorMessage' => 'The specified parameter Protocol is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidPort.ValueNotSupported', 'errorMessage' => 'The specified parameter Port is invalid.', 'description' => ''],
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
],
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
+ 403 => [
+ ['errorCode' => 'FirewallRuleLimitExceed', 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.', 'description' => ''],
+ ['errorCode' => 'FirewallRuleAlreadyExist', 'errorMessage' => 'The specified Rule already exist', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"CreationTime\\": \\"2021-03-08T05:31:06Z\\",\\n \\"InnerIpAddress\\": \\"172.26.XX.XX\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"InstanceId\\": \\"2ad1ae67295445f598017499dc****\\",\\n \\"PlanId\\": \\"swas.s2.c2m2s50b4t08\\",\\n \\"PublicIpAddress\\": \\"42.1.XX.XX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ExpiredTime\\": \\"2021-05-08T16:00:00Z\\",\\n \\"InstanceName\\": \\"test-InstanceName\\",\\n \\"BusinessStatus\\": \\"Normal\\",\\n \\"DdosStatus\\": \\"Normal\\",\\n \\"ImageId\\": \\"fe9c66133a9d4688872869726b52****\\",\\n \\"DisableReason\\": \\"EXPIRED\\",\\n \\"Combination\\": false,\\n \\"CombinationInstanceId\\": \\"com-f6c9a22****45b5b8de68ad608af1ba\\",\\n \\"Uuid\\": \\"41f30524-5df7-49c9-9c6e-32****489001\\",\\n \\"ResourceSpec\\": {\\n \\"DiskCategory\\": \\"ESSD\\",\\n \\"Cpu\\": 2,\\n \\"Bandwidth\\": 200,\\n \\"DiskSize\\": 60,\\n \\"Memory\\": 2,\\n \\"Flow\\": 818\\n },\\n \\"Image\\": {\\n \\"OsType\\": \\"windows\\",\\n \\"ImageName\\": \\"test-custom-1686536882356\\",\\n \\"ImageVersion\\": \\"V3.5\\",\\n \\"ImageType\\": \\"system\\",\\n \\"ImageIconUrl\\": \\"https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg\\",\\n \\"ImageContact\\": \\"https://selfs****e.console.aliyun.com/ticket/createIndex\\"\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"Disks\\": [\\n {\\n \\"CreationTime\\": \\"2023-02-24T02:20:10Z\\",\\n \\"Status\\": \\"In_use\\",\\n \\"Device\\": \\"/dev/xvda\\",\\n \\"Size\\": 50,\\n \\"DiskName\\": \\"SystemDisk\\",\\n \\"DiskChargeType\\": \\"PrePaid\\",\\n \\"DiskType\\": \\"system\\",\\n \\"Category\\": \\"ESSD\\",\\n \\"DiskId\\": \\"d-bp14wq0149cpp2x****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Remark\\": \\"remark\\",\\n \\"DiskTags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-aek2bti7cf7****\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-aekz7jmhg5s****\\",\\n \\"NetworkAttributes\\": [\\n {\\n \\"PublicIpAddress\\": \\"116.62.XX.XX\\",\\n \\"PrivateIpAddress\\": \\"72.25.XX.XX\\",\\n \\"PeakBandwidth\\": 200,\\n \\"PublicIpDdosStatus\\": \\"normal\\"\\n }\\n ],\\n \\"PlanType\\": \\"NORMAL\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListInstancesResponse>\\n <Instances>\\n <Status>Running</Status>\\n <CreationTime>2021-03-08T05:31:06Z</CreationTime>\\n <InnerIpAddress>172.26.XX.XX</InnerIpAddress>\\n <ChargeType>PrePaid</ChargeType>\\n <InstanceId>2ad1ae67295445f598017499dc****</InstanceId>\\n <PlanId>swas.s2.c2m2s50b4t08</PlanId>\\n <PublicIpAddress>42.1.XX.XX</PublicIpAddress>\\n <RegionId>cn-hangzhou</RegionId>\\n <ExpiredTime>2021-05-08T16:00:00Z</ExpiredTime>\\n <InstanceName>test-InstanceName</InstanceName>\\n <BusinessStatus>Normal</BusinessStatus>\\n <DdosStatus>Normal</DdosStatus>\\n <ImageId>fe9c66133a9d4688872869726b52****</ImageId>\\n </Instances>\\n <TotalCount>1</TotalCount>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n</ListInstancesResponse>","errorExample":""}]',
- 'title' => 'ListInstances',
- 'description' => 'You can call this operation to query the details of simple application servers in a specified region, including the names, public IP addresses, internal IP addresses, creation time, and expiration time of the servers.'."\n",
- ],
- 'LoginInstance' => [
- 'summary' => 'Logs on to a simple application server on Workbench.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"FirewallRuleIds\\": [\\n \\"1a16263ab0f541288312a15fa64280de\\"\\n ]\\n}","type":"json"}]',
+ 'title' => 'CreateFirewallRules',
+ 'description' => 'Firewalls serve to control network access to simple application servers and isolate security domains in the cloud. By default, SSH port 22, HTTP port 80, and HTTPS port 443 are enabled for simple application servers. Other ports are disabled. You can add firewall rules to enable more ports.',
+ 'changeSet' => [
+ ['createdAt' => '2024-02-20T03:36:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateFirewallRules'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateFirewallRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'CreateFirewallTemplate' => [
+ 'summary' => 'Creates a firewall template.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '140734',
- 'abilityTreeNodes' => [
- 'FEATUREswasN19LXQ',
- 'FEATUREswasK6WJ0Q',
- ],
+ 'abilityTreeCode' => '219650',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '不涉及租户隔离越权场景',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '9ae7106e68eb4402b0dcbd48a9de****',
- ],
+ 'schema' => ['description' => 'The ID of the region where the Simple Application Server instance is located.'."\n"
+ .'You can call [ListRegions](~~189315~~) to view a list of supported Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Username',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'The username of the simple application server.'."\n"
- ."\n"
- .'* For a Linux server, you do not need to enter a username.'."\n"
- .'* For a Windows server, the default username `administrator` is used.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'administrator',
- ],
+ 'schema' => ['description' => 'The name of the firewall template.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testName'],
],
[
- 'name' => 'Password',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => 'The password that corresponds to the username.'."\n"
- ."\n"
- .'* For a Linux server, you do not need to enter a password.'."\n"
- .'* For a Windows server, enter the password that you set. If you have not set a password for the simple application server, set a password. For more information, see [Reset the password](~~60055~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test****',
- ],
+ 'schema' => ['description' => 'The description of the firewall template.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'],
],
[
- 'name' => 'Port',
+ 'name' => 'FirewallRule',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The port number that is used to log on to the simple application server by using Workbench.'."\n"
- ."\n"
- .'* Linux servers: The default value is 22.'."\n"
- .'* Windows servers: The default value is 3389.'."\n"
- ."\n"
- .'> If you want to connect to a server by using a custom port, you must modify the default remote connection port. For more information, see [Configure a custom remote connection port](~~2807402~~).'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The firewall rules.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A firewall rule.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleProtocol' => ['description' => 'The transport-layer protocol. Valid values:'."\n"
+ ."\n"
+ .'- TCP: TCP.'."\n"
+ ."\n"
+ .'- UDP: UDP.'."\n"
+ ."\n"
+ .'- TCP+UDP: TCP and UDP.'."\n"
+ ."\n"
+ .'- ICMP: ICMP.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'TCP'],
+ 'Port' => ['description' => 'The port range. The valid range is 1 to 65535. Use a forward slash (/) to separate the start port from the end port. For example, `1024/1055` indicates a port range from 1024 to 1055.'."\n"
+ ."\n"
+ .'> If you set the protocol to ICMP, you must set the port range to -1/-1.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8080'],
+ 'SourceCidrIp' => ['description' => 'The source IPv4 CIDR block to which you want to grant access. Both CIDR notation and IPv4 addresses are supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '223.166.XX.XX'],
+ 'Remark' => ['description' => 'The remarks for the firewall rule.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Custom rule'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '3389',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -1855,38 +1110,42 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of response.'."\n",
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****',
- ],
- 'RedirectUrl' => [
- 'description' => 'The URL that you use to log on to the server.'."\n",
- 'type' => 'string',
- 'example' => 'https://ecs-workbench.aliyun.com/view/instance/single/gbktfz****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'FirewallTemplateId' => ['description' => 'The ID of the firewall template.', 'type' => 'string', 'title' => '', 'example' => 'ft-bcf1a7hrdq717****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2DE174B-7196-5778-A00D-6EA2601B****\\",\\n \\"RedirectUrl\\": \\"https://ecs-workbench.aliyun.com/view/instance/single/gbktfz****\\"\\n}","errorExample":""},{"type":"xml","example":"<LoginInstanceResponse>\\n <RequestId>C2DE174B-7196-5778-A00D-6EA2601B****</RequestId>\\n <RedirectUrl>https://ecs-workbench.aliyun.com/view/instance/single/gbktfz****</RedirectUrl>\\n</LoginInstanceResponse>","errorExample":""}]',
- 'title' => 'LoginInstance',
- 'description' => 'After you create a simple application server, you can log on to the simple application server to build environments and applications on the server.'."\n",
- ],
- 'DescribeInstanceVncUrl' => [
- 'summary' => 'Queries the VNC connection address of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"FirewallTemplateId\\": \\"ft-bcf1a7hrdq717****\\"\\n}","type":"json"}]',
+ 'title' => 'CreateFirewallTemplate',
+ 'description' => 'A firewall template can contain multiple firewall rules. You can use a template to apply a set of firewall rules to one or more instances simultaneously. This helps you set firewall rules more efficiently.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateFirewallTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'CreateFirewallTemplateRules' => [
+ 'summary' => 'Adds firewall rules to a firewall template based on your business requirements.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1895,82 +1154,118 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '219667',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server to which the firewall template is applied. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'FirewallTemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The ID of the firewall template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'FirewallRule',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
+ 'description' => 'The details of the firewall rule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleProtocol' => ['description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
+ ."\n"
+ .'* TCP'."\n"
+ .'* UDP'."\n"
+ .'* TCP+UDP'."\n"
+ .'* ICMP'."\n", 'type' => 'string', 'required' => true, 'example' => 'TCP', 'title' => ''],
+ 'Port' => ['description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
+ ."\n"
+ .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.'."\n", 'type' => 'string', 'required' => true, 'example' => '8080', 'title' => ''],
+ 'SourceCidrIp' => ['description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.'."\n", 'type' => 'string', 'required' => true, 'example' => '222.70.XX.XX', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks of the firewall rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'VncUrl' => [
- 'description' => 'The VNC connection address of the server.'."\n",
- 'type' => 'string',
- 'example' => 'wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3Dwz3L8wEMO6KMt7%252FXInEMtKVubBB%252F7rv055kOm8eUOD%252*****YlmsKjOfz6',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'FirewallTemplateRules' => [
+ 'description' => 'The firewall template rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'FirewallTemplateRuleId' => ['description' => 'The ID of the firewall template rule.'."\n", 'type' => 'string', 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
+ 'RuleProtocol' => ['description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
+ ."\n"
+ .'* TCP'."\n"
+ .'* UDP'."\n"
+ .'* TCP+UDP'."\n"
+ .'* ICMP: the ICMP protocol'."\n", 'type' => 'string', 'example' => 'TCP', 'title' => ''],
+ 'Port' => ['description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
+ ."\n"
+ .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.'."\n", 'type' => 'string', 'example' => '8080', 'title' => ''],
+ 'SourceCidrIp' => ['description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.'."\n", 'type' => 'string', 'example' => '171.233.XX.XX', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks of the firewall rule.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"FirewallTemplateRules\\": [\\n {\\n \\"FirewallTemplateRuleId\\": \\"ft-bcf1a7hrdq717****\\",\\n \\"RuleProtocol\\": \\"TCP\\",\\n \\"Port\\": \\"8080\\",\\n \\"SourceCidrIp\\": \\"171.233.XX.XX\\",\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'CreateFirewallTemplateRules',
+ 'description' => 'Adding firewall rules to a firewall template does not affect the firewall rules that have been applied to simple application servers..'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateFirewallTemplateRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplatId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"VncUrl\\": \\"wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3Dwz3L8wEMO6KMt7%252FXInEMtKVubBB%252F7rv055kOm8eUOD%252*****YlmsKjOfz6\\"\\n}","type":"json"}]',
- 'title' => 'DescribeInstanceVncUrl',
],
- 'ModifyInstanceVncPassword' => [
- 'summary' => 'Changes the VNC password of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateInstanceKeyPair' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1978,56 +1273,27 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas8GRVRI',
- ],
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'VncPassword',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The VNC connection password.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The name of the key pair.', 'type' => 'string', 'required' => true, 'example' => 'ceshi', 'title' => ''],
],
],
'responses' => [
@@ -2035,240 +1301,127 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ', 'title' => ''],
+ 'KeyPairName' => ['description' => 'The name of the key pair.', 'type' => 'string', 'example' => 'ceshi', 'title' => ''],
+ 'Fingerprint' => ['description' => 'The fingerprint of the key pair.', 'type' => 'string', 'example' => 'If2K1ItazA4GlKkWCEhdRj8Wd6czAvK9*****', 'title' => ''],
+ 'PrivateKey' => ['description' => 'The private key.', 'type' => 'string', 'example' => '***', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidPassword.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Password is invalid.',
- ],
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
+ ],
+ 'title' => 'CreateInstanceKeyPair',
+ 'summary' => 'Creates a key pair for a simple application server.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateInstanceKeyPair'],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateInstanceKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
- 'title' => 'ModifyInstanceVncPassword',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\",\\n \\"KeyPairName\\": \\"ceshi\\",\\n \\"Fingerprint\\": \\"If2K1ItazA4GlKkWCEhdRj8Wd6czAvK9*****\\",\\n \\"PrivateKey\\": \\"***\\"\\n}","type":"json"}]',
],
- 'ListInstancePlansModification' => [
- 'summary' => 'Queries the plans to which you can upgrade your simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateInstances' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswasOLUWJH',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREswasB80AJY', 'FEATUREswasUPXVQ5'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The image ID. You can call the [ListImages](~~189313~~) operation to query the available images in the specified region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e2c9c365024a44369c9b955a998a****', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Plans' => [
- 'description' => 'The operating system types supported by the plan.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Core' => [
- 'description' => 'The number of vCPUs.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Bandwidth' => [
- 'description' => 'The peak bandwidth. Unit: Mbit/s.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'DiskSize' => [
- 'description' => 'The disk size of the simple application server. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
- 'Flow' => [
- 'description' => 'The monthly data transfer quota. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'Memory' => [
- 'description' => 'The memory size. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PlanId' => [
- 'description' => 'The ID of the plan.'."\n",
- 'type' => 'string',
- 'example' => 'swas.s2.c2m1s40b3t04',
- ],
- 'DiskType' => [
- 'description' => 'The category of the disk. Valid values:'."\n"
- ."\n"
- .'* SSD: standard SSD'."\n"
- .'* ESSD: enhanced SSD'."\n",
- 'type' => 'string',
- 'example' => 'ESSD',
- ],
- 'OriginPrice' => [
- 'description' => 'The price of the plan.'."\n",
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '60',
- ],
- 'Currency' => [
- 'description' => 'The unit of the plan price. Valid values:'."\n"
- ."\n"
- .'* CNY'."\n"
- .'* USD'."\n",
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'SupportPlatform' => [
- 'description' => 'The operating system types supported by the plan.'."\n",
- 'type' => 'string',
- 'example' => '["Linux","Windows"]',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- ],
- 'description' => '',
- ],
+ [
+ 'name' => 'PlanId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The plan ID. You can call the [ListPlans](~~189314~~) operation to query all plans provided by Simple Application Server in the specified region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'swas.s1.c1m1s40b3t05', 'title' => ''],
],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ [
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The subscription period of the servers. Unit: months. Valid values: 1, 3, 6, 12, 24, and 36.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '36', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n"
+ ."\n"
+ .'- true'."\n"
+ ."\n"
+ .'- false'."\n"
+ ."\n"
+ .'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Plans\\": [\\n {\\n \\"Core\\": 2,\\n \\"Bandwidth\\": 200,\\n \\"DiskSize\\": 40,\\n \\"Flow\\": 400,\\n \\"Memory\\": 1,\\n \\"PlanId\\": \\"swas.s2.c2m1s40b3t04\\",\\n \\"DiskType\\": \\"ESSD\\",\\n \\"OriginPrice\\": 60,\\n \\"Currency\\": \\"CNY\\",\\n \\"SupportPlatform\\": \\"[\\\\\\"Linux\\\\\\",\\\\\\"Windows\\\\\\"]\\"\\n }\\n ],\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","errorExample":""},{"type":"xml","example":"<ListInstancePlansModificationResponse>\\n <Plans>\\n <Core>2</Core>\\n <Bandwidth>3</Bandwidth>\\n <DiskSize>40</DiskSize>\\n <Flow>400</Flow>\\n <Memory>1</Memory>\\n <PlanId>swas.s2.c2m1s40b3t04</PlanId>\\n <DiskType>ESSD</DiskType>\\n <OriginPrice>60</OriginPrice>\\n <Currency>CNY</Currency>\\n <SupportPlatform>[\\"Linux\\",\\"Windows\\"]</SupportPlatform>\\n </Plans>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n</ListInstancePlansModificationResponse>","errorExample":""}]',
- 'title' => 'ListInstancePlansModification',
- 'description' => 'If the plan of your simple application server does not meet your business requirements, you can call the ListInstancePlansModification operation to obtain a list of plans that can be upgraded for your simple application server. Then, you can call the [UpgradeInstance](~~190445~~) operation to upgrade the plan.'."\n"
- ."\n"
- .'> We recommend that you create snapshots for the disks of your simple application server to back up data before you upgrade the plan. For more information, see [CreateSnapshot](~~190452~~).'."\n"
- ."\n"
- .'For the precautions about plan upgrade, see [Upgrade a simple application server](~~61433~~).'."\n",
- ],
- 'ListInstancesTrafficPackages' => [
- 'summary' => 'Queries the details about data transfer plans of simple application servers.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'AutoRenewPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The auto-renewal period. This parameter is required only when you set `AutoRenew` to true. Unit: month. Valid values: 1, 3, 6, 12, 24, and 36.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '36', 'minimum' => '1', 'example' => '3', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'DataDiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The size of the data disk that is attached to the server. Unit: GB. Valid values: 0 to 16380. The value must be an integral multiple of 20.'."\n"
+ ."\n"
+ .'- A value of 0 indicates that no data disk is attached.'."\n"
+ ."\n"
+ .'- If the disk included in the specified plan is a standard SSD, the data disk must be 20 GB or larger in size.'."\n"
+ ."\n"
+ .'Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '16380', 'minimum' => '0', 'example' => '20', 'title' => ''],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'Amount',
'in' => 'query',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc******","2ad1ae67295445f598017499dc******"]',
- ],
+ 'schema' => ['description' => 'The number of simple application servers that you want to create. Valid values: 1 to 20.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChargeType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The billing method of the simple application servers. Set the value to PrePaid, which indicates the subscription billing method.'."\n"
+ ."\n"
+ .'Default value: PrePaid.', 'type' => 'string', 'required' => false, 'example' => 'PrePaid', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
@@ -2276,92 +1429,89 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'InstanceTrafficPackageUsages' => [
- 'description' => 'The data transfers that exceed the quota of the data transfer plan in the current month. Unit: bytes.'."\n",
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE', 'title' => ''],
+ 'InstanceIds' => [
+ 'description' => 'The IDs of the simple application servers.',
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'ccscqwqwqqqw****',
- ],
- 'TrafficUsed' => [
- 'description' => 'The used quota of the data transfer plan in the current month. Unit: Byte.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000',
- ],
- 'TrafficPackageTotal' => [
- 'description' => 'The quota of the data transfer plan in the current month. Unit: Byte.'."\n"
- ."\n"
- .'> TrafficPackageTotal = TrafficUsed + TrafficPackageRemaining'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20000',
- ],
- 'TrafficPackageRemaining' => [
- 'description' => 'The unused quota of the data transfer plan in the current month. Unit: Byte.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000',
- ],
- 'TrafficOverflow' => [
- 'description' => 'The data transfers that exceeds the quota of the data transfer plan in the current month. Unit: Byte.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
+ 'items' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'example' => '3a658ca270df4df39f22e289b338****', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ ['errorCode' => 'ExceedAccountQuota', 'errorMessage' => 'The accumulated instance amounts including this order have exceeded the quota of the account.', 'description' => ''],
+ ['errorCode' => 'NotEnoughStock', 'errorMessage' => 'The stock is insufficient.', 'description' => ''],
+ ['errorCode' => 'PlatformNotMatch', 'errorMessage' => 'The platform of specified ImageId and PlanId does not match.', 'description' => ''],
+ ['errorCode' => 'InvalidPeriod.ValueNotSupported', 'errorMessage' => 'The specified parameter Period is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidDataDiskSize.ValueNotSupported', 'errorMessage' => 'The specified parameter DataDiskSize is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidAmount.ValueNotSupported', 'errorMessage' => 'The specified parameter Amount is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidChargeType.ValueNotSupported', 'errorMessage' => 'The specified parameter ChargeType is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidAutoRenewPeriod.ValueNotSupported', 'errorMessage' => 'The specified parameter AutoRenewPeriod is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidPlanIdSize.ValueNotSupported', 'errorMessage' => 'The system disk size in the specified planId does not support the image.', 'description' => ''],
+ ['errorCode' => 'InvalidPlanMemorySize.ValueNotSupported', 'errorMessage' => 'The memory size in the specified planId does not support the image.', 'description' => ''],
+ ['errorCode' => 'CSS_SYSTEM_ERROR', 'errorMessage' => 'The sales system encountered an error.', 'description' => 'There was an error in the selling system.'],
+ ['errorCode' => 'SWAS_NOT_ENOUGH_ACTIVITY_STOCK', 'errorMessage' => 'The configuration you selected is sold out in the current region. Please try to select another configuration or region.', 'description' => 'The configuration you selected is sold out in the current region. Please try to select another configuration or region.'],
+ ],
+ 403 => [
+ ['errorCode' => 'PaymentFailed', 'errorMessage' => 'Payment failed. Please check your account balance.', 'description' => ''],
+ ['errorCode' => 'InvalidInstance.UnPaidOrder', 'errorMessage' => 'The specified Instance has an unpaid order.', 'description' => ''],
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter value is invalid.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => ''],
+ ['errorCode' => 'InvalidPlanId.NotFound', 'errorMessage' => 'The specified PlanId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ['errorCode' => 'NotEnoughUpgradeStock', 'errorMessage' => 'The upgrade stock is insufficient.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceTrafficPackageUsages\\": [\\n {\\n \\"InstanceId\\": \\"ccscqwqwqqqw****\\",\\n \\"TrafficUsed\\": 10000,\\n \\"TrafficPackageTotal\\": 20000,\\n \\"TrafficPackageRemaining\\": 10000,\\n \\"TrafficOverflow\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","errorExample":""},{"type":"xml","example":"<ListInstancesTrafficPackagesResponse>\\n <InstanceTrafficPackageUsages>\\n <InstanceId>ccscqwqwqqqw****</InstanceId>\\n <TrafficUsed>10000</TrafficUsed>\\n <TrafficPackageTotal>20000</TrafficPackageTotal>\\n <TrafficPackageRemaining>10000</TrafficPackageRemaining>\\n <TrafficOverflow>0</TrafficOverflow>\\n </InstanceTrafficPackageUsages>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n</ListInstancesTrafficPackagesResponse>","errorExample":""}]',
- 'title' => 'ListInstancesTrafficPackages',
- 'description' => 'You can query the details of data transfer plans of simple application servers, including the total quota, used quota, unused quota, and excess data transfers in the current month.'."\n"
+ 'title' => 'CreateInstances',
+ 'summary' => 'Creates subscription simple application servers.',
+ 'description' => '- Before you call this operation, we recommend that you understand the billing rules of Simple Application Server. For more information, see [Billable items](~~58623~~).'."\n"
."\n"
- .'Simple Application Server provides data transfer plans that can be used to offset data transfer fees. You are charged for excess data transfers. Take note of the following items:'."\n"
+ .'> If you have coupons in your Alibaba Cloud account, the coupons are preferentially used to pay for the simple application servers.'."\n"
."\n"
- .'* Only outbound data transfers of simple application servers over the Internet are calculated. Outbound data transfers include the data transfer quota and the excess data transfers beyond the quota. Inbound data transfers of simple application servers over the Internet are not calculated.'."\n"
- .'* Outbound data transfers from simple application servers to other Alibaba Cloud services over the Internet first consume data transfer quotas. If the quotas are exhausted, you are charged for excess data transfers.'."\n"
- .'* You are not charged for data transfers between simple application servers within the same virtual private cloud (VPC).'."\n"
+ .'- You can create a maximum of 50 simple application servers in a region for an Alibaba Cloud account.'."\n"
."\n"
- .'For more information, see [Quotas and billing of data transfers](~~86281~~).'."\n",
- ],
- 'DescribeInstancePasswordsSetting' => [
- 'summary' => 'Checks whether a password is set for a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ .'- When you call this operation to create simple application servers, make sure that the balance in your account is sufficient to pay for the servers. If the balance in your account is insufficient, the servers cannot be created.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-13T03:07:39.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateInstances'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E1FEE\\",\\n \\"InstanceIds\\": [\\n \\"3a658ca270df4df39f22e289b338****\\"\\n ]\\n}","type":"json"}]',
+ ],
+ 'CreateKeyPair' => [
+ 'summary' => 'Creates a Simple Application Server key pair.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2370,44 +1520,31 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas8GRVRI',
- ],
+ 'abilityTreeCode' => '219069',
+ 'abilityTreeNodes' => ['FEATUREswas9IJLCU'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '创建类接口，不涉及越权场景',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~2361076~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the Simple Application Server instance.'."\n"
+ .'Call [ListRegions](~~189315~~) to view the list of supported Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique value from your client for this parameter. The token can contain only ASCII characters and must be no more than 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The name of the key pair. The name must be 2 to 64 characters in length. It must start with a letter or a Chinese character and cannot start with http\\:// or https\\://. The name can contain digits, colons (:), underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => 'KeyPairName', 'title' => ''],
],
],
'responses' => [
@@ -2415,139 +1552,256 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4****',
- ],
- 'VncPasswordSetting' => [
- 'description' => 'Indicates whether a VNC connection password is set for the simple application server.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'InstancePasswordSetting' => [
- 'description' => 'Indicates whether a logon password is set for the simple application server.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
+ 'KeyPairName' => ['description' => 'The name of the key pair. The name must be 2 to 64 characters in length. It must start with a letter or a Chinese character and cannot start with http\\:// or https\\://. The name can contain digits, colons (:), underscores (\\_), and hyphens (-).', 'type' => 'string', 'example' => 'KeyPairName', 'title' => ''],
+ 'PrivateKeyBody' => ['description' => 'The private key of the key pair. The private key is PEM-encoded in the PKCS#8 format.', 'type' => 'string', 'example' => 'MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ 400 => [
+ ['errorCode' => 'KeyPairNameAlreadyExist', 'errorMessage' => 'The keyPair name already exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\",\\n \\"VncPasswordSetting\\": true,\\n \\"InstancePasswordSetting\\": true\\n}","type":"json"}]',
- 'title' => 'DescribeInstancePasswordsSetting',
- ],
- 'InstallCloudMonitorAgent' => [
- 'summary' => 'Installs the CloudMonitor agent for a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateKeyPair',
+ 'description' => 'An Alibaba Cloud Secure Shell (SSH) key pair is a secure and convenient authentication method that uses a public key and a private key for identity verification and encrypted communication over the SSH protocol. SSH key pairs are supported only on Linux instances and provide enhanced security and convenience.'."\n"
+ ."\n"
+ .'- Key pair logon is supported only for Simple Application Server instances that run Linux.'."\n"
+ ."\n"
+ .'- An Alibaba Cloud account can have a maximum of 10 key pairs in a region.'."\n"
+ ."\n"
+ .'- The console supports only the creation of 2048-bit RSA key pairs.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateKeyPair',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"KeyPairName\\": \\"KeyPairName\\",\\n \\"PrivateKeyBody\\": \\"MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateOrder' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswasOLUWJH'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The ID of the region. Call the [ListRegions](~~189315~~) operation to query available regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'OrderType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The type of the order.'."\n"
+ ."\n"
+ .'- Buy'."\n"
+ ."\n"
+ .'Default value: Buy', 'type' => 'string', 'default' => 'Buy', 'required' => false, 'example' => 'Buy', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'Commodity',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'Period' => ['description' => 'The subscription period of the Simple Application Server instance. Valid values: 1 to 20.'."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
+ 'PeriodUnit' => ['description' => 'The unit of the subscription period. Valid values:'."\n"
+ ."\n"
+ .'- Month'."\n"
+ ."\n"
+ .'- Year'."\n"
+ ."\n"
+ .'Default value: Month', 'type' => 'string', 'required' => true, 'example' => 'Month', 'title' => ''],
+ 'PayType' => ['description' => 'The payment type.'."\n"
+ ."\n"
+ .'- Prepaid: The subscription payment type.', 'type' => 'string', 'default' => 'Prepaid', 'required' => false, 'example' => 'Prepaid', 'title' => ''],
+ 'CommodityType' => ['description' => 'The type of resource to purchase.', 'type' => 'string', 'default' => 'Server', 'required' => false, 'example' => 'Server', 'title' => ''],
+ 'PlanId' => ['description' => 'The plan ID. Call the [ListPlans](~~189314~~) operation to query available plans in a region.', 'type' => 'string', 'required' => true, 'example' => 'swas.s.c2m1s30b1.linux', 'title' => ''],
+ 'ImageId' => ['description' => 'The image ID. Call the [ListImages](~~189313~~) operation to query available images in a region.', 'type' => 'string', 'required' => true, 'example' => '3e8eea0c00a04ff0b34a3ad8f1df455a', 'title' => ''],
+ 'Amount' => ['description' => 'The number of Simple Application Server instances to create. Valid values: 1 to 20.'."\n"
+ ."\n"
+ .'Default value: 1', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
+ 'DataDiskSize' => ['description' => 'The data disk capacity in GB. The value must be an integer from 0 to 16,380 and a multiple of 20.'."\n"
+ ."\n"
+ .'Default value: 0', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
+ 'AutoPay' => ['description' => 'Specifies whether to enable automatic payment for the order. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Enables automatic payment.'."\n"
+ ."\n"
+ .'- **false**: Disables automatic payment.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'AutoRenew' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n"
+ ."\n"
+ .'- true: Enables auto-renewal.'."\n"
+ ."\n"
+ .'- false: Disables auto-renewal.'."\n"
+ ."\n"
+ .'Default value: false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'AutoRenewPeriod' => ['description' => 'The auto-renewal period. This parameter is required if you set AutoRenew to true. Valid values:'."\n"
+ ."\n"
+ .'- If `PeriodUnit` is set to `Year`: 1, 2, and 3.'."\n"
+ ."\n"
+ .'- If `PeriodUnit` is set to `Month`: 1, 2, 3, 6, 12, 24, 36, 48, and 60.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '60', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
'required' => true,
- 'example' => '9ae7106e68eb4402b0dcbd48a9de****',
+ 'description' => 'The commodity details.',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Force',
+ 'name' => 'BusinessInfo',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'Specifies whether to forcibly install the CloudMonitor agent. Valid values:'."\n"
- ."\n"
- .'* true (default value): forcibly installs the CloudMonitor agent.'."\n"
- .'* false: does not forcibly install the CloudMonitor agent.'."\n",
- 'type' => 'boolean',
+ 'type' => 'object',
+ 'properties' => [
+ 'UseCoupon' => ['description' => 'Specifies whether to use a coupon. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Use a coupon.'."\n"
+ ."\n"
+ .'- **false**: Do not use a coupon.'."\n"
+ ."\n"
+ .'Default value: **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'OrderSource' => ['description' => 'The source of the order.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''],
+ 'PromotionOptions' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => 'The coupon ID.', 'type' => 'string', 'required' => false, 'example' => '802681580959', 'title' => ''],
+ 'PromotionOptionCode' => ['description' => 'The promotion option code.', 'type' => 'string', 'required' => false, 'example' => 'youhui_quan', 'title' => ''],
+ 'PromotionFilter' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UseCoupon' => ['description' => 'Specifies whether to use a coupon. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Use a coupon.'."\n"
+ ."\n"
+ .'- **false**: Do not use a coupon.'."\n"
+ ."\n"
+ .'Default value: **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'False', 'title' => ''],
+ ],
+ 'description' => 'The promotion conditions.',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ActivityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'The promotion options.',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AliyunLang' => ['description' => 'The language of the response. Default value: zh.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
+ 'lx_channel_cookie_value' => ['description' => '-', 'type' => 'string', 'required' => false, 'example' => 'IaEvKFpwjO1lMRzGWyJdT9KWob7ruIK%2F2zTcdPRkQ%2BIDp5GIJSQT%2FL3qUUcjJ3KQfud3NrMUlEqLaJWWIVwJgw%3D%3D', 'title' => ''],
+ ],
+ 'description' => 'Additional business information.',
'required' => false,
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'FromApp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The source of the request. Valid values:'."\n"
+ ."\n"
+ .'- **OpenApi**: The request is from an API call.'."\n"
+ ."\n"
+ .'- **mongo\\_buy**: The request is from the console.', 'type' => 'string', 'required' => false, 'example' => 'Buy', 'title' => ''],
+ ],
+ [
+ 'name' => 'CouponNo',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The coupon code. The default value is `youhuiquan_promotion_option_id_for_blank`.', 'type' => 'string', 'required' => false, 'example' => '772339720881', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4D10F506-E583-517D-A937-4378BF0C665B'],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '276025619780639', 'title' => ''],
],
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ 400 => [
+ ['errorCode' => 'CSS_SYSTEM_ERROR', 'errorMessage' => 'The sales system encountered an error.', 'description' => 'There was an error in the selling system.'],
+ ['errorCode' => 'SWAS_NOT_ENOUGH_ACTIVITY_STOCK', 'errorMessage' => 'The configuration you selected is sold out in the current region. Please try to select another configuration or region.', 'description' => 'The configuration you selected is sold out in the current region. Please try to select another configuration or region.'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\"\\n}","type":"json"}]',
- 'title' => 'InstallCloudMonitorAgent',
- ],
- 'DescribeCloudMonitorAgentStatuses' => [
- 'summary' => 'Queries the status of the CloudMonitor agent on simple application servers.',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateOrder',
+ 'summary' => 'Get pricing for Simple Application Server.',
+ 'description' => 'An Alibaba Cloud SSH key pair uses the SSH protocol to provide secure login authentication by verifying identity and encrypting communication. Each key pair consists of a public key and a private key and can be used only with Linux instances.'."\n"
+ ."\n"
+ .'- You can use key pairs to log in only to Simple Application Server instances that run Linux.'."\n"
+ ."\n"
+ .'- An Alibaba Cloud account can have a maximum of 10 key pairs in each region.'."\n"
+ ."\n"
+ .'- In the console, you can create only RSA 2048-bit key pairs.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D10F506-E583-517D-A937-4378BF0C665B\\",\\n \\"OrderId\\": \\"276025619780639\\"\\n}","type":"json"}]',
+ ],
+ 'CreateSnapshot' => [
+ 'summary' => 'Creates a snapshot for a disk.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2556,39 +1810,63 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '20458',
+ 'abilityTreeNodes' => ['FEATUREswasHVUGWX'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server to which the disk is attached.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'DiskId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The disk ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp18kjxg9ebrhsgi****', 'title' => ''],
+ ],
+ [
+ 'name' => 'SnapshotName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The snapshot name. The name must be 2 to 50 characters in length. It must start with a letter but cannot start with `http://` or `https://`. The name can only contain letters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-SnapshotName', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
+ 'description' => 'The tags that you want to add to the snapshot. You can specify up to 20 tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags of the snapshot.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of the tag to add to the snapshot. Valid values of N: 1 to 20.'."\n"
+ ."\n"
+ .'The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain http\\:// or https\\://. The tag key cannot start with acs: or aliyun.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The value of the tag to add to the snapshot. Valid values of N: 1 to 20.'."\n"
+ ."\n"
+ .'The tag value can be an empty string. The tag value can be up to 64 characters in length and cannot contain http\\:// or https\\://.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc******","2ad1ae67295445f598017499dc******"]',
- ],
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****', 'title' => ''],
],
],
'responses' => [
@@ -2596,250 +1874,138 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE',
- ],
- 'InstanceStatusList' => [
- 'description' => 'Indicates whether the Cloud Monitor agent was automatically installed on the simple application server.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Indicates whether the Cloud Monitor agent was automatically installed on the simple application server.',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => 'The running status of the Cloud Monitoring plug-in. Possible values are:'."\n"
- ."\n"
- .'- running: Cloud Monitoring plug-in running.'."\n"
- .'- stopped: Cloud Monitoring plug-in stopped.'."\n"
- .'- installing: Cloud Monitoring plug-in installing.'."\n"
- .'- install_faild: Cloud Monitoring plug-in installation failed.'."\n"
- .'- abnormal: Cloud Monitoring plug-in installation abnormal.'."\n"
- .'- not_installed: Cloud Monitoring plug-in not installed.',
- 'type' => 'string',
- 'example' => 'running',
- ],
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'c854dc6f07e74953830bb5808d0****',
- ],
- 'AutoInstall' => [
- 'description' => 'Indicates whether the Cloud Monitor agent was automatically installed on the simple application server. Valid values:'."\n"
- ."\n"
- .'- true'."\n"
- .'- false',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
+ 'SnapshotId' => ['description' => 'The snapshot ID.', 'type' => 'string', 'example' => 's-bp16oazlsold4dks****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRemark.ValueNotSupported', 'errorMessage' => 'The specified parameter Remark is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidRemark.Duplicate', 'errorMessage' => 'The specified Remark already exists.', 'description' => ''],
+ ['errorCode' => 'IncorrectStatus', 'errorMessage' => 'The state of the disk or instance does not currently support snapshot creation.', 'description' => ''],
+ ['errorCode' => 'InvalidSnapshotName.ValueNotSupported', 'errorMessage' => 'The specified SnapshotName is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidSnapshotName.Duplicate', 'errorMessage' => 'The specified SnapshotName already exists.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'SnapshotLimitExceed', 'errorMessage' => 'The maximum number of snapshots in an instance is exceeded.', 'description' => ''],
+ ['errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A snapshot is being created in the specified disk. Please try again later.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidDiskId.NotFound', 'errorMessage' => 'The specified DiskId does not exist.', 'description' => ''],
+ ],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E1FEE\\",\\n \\"InstanceStatusList\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"InstanceId\\": \\"c854dc6f07e74953830bb5808d0****\\",\\n \\"AutoInstall\\": true\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'DescribeCloudMonitorAgentStatuses',
- ],
- 'DescribeMonitorData' => [
- 'summary' => 'Queries the monitoring information about vCPUs, memory, disk IOPS, and traffic of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'CreateSnapshot',
+ 'description' => 'A snapshot is a point-in-time backup of a disk. Snapshots can be used to back up data, recover data after misoperations on servers, recover data after network attacks, and create custom images.'."\n"
+ ."\n"
+ .'> You are not charged for creating snapshots in Simple Application Server.'."\n"
+ ."\n"
+ .'### [](#)Precautions'."\n"
+ ."\n"
+ .'- You can create up to three snapshots for each simple application server.'."\n"
+ ."\n"
+ .'- The maximum number of snapshots that you create per Alibaba Cloud account is triple of the number of simple application servers that are created. The value cannot be greater than 15.'."\n"
+ ."\n"
+ .'- If a simple application server is automatically released due to expiration, the snapshots created for the server are deleted.'."\n"
+ ."\n"
+ .'- If you reset a simple application server after you create a snapshot for the server, the snapshot is retained but cannot be used to restore the disks of the server.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-29T02:22:21.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-02-20T03:36:58.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSnapshot'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateSnapshot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SnapshotId\\": \\"s-bp16oazlsold4dks****\\",\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteCommand' => [
+ 'summary' => 'Deletes a Command Assistant command.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'MetricName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the metric. Valid values:'."\n"
- ."\n"
- .'* MEMORY_ACTUALUSEDSPACE: the memory usage. Unit: bytes.'."\n"
- .'* DISKUSAGE_USED: the disk usage. Unit: bytes.'."\n"
- .'* CPU_UTILIZATION: the CPU usage, in percentage.'."\n"
- .'* VPC_PUBLICIP_INTERNETOUT_RATE: the outbound bandwidth. Unit: bits/s.'."\n"
- .'* VPC_PUBLICIP_INTERNETIN_RATE: the inbound bandwidth. Unit: bits/s.'."\n"
- .'* DISK_READ_IOPS: the read IOPS of the disk. Unit: count/s.'."\n"
- .'* DISK_WRITE_IOPS: the write IOPS of the disk. Unit: count/s.'."\n"
- .'* FLOW_USED: the traffic usage. Unit: bytes.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DISKUSAGE_USED',
- ],
- ],
- [
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The interval at which the monitoring data is queried. Valid values: 60, 300, and 900. Unit: seconds.'."\n"
- ."\n"
- .'> If MetricName is set to FLOW_USED, set Period to 3600 (one hour). In other cases, set Period based on your business requirements.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '60',
- ],
- ],
- [
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query. The following formats are supported:'."\n"
- ."\n"
- .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 January 1, 1970.'."\n"
- .'* Time format: YYYY-MM-DDThh:mm:ssZ.'."\n"
- .'> '."\n"
- .'> - The specified time range includes the end time and excludes the start time. The start time must be earlier than the end time.'."\n"
- .'> - The interval between the start time and the end time is less than or equal to 31 days.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-07T04:04:44Z',
- ],
- ],
- [
- 'name' => 'EndTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. The following formats are supported:'."\n"
- ."\n"
- .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 January 1, 1970.'."\n"
- .'* Time format: YYYY-MM-DDThh:mm:ssZ.'."\n"
- ."\n"
- .'> The interval between the start time and the end time is less than or equal to 31 days.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-08T08:04:44Z',
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***',
- ],
- ],
- [
- 'name' => 'Length',
+ 'name' => 'CommandId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Valid values: 1 to 1440.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['description' => 'The command ID. You can call the [DescribeCommands](~~64843~~) operation to query all available command IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-sh02yh0932w****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'Datapoints' => [
- 'description' => 'The monitoring data.'."\n",
- 'type' => 'string',
- 'example' => '[]',
- ],
- 'Period' => [
- 'description' => 'The interval at which the monitoring data is queried. Valid values: 60, 300, and 900. Unit: seconds.'."\n"
- ."\n"
- .'> If you set the MetricName request parameter to FLOW_USED, the value of Period is 3600 (one hour).'."\n",
- 'type' => 'string',
- 'example' => '60',
- ],
- 'NextToken' => [
- 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n",
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***'."\n",
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteCommand',
+ 'description' => 'You cannot delete commands that are being run.'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCommand'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteCommand',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#CommandId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"Datapoints\\": \\"[]\\",\\n \\"Period\\": \\"60\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***\\\\n\\"\\n}","type":"json"}]',
- 'title' => 'DescribeMonitorData',
],
- 'DescribeSecurityAgentStatus' => [
- 'summary' => 'Queries the status of the Security Center agent on a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteCustomImage' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2847,40 +2013,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the custom image. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The custom image ID.', 'type' => 'string', 'required' => true, 'example' => 'm-2zehv38jjmwva1ee****', 'title' => ''],
],
],
'responses' => [
@@ -2888,46 +2036,58 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'ClientStatus' => [
- 'description' => 'The status of the Security Center agent. Valid values:'."\n"
- ."\n"
- .'* pause: The Security Center agent suspends protection for your server.'."\n"
- .'* online: The Security Center agent is protecting your server.'."\n"
- .'* offline: The Security Center agent does not protect your server.'."\n",
- 'type' => 'string',
- 'example' => 'online',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'CustomImageInShare', 'errorMessage' => 'The custom image is being shared. Please disable sharing first and then delete it.', 'description' => 'The custom image is being shared. To delete this custom image, disable its sharing first.'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => ''],
+ ],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"ClientStatus\\": \\"online\\"\\n}","type":"json"}]',
- 'title' => 'DescribeSecurityAgentStatus',
- ],
- 'RebootInstance' => [
- 'summary' => 'Restarts a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DeleteCustomImage',
+ 'summary' => 'Deletes a custom image.',
+ 'description' => 'You can delete a custom image that you no longer need. After the custom image is deleted, you cannot use the custom image to reset the simple application servers that were created based on the custom image.'."\n"
+ ."\n"
+ .'> To delete a shared image, you must unshare the image before you can delete it. After a custom image is unshared, you cannot query the custom image by using the Elastic Compute Service (ECS) console or API. If you want to use a custom image to create ECS instances, we recommend that you copy the custom image before you delete it. For more information, see [Copy a shared image of a simple application server in the ECS console](~~199378~~).',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCustomImage'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteCustomImage',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteCustomImages' => [
+ 'summary' => 'Deletes custom images. If you no longer require a custom image, you can call this operation to delete the custom image. You can also call this operation to delete multiple custom images at the same time. After a custom image is deleted, you cannot use the custom image to reset the simple application servers that were created based on the custom image.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2936,46 +2096,25 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '20468',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '215038',
+ 'abilityTreeNodes' => ['FEATUREswasCJL3RE'],
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ImageIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the custom image. The value can be a JSON array that consists of up to 15 image IDs. Separate multiple image IDs with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["m-2zehv38jjmwva1ee****", "m-bp1hj0zhmheyq2kz****"]', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [Ensure idempotence](~~25693~~)', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
],
'responses' => [
@@ -2983,51 +2122,51 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus',
- 'errorMessage' => 'The state of the current instance does not support this operation.',
- ],
+ 400 => [
+ ['errorCode' => 'CustomImageInShare', 'errorMessage' => 'The custom image is in sharing,please unshare first then to retry.', 'description' => 'The custom image is being shared, please unshare.'],
],
- [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","errorExample":""},{"type":"xml","example":"<RebootInstanceResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n</RebootInstanceResponse>","errorExample":""}]',
- 'title' => 'RebootInstance',
- 'description' => '* Only simple application servers that are in the Running state can be restarted.'."\n"
- .'* After you restart a simple application server, it enters the Starting state.'."\n",
- ],
- 'RebootInstances' => [
- 'summary' => 'Restarts simple application servers.',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteCustomImages',
+ 'description' => 'If a custom image is shared, you must unshare the image before you can delete it. After a custom image is unshared, you cannot query the custom image by using the Elastic Compute Service (ECS) console or by calling an ECS API operation. If you want to use a custom image to create ECS instances, we recommend that you copy the custom image before you delete it. For more information, see [Copy a custom image](~~199378~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteCustomImages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageIds}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteFirewallRule' => [
+ 'summary' => 'Deletes a firewall rule of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3035,55 +2174,27 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
- 'name' => 'ForceReboot',
+ 'name' => 'RuleId',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to forcibly restart the servers. Valid values:'."\n"
- ."\n"
- .'* true: forcibly restarts the servers. This operation is equivalent to the typical power-off operation. Cache data that is not written to storage devices on the server will be lost.'."\n"
- .'* false: normally restarts the instance.'."\n"
- ."\n"
- .'Default value: false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The ID of the firewall rule.', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****', 'title' => ''],
],
],
'responses' => [
@@ -3091,49 +2202,60 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidProtocol.ValueNotSupported', 'errorMessage' => 'The specified parameter Protocol is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidPort.ValueNotSupported', 'errorMessage' => 'The specified parameter Port is invalid.', 'description' => ''],
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
+ ],
403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus',
- 'errorMessage' => 'The state of the current instance does not support this operation.',
- ],
+ ['errorCode' => 'FirewallRuleLimitExceed', 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.', 'description' => ''],
+ ['errorCode' => 'FirewallRuleAlreadyExist', 'errorMessage' => 'The specified Rule already exist', 'description' => ''],
],
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'DeleteFirewallRule',
+ 'description' => 'After a firewall rule is deleted, your business deployed on the simple application server may become inaccessible. Before you delete a firewall rule, make sure that the firewall rule is no longer needed by the simple application server.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteFirewallRule'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteFirewallRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/{#RuleId}'],
+ ],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
- 'title' => 'RebootInstances',
],
- 'UpgradeInstance' => [
- 'summary' => 'Upgrades the plan for a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteFirewallRules' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3142,55 +2264,37 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREswasOLUWJH',
- ],
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '216901',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PlanId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the new plan. You can call the [ListPlans](~~189314~~) operation to query the plans provided by Simple Application Server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'swas.s2.c2m2s50b4t08',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'RuleIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
+ 'description' => 'The IDs of the firewall rules that you want to delete.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the firewall rule that you want to delete.', 'type' => 'string', 'required' => false, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****', 'title' => ''],
'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -3199,69 +2303,57 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidPlanIdUpgrade.ValueNotSupported',
- 'errorMessage' => 'The specification of the specified planId is lower than the current server specification.',
- ],
+ ['errorCode' => 'InvalidProtocol.ValueNotSupported', 'errorMessage' => 'The specified parameter Protocol is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidPort.ValueNotSupported', 'errorMessage' => 'The specified parameter Port is invalid.', 'description' => ''],
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'PaymentFailed',
- 'errorMessage' => 'Payment failed. Please check your account balance.',
- ],
- [
- 'errorCode' => 'InvalidInstance.UnPaidOrder',
- 'errorMessage' => 'The specified Instance has an unpaid order.',
- ],
+ ['errorCode' => 'FirewallRuleLimitExceed', 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.', 'description' => ''],
+ ['errorCode' => 'FirewallRuleAlreadyExist', 'errorMessage' => 'The specified Rule already exist', 'description' => ''],
],
[
- [
- 'errorCode' => 'InvalidPlanId.NotFound',
- 'errorMessage' => 'The specified PlanId does not exist.',
- ],
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
- [
- 'errorCode' => 'NotEnoughUpgradeStock',
- 'errorMessage' => 'The upgrade stock is insufficient.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpgradeInstanceResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n</UpgradeInstanceResponse>","errorExample":""}]',
- 'title' => 'UpgradeInstance',
- 'description' => '* The plan of a simple application server can only be upgraded. For more information about plans, see [Billable items](~~58623~~).'."\n"
- .'* Before you call this operation, make sure that the balance in your account is sufficient. If the balance in your account is insufficient, the upgrade fails.'."\n",
- ],
- 'RenewInstance' => [
- 'summary' => 'Renews a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DeleteFirewallRules',
+ 'summary' => 'Deletes multiple firewall rules of a simple application server.',
+ 'description' => 'After a firewall rule is deleted, your business deployed on the simple application server may become inaccessible. Before you delete a firewall rule, make sure that the firewall rule is no longer needed by the simple application server.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteFirewallRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteFirewallTemplateRules' => [
+ 'summary' => 'Deletes firewall rules from a firewall template based on your requirements.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3270,58 +2362,38 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREswasOLUWJH',
- ],
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '219670',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'Period',
+ 'name' => 'FirewallTemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The renewal period. Unit: month. Valid values: 1, 3, 6, 12, 24, and 36.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '36',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The ID of the firewall template.', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'FirewallTemplateRuleId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
+ 'description' => 'The IDs of the firewall template rules.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the firewall template rule.', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -3330,51 +2402,41 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidPeriod.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Period is invalid.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'title' => 'DeleteFirewallTemplateRules',
+ 'description' => 'Deletion of firewall rules does not affect the firewall rules that have been applied to simple application servers.',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-12T06:36:03.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteFirewallTemplateRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","errorExample":""},{"type":"xml","example":"<RenewInstanceResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n</RenewInstanceResponse>","errorExample":""}]',
- 'title' => 'RenewInstance',
- 'description' => '* Before you call this operation, we recommend that you understand the billing of Simple Application Server. For more information, see [Billable items](~~58623~~).'."\n"
- .'* Before you call this operation, make sure that the balance in your account is sufficient. If the balance in your account is insufficient, the renewal fails.'."\n",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
],
- 'ResetSystem' => [
- 'summary' => 'Resets a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteFirewallTemplates' => [
+ 'summary' => 'Deletes firewall templates from a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3383,83 +2445,33 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '20471',
- 'abilityTreeNodes' => [
- 'FEATUREswasI9F3VX',
- ],
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '219657',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
- ],
- [
- 'name' => 'ImageId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the destination image. If you do not specify this parameter, the current image is reset.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '794c230fd3e64ea19f83f4d7a0ad****',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [Ensure idempotence](~~25693~~)'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'LoginCredentials',
+ 'name' => 'FirewallTemplateId',
'in' => 'query',
- 'style' => 'flat',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The information about the logon credentials.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Password' => [
- 'description' => 'The password that corresponds to the administrator.'."\n"
- ."\n"
- .'* For Windows servers, the default administrator account is Administrator.'."\n"
- .'* Linux servers, the default administrator account is root.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
- 'KeyPairName' => [
- 'description' => 'The name of the key pair that you want to bind to the simple application server. Only Linux simple application servers support key pairs.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aliyunkey',
- ],
- ],
- 'required' => false,
+ 'description' => 'The IDs of the firewall templates.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the firewall template.', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -3468,90 +2480,41 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidImageId.NotSupport',
- 'errorMessage' => 'The specified ImageId does not support the operation.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- [
- 'errorCode' => 'InvalidImageId.NotFound',
- 'errorMessage' => 'The specified ImageId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'title' => 'DeleteFirewallTemplates',
+ 'description' => 'Deleting a firewall template does not affect the firewall rules that have been applied to simple application servers. You can delete firewall templates that you no longer need.',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-12T06:36:03.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteFirewallTemplates',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetSystemResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n</ResetSystemResponse>","errorExample":""}]',
- 'title' => 'ResetSystem',
- 'description' => 'You can reset a simple application server to re-install its applications or operating system and re-initialize the server. You can reset a simple application server by resetting the current system or changing the image.'."\n"
- ."\n"
- .'* Reset the current system: You can re-install the operating system without changing the image.'."\n"
- .'* Change the image: You can select another Alibaba Cloud image or a custom image to re-install the operating system.'."\n"
- ."\n"
- .'### [](#)Precautions'."\n"
- ."\n"
- .'* Resetting the system or changing the image of a simple application server clears the disk data on the server. Back up the data as needed.'."\n"
- ."\n"
- .'* After you reset a simple application server, monitoring may fail. In this case, you can use one of the following methods to install the CloudMonitor agent on the server:'."\n"
- ."\n"
- .' * Connect to the server: For more information, see [Manually install the CloudMonitor agent for C++ on an ECS instance](~~183482~~).'."\n"
- .' * Use Command Assistant: For more information, see [Use Command Assistant](~~438681~~). You can obtain the command that can be used to install CloudMonitor from the "Common commands" section of the [Use Command Assistant](~~438681~~) topic.'."\n"
- ."\n"
- .'### [](#)Limits'."\n"
- ."\n"
- .'* Snapshots that are created before the reset are retained, but the snapshots cannot be used to restore the disks of the server.'."\n"
- ."\n"
- .'* You cannot reset simple application servers that were created from custom images that contain data of data disks.'."\n"
- ."\n"
- .'* If you reset a simple application server by replacing the existing image with a custom image, the following limits apply:'."\n"
- ."\n"
- .' * The custom image must reside in the same region as the current server.'."\n"
- ."\n"
- .' * The custom image cannot be created based on the current server. If you want to restore the data on the server, you can use a snapshot of the server to restore disk data.'."\n"
- ."\n"
- .' * If your simple application server resides in a region outside the Chinese mainland, you cannot switch the operating system of the server between Windows Server and Linux. You cannot use a Windows Server custom image to reset a Linux simple application server. Similarly, you cannot use a Linux custom image to reset a Windows Server simple application server. You can switch the operating systems of simple application servers only between Windows Server versions or between Linux distributions.'."\n"
- ."\n"
- .' * The following limits apply to the disks attached to the simple application server:'."\n"
- ."\n"
- .' * If the custom image contains a system disk and a data disk but only a system disk is attached to the simple application server, you cannot use the custom image to reset the simple application server.'."\n"
- .' * If the system disk size of the custom image is greater than the system disk size of the simple application server, you cannot directly use the custom image to reset the simple application server.'."\n"
- .' * Only if the system disk size of the simple application server is greater than or equal to the system disk size of the custom image, you can use the custom image to reset the simple application server. To increase the system disk size of your server, you can upgrade the server configuration. For more information, see Upgrade a simple application server.'."\n"
- .' * If the data disk size of the custom image is greater than the data disk size of the simple application server, you cannot use the custom image to reset the simple application server.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\"\\n}","type":"json"}]',
],
- 'CreateInstanceKeyPair' => [
- 'summary' => 'Creates a key pair for a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteInstanceKeyPair' => [
+ 'summary' => 'Deletes the key pair of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3559,50 +2522,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- ],
- [
- 'name' => 'KeyPairName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the key pair.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ceshi',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
],
'responses' => [
@@ -3610,51 +2545,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
- ],
- 'KeyPairName' => [
- 'description' => 'The name of the key pair.'."\n",
- 'type' => 'string',
- 'example' => 'ceshi',
- ],
- 'Fingerprint' => [
- 'description' => 'The fingerprint of the key pair.'."\n",
- 'type' => 'string',
- 'example' => 'If2K1ItazA4GlKkWCEhdRj8Wd6czAvK9*****',
- ],
- 'PrivateKey' => [
- 'description' => 'The private key.'."\n",
- 'type' => 'string',
- 'example' => '***',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\",\\n \\"KeyPairName\\": \\"ceshi\\",\\n \\"Fingerprint\\": \\"If2K1ItazA4GlKkWCEhdRj8Wd6czAvK9*****\\",\\n \\"PrivateKey\\": \\"***\\"\\n}","type":"json"}]',
- 'title' => 'CreateInstanceKeyPair',
- ],
- 'CreateKeyPair' => [
- 'summary' => 'Creates a key pair.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DeleteInstanceKeyPair',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteInstanceKeyPair'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteInstanceKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteKeyPairs' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3663,47 +2591,33 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '219069',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '创建类接口，不涉及越权场景',
- 'tenantRelevance' => 'publicInformation',
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '219072',
+ 'abilityTreeNodes' => ['FEATUREswas9IJLCU'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'KeyPairName',
+ 'name' => 'KeyPairNames',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The name of the key pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (.), underscores (\\_), and hyphens (-). It must start with a letter but cannot start with http:// or https://.'."\n",
- 'type' => 'string',
+ 'description' => 'The names of the SSH key pairs. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with http\\:// or https\\://. You can specify the names of a maximum of 50 SSH key pairs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of the SSH key pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with http\\:// or https\\://. You can specify the names of a maximum of 50 SSH key pairs.', 'type' => 'string', 'required' => false, 'example' => 'testKeyPair', 'title' => ''],
'required' => true,
- 'example' => 'KeyPairName',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -3712,55 +2626,46 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'KeyPairName' => [
- 'description' => 'The name of the key pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (.), underscores (\\_), and hyphens (-). It must start with a letter but cannot start with http:// or https://.'."\n",
- 'type' => 'string',
- 'example' => 'KeyPairName',
- ],
- 'PrivateKeyBody' => [
- 'description' => 'The private key of the key pair. The PEM-encoded private key is in PKCS#8 format.'."\n",
- 'type' => 'string',
- 'example' => 'MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'KeyPairNameAlreadyExist',
- 'errorMessage' => 'The keyPair name already exist.',
- ],
+ ['errorCode' => 'InvalidParameter.KeypairAlreadyAttachedInstance', 'errorMessage' => 'The specified keyPair attached to instances can not be deleted.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"KeyPairName\\": \\"KeyPairName\\",\\n \\"PrivateKeyBody\\": \\"MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****\\"\\n}","type":"json"}]',
- 'title' => 'CreateKeyPair',
- 'description' => 'Alibaba Cloud SSH key pairs offer a secure and efficient logon authentication mechanism, facilitating both verification and encrypted communication within the SSH protocol framework. An SSH key pair is essentially constituted by a public key and a private key. Tailored for Linux-based simple application servers, this security measure enhances security and convenience, effectively addressing your heightened security requirements.'."\n"
- ."\n"
- .'* The key pair logon method is only valid for Linux-based simple application servers.'."\n"
- .'* A maximum of 10 key pairs can be created in a region for an Alibaba Cloud account.'."\n"
- .'* Only RSA 2048-bit key pairs can be created in the Simple Application Server console.'."\n",
- ],
- 'UploadInstanceKeyPair' => [
- 'summary' => 'Imports a key pair for a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteKeyPairs',
+ 'summary' => 'Deletes the SSH key pairs of simple application servers.',
+ 'description' => 'You must unbind SSH key pairs that you no longer use from simple application servers before you delete the SSH key pairs.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteKeyPairs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteSnapshot' => [
+ 'summary' => 'Deletes a snapshot of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3768,60 +2673,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
+ 'schema' => ['description' => 'The region ID of the snapshot.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'KeyPairName',
+ 'name' => 'SnapshotId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the key pair.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_gin',
- ],
+ 'schema' => ['description' => 'The snapshot ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-bp16oazlsold4dks****', 'title' => ''],
],
[
- 'name' => 'PublicKey',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The public key.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID5aQ5bM0Am3mWe+upjSXqisUT4DLR6ExwvA0***** **@**.com',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
],
'responses' => [
@@ -3829,36 +2696,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidSnapshotId.NotFound', 'errorMessage' => 'The specified SnapshotId does not exist.', 'description' => ''],
+ ],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
- 'title' => 'UploadInstanceKeyPair',
- ],
- 'ImportKeyPair' => [
- 'summary' => 'Imports an existing key pair to the Simple Application Server console.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DeleteSnapshot',
+ 'description' => 'You can delete a snapshot if you no longer need it.'."\n"
+ ."\n"
+ .'> If a custom image was created from the snapshot, delete the custom image before you delete the snapshot.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-25T10:53:42.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteSnapshot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteSnapshots' => [
+ 'summary' => 'Deletes snapshots of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3867,58 +2754,26 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219071',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '无越权场景',
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREswasHVUGWX'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
- ],
- [
- 'name' => 'KeyPairName',
+ 'name' => 'SnapshotIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the key pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with http:// or https://.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'KeyPairName',
- ],
+ 'schema' => ['description' => 'The snapshot IDs. The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple snapshot IDs with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"]', 'title' => ''],
],
[
- 'name' => 'PublicKeyBody',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The public key of the key pair.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
],
'responses' => [
@@ -3926,133 +2781,175 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'KeyPairName' => [
- 'description' => 'The name of the key pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with http:// or https://.'."\n",
- 'type' => 'string',
- 'example' => 'KeyPairName',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'KeyPairNameAlreadyExist',
- 'errorMessage' => 'The keyPair name already exist.',
- ],
+ ['errorCode' => 'InvalidSnapshotIds', 'errorMessage' => 'The specified SnapshotIds is not valid.', 'description' => 'The specified snapshot ID is invalid.'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidSnapshotId.NotFound', 'errorMessage' => 'The specified SnapshotId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"KeyPairName\\": \\"KeyPairName\\"\\n}","type":"json"}]',
- 'title' => 'ImportKeyPair',
- 'description' => 'You can call this operation to import an existing key pair to the Simple Application Server console. This way, you can use the key pair to log on to simple application servers. The existing key pair that you want to import must use a supported encryption method. For more information, see [Q2: Which encryption methods must be used by key pairs when I import existing key pairs to the Simple Application Server console?](~~59085~~)'."\n",
- ],
- 'DescribeInstanceKeyPair' => [
- 'summary' => 'Queries information about the key pair of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DeleteSnapshots',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshots'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteSnapshots',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotIds}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2DE174B-7196-5778-A00D-6EA2601B****\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeCloudAssistantAttributes' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'abilityTreeCode' => '214711',
+ 'abilityTreeNodes' => ['FEATUREswasWZKIOQ'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the specified simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Pages start from page 1.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
+ 'description' => 'The IDs of the simple application servers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => false, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]', 'title' => ''],
'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
+ 'maxItems' => 50,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'KeyPairName' => [
- 'description' => 'The name of the key pair.'."\n",
- 'type' => 'string',
- 'example' => 'KeyPairName',
- ],
- 'Fingerprint' => [
- 'description' => 'The fingerprint of the key pair.'."\n",
- 'type' => 'string',
- 'example' => '4f:70:62:e9:0c:72:f7:ee:74:ce:e3:bf:e0:82:**:**',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'CloudAssistant' => [
+ 'description' => 'The Command Assistant information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'example' => '85dbe3e7cc7b49e1a3df4af3bfa4ebbf', 'title' => ''],
+ 'CloudAssistantStatus' => ['description' => 'Indicates whether Command Assistant is running. Valid values:'."\n"
+ ."\n"
+ .'true: Heartbeats are detected in the last 2 minutes.'."\n"
+ ."\n"
+ .'false: Heartbeats are not detected in the last 2 minutes.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'LastInvokedTime' => ['description' => 'The time when commands were last run.', 'type' => 'string', 'example' => '2021-03-15T08:00:00Z'."\n", 'title' => ''],
+ 'CloudAssistantVersion' => ['description' => 'The version number of the Command Assistant agent. Null is returned if the Command Assistant agent is not installed or is not running.', 'type' => 'string', 'example' => '2.2.0.106'."\n", 'title' => ''],
+ 'ActiveTaskCount' => ['description' => 'The number of active tasks in Command Assistant.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'InvocationCount' => ['description' => 'The number of completed tasks in Command Assistant.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''],
+ 'LastHeartbeatTime' => ['description' => 'The time when the last heartbeat of Command Assistant was detected. The value is updated every minute on average. The interval can be 55, 60, or 65 seconds.', 'type' => 'string', 'example' => '2021-03-15T09:00:00Z'."\n", 'title' => ''],
+ 'OSType' => ['description' => 'The OS type of the simple application server. Valid values:'."\n"
+ ."\n"
+ .'- Windows'."\n"
+ ."\n"
+ .'- Linux'."\n"
+ ."\n"
+ .'- FreeBSD', 'type' => 'string', 'example' => 'Linux', 'title' => ''],
+ 'SupportSessionManager' => ['description' => 'Indicates whether Command Assistant supports session management. If Command Assistant does not support session management, the version of the Command Assistant agent is too earlier. We recommend that you update your Command Assistant agent to the latest version.'."\n"
+ ."\n"
+ .'To use the session management feature, you must make sure that the version of your Command Assistant agent meets one of the following requirements:'."\n"
+ ."\n"
+ .'If your simple application server runs Linux, the version of the Command Assistant agent on the server must be 2.2.3.189 or later. If your simple application server runs Windows, the version of the Command Assistant agent on the server must be 2.1.3.189 or later.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'title' => 'DescribeCloudAssistantAttributes',
+ 'summary' => 'Queries the Command Assistant information of simple application servers.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCloudAssistantAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"KeyPairName\\": \\"KeyPairName\\",\\n \\"Fingerprint\\": \\"4f:70:62:e9:0c:72:f7:ee:74:ce:e3:bf:e0:82:**:**\\"\\n}","type":"json"}]',
- 'title' => 'DescribeInstanceKeyPair',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"CloudAssistant\\": [\\n {\\n \\"InstanceId\\": \\"85dbe3e7cc7b49e1a3df4af3bfa4ebbf\\",\\n \\"CloudAssistantStatus\\": \\"true\\",\\n \\"LastInvokedTime\\": \\"2021-03-15T08:00:00Z\\\\n\\",\\n \\"CloudAssistantVersion\\": \\"2.2.0.106\\\\n\\",\\n \\"ActiveTaskCount\\": 0,\\n \\"InvocationCount\\": 4,\\n \\"LastHeartbeatTime\\": \\"2021-03-15T09:00:00Z\\\\n\\",\\n \\"OSType\\": \\"Linux\\",\\n \\"SupportSessionManager\\": true\\n }\\n ],\\n \\"TotalCount\\": 4,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n}","type":"json"}]',
],
- 'ListKeyPairs' => [
- 'summary' => 'Queries the AccessKey pairs that are bound to simple application servers in a specific region.',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeCloudAssistantStatus' => [
+ 'summary' => 'Queries whether the Cloud Assistant client is installed on simple application servers.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4060,150 +2957,115 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '219096',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'KeyPairName',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the AccessKey pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with http:// or https://.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'KeyPairName',
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Pages start from page 1.'."\n"
+ ."\n"
+ .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Page starts from page 1. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'Maximum value: 50.'."\n"
+ ."\n"
+ .'Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The IDs of the simple application servers.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the simple application server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
'required' => false,
- 'example' => '10',
+ 'maxItems' => 50,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- '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',
- ],
- 'KeyPairs' => [
- 'description' => 'Details about the queried AccessKey pairs.'."\n",
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'CloudAssistantStatus' => [
+ 'description' => 'Indicates whether the Cloud Assistant client is installed on the server.'."\n",
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
- 'CreationTime' => [
- 'description' => 'The time when the AccessKey pair was created.'."\n",
- 'type' => 'string',
- 'example' => '2024-05-06T02:28Z',
- ],
- 'KeyPairName' => [
- 'description' => 'The name of the AccessKey pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with http:// or https://.'."\n",
- 'type' => 'string',
- 'example' => 'testKeyPairName',
- ],
- 'PublicKey' => [
- 'description' => 'The content of the public key.'."\n",
- 'type' => 'string',
- 'example' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****',
- ],
- 'InstanceIds' => [
- 'description' => 'The IDs of simple application servers. A maximum of 50 IDs of simple application servers can be returned.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the simple application server. A maximum of 50 IDs of simple application servers can be returned.'."\n",
- 'type' => 'string',
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- ],
+ 'InstanceId' => ['description' => 'The ID of the simple application server.'."\n", 'type' => 'string', 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
+ 'Status' => ['description' => 'Indicates whether the Cloud Assistant client is installed on the server.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'Maximum value: 50.'."\n"
+ ."\n"
+ .'Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Pages start from page 1.'."\n"
+ ."\n"
+ .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"CloudAssistantStatus\\": [\\n {\\n \\"InstanceId\\": \\"ace0706b2ac4454d984295a94213****\\",\\n \\"Status\\": true\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeCloudAssistantStatusResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n <CloudAssistantStatus>\\n <InstanceId>ace0706b2ac4454d984295a94213****</InstanceId>\\n <Status>true</Status>\\n </CloudAssistantStatus>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n</DescribeCloudAssistantStatusResponse>","errorExample":""}]',
+ 'title' => 'DescribeCloudAssistantStatus',
+ 'description' => 'By default, the Cloud Assistant client is installed on simple application servers. If you have manually uninstalled the client, you must reinstall the client. Otherwise, you cannot run commands on the servers.'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2022-06-21T07:24:04.000Z', 'description' => 'OpenAPI offline'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"KeyPairs\\": [\\n {\\n \\"CreationTime\\": \\"2024-05-06T02:28Z\\",\\n \\"KeyPairName\\": \\"testKeyPairName\\",\\n \\"PublicKey\\": \\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****\\",\\n \\"InstanceIds\\": [\\n \\"2ad1ae67295445f598017499dc****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListKeyPairs',
- ],
- 'AttachKeyPair' => [
- 'summary' => 'Binds a key pair to simple application servers.',
- 'methods' => [
- 'post',
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudAssistantStatus'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCloudAssistantStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeCloudMonitorAgentStatuses' => [
+ 'summary' => 'Queries the status of the CloudMonitor agent on simple application servers.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4211,61 +3073,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '219076',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
'name' => 'InstanceIds',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The IDs of simple application servers. You can specify a maximum of 50 IDs of simple application servers.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the simple application server to which you want to bind the SSH key pair. You can specify a maximum of 50 IDs of simple application servers.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'KeyPairName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the key pair that you want to bind to the simple application server. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_gin',
- ],
+ 'schema' => ['description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc******","2ad1ae67295445f598017499dc******"]', 'title' => ''],
],
],
'responses' => [
@@ -4273,557 +3096,673 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of simple application servers to which the key pair is bound.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'FailCount' => [
- 'description' => 'The total number of simple application servers to which the key pair failed to be bound.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Results' => [
- 'title' => '结果列表',
- 'description' => 'The request results.'."\n",
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE', 'title' => ''],
+ 'InstanceStatusList' => [
+ 'description' => 'Indicates whether the Cloud Monitor agent was automatically installed on the simple application server.',
'type' => 'array',
'items' => [
- 'description' => 'The operation results.'."\n",
+ 'description' => 'Indicates whether the Cloud Monitor agent was automatically installed on the simple application server.',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '结果码',
- 'description' => 'The HTTP status code.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '结果信息',
- 'description' => 'The response message.'."\n",
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'title' => '是否成功',
- 'description' => 'Indicates whether the key pair is bound to the simple application server successfully. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'InstanceId' => [
- 'title' => '实例id',
- 'description' => 'The simple application server ID.'."\n",
- 'type' => 'string',
- 'example' => 'aa6e71ddb35c46679bc4753d6219d604',
- ],
+ 'Status' => ['description' => 'The running status of the Cloud Monitoring plug-in. Possible values are:'."\n"
+ ."\n"
+ .'- running: Cloud Monitoring plug-in running.'."\n"
+ ."\n"
+ .'- stopped: Cloud Monitoring plug-in stopped.'."\n"
+ ."\n"
+ .'- installing: Cloud Monitoring plug-in installing.'."\n"
+ ."\n"
+ .'- install\\_faild: Cloud Monitoring plug-in installation failed.'."\n"
+ ."\n"
+ .'- abnormal: Cloud Monitoring plug-in installation abnormal.'."\n"
+ ."\n"
+ .'- not\\_installed: Cloud Monitoring plug-in not installed.', 'type' => 'string', 'example' => 'running', 'title' => ''],
+ 'InstanceId' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'example' => 'c854dc6f07e74953830bb5808d0****', 'title' => ''],
+ 'AutoInstall' => ['description' => 'Indicates whether the Cloud Monitor agent was automatically installed on the simple application server. Valid values:'."\n"
+ ."\n"
+ .'- true'."\n"
+ ."\n"
+ .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified Instance Id does not exist.',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"TotalCount\\": 2,\\n \\"FailCount\\": 2,\\n \\"Results\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": \\"true\\",\\n \\"InstanceId\\": \\"aa6e71ddb35c46679bc4753d6219d604\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'AttachKeyPair',
- 'description' => 'You can bind only one key pair to a simple application server in the Simple Application Server console. If a simple application server has a key pair bound, the new key pair overwrites the original key pair.'."\n",
- ],
- 'DetachKeyPair' => [
- 'summary' => 'Unbinds key pairs from simple application servers.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DescribeCloudMonitorAgentStatuses',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudMonitorAgentStatuses'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCloudMonitorAgentStatuses',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E1FEE\\",\\n \\"InstanceStatusList\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"InstanceId\\": \\"c854dc6f07e74953830bb5808d0****\\",\\n \\"AutoInstall\\": true\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeCommandInvocations' => [
+ 'summary' => 'Queries the executions and execution status of a Cloud Assistant command.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '219077',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'CommandId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers from which you want to unbind SSH key pairs. You can specify a maximum of 50 IDs of simple application servers.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the simple application server from which you want to unbind an SSH key pair. You can specify a maximum of 50 IDs of simple application servers.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The command ID. You can call the [DescribeCommands](~~64843~~) operation to query all available command IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c-sh02yh0932w****', 'title' => ''],
],
[
- 'name' => 'KeyPairName',
+ 'name' => 'InvokeId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the key pair. The name must be globally unique. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'KeyPairName',
- ],
+ 'schema' => ['description' => 'The execution ID of the command.'."\n", 'type' => 'string', 'required' => false, 'example' => 't-hz02p9545t6****', 'title' => ''],
+ ],
+ [
+ 'name' => 'CommandName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The command name. If both CommandName and InstanceId are specified, CommandName does not take effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''],
+ ],
+ [
+ 'name' => 'InvocationStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The overall execution state of the command. The value of this parameter depends on the execution status of the command on all the involved instances. Valid values:'."\n"
+ ."\n"
+ .'* Pending: The command is being verified or sent. When the execution state on at least one instance is Pending, the overall execution state is Pending.'."\n"
+ ."\n"
+ .'* Running: The command is being run on the instances. When the execution state on at least one instance is Running, the overall execution state is Running.'."\n"
+ ."\n"
+ .'* Success: When the execution state on at least one instance is Success and the execution state on other instances is Stopped or Success, the overall execution state is Success.'."\n"
+ ."\n"
+ .' * Command that is set to run immediately: The command execution is complete, and the exit code is 0.'."\n"
+ ."\n"
+ .'* Failed: When the execution state on all instances is Stopped or Failed, the overall execution state is Failed. When the execution state on an instance is one of the following values, Failed is returned as the overall execution state:'."\n"
+ ."\n"
+ .' * Invalid: The command is invalid.'."\n"
+ .' * Aborted: The command fails to be sent.'."\n"
+ .' * Failed: The command execution is complete, and the exit code is not 0.'."\n"
+ .' * Timeout: The command execution times out.'."\n"
+ .' * Error: An error occurs when the command is being run.'."\n"
+ ."\n"
+ .'* Stopping: The command task is being stopped. When the execution state on at least one instance is Stopping, the overall execution state is Stopping.'."\n"
+ ."\n"
+ .'* Stopped: The command task is stopped. When the execution state on all instances is Stopped, the overall execution state is Stopped. When the execution state on an instance is one of the following values, Stopped is returned as the overall execution state:'."\n"
+ ."\n"
+ .' * Cancelled: The command task is canceled.'."\n"
+ .' * Terminated: The command task is terminated.'."\n"
+ ."\n"
+ .'* PartialFailed: The command execution succeeds on some instances and fails on other instances. When the execution state on some instances is Success and the execution state on other instances is Failed or Stopped, the overall execution state is PartialFailed.'."\n"
+ ."\n"
+ .'> The value of the `InvokeStatus` response parameter is similar to the value of InvocationStatus. We recommend that you ignore InvokeStatus and check the value of InvocationStatus.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Success', 'title' => ''],
+ ],
+ [
+ 'name' => 'CommandType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The command type. Valid values:'."\n"
+ ."\n"
+ .'* RunBatScript: batch command, applicable to Windows instances'."\n"
+ .'* RunPowerShellScript: PowerShell command, applicable to Windows instances'."\n"
+ .'* RunShellScript: shell command, applicable to Linux instances'."\n", 'type' => 'string', 'required' => false, 'example' => 'RunPowerShellScript', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Pages start from 1. Default value: 1.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'Maximum value: 50.'."\n"
+ ."\n"
+ .'Default value: 10.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of simple application servers from which the SSH key pair is unbound.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'FailCount' => [
- 'description' => 'The total number of simple application servers from which you fail to unbind key pairs.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Results' => [
- 'title' => '结果列表',
- 'description' => 'The request results.'."\n",
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'TotalCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'CommandInvocations' => [
+ 'description' => 'The command executions.'."\n",
'type' => 'array',
'items' => [
- 'description' => 'The result set of the unbind operation.'."\n",
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '结果码',
- 'description' => 'The HTTP status code.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '结果信息',
- 'description' => 'The response message.'."\n",
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'title' => '是否成功',
- 'description' => 'Indicates whether the key pair is unbound from the simple application server successfully. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'string',
- 'example' => 'True',
- ],
- 'InstanceId' => [
- 'title' => '实例id',
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'aa6e71ddb35c46679bc4753d6219d604',
+ 'InvokeId' => ['description' => 'The execution ID of the command.'."\n", 'type' => 'string', 'example' => 't-hz0373jyzxt****', 'title' => ''],
+ 'CreationTime' => ['description' => 'The time when the command was created.'."\n", 'type' => 'string', 'example' => '2023-04-27T10:11:58', 'title' => ''],
+ 'CommandId' => ['description' => 'The command ID.'."\n", 'type' => 'string', 'example' => 'c-hy0338xh28r****', 'title' => ''],
+ 'InvocationStatus' => ['description' => 'The overall execution state of the command. Valid values:'."\n"
+ ."\n"
+ .'* Pending: The command is being verified or sent.'."\n"
+ .'* Invalid: The specified command type or parameter is invalid.'."\n"
+ .'* Aborted: The command failed to be sent to the instances. To send a command to an instance, make sure that the instance is in the Running state and the command is sent to the instance within 1 minute.'."\n"
+ .'* Running: The command is being run on the instances.'."\n"
+ .'* Success: The command execution is complete, and the exit code is 0.'."\n"
+ .'* Failed: The command execution is complete, and the exit code is not 0.'."\n"
+ .'* Error: The command execution cannot proceed due to an exception.'."\n"
+ .'* Timeout: The command execution timed out.'."\n"
+ .'* Cancelled: The command execution is canceled, and the command is not started.'."\n"
+ .'* Stopping: The command in the Running state is being stopped.'."\n"
+ .'* Terminated: The command is terminated when it is being run.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'CommandName' => ['description' => 'The command name.'."\n", 'type' => 'string', 'example' => 'testCommandName', 'title' => ''],
+ 'CommandType' => ['description' => 'The command type.'."\n", 'type' => 'string', 'example' => 'RunShellScript', 'title' => ''],
+ 'CommandDescription' => ['description' => 'The description of the command.'."\n", 'type' => 'string', 'example' => 'testDescription', 'title' => ''],
+ 'Username' => ['description' => 'The username that is used to run the command.'."\n", 'type' => 'string', 'example' => 'root', 'title' => ''],
+ 'WorkingDir' => ['description' => 'The working directory of the command.'."\n", 'type' => 'string', 'example' => 'c:\\wwwroot', 'title' => ''],
+ 'Timeout' => ['description' => 'The timeout period. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
+ 'CommandContent' => ['description' => 'The content of the command.'."\n", 'type' => 'string', 'example' => 'echo 123', 'title' => ''],
+ 'Parameters' => ['description' => 'The custom parameters in the command. If no custom parameter exists in the command, the default value is {}.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'InvokeInstances' => [
+ 'description' => 'The instances on which the command is run.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => 'The ID of the simple application server.'."\n", 'type' => 'string', 'example' => '2445f4aecdac4b71ba2c7e3a7ccf****', 'title' => ''],
+ 'StartTime' => ['description' => 'The beginning of the time range during which the command is run on the instance.'."\n", 'type' => 'string', 'example' => '2023-05-09T03:32:24Z', 'title' => ''],
+ 'FinishTime' => ['description' => 'The end of the time range during which the command is run on the instance.'."\n", 'type' => 'string', 'example' => '2023-04-03T02:42:29Z', 'title' => ''],
+ 'InvocationStatus' => ['description' => 'The execution state of the command on a single instance. Valid values:'."\n"
+ ."\n"
+ .'* Pending: The command is being verified or sent.'."\n"
+ ."\n"
+ .'* Invalid: The specified command type or parameter is invalid.'."\n"
+ ."\n"
+ .'* Aborted: The command failed to be sent to the instance. To send a command to an instance, make sure that the instance is in the Running state and the command is sent to the instance within 1 minute.'."\n"
+ ."\n"
+ .'* Running: The command is being run on the instance.'."\n"
+ ."\n"
+ .'* Success:'."\n"
+ ."\n"
+ .' * Command that is set to run only once: The command execution is complete, and the exit code is 0.'."\n"
+ .' * Command that is set to run on a schedule: The previous command execution is complete, the exit code is 0, and the specified cycle ends.'."\n"
+ ."\n"
+ .'* Failed:'."\n"
+ ."\n"
+ .' * Command that is set to run only once: The command execution is complete, and the exit code is not 0.'."\n"
+ .' * Command that is set to run on a schedule: The previous command execution is complete, the exit code is not 0, and the specified cycle is about to end.'."\n"
+ ."\n"
+ .'* Error: The command execution cannot proceed due to an exception.'."\n"
+ ."\n"
+ .'* Timeout: The command execution timed out.'."\n"
+ ."\n"
+ .'* Cancelled: The command execution is canceled, and the command is not started.'."\n"
+ ."\n"
+ .'* Stopping: The command task is being stopped.'."\n"
+ ."\n"
+ .'* Terminated: The command is terminated when it is being run.'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'Output' => ['description' => 'The command output.'."\n", 'type' => 'string', 'example' => 'OutputMsg', 'title' => ''],
+ 'ExitCode' => ['description' => 'The exit code of the command.'."\n"
+ ."\n"
+ .'* For Linux instances, the exit code is the exit code of the shell command.'."\n"
+ .'* For Windows instances, the exit code is the exit code of the batch or PowerShell command.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'ErrorInfo' => [
+ 'description' => 'The error message returned if the command failed to be sent or run. Valid values:'."\n"
+ ."\n"
+ .'* null: The command is run as expected.'."\n"
+ .'* the specified instance does not exists: The specified instance does not exist or is released.'."\n"
+ .'* the instance has released when create task: The instance is released when the command is being run.'."\n"
+ .'* the instance is not running when create task: The instance is not in the Running state when the command is being run.'."\n"
+ .'* the command is not applicable: The command is not applicable to the specified instance.'."\n"
+ .'* the specified account does not exists: The specified account does not exist.'."\n"
+ .'* the specified directory does not exists: The specified directory does not exist.'."\n"
+ .'* the cron job expression is invalid: The specified CRON expression for the execution schedule is invalid.'."\n"
+ .'* the aliyun service is not running on the instance: Cloud Assistant Agent is not running.'."\n"
+ .'* the aliyun service in the instance does not response: Cloud Assistant Agent does not respond to your request.'."\n"
+ .'* the aliyun service in the instance is upgrading now: Cloud Assistant Agent is being updated.'."\n"
+ .'* the aliyun service in the instance need upgrade: Cloud Assistant Agent needs to be updated.'."\n"
+ .'* the command delivery has been timeout: The request to send the command timed out.'."\n"
+ .'* the command execution has been timeout: The command execution timed out.'."\n"
+ .'* the command execution got an exception: An exception occurred when the command was being run.'."\n"
+ .'* the command execution has been interrupted: The command execution is interrupted.'."\n"
+ .'* the command execution exit code is not zero: The command execution is complete, and the exit code is not 0.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'the specified instance does not exists',
+ 'title' => '',
+ ],
+ 'ErrorCode' => ['description' => 'The error code returned if the command failed to be sent or run.'."\n"
+ ."\n"
+ .'* null: The command is run as expected.'."\n"
+ .'* InstanceNotExists: The specified instance does not exist or is released.'."\n"
+ .'* InstanceReleased: The instance is released when the command is being run.'."\n"
+ .'* InstanceNotRunning: The instance is not in the Running state when the command is being run.'."\n"
+ .'* CommandNotApplicable: The command is not applicable to the specified instance.'."\n"
+ .'* AccountNotExists: The specified account does not exist.'."\n"
+ .'* DirectoryNotExists: The specified directory does not exist.'."\n"
+ .'* BadCronExpression: The specified CRON expression for the execution schedule is invalid.'."\n"
+ .'* ClientNotRunning: Cloud Assistant Agent is not running.'."\n"
+ .'* ClientNotResponse: Cloud Assistant Agent does not respond to your request.'."\n"
+ .'* ClientIsUpgrading: Cloud Assistant Agent is being updated.'."\n"
+ .'* ClientNeedUpgrade: Cloud Assistant Agent needs to be updated.'."\n"
+ .'* DeliveryTimeout: The request to send the command timed out.'."\n"
+ .'* ExecutionTimeout: The command execution timed out.'."\n"
+ .'* ExecutionException: An exception occurred when the command was being run.'."\n"
+ .'* ExecutionInterrupted: The command execution is interrupted.'."\n"
+ .'* ExitCodeNonzero: The command execution is complete, and the exit code is not 0.'."\n", 'type' => 'string', 'example' => 'InstanceNotExists', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter.KeypairNotAttachedInstance',
- 'errorMessage' => 'The specified keyPair not attached to instances.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified Instance Id does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"CommandInvocations\\": [\\n {\\n \\"InvokeId\\": \\"t-hz0373jyzxt****\\",\\n \\"CreationTime\\": \\"2023-04-27T10:11:58\\",\\n \\"CommandId\\": \\"c-hy0338xh28r****\\",\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"CommandName\\": \\"testCommandName\\",\\n \\"CommandType\\": \\"RunShellScript\\",\\n \\"CommandDescription\\": \\"testDescription\\",\\n \\"Username\\": \\"root\\",\\n \\"WorkingDir\\": \\"c:\\\\\\\\wwwroot\\",\\n \\"Timeout\\": 60,\\n \\"CommandContent\\": \\"echo 123\\",\\n \\"Parameters\\": \\"{}\\",\\n \\"InvokeInstances\\": [\\n {\\n \\"InstanceId\\": \\"2445f4aecdac4b71ba2c7e3a7ccf****\\",\\n \\"StartTime\\": \\"2023-05-09T03:32:24Z\\",\\n \\"FinishTime\\": \\"2023-04-03T02:42:29Z\\",\\n \\"InvocationStatus\\": \\"Running\\",\\n \\"Output\\": \\"OutputMsg\\",\\n \\"ExitCode\\": 0,\\n \\"ErrorInfo\\": \\"the specified instance does not exists\\",\\n \\"ErrorCode\\": \\"InstanceNotExists\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeCommandInvocations',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCommandInvocations',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"TotalCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"Results\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": \\"true\\",\\n \\"InstanceId\\": \\"aa6e71ddb35c46679bc4753d6219d604\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'DetachKeyPair',
- 'description' => 'If you want to change the SSH key pairs that are bound to your simple application servers or your end user no longer needs to access a specific simple application server, you can unbind the SSH key pairs from simple application servers to improve the security of the simple application servers or restrict access to the specific simple application server.'."\n",
],
- 'DeleteInstanceKeyPair' => [
- 'summary' => 'Deletes the key pair of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeCommands' => [
+ 'summary' => 'Queries the commands that you created or the common commands that Alibaba Cloud provides.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '184928',
+ 'abilityTreeNodes' => ['FEATUREswasWZKIOQ'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'CommandId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The command ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c-sh02yh0932w****', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The command name. Fuzzy match is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- ],
- 'description' => '',
- ],
- ],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteInstanceKeyPair',
- ],
- 'DeleteKeyPairs' => [
- 'summary' => 'Deletes the SSH key pairs of simple application servers.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'Provider',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The provider of the common command. Take note of the following items:'."\n"
+ ."\n"
+ .'* If you set this parameter to `AlibabaCloud`, all the common commands provided by Alibaba Cloud are queried.'."\n"
+ .'* If you set this parameter to `User`, all the custom commands created by you are queried.'."\n", 'type' => 'string', 'required' => true, 'example' => 'AlibabaCloud', 'title' => ''],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '219072',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The language type of the command. Valid values:'."\n"
+ ."\n"
+ .'* RunBatScript: batch command, applicable to Windows instances'."\n"
+ .'* RunPowerShellScript: PowerShell command, applicable to Windows instances'."\n"
+ .'* RunShellScript: shell command, applicable to Linux instances'."\n", 'type' => 'string', 'required' => false, 'example' => 'RunShellScript', 'title' => ''],
],
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Pages start from 1.'."\n"
+ ."\n"
+ .'Default value: 1.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'Maximum value: 50.'."\n"
+ ."\n"
+ .'Default value: 10.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'KeyPairNames',
+ 'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The names of the SSH key pairs. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with http:// or https://. You can specify the names of a maximum of 50 SSH key pairs.'."\n",
+ 'description' => 'The tags that are bound to the command.'."\n",
'type' => 'array',
'items' => [
- 'description' => 'The name of the SSH key pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with http:// or https://. You can specify the names of a maximum of 50 SSH key pairs.'."\n",
- 'type' => 'string',
+ 'description' => 'The tags of the command.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key of the command. A tag key can be 1 to 64 characters in length. Valid values of N: 1 to 20.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value of the command. A tag value can be up to 64 characters in length. Valid values of N: 1 to 20.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
+ ],
'required' => false,
- 'example' => 'testKeyPair',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => true,
+ 'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'TotalCount' => ['description' => 'The total number of commands.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Commands' => [
+ 'description' => 'The queried commands.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The commands.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CommandId' => ['description' => 'The command ID.'."\n", 'type' => 'string', 'example' => 'c-gov1k1tqwi9****', 'title' => ''],
+ 'Tags' => [
+ 'description' => 'The tags that are bound to the command.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags of the command.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key of the command.'."\n", 'type' => 'string', 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value of the command.'."\n", 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CreationTime' => ['description' => 'The time when the command was created.'."\n", 'type' => 'string', 'example' => '2023-01-05T06:38:53Z', 'title' => ''],
+ 'Name' => ['description' => 'The name of the command.'."\n", 'type' => 'string', 'example' => 'testName', 'title' => ''],
+ 'Provider' => ['description' => 'The provider of the command.'."\n", 'type' => 'string', 'example' => 'User', 'title' => ''],
+ 'Type' => ['description' => 'The type of the command.'."\n", 'type' => 'string', 'example' => 'RunShellScript', 'title' => ''],
+ 'Timeout' => ['description' => 'The timeout period of the command.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
+ 'Description' => ['description' => 'The description of the command.'."\n", 'type' => 'string', 'example' => 'testDescription', 'title' => ''],
+ 'WorkingDir' => ['description' => 'The execution path of the command.'."\n", 'type' => 'string', 'example' => '/home', 'title' => ''],
+ 'CommandContent' => ['description' => 'The content of the command.'."\n", 'type' => 'string', 'example' => 'cat /etc/ssh/sshd_config', 'title' => ''],
+ 'EnableParameter' => ['description' => 'Indicates whether the custom parameter feature is enabled for the command.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'ParameterNames' => [
+ 'description' => 'The custom parameter names that are parsed from the command content specified when the command was created. The custom parameter names are returned in the list format. If the custom parameter feature is disabled, an empty list is returned.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The custom parameter name.'."\n", 'type' => 'string', 'example' => 'parameter1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ParameterDefinitions' => [
+ 'description' => 'Details of the custom parameter.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The custom parameter.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Required' => ['description' => 'Indicates whether the custom parameter is required. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n"
+ ."\n"
+ .'Default value: false.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'Description' => ['description' => 'The description of the custom parameter.'."\n", 'type' => 'string', 'example' => '命令助手Agent安装包路径', 'title' => ''],
+ 'DefaultValue' => ['description' => 'The default value of the custom parameter.'."\n", 'type' => 'string', 'example' => 'https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm', 'title' => ''],
+ 'ParameterName' => ['description' => 'The name of the custom parameter.'."\n", 'type' => 'string', 'example' => 'DownloadUrl', 'title' => ''],
+ 'PossibleValues' => [
+ 'description' => 'The valid values of the custom parameter.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'A valid value of the custom parameter.'."\n", 'type' => 'string', 'example' => 'Linux', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ResourceGroupId' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-aek2bti7cf7****', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter.KeypairAlreadyAttachedInstance',
- 'errorMessage' => 'The specified keyPair attached to instances can not be deleted.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Commands\\": [\\n {\\n \\"CommandId\\": \\"c-gov1k1tqwi9****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"CreationTime\\": \\"2023-01-05T06:38:53Z\\",\\n \\"Name\\": \\"testName\\",\\n \\"Provider\\": \\"User\\",\\n \\"Type\\": \\"RunShellScript\\",\\n \\"Timeout\\": 60,\\n \\"Description\\": \\"testDescription\\",\\n \\"WorkingDir\\": \\"/home\\",\\n \\"CommandContent\\": \\"cat /etc/ssh/sshd_config\\",\\n \\"EnableParameter\\": false,\\n \\"ParameterNames\\": [\\n \\"parameter1\\"\\n ],\\n \\"ParameterDefinitions\\": [\\n {\\n \\"Required\\": false,\\n \\"Description\\": \\"命令助手Agent安装包路径\\",\\n \\"DefaultValue\\": \\"https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm\\",\\n \\"ParameterName\\": \\"DownloadUrl\\",\\n \\"PossibleValues\\": [\\n \\"Linux\\"\\n ]\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-aek2bti7cf7****\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeCommands',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-29T02:22:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-02-20T03:36:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCommands',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/*'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/{#CommandId}'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteKeyPairs',
- 'description' => 'You must unbind SSH key pairs that you no longer use from simple application servers before you delete the SSH key pairs.'."\n",
],
- 'CreateFirewallTemplate' => [
- 'summary' => 'Creates a firewall template.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeDatabaseErrorLogs' => [
+ 'summary' => 'Queries the error logs of a lightweight database instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219650',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'abilityTreeNodes' => ['FEATUREswas8F6GI9'],
'autoTest' => false,
- 'notSupportAutoTestReason' => '不涉及租户隔离越权场景',
+ 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server to which the firewall template belongs. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region where the lightweight database instance resides.'."\n"
+ ."\n"
+ .'You can call the [ListRegions](~~189315~~) operation to query the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => 'The ID of the lightweight database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The description of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'FirewallRule',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The details of the firewall rule.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RuleProtocol' => [
- 'description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
- ."\n"
- .'* TCP'."\n"
- .'* UDP'."\n"
- .'* TCP+UDP'."\n"
- .'* ICMP'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
- ."\n"
- .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '223.166.XX.XX',
- ],
- 'Remark' => [
- 'description' => 'The remarks of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The number of error logs to return per page.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '30', 'default' => '30', 'required' => false, 'example' => '30', 'title' => ''],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The start of the time range to query. The time must be in UTC and formatted as `yyyy-MM-ddTHH:mmZ` according to the [ISO 8601](~~25696~~) standard.'."\n"
+ ."\n"
+ .'> The time displayed in the console is 8 hours ahead of the specified UTC time.', 'type' => 'string', 'required' => true, 'example' => '2022-09-07T04:04Z', 'title' => ''],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end of the time range to query. The time must be in UTC and formatted as `yyyy-MM-ddTHH:mmZ` according to the [ISO 8601](~~25696~~) standard. This value must be later than the start time.'."\n"
+ ."\n"
+ .'> The time displayed in the console is 8 hours ahead of the specified UTC time.', 'type' => 'string', 'required' => true, 'example' => '2022-09-08T04:04Z', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Schema of response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'FirewallTemplateId' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'example' => 'ft-bcf1a7hrdq717****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of matching error logs.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'ErrorLogs' => [
+ 'description' => 'An array of error logs.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Details of an error log.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorInfo' => ['description' => 'The error information.', 'type' => 'string', 'example' => 'spid52 DBCC TRACEON 3499, server process ID (SPID) 52. This is an informational message only; no user action is required', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the error log was generated. The time is in UTC and formatted as `yyyy-MM-ddTHH:mm:ssZ` according to the [ISO 8601](~~25696~~) standard.'."\n"
+ ."\n"
+ .'> The time displayed in the console is 8 hours ahead of the specified UTC time.', 'type' => 'string', 'example' => '2022-09-08T12:11:04Z', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"FirewallTemplateId\\": \\"ft-bcf1a7hrdq717****\\"\\n}","type":"json"}]',
- 'title' => 'CreateFirewallTemplate',
- 'description' => 'Simple Application Server supports the firewall template feature that provides multiple firewall rules. You can use a template to add a group of firewall rules to one or more simple application servers at a time. This improves the efficiency of setting firewall rules.'."\n",
- ],
- 'DescribeFirewallTemplates' => [
- 'summary' => 'Queries details about firewall templates.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DescribeDatabaseErrorLogs',
+ 'description' => 'Use this operation to query the error logs of a lightweight database instance to identify and troubleshoot issues.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-15T09:30:16.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabaseErrorLogs'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeDatabaseErrorLogs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 20,\\n \\"ErrorLogs\\": [\\n {\\n \\"ErrorInfo\\": \\"spid52 DBCC TRACEON 3499, server process ID (SPID) 52. This is an informational message only; no user action is required\\",\\n \\"CreateTime\\": \\"2022-09-08T12:11:04Z\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeDatabaseInstanceMetricData' => [
+ 'summary' => 'Retrieves monitoring metrics for a lightweight database instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4832,615 +3771,567 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '219665',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswas8F6GI9'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the lightweight database instance. You can call the [ListRegions](~~189315~~) operation to get the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'FirewallTemplateId',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The IDs of the firewall templates.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The ID of the lightweight database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'MetricName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => 'The name of the metric. Valid values:'."\n"
+ ."\n"
+ .'- `MySQL_MemCpuUsage`: The CPU utilization and memory usage of the instance, as a percentage of the total resources of the operating system.'."\n"
+ ."\n"
+ .'- `MySQL_DetailedSpaceUsage`: The total, data, log, temporary, and system disk space usage of the instance.'."\n"
+ ."\n"
+ .'- `MySQL_Sessions`: The number of active and total connections.'."\n"
+ ."\n"
+ .'- `MySQL_IOPS`: The IOPS of the instance.', 'type' => 'string', 'required' => true, 'example' => 'MySQL_MemCpuUsage', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from page 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The start of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n"
+ ."\n"
+ .'> The time in the console is displayed in UTC+8.', 'type' => 'string', 'required' => true, 'example' => '2022-09-06T04:04Z', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Default value: 20.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The end of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n"
+ ."\n"
+ .'> The time in the console is displayed in UTC+8.', 'type' => 'string', 'required' => true, 'example' => '2022-09-07T04:04Z', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from page 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page. Default value: 20.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'FirewallTemplates' => [
- 'description' => 'The information about the queried firewall templates.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'FirewallTemplateId' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- 'CreationTime' => [
- 'description' => 'The time when the firewall template was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2024-04-10T02:10:14Z',
- ],
- 'Name' => [
- 'description' => 'The name of the firewall template.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => 'The description of the firewall template.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'CreateTime' => [
- 'description' => 'The time when the firewall template was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n"
- ."\n"
- .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n",
- 'type' => 'string',
- 'example' => '2024-04-29T02:01:38Z',
- ],
- 'FirewallTemplateRules' => [
- 'description' => 'The details of the firewall template rules.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'FirewallTemplateRuleId' => [
- 'description' => 'The ID of the firewall template rule.'."\n",
- 'type' => 'string',
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
- 'RuleProtocol' => [
- 'description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
- ."\n"
- .'* TCP'."\n"
- .'* UDP'."\n"
- .'* TCP+UDP'."\n"
- .'* ICMP'."\n",
- 'type' => 'string',
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
- ."\n"
- .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.'."\n",
- 'type' => 'string',
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.'."\n",
- 'type' => 'string',
- 'example' => '119.145.XX.XX',
- ],
- 'Remark' => [
- 'description' => 'The remarks of the firewall template rule.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'MetricName' => ['description' => 'The name of the metric. Valid values:'."\n"
+ ."\n"
+ .'- `MySQL_MemCpuUsage`: The CPU utilization and memory usage of the instance, as a percentage of the total resources of the operating system.'."\n"
+ ."\n"
+ .'- `MySQL_DetailedSpaceUsage`: The total, data, log, temporary, and system disk space usage of the instance.'."\n"
+ ."\n"
+ .'- `MySQL_Sessions`: The number of active and total connections.'."\n"
+ ."\n"
+ .'- `MySQL_IOPS`: The IOPS of the instance.', 'type' => 'string', 'example' => 'MySQL_MemCpuUsage', 'title' => ''],
+ 'Unit' => ['description' => 'The unit of the metric data.'."\n"
+ ."\n"
+ .'- %'."\n"
+ ."\n"
+ .'- int'."\n"
+ ."\n"
+ .'- MB', 'type' => 'string', 'example' => '%', 'title' => ''],
+ 'DataFormat' => ['description' => 'The format of the metric data. Valid values:'."\n"
+ ."\n"
+ .'- `cpuusage&memusage`'."\n"
+ ."\n"
+ .'- `active_session&total_session`'."\n"
+ ."\n"
+ .'- `ins_size&data_size&log_size&tmp_size&other_size`'."\n"
+ ."\n"
+ .'- `io`', 'type' => 'string', 'example' => 'cpuusage&memusage', 'title' => ''],
+ 'MetricData' => ['description' => 'The metric data details.', 'type' => 'string', 'example' => '[ { \\"date"\\: " 2022-09-06T04:04:00Z",\\"value\\":\\"0.77&3.69\\" } ]', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"FirewallTemplates\\": [\\n {\\n \\"FirewallTemplateId\\": \\"ft-bcf1a7hrdq717****\\",\\n \\"CreationTime\\": \\"2024-04-10T02:10:14Z\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": \\"2024-04-29T02:01:38Z\\",\\n \\"FirewallTemplateRules\\": [\\n {\\n \\"FirewallTemplateRuleId\\": \\"eeea34d9867b4d55a4ff8d5fcfbd****\\",\\n \\"RuleProtocol\\": \\"TCP\\",\\n \\"Port\\": \\"8080\\",\\n \\"SourceCidrIp\\": \\"119.145.XX.XX\\",\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'DescribeFirewallTemplates',
- ],
- 'CreateFirewallTemplateRules' => [
- 'summary' => 'Adds firewall rules to a firewall template based on your business requirements.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DescribeDatabaseInstanceMetricData',
+ 'description' => 'After you create a lightweight database instance, you can retrieve its detailed monitoring metrics. These metrics include CPU and memory usage, disk space, IOPS (Input/Output Operations Per Second), and the number of connections.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-15T09:30:16.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabaseInstanceMetricData'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeDatabaseInstanceMetricData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"MetricName\\": \\"MySQL_MemCpuUsage\\",\\n \\"Unit\\": \\"%\\",\\n \\"DataFormat\\": \\"cpuusage&memusage\\",\\n \\"MetricData\\": \\"[ { \\\\\\\\\\\\\\"date\\\\\\"\\\\\\\\: \\\\\\" 2022-09-06T04:04:00Z\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.77&3.69\\\\\\\\\\\\\\" } ]\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeDatabaseInstanceParameters' => [
+ 'summary' => 'View parameters for a lightweight database instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '219667',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswas8F6GI9'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server to which the firewall template is applied. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'FirewallTemplateId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => 'The ID of the region where the lightweight database instance is located. You can call [ListRegions](~~189315~~) to query the most recent region list.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'FirewallRule',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The details of the firewall rule.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RuleProtocol' => [
- 'description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
- ."\n"
- .'* TCP'."\n"
- .'* UDP'."\n"
- .'* TCP+UDP'."\n"
- .'* ICMP'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
- ."\n"
- .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '222.70.XX.XX',
- ],
- 'Remark' => [
- 'description' => 'The remarks of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The ID of the lightweight database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The data returned.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'Engine' => ['description' => 'The database engine. Currently, only `MySQL` is supported.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
+ 'EngineVersion' => ['description' => 'The engine version. Valid values:'."\n"
+ ."\n"
+ .'- `5.7`: MySQL 5.7.'."\n"
+ ."\n"
+ .'- `8.0`: MySQL 8.0.', 'type' => 'string', 'example' => '5.5', 'title' => ''],
+ 'ConfigParameters' => [
+ 'description' => 'A list of configuration parameters being synchronized. After you modify and submit parameters, the instance starts to synchronize them. Once synchronization is complete, these parameters are removed from this list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of a configuration parameter that is being synchronized.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterDescription' => ['description' => 'The description of the parameter.', 'type' => 'string', 'example' => 'Auto-increment columns are incremented by this', 'title' => ''],
+ 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'auto_increment_increment', 'title' => ''],
+ 'ParameterValue' => ['description' => 'The value of the parameter.'."\n"
+ ."\n"
+ .'> The value varies by parameter.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'ForceModify' => ['description' => 'Indicates whether you can modify the parameter value. Valid values:'."\n"
+ ."\n"
+ .'- `true`: You can modify the parameter value.'."\n"
+ ."\n"
+ .'- `false`: You cannot modify the parameter value.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ForceRestart' => ['description' => 'Indicates if the database must be restarted for a parameter modification to take effect. Valid values:'."\n"
+ ."\n"
+ .'- `true`: A restart is required. To apply changes for a parameter that requires a restart, you must set the `ForceRestart` parameter to `true`.'."\n"
+ ."\n"
+ .'- `false`: A restart is not required.'."\n"
+ ."\n"
+ .'Default value: `false`.', 'type' => 'string', 'example' => 'false', 'title' => ''],
+ 'CheckingCode' => ['description' => 'The value range of the parameter.'."\n"
+ ."\n"
+ .'> The value range varies by parameter.', 'type' => 'string', 'example' => '[1-65535]', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'FirewallTemplateRules' => [
- 'description' => 'The firewall template rules.'."\n",
+ 'RunningParameters' => [
+ 'description' => 'A list of running parameters.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The details of a running parameter.',
'type' => 'object',
'properties' => [
- 'FirewallTemplateRuleId' => [
- 'description' => 'The ID of the firewall template rule.'."\n",
- 'type' => 'string',
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- 'RuleProtocol' => [
- 'description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
- ."\n"
- .'* TCP'."\n"
- .'* UDP'."\n"
- .'* TCP+UDP'."\n"
- .'* ICMP: the ICMP protocol'."\n",
- 'type' => 'string',
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
- ."\n"
- .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.'."\n",
- 'type' => 'string',
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.'."\n",
- 'type' => 'string',
- 'example' => '171.233.XX.XX',
- ],
- 'Remark' => [
- 'description' => 'The remarks of the firewall rule.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
+ 'ParameterDescription' => ['description' => 'The description of the running parameter.', 'type' => 'string', 'example' => 'When this variable has a value of 1 (the default), the server automatically grants the EXECUTE and ALTER ROUTINE privileges to the creator of a stored routine, if the user cannot already execute and alter or drop the routine. (The ALTER ROUTINE privilege is required to drop the routine.) The server also automatically drops those privileges from the creator when the routine is dropped. If automatic_sp_privileges is 0, the server does not automatically add or drop these privileges.', 'title' => ''],
+ 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'autocommit', 'title' => ''],
+ 'ParameterValue' => ['description' => 'The value of the running parameter.', 'type' => 'string', 'example' => 'ON', 'title' => ''],
+ 'ForceModify' => ['description' => 'Indicates whether you can modify the parameter value. Valid values:'."\n"
+ ."\n"
+ .'- `true`: You can modify the parameter value.'."\n"
+ ."\n"
+ .'- `false`: You cannot modify the parameter value.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ForceRestart' => ['description' => 'Indicates if the database must be restarted for a parameter modification to take effect. Valid values:'."\n"
+ ."\n"
+ .'- `true`: A restart is required. To apply changes for a parameter that requires a restart, you must set the `ForceRestart` parameter to `true`.'."\n"
+ ."\n"
+ .'- `false`: A restart is not required.'."\n"
+ ."\n"
+ .'Default value: `false`.', 'type' => 'string', 'example' => 'false', 'title' => ''],
+ 'CheckingCode' => ['description' => 'The value range of the parameter.'."\n"
+ ."\n"
+ .'> The value range varies by parameter.', 'type' => 'string', 'example' => '[ON|OFF]', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"FirewallTemplateRules\\": [\\n {\\n \\"FirewallTemplateRuleId\\": \\"ft-bcf1a7hrdq717****\\",\\n \\"RuleProtocol\\": \\"TCP\\",\\n \\"Port\\": \\"8080\\",\\n \\"SourceCidrIp\\": \\"171.233.XX.XX\\",\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'CreateFirewallTemplateRules',
- 'description' => 'Adding firewall rules to a firewall template does not affect the firewall rules that have been applied to simple application servers..'."\n",
- ],
- 'ApplyFirewallTemplate' => [
- 'summary' => 'Uses a firewall template to apply firewall rules to multiple simple application servers at a time. This improves your efficiency of setting firewall rules.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DescribeDatabaseInstanceParameters',
+ 'description' => 'This operation retrieves the parameter details of a lightweight database instance.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-18T09:22:12.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabaseInstanceParameters'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeDatabaseInstanceParameters',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"5.5\\",\\n \\"ConfigParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"Auto-increment columns are incremented by this\\",\\n \\"ParameterName\\": \\"auto_increment_increment\\",\\n \\"ParameterValue\\": \\"1\\",\\n \\"ForceModify\\": \\"true\\",\\n \\"ForceRestart\\": \\"false\\",\\n \\"CheckingCode\\": \\"[1-65535]\\"\\n }\\n ],\\n \\"RunningParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"When this variable has a value of 1 (the default), the server automatically grants the EXECUTE and ALTER ROUTINE privileges to the creator of a stored routine, if the user cannot already execute and alter or drop the routine. (The ALTER ROUTINE privilege is required to drop the routine.) The server also automatically drops those privileges from the creator when the routine is dropped. If automatic_sp_privileges is 0, the server does not automatically add or drop these privileges.\\",\\n \\"ParameterName\\": \\"autocommit\\",\\n \\"ParameterValue\\": \\"ON\\",\\n \\"ForceModify\\": \\"true\\",\\n \\"ForceRestart\\": \\"false\\",\\n \\"CheckingCode\\": \\"[ON|OFF]\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeDatabaseInstances' => [
+ 'summary' => 'This topic describes lightweight database instances.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '219675',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region where the lightweight database instances are located.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'DatabaseInstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The IDs of the lightweight database instances. The value is a JSON array that can contain up to 100 instance IDs.', 'type' => 'string', 'required' => false, 'example' => '["swasdb-xxx******","swasdb-yyy******"]', 'title' => ''],
],
[
- 'name' => 'FirewallTemplateId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Pages start from page 1.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the simple application server. A maximum of 10 server IDs are supported.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'd9e781ff8a8f49ee812796f12799****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'Maximum value: 100.'."\n"
+ ."\n"
+ .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The data returned.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'TaskId' => [
- 'description' => 'The ID of the execution to apply the template.'."\n",
- 'type' => 'string',
- 'example' => 'aft-ikgt0bynitvs3****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4****'],
+ 'DatabaseInstances' => [
+ 'description' => 'The information about the Simple Application Server database instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of a Simple Application Server database instance.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => 'The region ID of the Simple Application Server database instance.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'DatabaseInstanceId' => ['description' => 'The ID of the Simple Application Server database instance.', 'type' => 'string', 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
+ 'DatabaseInstanceName' => ['description' => 'The name of the Simple Application Server database instance.', 'type' => 'string', 'example' => 'My database', 'title' => ''],
+ 'DatabaseInstanceEdition' => ['description' => 'The edition of the Simple Application Server database instance. Valid values:'."\n"
+ ."\n"
+ .'- `swas.db.c1m1s25`: 35 CNY/month.'."\n"
+ ."\n"
+ .'- `swas.db.c1m2s80`: 100 CNY/month.'."\n"
+ ."\n"
+ .'- `swas.db.c2m4s120`: 200 CNY/month.'."\n"
+ ."\n"
+ .'- `swas.db.c2m8s240`: 300 CNY/month.', 'type' => 'string', 'example' => 'swas.db.c1m1s25', 'title' => ''],
+ 'DatabaseVersion' => ['description' => 'The database version. Valid values:'."\n"
+ ."\n"
+ .'- `5.7`: MySQL 5.7.'."\n"
+ ."\n"
+ .'- `8.0`: MySQL 8.0.', 'type' => 'string', 'example' => '5.7', 'title' => ''],
+ 'Cpu' => ['description' => 'The number of vCPUs.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Memory' => ['description' => 'The memory size. Unit: GB.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Storage' => ['description' => 'The disk space of the ESSD. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''],
+ 'PrivateConnection' => ['description' => 'The private connection endpoint.', 'type' => 'string', 'example' => 'rm-bp1d39opj7906****.mysql.rds.aliyuncs.com', 'title' => ''],
+ 'PublicConnection' => ['description' => 'The public connection endpoint.'."\n"
+ ."\n"
+ .'> This parameter is returned only if a public endpoint is enabled for the instance. You can call the [AllocatePublicConnection](~~451413~~) operation to enable a public endpoint.', 'type' => 'string', 'example' => 'db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com', 'title' => ''],
+ 'DatabaseInstanceStatus' => ['description' => 'The status of the Simple Application Server database instance. Valid values:'."\n"
+ ."\n"
+ .'- `Pending`: The instance is being created.'."\n"
+ ."\n"
+ .'- `Restarting`: The instance is being restarted.'."\n"
+ ."\n"
+ .'- `Running`: The instance is running.'."\n"
+ ."\n"
+ .'- `Stopping`: The instance is being stopped.'."\n"
+ ."\n"
+ .'- `Stopped`: The instance is stopped.'."\n"
+ ."\n"
+ .'- `UPGRADING`: The instance is being upgraded.'."\n"
+ ."\n"
+ .'- `DISABLED`: The instance is disabled.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'BusinessStatus' => ['description' => 'The business status of the instance. Valid values:'."\n"
+ ."\n"
+ .'- `normal`: The instance is normal.'."\n"
+ ."\n"
+ .'- `expired`: The instance has expired.'."\n"
+ ."\n"
+ .'- `overdue`: The payment for the instance is overdue.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
+ 'CreationTime' => ['description' => 'The time when the instance was created. The time follows the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-09-01T02:39:46Z', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'The time when the instance expires. The time follows the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n"
+ ."\n"
+ .'> The expiration time displayed in the console is eight hours later than the UTC time.', 'type' => 'string', 'example' => '2022-10-01T16:00:00Z', 'title' => ''],
+ 'ChargeType' => ['description' => 'The billing method of the instance. Only the subscription billing method is supported. The value is fixed as `PrePaid`.'."\n"
+ ."\n"
+ .'Default value: `PrePaid`.', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''],
+ 'SuperAccountName' => ['description' => 'The name of the privileged account of the Simple Application Server database instance.', 'type' => 'string', 'example' => 'administrator', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'PageSize' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageNumber' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"TaskId\\": \\"aft-ikgt0bynitvs3****\\"\\n}","type":"json"}]',
- 'title' => 'ApplyFirewallTemplate',
- 'description' => 'If the port range, protocol, and source IP address of a firewall rule in a firewall template are the same as the port range, protocol, and source IP address of an existing rule, the new rule overwrites the existing rule regardless of whether the existing rule is enabled or disabled.'."\n",
- ],
- 'ModifyFirewallTemplate' => [
- 'summary' => 'Modifies the firewall rule in a firewall template. You can apply the new firewall rule to simple application servers.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\",\\n \\"DatabaseInstances\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DatabaseInstanceId\\": \\"db-38263fa955774501a2ae1bdaed6f****\\",\\n \\"DatabaseInstanceName\\": \\"My database\\",\\n \\"DatabaseInstanceEdition\\": \\"swas.db.c1m1s25\\",\\n \\"DatabaseVersion\\": \\"5.7\\",\\n \\"Cpu\\": \\"1\\",\\n \\"Memory\\": \\"1\\",\\n \\"Storage\\": 25,\\n \\"PrivateConnection\\": \\"rm-bp1d39opj7906****.mysql.rds.aliyuncs.com\\",\\n \\"PublicConnection\\": \\"db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com\\",\\n \\"DatabaseInstanceStatus\\": \\"Running\\",\\n \\"BusinessStatus\\": \\"normal\\",\\n \\"CreationTime\\": \\"2022-09-01T02:39:46Z\\",\\n \\"ExpiredTime\\": \\"2022-10-01T16:00:00Z\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"SuperAccountName\\": \\"administrator\\"\\n }\\n ],\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 10,\\n \\"TotalCount\\": 5\\n}","type":"json"}]',
+ 'title' => 'DescribeDatabaseInstances',
+ 'description' => 'This operation retrieves details for one or more lightweight database instances in a specified region, including the instance ID, name, plan, database version, public IP address, private IP address, creation time, and expiration time.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-15T09:30:16.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabaseInstances'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeDatabaseInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'DescribeDatabaseSlowLogRecords' => [
+ 'summary' => 'Retrieves slow log details for Simple Database Service.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '219662',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswas8F6GI9'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID of the lightweight database instance.'."\n"
+ .'You can call the [ListRegions](~~189315~~) operation to get the latest list of supported Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The ID of the lightweight database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
[
- 'name' => 'FirewallTemplateId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Starting value: 1.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Valid values: 30 to 100.'."\n"
+ ."\n"
+ .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '30', 'default' => '30', 'required' => false, 'example' => '30', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The description of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The beginning of the time range to query.'."\n"
+ ."\n"
+ .'The time is in UTC and must be formatted as `yyyy-MM-ddTHH:mm:ssZ` as specified by the [ISO 8601](~~25696~~) standard.'."\n"
+ ."\n"
+ .'> The console displays this time in the UTC+8 time zone.', 'type' => 'string', 'required' => true, 'example' => '2022-09-07T04:04:44Z', 'title' => ''],
],
[
- 'name' => 'FirewallTemplateRule',
+ 'name' => 'EndTime',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The firewall rule in the template.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'FirewallTemplateRuleId' => [
- 'description' => 'The ID of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
- 'RuleProtocol' => [
- 'description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
- ."\n"
- .'* TCP'."\n"
- .'* UDP'."\n"
- .'* TCP+UDP'."\n"
- .'* ICMP'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
- ."\n"
- .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.0.0.0/0',
- ],
- 'Remark' => [
- 'description' => 'The remarks of the firewall template rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. The interval between the start time and the end time cannot be longer than 7 days.'."\n"
+ ."\n"
+ .'The time is in UTC and must be formatted as `yyyy-MM-ddTHH:mm:ssZ` as specified by the [ISO 8601](~~25696~~) standard.'."\n"
+ ."\n"
+ .'> The console displays this time in the UTC+8 time zone.', 'type' => 'string', 'required' => true, 'example' => '2022-09-08T04:04:44Z', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The data returned.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PageNumber' => ['description' => 'The page number of the returned page.'."\n"
+ ."\n"
+ .'Starts from 1.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries to return on each page. Valid values: 30 to 100.'."\n"
+ ."\n"
+ .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of slow query logs.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'PhysicalIORead' => ['description' => 'The number of logical reads.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
+ 'SlowLogs' => [
+ 'description' => 'The slow query logs.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Details of slow query logs.',
+ 'type' => 'object',
+ 'properties' => [
+ 'HostAddress' => ['description' => 'The IP address of the client that is used to connect to the database.', 'type' => 'string', 'example' => 'xxx[xxx] @ [1xx.xxx.xxx.xx]', 'title' => ''],
+ 'QueryTimes' => ['description' => 'The execution duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'SQLText' => ['description' => 'The details of the SQL statement.', 'type' => 'string', 'example' => 'select sleep(2)', 'title' => ''],
+ 'QueryTimeMS' => ['description' => 'The execution duration. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2001', 'title' => ''],
+ 'LockTimes' => ['description' => 'The lock duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'ExecutionStartTime' => ['description' => 'The start time of the execution. The time is displayed in UTC and is in the `yyyy-MM-ddTHH:mm:ssZ` format.'."\n"
+ ."\n"
+ .'> The time displayed in the console is in the UTC+8 time zone, which is 8 hours later than the time in UTC.', 'type' => 'string', 'example' => '2022-09-08T01:40:44Z', 'title' => ''],
+ 'ReturnRowCounts' => ['description' => 'The number of returned rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'ParseRowCounts' => ['description' => 'The number of parsed rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'DBName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'testDB', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => 'ModifyFirewallTemplate',
- 'description' => 'Modifying a firewall template does not affect the firewall rules that have been applied to simple application servers.'."\n",
- ],
- 'DescribeFirewallTemplateApplyResults' => [
- 'summary' => 'Queries the result of applying a firewall template to simple application servers.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DescribeDatabaseSlowLogRecords',
+ 'description' => 'You can query the slow logs of a Simple Database Service instance to diagnose issues.'."\n"
+ ."\n"
+ .'> Simple Database Service retains slow logs for 7 days.',
+ 'changeSet' => [
+ ['createdAt' => '2023-09-20T05:07:30.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-09-18T11:38:14.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-07-15T09:30:16.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabaseSlowLogRecords'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeDatabaseSlowLogRecords',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 20,\\n \\"PhysicalIORead\\": 200,\\n \\"Engine\\": \\"MySQL\\",\\n \\"SlowLogs\\": [\\n {\\n \\"HostAddress\\": \\"xxx[xxx] @ [1xx.xxx.xxx.xx]\\",\\n \\"QueryTimes\\": 2,\\n \\"SQLText\\": \\"select sleep(2)\\",\\n \\"QueryTimeMS\\": 2001,\\n \\"LockTimes\\": 0,\\n \\"ExecutionStartTime\\": \\"2022-09-08T01:40:44Z\\",\\n \\"ReturnRowCounts\\": 1,\\n \\"ParseRowCounts\\": 1,\\n \\"DBName\\": \\"testDB\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeFirewallTemplateApplyResults' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5451,80 +4342,47 @@
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '219676',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'FirewallTemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => 'The ID of the firewall template.', 'type' => 'string', 'required' => false, 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The ID of the execution to apply the template.'."\n",
+ 'description' => 'The ID of the execution to apply the template.',
'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the execution to apply the template.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aft-ikgt0bynitvs3****',
- ],
+ 'items' => ['description' => 'The ID of the execution to apply the template.', 'type' => 'string', 'required' => false, 'example' => 'aft-ikgt0bynitvs3****', 'title' => ''],
'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Default value: 20.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
@@ -5532,114 +4390,95 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page. Default value: 20.'."\n",
- 'type' => 'string',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page. Default value: 20.', 'type' => 'string', 'example' => '20', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '1', 'title' => ''],
'data' => [
- 'description' => 'The returned results.'."\n",
+ 'description' => 'The returned results.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => 'The ID of the execution to apply the template.'."\n",
- 'type' => 'string',
- 'example' => 'aft-ikgt0bynitvs3****',
- ],
- 'FirewallTemplateId' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- 'Status' => [
- 'description' => 'The status of applying the template to all simple application servers. Valid values:'."\n"
- ."\n"
- .'* Running: The firewall template is being applied to simple application servers.'."\n"
- .'* Failed: The firewall template is applied to none of simple application servers.'."\n"
- .'* Success: The firewall template is applied to all simple application servers.'."\n"
- .'* PartFailed: The firewall template fails to be applied to some simple application servers.'."\n",
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'FailedCount' => [
- 'description' => 'The total number of simple application servers to which the firewall template fails to apply.'."\n",
- 'type' => 'string',
- 'example' => '0',
- ],
+ 'TaskId' => ['description' => 'The ID of the execution to apply the template.', 'type' => 'string', 'example' => 'aft-ikgt0bynitvs3****', 'title' => ''],
+ 'FirewallTemplateId' => ['description' => 'The ID of the firewall template.', 'type' => 'string', 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
+ 'Status' => ['description' => 'The status of applying the template to all simple application servers. Valid values:'."\n"
+ ."\n"
+ .'- Running: The firewall template is being applied to simple application servers.'."\n"
+ ."\n"
+ .'- Failed: The firewall template is applied to none of simple application servers.'."\n"
+ ."\n"
+ .'- Success: The firewall template is applied to all simple application servers.'."\n"
+ ."\n"
+ .'- PartFailed: The firewall template fails to be applied to some simple application servers.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'FailedCount' => ['description' => 'The total number of simple application servers to which the firewall template fails to apply.', 'type' => 'string', 'example' => '0', 'title' => ''],
'InstanceApplyResults' => [
- 'description' => 'The result of applying the firewall template to the simple application servers.'."\n",
+ 'description' => 'The result of applying the firewall template to the simple application servers.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => '33774babccc84003a2b1ad47e8001233',
- ],
- 'Status' => [
- 'description' => 'The status of applying the firewall template to the simple application servers. Valid values:'."\n"
- ."\n"
- .'* Running: The firewall template is being applied to the simple application servers.'."\n"
- .'* Failed: The firewall template is applied to none of the simple application servers.'."\n"
- .'* Success: The firewall template is applied to all the simple application servers.'."\n"
- .'* PartFailed: The firewall template fails to be applied to some simple application servers.'."\n",
- 'type' => 'string',
- 'example' => 'Success',
- ],
+ 'InstanceId' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'example' => '33774babccc84003a2b1ad47e8001233', 'title' => ''],
+ 'Status' => ['description' => 'The status of applying the firewall template to the simple application servers. Valid values:'."\n"
+ ."\n"
+ .'- Running: The firewall template is being applied to the simple application servers.'."\n"
+ ."\n"
+ .'- Failed: The firewall template is applied to none of the simple application servers.'."\n"
+ ."\n"
+ .'- Success: The firewall template is applied to all the simple application servers.'."\n"
+ ."\n"
+ .'- PartFailed: The firewall template fails to be applied to some simple application servers.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'CreateTime' => [
- 'description' => 'The time when the firewall template was applied to the simple application servers.'."\n",
- 'type' => 'string',
- 'example' => 'Tue May 14 11:53:07 CST 2024',
- ],
+ 'CreateTime' => ['description' => 'The time when the firewall template was applied to the simple application servers.', 'type' => 'string', 'example' => 'Tue May 14 11:53:07 CST 2024', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"20\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"data\\": [\\n {\\n \\"TaskId\\": \\"aft-ikgt0bynitvs3****\\",\\n \\"FirewallTemplateId\\": \\"ft-bcf1a7hrdq717****\\",\\n \\"Status\\": \\"Success\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"FailedCount\\": \\"0\\",\\n \\"InstanceApplyResults\\": [\\n {\\n \\"InstanceId\\": \\"33774babccc84003a2b1ad47e8001233\\",\\n \\"Status\\": \\"Success\\"\\n }\\n ],\\n \\"CreateTime\\": \\"Tue May 14 11:53:07 CST 2024\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeFirewallTemplateApplyResults',
- ],
- 'DescribeFirewallTemplateRulesApplyResult' => [
- 'summary' => 'Queries the result of applying a firewall template rule to simple application servers.',
- 'methods' => [
- 'post',
- 'get',
+ 'summary' => 'Queries the result of applying a firewall template to simple application servers.',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-12T06:36:03.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeFirewallTemplateApplyResults',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"20\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"data\\": [\\n {\\n \\"TaskId\\": \\"aft-ikgt0bynitvs3****\\",\\n \\"FirewallTemplateId\\": \\"ft-bcf1a7hrdq717****\\",\\n \\"Status\\": \\"Success\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"FailedCount\\": \\"0\\",\\n \\"InstanceApplyResults\\": [\\n {\\n \\"InstanceId\\": \\"33774babccc84003a2b1ad47e8001233\\",\\n \\"Status\\": \\"Success\\"\\n }\\n ],\\n \\"CreateTime\\": \\"Tue May 14 11:53:07 CST 2024\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeFirewallTemplateRulesApplyResult' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5650,62 +4489,33 @@
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '219677',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
'name' => 'FirewallTemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => 'The ID of the firewall template.', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the execution to apply the template rule.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aft-ikgt0bynitvs3****',
- ],
+ 'schema' => ['description' => 'The ID of the execution to apply the template rule.', 'type' => 'string', 'required' => true, 'example' => 'aft-ikgt0bynitvs3****', 'title' => ''],
],
],
'responses' => [
@@ -5713,179 +4523,222 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
'data' => [
- 'description' => 'The returned results.'."\n",
+ 'description' => 'The returned results.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
- 'RuleProtocol' => [
- 'description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
- ."\n"
- .'* TCP'."\n"
- .'* UDP'."\n"
- .'* TCP+UDP'."\n"
- .'* ICMP'."\n",
- 'type' => 'string',
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
- ."\n"
- .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.'."\n",
- 'type' => 'string',
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.'."\n",
- 'type' => 'string',
- 'example' => '119.145.XX.XX',
- ],
- 'Remark' => [
- 'description' => 'The remarks of the firewall rule.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Success' => [
- 'description' => 'The status of applying the firewall template rule to the simple application servers.'."\n"
- ."\n"
- .'* Pending: The template rule does not start to be applied to the simple application servers.'."\n"
- .'* Applying: The template rule is being applied to the simple application servers.'."\n"
- .'* Success: The template rule is successfully applied to the simple application servers.'."\n"
- .'* PartFailed: The template rule fails to be applied to some simple application servers.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => 'The error codes when the firewall template rule fails to be applied.'."\n",
- 'type' => 'string',
- 'example' => '500',
- ],
- 'ErrorInfo' => [
- 'description' => 'The error message that is displayed when the firewall template rule fails to be applied.'."\n",
- 'type' => 'string',
- 'example' => 'An error occurred while processing your request.',
- ],
+ 'RuleProtocol' => ['description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
+ ."\n"
+ .'- TCP'."\n"
+ ."\n"
+ .'- UDP'."\n"
+ ."\n"
+ .'- TCP+UDP'."\n"
+ ."\n"
+ .'- ICMP', 'type' => 'string', 'example' => 'TCP', 'title' => ''],
+ 'Port' => ['description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
+ ."\n"
+ .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.', 'type' => 'string', 'example' => '8080', 'title' => ''],
+ 'SourceCidrIp' => ['description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.', 'type' => 'string', 'example' => '119.145.XX.XX', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks of the firewall rule.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Success' => ['description' => 'The status of applying the firewall template rule to the simple application servers.'."\n"
+ ."\n"
+ .'- Pending: The template rule does not start to be applied to the simple application servers.'."\n"
+ ."\n"
+ .'- Applying: The template rule is being applied to the simple application servers.'."\n"
+ ."\n"
+ .'- Success: The template rule is successfully applied to the simple application servers.'."\n"
+ ."\n"
+ .'- PartFailed: The template rule fails to be applied to some simple application servers.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error codes when the firewall template rule fails to be applied.', 'type' => 'string', 'example' => '500', 'title' => ''],
+ 'ErrorInfo' => ['description' => 'The error message that is displayed when the firewall template rule fails to be applied.', 'type' => 'string', 'example' => 'An error occurred while processing your request.', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"data\\": [\\n {\\n \\"RuleProtocol\\": \\"TCP\\",\\n \\"Port\\": \\"8080\\",\\n \\"SourceCidrIp\\": \\"119.145.XX.XX\\",\\n \\"Remark\\": \\"test\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"500\\",\\n \\"ErrorInfo\\": \\"An error occurred while processing your request.\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeFirewallTemplateRulesApplyResult',
- ],
- 'DeleteFirewallTemplateRules' => [
- 'summary' => 'Deletes firewall rules from a firewall template based on your requirements.',
- 'methods' => [
- 'post',
- 'get',
+ 'summary' => 'Queries the result of applying a firewall template rule to simple application servers.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeFirewallTemplateRulesApplyResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"data\\": [\\n {\\n \\"RuleProtocol\\": \\"TCP\\",\\n \\"Port\\": \\"8080\\",\\n \\"SourceCidrIp\\": \\"119.145.XX.XX\\",\\n \\"Remark\\": \\"test\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"500\\",\\n \\"ErrorInfo\\": \\"An error occurred while processing your request.\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeFirewallTemplates' => [
+ 'summary' => 'Queries details about firewall templates.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '219670',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219665',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'FirewallTemplateId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
+ 'description' => 'The IDs of the firewall templates.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the firewall template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'FirewallTemplateId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => 'The name of the firewall template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''],
],
[
- 'name' => 'FirewallTemplateRuleId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The IDs of the firewall template rules.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the firewall template rule.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Pages start from page 1.'."\n"
+ ."\n"
+ .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Pages start from page 1.'."\n"
+ ."\n"
+ .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'FirewallTemplates' => [
+ 'description' => 'The information about the queried firewall templates.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'FirewallTemplateId' => ['description' => 'The ID of the firewall template.'."\n", 'type' => 'string', 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
+ 'CreationTime' => ['description' => 'The time when the firewall template was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-04-10T02:10:14Z', 'title' => ''],
+ 'Name' => ['description' => 'The name of the firewall template.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Description' => ['description' => 'The description of the firewall template.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the firewall template was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n"
+ ."\n"
+ .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n", 'type' => 'string', 'example' => '2024-04-29T02:01:38Z', 'title' => ''],
+ 'FirewallTemplateRules' => [
+ 'description' => 'The details of the firewall template rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'FirewallTemplateRuleId' => ['description' => 'The ID of the firewall template rule.'."\n", 'type' => 'string', 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****', 'title' => ''],
+ 'RuleProtocol' => ['description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
+ ."\n"
+ .'* TCP'."\n"
+ .'* UDP'."\n"
+ .'* TCP+UDP'."\n"
+ .'* ICMP'."\n", 'type' => 'string', 'example' => 'TCP', 'title' => ''],
+ 'Port' => ['description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
+ ."\n"
+ .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.'."\n", 'type' => 'string', 'example' => '8080', 'title' => ''],
+ 'SourceCidrIp' => ['description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.'."\n", 'type' => 'string', 'example' => '119.145.XX.XX', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks of the firewall template rule.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteFirewallTemplateRules',
- 'description' => 'Deletion of firewall rules does not affect the firewall rules that have been applied to simple application servers.'."\n",
- ],
- 'DeleteFirewallTemplates' => [
- 'summary' => 'Deletes firewall templates from a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"FirewallTemplates\\": [\\n {\\n \\"FirewallTemplateId\\": \\"ft-bcf1a7hrdq717****\\",\\n \\"CreationTime\\": \\"2024-04-10T02:10:14Z\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": \\"2024-04-29T02:01:38Z\\",\\n \\"FirewallTemplateRules\\": [\\n {\\n \\"FirewallTemplateRuleId\\": \\"eeea34d9867b4d55a4ff8d5fcfbd****\\",\\n \\"RuleProtocol\\": \\"TCP\\",\\n \\"Port\\": \\"8080\\",\\n \\"SourceCidrIp\\": \\"119.145.XX.XX\\",\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeFirewallTemplates',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeFirewallTemplates',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeInstanceKeyPair' => [
+ 'summary' => 'Queries information about the key pair of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5893,51 +4746,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '219657',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
- 'name' => 'FirewallTemplateId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The IDs of the firewall templates.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the firewall template.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
],
'responses' => [
@@ -5945,30 +4769,46 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
+ 'KeyPairName' => ['description' => 'The name of the key pair.', 'type' => 'string', 'example' => 'KeyPairName', 'title' => ''],
+ 'Fingerprint' => ['description' => 'The fingerprint of the key pair.', 'type' => 'string', 'example' => '4f:70:62:e9:0c:72:f7:ee:74:ce:e3:bf:e0:82:**:**', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteFirewallTemplates',
- 'description' => 'Deleting a firewall template does not affect the firewall rules that have been applied to simple application servers. You can delete firewall templates that you no longer need.'."\n",
- ],
- 'DeleteFirewallRules' => [
- 'summary' => 'Deletes multiple firewall rules of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'DescribeInstanceKeyPair',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceKeyPair'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeInstanceKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"KeyPairName\\": \\"KeyPairName\\",\\n \\"Fingerprint\\": \\"4f:70:62:e9:0c:72:f7:ee:74:ce:e3:bf:e0:82:**:**\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeInstancePasswordsSetting' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5977,60 +4817,26 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '216901',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswas8GRVRI'],
],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~2361076~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'RuleIds',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'description' => 'The IDs of the firewall rules that you want to delete.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the firewall rule that you want to delete.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
],
'responses' => [
@@ -6038,68 +4844,48 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4****', 'title' => ''],
+ 'VncPasswordSetting' => ['description' => 'Indicates whether a VNC connection password is set for the simple application server.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'InstancePasswordSetting' => ['description' => 'Indicates whether a logon password is set for the simple application server.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidProtocol.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Protocol is invalid.',
- ],
- [
- 'errorCode' => 'InvalidPort.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Port is invalid.',
- ],
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
- 403 => [
- [
- 'errorCode' => 'FirewallRuleLimitExceed',
- 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.',
- ],
- [
- 'errorCode' => 'FirewallRuleAlreadyExist',
- 'errorMessage' => 'The specified Rule already exist',
- ],
+ ],
+ 'title' => 'DescribeInstancePasswordsSetting',
+ 'summary' => 'Checks whether a password is set for a simple application server.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstancePasswordsSetting'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeInstancePasswordsSetting',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
- 'title' => 'DeleteFirewallRules',
- 'description' => 'After a firewall rule is deleted, your business deployed on the simple application server may become inaccessible. Before you delete a firewall rule, make sure that the firewall rule is no longer needed by the simple application server.'."\n",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\",\\n \\"VncPasswordSetting\\": true,\\n \\"InstancePasswordSetting\\": true\\n}","type":"json"}]',
],
- 'CreateFirewallRule' => [
- 'summary' => 'Creates a firewall rule for a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeInstanceVncUrl' => [
+ 'summary' => 'Queries the VNC connection address of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6107,85 +4893,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '20456',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
- ],
- [
- 'name' => 'RuleProtocol',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The transport layer protocol. Valid values:'."\n"
- ."\n"
- .'* TCP'."\n"
- .'* UDP'."\n"
- .'* TCP+UDP'."\n"
- .'* ICMP'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'TCP',
- ],
- ],
- [
- 'name' => 'Port',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The port range.'."\n"
- ."\n"
- .'* When the transport layer protocol is TCP and/or UDP, the port range is 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: 1024/1055, which specifies the port range from 1024 to 1055.'."\n"
- .'* When the transport layer protocol is ICMP, the port range is -1/-1, which indicates all ports.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '3306',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'Remark',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The remarks of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TEST',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
],
],
'responses' => [
@@ -6193,529 +4916,324 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'FirewallId' => [
- 'description' => 'The ID of the firewall rule.'."\n",
- 'type' => 'string',
- 'example' => '8007e18c61024aafbd776d52d0****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'VncUrl' => ['description' => 'The VNC connection address of the server.', 'type' => 'string', 'example' => 'wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3Dwz3L8wEMO6KMt7%252FXInEMtKVubBB%252F7rv055kOm8eUOD%252*****YlmsKjOfz6', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidProtocol.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Protocol is invalid.',
- ],
- [
- 'errorCode' => 'InvalidPort.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Port is invalid.',
- ],
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
- 403 => [
- [
- 'errorCode' => 'FirewallRuleLimitExceed',
- 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.',
- ],
- [
- 'errorCode' => 'FirewallRuleAlreadyExist',
- 'errorMessage' => 'The specified Rule already exist',
- ],
+ ],
+ 'title' => 'DescribeInstanceVncUrl',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceVncUrl'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeInstanceVncUrl',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"FirewallId\\": \\"8007e18c61024aafbd776d52d0****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateFirewallRuleResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F\\t</RequestId>\\n <FirewallId>8007e18c61024aafbd776d52d0****</FirewallId>\\n</CreateFirewallRuleResponse>","errorExample":""}]',
- 'title' => 'CreateFirewallRule',
- 'description' => 'Firewalls serve to control network access to simple application servers and isolate security domains in the cloud. By default, SSH port 22, HTTP port 80, and HTTPS port 443 are enabled for simple application servers. Other ports are disabled. You can add firewall rules to enable more ports.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"VncUrl\\": \\"wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3Dwz3L8wEMO6KMt7%252FXInEMtKVubBB%252F7rv055kOm8eUOD%252*****YlmsKjOfz6\\"\\n}","type":"json"}]',
],
- 'CreateFirewallRules' => [
- 'summary' => 'Creates multiple firewall rules for a simple application server at a time.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeInvocationResult' => [
+ 'summary' => 'Queries the execution result of a command.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InvokeId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The execution ID. You can call the [DescribeInvocations](~~439368~~) operation to query execution IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 't-bj02prjhw1n****', 'title' => ''],
],
[
- 'name' => 'FirewallRules',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'Details about the firewall rules.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'Details about the firewall rules.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'RuleProtocol' => [
- 'description' => 'The transport layer protocol. Valid values:'."\n"
- ."\n"
- .'* TCP'."\n"
- .'* UDP'."\n"
- .'* TCP+UDP'."\n"
- .'* ICMP'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => 'The port number.'."\n"
- ."\n"
- .'* When the transport layer protocol is TCP and/or UDP, the port number range is 1 to 65535. Specify a port range in the format of \\<Start port number>/\\<End port number>. Example: 1/200.'."\n"
- .'* When the transport layer protocol is ICMP, the port number range is -1/-1, which indicates all ports.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '3306',
- ],
- 'SourceCidrIp' => [
- 'description' => 'The IP address or CIDR block that is allowed in the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '47.101.XX.XX',
- ],
- 'Remark' => [
- 'description' => 'The description of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TEST',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Tag',
+ 'name' => 'RegionId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The tags that you want to add to the firewall. You can specify up to 20 tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tags of the firewall rule.',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key. Valid values of N: 1 to 20.'."\n"
- ."\n"
- .'The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value. Valid values of N: 1 to 20.'."\n"
- ."\n"
- .'The tag value can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'FirewallRuleIds' => [
- 'description' => 'The IDs of the firewall rules that you created.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the firewall rule that you created.'."\n",
- 'type' => 'string',
- 'example' => '1a16263ab0f541288312a15fa64280de',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'InvocationResult' => [
+ 'description' => 'The execution results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'StartTime' => ['description' => 'The time when the execution started.'."\n", 'type' => 'string', 'example' => '2022-07-11T06:37:16Z', 'title' => ''],
+ 'FinishedTime' => ['description' => 'The time when the execution ended.'."\n", 'type' => 'string', 'example' => '2022-07-11T06:37:17Z', 'title' => ''],
+ 'InvocationStatus' => ['description' => 'The status of the execution progress. Valid values:'."\n"
+ ."\n"
+ .'* Pending: The command is being verified or sent.'."\n"
+ .'* Invalid: The specified command type or parameter is invalid.'."\n"
+ .'* Aborted: The command fails to be sent to the server. To send a command to a server, make sure that the server is in the Running state and the command can be sent within 1 minute.'."\n"
+ .'* Running: The command is being executed on the server.'."\n"
+ .'* Success: The execution is completed, and the exit code is 0.'."\n"
+ .'* Failed: The execution is completed, and the exit code is not 0.'."\n"
+ .'* Error: The execution cannot proceed due to an exception.'."\n"
+ .'* Timeout: The execution times out.'."\n"
+ .'* Cancelled: The execution is canceled, and the command is not executed.'."\n"
+ .'* Stopping: The command in the Running state is being stopped.'."\n"
+ .'* Terminated: The command is terminated while it is being executed.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'ExitCode' => ['description' => 'The exit code of the command.'."\n"
+ ."\n"
+ .'* For Linux instances, the exit code is the exit code of the shell command.'."\n"
+ .'* For Windows instances, the exit code is the exit code of the batch or PowerShell command.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'ErrorInfo' => ['description' => 'The error message returned when the command is not successfully sent or executed. Valid values:'."\n"
+ ."\n"
+ .'* If this parameter is empty, the command is executed normally.'."\n"
+ .'* the specified instance does not exists: The specified server does not exist or is released.'."\n"
+ .'* the instance has released when create task: The server was released while the command was being executed on the server.'."\n"
+ .'* the instance is not running when create task: The server is not in the Running state while the command is being executed.'."\n"
+ .'* the command is not applicable: The command is not applicable to the specified server.'."\n"
+ .'* the specified account does not exists: The specified account does not exist.'."\n"
+ .'* the specified directory does not exists: The specified directory does not exist.'."\n"
+ .'* the cron job expression is invalid: The specified cron expression is invalid.'."\n"
+ .'* the aliyun service is not running on the instance: The Cloud Assistance client is not running.'."\n"
+ .'* the aliyun service in the instance does not response: The Cloud Assistant client does not respond to your request.'."\n"
+ .'* the aliyun service in the instance is upgrading now: The Cloud Assistant client is being upgraded.'."\n"
+ .'* the aliyun service in the instance need upgrade: The Cloud Assistant client needs to be upgraded.'."\n"
+ .'* the command delivery has been timeout: Command sending times out.'."\n"
+ .'* the command execution has been timeout: The execution times out.'."\n"
+ .'* the command execution got an exception: An exception occurs while the command is being executed.'."\n"
+ .'* the command execution has been interrupted: The execution is interrupted.'."\n"
+ .'* the command execution exit code is not zero: The execution is complete, and the exit code is not 0.'."\n", 'type' => 'string', 'example' => 'the specified instance does not exists', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code that is returned if the command failed to be sent or executed.'."\n"
+ ."\n"
+ .'* If this parameter is empty, the command is executed normally.'."\n"
+ .'* InstanceNotExists: The specified server does not exist or is released.'."\n"
+ .'* InstanceReleased: The server was released while the command was being executed on the server.'."\n"
+ .'* InstanceNotRunning: The server is not in the Running state while the command is being executed.'."\n"
+ .'* CommandNotApplicable: The command is not applicable to the specified server.'."\n"
+ .'* AccountNotExists: The specified account does not exist.'."\n"
+ .'* DirectoryNotExists: The specified directory does not exist.'."\n"
+ .'* BadCronExpression: The specified cron expression for the execution schedule is invalid.'."\n"
+ .'* ClientNotRunning: The Cloud Assistant client is not running.'."\n"
+ .'* ClientNotResponse: The Cloud Assistant client does not respond.'."\n"
+ .'* ClientIsUpgrading: The Cloud Assistant client is being upgraded.'."\n"
+ .'* ClientNeedUpgrade: The Cloud Assistant client needs to be upgraded.'."\n"
+ .'* DeliveryTimeout: Command sending times out.'."\n"
+ .'* ExecutionTimeout: The execution times out.'."\n"
+ .'* ExecutionException: An exception occurs while the command is being executed.'."\n"
+ .'* ExecutionInterrupted: The execution is interrupted.'."\n"
+ .'* ExitCodeNonzero: The execution is complete, but the exit code is not 0.'."\n", 'type' => 'string', 'example' => 'InstanceNotExists', 'title' => ''],
+ 'InvokeId' => ['description' => 'The execution ID.'."\n", 'type' => 'string', 'example' => 't-bj02prjje65****', 'title' => ''],
+ 'InvokeRecordStatus' => ['description' => 'The status of the execution. Valid values:'."\n"
+ ."\n"
+ .'* Running'."\n"
+ .'* Finished'."\n"
+ .'* Failed'."\n"
+ .'* Stopped'."\n", 'type' => 'string', 'example' => 'Finished', 'title' => ''],
+ 'InvokeUser' => ['description' => 'The username who executes the command on the simple application server.'."\n", 'type' => 'string', 'example' => 'root', 'title' => ''],
+ 'Output' => ['description' => 'The command output.'."\n", 'type' => 'string', 'example' => 'YWRtaW4K', 'title' => ''],
+ 'InstanceId' => ['description' => 'The ID of the simple application server.'."\n", 'type' => 'string', 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidProtocol.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Protocol is invalid.',
- ],
- [
- 'errorCode' => 'InvalidPort.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Port is invalid.',
- ],
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'FirewallRuleLimitExceed',
- 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.',
- ],
- [
- 'errorCode' => 'FirewallRuleAlreadyExist',
- 'errorMessage' => 'The specified Rule already exist',
- ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"InvocationResult\\": {\\n \\"StartTime\\": \\"2022-07-11T06:37:16Z\\",\\n \\"FinishedTime\\": \\"2022-07-11T06:37:17Z\\",\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"ExitCode\\": 0,\\n \\"ErrorInfo\\": \\"the specified instance does not exists\\",\\n \\"ErrorCode\\": \\"InstanceNotExists\\",\\n \\"InvokeId\\": \\"t-bj02prjje65****\\",\\n \\"InvokeRecordStatus\\": \\"Finished\\",\\n \\"InvokeUser\\": \\"root\\",\\n \\"Output\\": \\"YWRtaW4K\\",\\n \\"InstanceId\\": \\"ace0706b2ac4454d984295a94213****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeInvocationResultResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n <InvocationResult>\\n <StartTime>2022-07-11T06:37:16Z</StartTime>\\n <FinishedTime>2022-07-11T06:37:17Z</FinishedTime>\\n <InvocationStatus>Success</InvocationStatus>\\n <ExitCode>0</ExitCode>\\n <ErrorInfo>the specified instance does not exists</ErrorInfo>\\n <ErrorCode>InstanceNotExists</ErrorCode>\\n <InvokeId>t-bj02prjje65****</InvokeId>\\n <InvokeRecordStatus>Finished</InvokeRecordStatus>\\n <InvokeUser>root</InvokeUser>\\n <Output>YWRtaW4K</Output>\\n <InstanceId>ace0706b2ac4454d984295a94213****</InstanceId>\\n </InvocationResult>\\n</DescribeInvocationResultResponse>","errorExample":""}]',
+ 'title' => 'DescribeInvocationResult',
+ 'description' => '* After you execute a command, the command may not succeed or return the expected results. You can call this operation to query the execution result of a command.'."\n"
+ .'* You can query the execution results that were generated within the last two weeks. A maximum of 100,000 entries of execution results can be retained.'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2022-06-21T07:24:04.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInvocationResult'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeInvocationResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/{#InstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"FirewallRuleIds\\": [\\n \\"1a16263ab0f541288312a15fa64280de\\"\\n ]\\n}","type":"json"}]',
- 'title' => 'CreateFirewallRules',
- 'description' => 'Firewalls serve to control network access to simple application servers and isolate security domains in the cloud. By default, SSH port 22, HTTP port 80, and HTTPS port 443 are enabled for simple application servers. Other ports are disabled. You can add firewall rules to enable more ports.'."\n",
],
- 'ListFirewallRules' => [
- 'summary' => 'Queries the firewall rules of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeInvocations' => [
+ 'summary' => 'Queries details about command execution.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'Maximum value: 100.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.'."\n", 'type' => 'string', 'required' => true, 'example' => '3a658ca270df4df39f22e289b338****', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from page 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Pages start from page 1.'."\n"
+ ."\n"
+ .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Tag',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The tags of the firewall rule.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tag of the firewall rule.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key. A tag key must be 1 to 64 characters in length. You can add up to 20 tags.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value. A tag value must be 1 to 64 characters in length. You can add up to 20 tags.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'Maximum value: 50.'."\n"
+ ."\n"
+ .'Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'FirewallRuleId',
+ 'name' => 'InvokeStatus',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1a16263ab0f541288312a15fa64280de',
- ],
+ 'schema' => ['description' => 'The status of the command execution. Valid values:'."\n"
+ ."\n"
+ .'* Running: The command is being executed.'."\n"
+ .'* Finished: The execution is complete.'."\n"
+ .'* Failed: The execution fails.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Finished', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- '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',
- ],
- 'FirewallRules' => [
- 'description' => 'Details of the firewall rules.'."\n",
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'Invocations' => [
+ 'description' => 'The command name.'."\n",
'type' => 'array',
'items' => [
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'Remark' => [
- 'description' => 'The remarks of the firewall rule.'."\n",
- 'type' => 'string',
- 'example' => 'TEST',
- ],
- 'Port' => [
- 'description' => 'The port range.'."\n",
- 'type' => 'string',
- 'example' => '3306',
- ],
- 'RuleId' => [
- 'description' => 'The ID of the firewall rule.'."\n",
- 'type' => 'string',
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
- 'RuleProtocol' => [
- 'description' => 'The transport layer protocol. Valid values:'."\n"
- ."\n"
- .'* TCP'."\n"
- .'* UDP'."\n"
- .'* TCP+UDP'."\n",
- 'type' => 'string',
- 'example' => 'TCP',
- ],
- 'Policy' => [
- 'description' => 'The firewall policy. Valid values:'."\n"
- ."\n"
- .'* accept: Access is allowed.'."\n"
- .'* drop: Access is refused.'."\n",
- 'type' => 'string',
- 'example' => 'accept',
- ],
- 'Tags' => [
- 'description' => 'The tags of the firewall rule.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tag of the firewall rule.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- ],
- ],
- ],
- 'SourceCidrIp' => [
- 'description' => 'The source CIDR block.'."\n",
- 'type' => 'string',
- 'example' => '0.0.0.0/0',
- ],
+ 'CreationTime' => ['description' => 'The time when the command was created.'."\n", 'type' => 'string', 'example' => '2022-07-11T06:37:16Z', 'title' => ''],
+ 'InvocationStatus' => ['description' => 'The status of the command. Valid values:'."\n"
+ ."\n"
+ .'* Pending: The command is being verified or sent.'."\n"
+ .'* Invalid: The specified command type or parameter is invalid.'."\n"
+ .'* Aborted: The command failed to be sent. To send a command to an instance, make sure that the instance is in the Running state and the command is sent to the instance within 1 minute.'."\n"
+ .'* Running: The command is being run on the instance.'."\n"
+ .'* Success: The command finishes running, and the exit code is 0.'."\n"
+ .'* Failed: The command finishes running, but the exit code is not 0.'."\n"
+ .'* Error: The running of the command cannot proceed due to an exception.'."\n"
+ .'* Timeout: The running of the command times out.'."\n"
+ .'* Cancelled: The running is canceled, and the command is not run.'."\n"
+ .'* Stopping: The command that is running is being stopped.'."\n"
+ .'* Terminated: The command is terminated while it is being run.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'CommandType' => ['description' => 'The type of the command. Valid values:'."\n"
+ ."\n"
+ .'* RunBatScript: batch command (applicable to Windows instances).'."\n"
+ .'* RunPowerShellScript: PowerShell command (applicable to Windows instances).'."\n"
+ .'* RunShellScript: shell command (applicable to Linux instances).'."\n", 'type' => 'string', 'example' => 'RunShellScript', 'title' => ''],
+ 'CommandContent' => ['description' => 'The content of the command, which is Base64-encoded.'."\n", 'type' => 'string', 'example' => 'bHM=', 'title' => ''],
+ 'Parameters' => ['description' => 'The custom parameters in the command. If no custom parameter exists in the command, the default value is {}.'."\n", 'type' => 'object', 'example' => '{}', 'title' => ''],
+ 'InvokeStatus' => ['description' => 'The status of the command. Valid values:'."\n"
+ ."\n"
+ .'* Running: The command is running.'."\n"
+ .'* Finished: The command finishes running.'."\n"
+ .'* Failed: The running of the command failed.'."\n"
+ .'* Stopped: The running is stopped.'."\n", 'type' => 'string', 'example' => 'Finished', 'title' => ''],
+ 'InvokeId' => ['description' => 'The ID of the command task.'."\n", 'type' => 'string', 'example' => 't-hz02p9545t6****', 'title' => ''],
+ 'CommandName' => ['description' => 'The name of the command.'."\n", 'type' => 'string', 'example' => 'testname', 'title' => ''],
],
- 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'InvalidParam',
- 'errorMessage' => 'The specified parameter value is invalid.',
- ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"Invocations\\": [\\n {\\n \\"CreationTime\\": \\"2022-07-11T06:37:16Z\\",\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"CommandType\\": \\"RunShellScript\\",\\n \\"CommandContent\\": \\"bHM=\\",\\n \\"Parameters\\": {},\\n \\"InvokeStatus\\": \\"Finished\\",\\n \\"InvokeId\\": \\"t-hz02p9545t6****\\",\\n \\"CommandName\\": \\"testname\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 10\\n}","errorExample":""},{"type":"xml","example":"<DescribeInvocationsResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n <Invocations>\\n <CreationTime>2022-07-11T06:37:16Z</CreationTime>\\n <InvocationStatus>Success</InvocationStatus>\\n <CommandType>RunShellScript</CommandType>\\n <CommandContent>bHM=</CommandContent>\\n <InvokeStatus>Finished</InvokeStatus>\\n <InvokeId>t-hz02p9545t6****</InvokeId>\\n <CommandName>testname</CommandName>\\n </Invocations>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <TotalCount>10</TotalCount>\\n</DescribeInvocationsResponse>","errorExample":""}]',
+ 'title' => 'DescribeInvocations',
+ 'description' => '* After you execute a command, the command may not succeed or return the expected results. You can call this operation to query the actual execution results.'."\n"
+ .'* You can query the execution results that were generated within the last two weeks. Up to 100,000 entries of execution results can be retained.'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2022-06-21T07:24:04.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInvocations'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeInvocations',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 4,\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"FirewallRules\\": [\\n {\\n \\"Remark\\": \\"test-MySQL服务器默认端口\\",\\n \\"Port\\": \\"3306\\",\\n \\"RuleId\\": \\"eeea34d9867b4d55a4ff8d5fcfbd****\\",\\n \\"RuleProtocol\\": \\"TCP\\",\\n \\"Policy\\": \\"accept\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"SourceCidrIp\\": \\"0.0.0.0/0\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListFirewallRulesResponse>\\n <TotalCount>4</TotalCount>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <FirewallRules>\\n <Remark>test-MySQL服务器默认端口</Remark>\\n <Port>3306</Port>\\n <RuleId>eeea34d9867b4d55a4ff8d5fcfbd****</RuleId>\\n <RuleProtocol>TCP</RuleProtocol>\\n <Policy>accept</Policy>\\n <SourceCidrIp>0.0.0.0/0</SourceCidrIp>\\n </FirewallRules>\\n</ListFirewallRulesResponse>","errorExample":""}]',
- 'title' => 'ListFirewallRules',
- 'description' => 'You can call the ListFirewallRules operation to query the firewall rule details of a simple application server, including the port range, firewall rule ID, and transport layer protocol.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'ModifyFirewallRule' => [
- 'summary' => 'Modifies the firewall rule of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeMonitorData' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6723,95 +5241,84 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
],
[
- 'name' => 'RuleId',
+ 'name' => 'MetricName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
+ 'schema' => ['description' => 'The name of the metric. Valid values:'."\n"
+ ."\n"
+ .'- MEMORY\\_ACTUALUSEDSPACE: the memory usage. Unit: bytes.'."\n"
+ ."\n"
+ .'- DISKUSAGE\\_USED: the disk usage. Unit: bytes.'."\n"
+ ."\n"
+ .'- CPU\\_UTILIZATION: the CPU usage, in percentage.'."\n"
+ ."\n"
+ .'- VPC\\_PUBLICIP\\_INTERNETOUT\\_RATE: the outbound bandwidth. Unit: bits/s.'."\n"
+ ."\n"
+ .'- VPC\\_PUBLICIP\\_INTERNETIN\\_RATE: the inbound bandwidth. Unit: bits/s.'."\n"
+ ."\n"
+ .'- DISK\\_READ\\_IOPS: the read IOPS of the disk. Unit: count/s.'."\n"
+ ."\n"
+ .'- DISK\\_WRITE\\_IOPS: the write IOPS of the disk. Unit: count/s.'."\n"
+ ."\n"
+ .'- FLOW\\_USED: the traffic usage. Unit: bytes.', 'type' => 'string', 'required' => true, 'example' => 'DISKUSAGE_USED', 'title' => ''],
],
[
- 'name' => 'RuleProtocol',
+ 'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => 'The transport layer protocol. Valid values:'."\n"
- ."\n"
- .'* TCP: the TCP protocol'."\n"
- .'* UDP: the UDP protocol'."\n"
- .'* TCP+UDP: the TCP and UDP protocols'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TCP',
- ],
+ 'schema' => ['description' => 'The interval at which the monitoring data is queried. Valid values: 60, 300, and 900. Unit: seconds.'."\n"
+ ."\n"
+ .'> If MetricName is set to FLOW\\_USED, set Period to 3600 (one hour). In other cases, set Period based on your business requirements.', 'type' => 'string', 'required' => true, 'example' => '60', 'title' => ''],
],
[
- 'name' => 'Port',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The port range. Valid values: 165535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 10241055.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '3306',
- ],
+ 'schema' => ['description' => 'The beginning of the time range to query. The following formats are supported:'."\n"
+ ."\n"
+ .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 January 1, 1970.'."\n"
+ ."\n"
+ .'- Time format: YYYY-MM-DDThh:mm:ssZ.'."\n"
+ ."\n"
+ .'> * The specified time range includes the end time and excludes the start time. The start time must be earlier than the end time.'."\n"
+ .'>'."\n"
+ .'> * The interval between the start time and the end time is less than or equal to 31 days.', 'type' => 'string', 'required' => true, 'example' => '2022-09-07T04:04:44Z', 'title' => ''],
],
[
- 'name' => 'SourceCidrIp',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The IP address or CIDR block that is allowed in the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.147.33.**',
- ],
+ 'schema' => ['description' => 'The end of the time range to query. The following formats are supported:'."\n"
+ ."\n"
+ .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 January 1, 1970.'."\n"
+ ."\n"
+ .'- Time format: YYYY-MM-DDThh:mm:ssZ.'."\n"
+ ."\n"
+ .'> The interval between the start time and the end time is less than or equal to 31 days.', 'type' => 'string', 'required' => true, 'example' => '2022-09-08T08:04:44Z', 'title' => ''],
],
[
- 'name' => 'Remark',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The remarks of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'custom',
- ],
+ 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Length',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 1440.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''],
],
],
'responses' => [
@@ -6819,207 +5326,397 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
+ 'Datapoints' => ['description' => 'The monitoring data.', 'type' => 'string', 'example' => '[]', 'title' => ''],
+ 'Period' => ['description' => 'The interval at which the monitoring data is queried. Valid values: 60, 300, and 900. Unit: seconds.'."\n"
+ ."\n"
+ .'> If you set the MetricName request parameter to FLOW\\_USED, the value of Period is 3600 (one hour).', 'type' => 'string', 'example' => '60', 'title' => ''],
+ 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***'."\n", 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidProtocol.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Protocol is invalid.',
- ],
- [
- 'errorCode' => 'InvalidPort.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Port is invalid.',
- ],
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
- 403 => [
- [
- 'errorCode' => 'FirewallRuleLimitExceed',
- 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.',
- ],
- [
- 'errorCode' => 'FirewallRuleAlreadyExist',
- 'errorMessage' => 'The specified Rule already exist',
- ],
+ ],
+ 'title' => 'DescribeMonitorData',
+ 'summary' => 'Queries the monitoring information about vCPUs, memory, disk IOPS, and traffic of a simple application server.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeMonitorData'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeMonitorData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E1FEE\\"\\n}","type":"json"}]',
- 'title' => 'ModifyFirewallRule',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"Datapoints\\": \\"[]\\",\\n \\"Period\\": \\"60\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***\\\\n\\"\\n}","type":"json"}]',
],
- 'EnableFirewallRule' => [
- 'summary' => 'Enables a firewall rule for a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribePrice' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswasOLUWJH'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
+ 'schema' => ['description' => 'The region ID of the Simple Application Server instance.'."\n"
+ .'You can call [ListRegions](~~189315~~) to query the list of supported regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'CommodityType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The resource type. Valid values:'."\n"
+ .'- Server', 'type' => 'string', 'required' => true, 'example' => 'Server', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'PlanId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The plan ID. You can call [ListPlans](~~189314~~) to query all plans in a specified region.', 'type' => 'string', 'required' => true, 'example' => 'swas.s1.cxxxxxx3t05', 'title' => ''],
],
[
- 'name' => 'RuleId',
+ 'name' => 'DataDiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
+ 'schema' => ['description' => 'The size of the attached data cloud disk. Unit: GB. Valid values: 0 to 16380. The value must be a multiple of 20.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '16380', 'minimum' => '20', 'required' => false, 'example' => '20', 'title' => ''],
],
[
- 'name' => 'Remark',
+ 'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => 'The remarks of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'custom',
- ],
+ 'schema' => ['description' => 'The billing duration. Valid values:'."\n"
+ .'- If PriceUnit is set to Month: 1 to 9.'."\n"
+ .'- If PriceUnit is set to Year: 1 to 5.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'SourceCidrIp',
+ 'name' => 'PriceUnit',
'in' => 'query',
+ 'schema' => ['description' => 'Valid values:'."\n"
+ .'- Month: the monthly billing unit.'."\n"
+ .'- Year: the yearly billing unit.'."\n"
+ ."\n"
+ .'Default value: Month.', 'type' => 'string', 'default' => 'Month', 'required' => false, 'example' => 'Month', 'title' => ''],
+ ],
+ [
+ 'name' => 'Amount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of Simple Application Server instances to create. Valid values: 1 to 20.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PayType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The billing type of the instance. Valid values:'."\n"
+ .'- Prepaid: subscription.'."\n"
+ ."\n"
+ .'Example value: Prepaid.', 'type' => 'string', 'default' => 'Prepaid', 'required' => false, 'example' => 'Prepaid', 'title' => ''],
+ ],
+ [
+ 'name' => 'PromotionOptions',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'The IP address or CIDR block that is allowed in the firewall policy.'."\n",
- 'type' => 'string',
+ 'description' => 'The promotion option information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CouponNo' => ['description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''],
+ 'ActivityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
'required' => false,
- 'example' => '10.147.33.**',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'OrderType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The order type. Valid values:'."\n"
+ .'- Buy'."\n"
+ ."\n"
+ .'Default value: Buy.', 'type' => 'string', 'required' => false, 'example' => 'UPLOAD', 'title' => ''],
+ ],
+ [
+ 'name' => 'AcceptLanguage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The language of the response. Valid values:'."\n"
+ ."\n"
+ .'- **zh-CN** (default): Chinese.'."\n"
+ ."\n"
+ .'- **en-US**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PriceInfo' => [
+ 'description' => 'The price details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Rules' => [
+ 'description' => 'The promotion rule information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The promotion rule information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => 'The description of the custom parameter.', 'type' => 'string', 'example' => '买满一年，立享官网价格xxx折扣优惠。', 'title' => ''],
+ 'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '142', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Price' => [
+ 'description' => 'The price information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '1580', 'title' => ''],
+ 'DiscountPrice' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''],
+ 'StandardPrice' => ['description' => 'The standard discount price on the official website or the direct sales contract discount price.', 'type' => 'number', 'format' => 'float', 'example' => '899', 'title' => ''],
+ 'StandardDiscountPrice' => ['description' => 'The promotional price based on the standard website discount.', 'type' => 'number', 'format' => 'float', 'example' => '85', 'title' => ''],
+ 'IsContractPromotion' => ['description' => 'Indicates whether a promotion is applied.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'Currency' => ['description' => 'The currency unit. Valid values:'."\n"
+ ."\n"
+ .'- CNY: Chinese Yuan.'."\n"
+ .'- USD: US Dollar.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'TradePrice' => ['description' => 'The transaction price.', 'type' => 'number', 'format' => 'float', 'example' => '267.4', 'title' => ''],
+ 'DetailInfos' => [
+ 'description' => 'The detailed pricing information of each configuration.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The detailed pricing information of each configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '1850', 'title' => ''],
+ 'DiscountPrice' => ['description' => 'The discount price.', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''],
+ 'CommodityType' => ['description' => 'The resource name.', 'type' => 'string', 'example' => 'Server', 'title' => ''],
+ 'TradePrice' => ['description' => 'The transaction price.', 'type' => 'number', 'format' => 'float', 'example' => '267.4', 'title' => ''],
+ 'Promotions' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DiscountOff' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''],
+ 'RuleId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Coupons' => [
+ 'description' => 'Indicates whether the coupon is selected.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The coupon code.',
+ 'type' => 'object',
+ 'properties' => [
+ 'IsSelected' => ['description' => 'Indicates whether the coupon is selected.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'CouponNo' => ['description' => 'The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''],
+ 'Description' => ['description' => 'The description of the custom parameter.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'DiscountOff' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '20.0', 'title' => ''],
+ 'OptionCode' => ['description' => 'The promotion ID.', 'type' => 'string', 'example' => '*****', 'title' => ''],
+ 'Name' => ['description' => 'The command name.', 'type' => 'string', 'example' => 'ACS-SWAS-GenerateRsaKeypair-windows.ps1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Promotions' => [
+ 'description' => 'The promotion information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The promotion information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The coupon name.', 'type' => 'string', 'example' => 'ACS-SWAS-ResetPassword-for-linux.sh', 'title' => ''],
+ 'DiscountOff' => ['description' => 'The discount amount of the coupon.', 'type' => 'number', 'format' => 'float', 'example' => '20.0', 'title' => ''],
+ 'RuleIds' => [
+ 'description' => 'The promotion ID.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The promotion ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'a7c77d3b3e6d458996410c650ef38326', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'description' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidProtocol.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Protocol is invalid.',
- ],
- [
- 'errorCode' => 'InvalidPort.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Port is invalid.',
- ],
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ ['errorCode' => 'CSS_SYSTEM_ERROR', 'errorMessage' => 'The sales system encountered an error.', 'description' => 'There was an error in the selling system.'],
],
- 403 => [
- [
- 'errorCode' => 'FirewallRuleLimitExceed',
- 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.',
- ],
- [
- 'errorCode' => 'FirewallRuleAlreadyExist',
- 'errorMessage' => 'The specified Rule already exist',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query price',
+ 'summary' => 'Retrieves the pricing information of a Simple Application Server product.',
+ 'description' => '- After you run a command, the command is not guaranteed to succeed or produce the expected results. Check the actual execution result based on the response.'."\n"
+ .'- You can query execution information from the last two weeks. A maximum of 100,000 execution records are retained.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PriceInfo\\": {\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满一年，立享官网价格xxx折扣优惠。\\",\\n \\"RuleId\\": 142\\n }\\n ],\\n \\"Price\\": {\\n \\"OriginalPrice\\": 1580,\\n \\"DiscountPrice\\": 0,\\n \\"StandardPrice\\": 899,\\n \\"StandardDiscountPrice\\": 85,\\n \\"IsContractPromotion\\": false,\\n \\"Currency\\": \\"CNY\\",\\n \\"TradePrice\\": 267.4,\\n \\"DetailInfos\\": [\\n {\\n \\"OriginalPrice\\": 1850,\\n \\"DiscountPrice\\": 0,\\n \\"CommodityType\\": \\"Server\\",\\n \\"TradePrice\\": 267.4,\\n \\"Promotions\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"DiscountOff\\": 0,\\n \\"RuleId\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Coupons\\": [\\n {\\n \\"IsSelected\\": false,\\n \\"CouponNo\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"Description\\": \\"OK\\",\\n \\"DiscountOff\\": 20,\\n \\"OptionCode\\": \\"*****\\",\\n \\"Name\\": \\"ACS-SWAS-GenerateRsaKeypair-windows.ps1\\"\\n }\\n ],\\n \\"Promotions\\": [\\n {\\n \\"Name\\": \\"ACS-SWAS-ResetPassword-for-linux.sh\\",\\n \\"DiscountOff\\": 20,\\n \\"RuleIds\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeSecurityAgentStatus' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
+ ],
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'ClientStatus' => ['description' => 'The status of the Security Center agent. Valid values:'."\n"
+ ."\n"
+ .'- pause: The Security Center agent suspends protection for your server.'."\n"
+ ."\n"
+ .'- online: The Security Center agent is protecting your server.'."\n"
+ ."\n"
+ .'- offline: The Security Center agent does not protect your server.', 'type' => 'string', 'example' => 'online', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
- 'title' => 'EnableFirewallRule',
- ],
- 'DisableFirewallRule' => [
- 'summary' => 'Disables a firewall rule of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'DescribeSecurityAgentStatus',
+ 'summary' => 'Queries the status of the Security Center agent on a simple application server.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSecurityAgentStatus'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeSecurityAgentStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"ClientStatus\\": \\"online\\"\\n}","type":"json"}]',
+ ],
+ 'DetachKeyPair' => [
+ 'summary' => 'Unbinds key pairs from simple application servers.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7029,59 +5726,38 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
+ 'abilityTreeCode' => '219077',
+ 'abilityTreeNodes' => ['FEATUREswas9IJLCU'],
],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
- 'name' => 'RuleId',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The ID of the firewall rule. You can call the ListFirewallRules operation to query the ID of the firewall rule.'."\n",
- 'type' => 'string',
+ 'description' => 'The IDs of the simple application servers from which you want to unbind SSH key pairs. You can specify a maximum of 50 IDs of simple application servers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the simple application server from which you want to unbind an SSH key pair. You can specify a maximum of 50 IDs of simple application servers.', 'type' => 'string', 'required' => false, 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Remark',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The remarks of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'custom',
- ],
+ 'schema' => ['description' => 'The name of the key pair. The name must be globally unique. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with http\\:// or https\\://.', 'type' => 'string', 'required' => true, 'example' => 'KeyPairName', 'title' => ''],
],
],
'responses' => [
@@ -7089,67 +5765,74 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of simple application servers from which the SSH key pair is unbound.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'FailCount' => ['description' => 'The total number of simple application servers from which you fail to unbind key pairs.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Results' => [
+ 'title' => '',
+ 'description' => 'The request results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The result set of the unbind operation.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The HTTP status code.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'success'],
+ 'Success' => ['description' => 'Indicates whether the key pair is unbound from the simple application server successfully. Valid values:'."\n"
+ ."\n"
+ .'- true'."\n"
+ ."\n"
+ .'- false', 'type' => 'string', 'title' => '', 'example' => 'true'],
+ 'InstanceId' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'title' => '', 'example' => 'aa6e71ddb35c46679bc4753d6219d604'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidProtocol.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Protocol is invalid.',
- ],
- [
- 'errorCode' => 'InvalidPort.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Port is invalid.',
- ],
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ ['errorCode' => 'InvalidParameter.KeypairNotAttachedInstance', 'errorMessage' => 'The specified keyPair not attached to instances.', 'description' => ''],
],
- 403 => [
- [
- 'errorCode' => 'FirewallRuleLimitExceed',
- 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.',
- ],
- [
- 'errorCode' => 'FirewallRuleAlreadyExist',
- 'errorMessage' => 'The specified Rule already exist',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified Instance Id does not exist.', 'description' => 'The specified instance ID does not exist.'],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DetachKeyPair',
+ 'description' => 'If you want to change the SSH key pairs that are bound to your simple application servers or your end user no longer needs to access a specific simple application server, you can unbind the SSH key pairs from simple application servers to improve the security of the simple application servers or restrict access to the specific simple application server.',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-28T05:40:57.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:DetachKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\"\\n}","type":"json"}]',
- 'title' => 'DisableFirewallRule',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"TotalCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"Results\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": \\"true\\",\\n \\"InstanceId\\": \\"aa6e71ddb35c46679bc4753d6219d604\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DeleteFirewallRule' => [
- 'summary' => 'Deletes a firewall rule of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DisableFirewallRule' => [
+ 'summary' => 'Disables a firewall rule of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7157,51 +5840,32 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
'name' => 'RuleId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the firewall rule.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
+ 'schema' => ['description' => 'The ID of the firewall rule. You can call the ListFirewallRules operation to query the ID of the firewall rule.', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The remarks of the firewall rule.', 'type' => 'string', 'example' => 'Custom', 'required' => false, 'title' => ''],
],
],
'responses' => [
@@ -7209,71 +5873,58 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidProtocol.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Protocol is invalid.',
- ],
- [
- 'errorCode' => 'InvalidPort.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Port is invalid.',
- ],
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ ['errorCode' => 'InvalidProtocol.ValueNotSupported', 'errorMessage' => 'The specified parameter Protocol is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidPort.ValueNotSupported', 'errorMessage' => 'The specified parameter Port is invalid.', 'description' => ''],
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'FirewallRuleLimitExceed',
- 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.',
- ],
- [
- 'errorCode' => 'FirewallRuleAlreadyExist',
- 'errorMessage' => 'The specified Rule already exist',
- ],
+ ['errorCode' => 'FirewallRuleLimitExceed', 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.', 'description' => ''],
+ ['errorCode' => 'FirewallRuleAlreadyExist', 'errorMessage' => 'The specified Rule already exist', 'description' => ''],
],
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteFirewallRuleResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n</DeleteFirewallRuleResponse>","errorExample":""}]',
- 'title' => 'DeleteFirewallRule',
- 'description' => 'After a firewall rule is deleted, your business deployed on the simple application server may become inaccessible. Before you delete a firewall rule, make sure that the firewall rule is no longer needed by the simple application server.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CreateSnapshot' => [
- 'summary' => 'Creates a snapshot for a disk.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\"\\n}","type":"json"}]',
+ 'title' => 'DisableFirewallRule',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DisableFirewallRule'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:DisableFirewallRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/{#RuleId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'EnableFirewallRule' => [
+ 'summary' => 'Enables a firewall rule for a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7281,100 +5932,37 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '20458',
- 'abilityTreeNodes' => [
- 'FEATUREswasHVUGWX',
- ],
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server to which the disk is attached.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
],
[
- 'name' => 'DiskId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The disk ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'd-bp18kjxg9ebrhsgi****',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'SnapshotName',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The snapshot name. The name must be 2 to 50 characters in length. It must start with a letter but cannot start with `http://` or `https://`. The name can only contain letters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-SnapshotName',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'RuleId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The ID of the firewall rule.', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****', 'title' => ''],
],
[
- 'name' => 'Tag',
+ 'name' => 'Remark',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The tags that you want to add to the snapshot. You can specify up to 20 tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tags of the snapshot.',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The key of the tag to add to the snapshot. Valid values of N: 1 to 20.'."\n"
- ."\n"
- .'The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The value of the tag to add to the snapshot. Valid values of N: 1 to 20.'."\n"
- ."\n"
- .'The tag value can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The remarks of the firewall rule.', 'type' => 'string', 'example' => 'Custom', 'required' => false, 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'SourceCidrIp',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => 'The IP address or CIDR block that is allowed in the firewall policy.', 'type' => 'string', 'required' => false, 'example' => '10.147.33.**', 'title' => ''],
],
],
'responses' => [
@@ -7382,230 +5970,95 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'SnapshotId' => [
- 'description' => 'The snapshot ID.'."\n",
- 'type' => 'string',
- 'example' => 's-bp16oazlsold4dks****',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRemark.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Remark is invalid.',
- ],
- [
- 'errorCode' => 'InvalidRemark.Duplicate',
- 'errorMessage' => 'The specified Remark already exists.',
- ],
- [
- 'errorCode' => 'IncorrectStatus',
- 'errorMessage' => 'The state of the disk or instance does not currently support snapshot creation.',
- ],
- [
- 'errorCode' => 'InvalidSnapshotName.ValueNotSupported',
- 'errorMessage' => 'The specified SnapshotName is invalid.',
- ],
- [
- 'errorCode' => 'InvalidSnapshotName.Duplicate',
- 'errorMessage' => 'The specified SnapshotName already exists.',
- ],
+ ['errorCode' => 'InvalidProtocol.ValueNotSupported', 'errorMessage' => 'The specified parameter Protocol is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidPort.ValueNotSupported', 'errorMessage' => 'The specified parameter Port is invalid.', 'description' => ''],
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'SnapshotLimitExceed',
- 'errorMessage' => 'The maximum number of snapshots in an instance is exceeded.',
- ],
- [
- 'errorCode' => 'IncorrectDiskStatus.CreatingSnapshot',
- 'errorMessage' => 'A snapshot is being created in the specified disk. Please try again later.',
- ],
+ ['errorCode' => 'FirewallRuleLimitExceed', 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.', 'description' => ''],
+ ['errorCode' => 'FirewallRuleAlreadyExist', 'errorMessage' => 'The specified Rule already exist', 'description' => ''],
],
[
- [
- 'errorCode' => 'InvalidDiskId.NotFound',
- 'errorMessage' => 'The specified DiskId does not exist.',
- ],
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"SnapshotId\\": \\"s-bp16oazlsold4dks****\\",\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateSnapshotResponse>\\n <SnapshotId>s-bp16oazlsold4dks****</SnapshotId>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n</CreateSnapshotResponse>","errorExample":""}]',
- 'title' => 'CreateSnapshot',
- 'description' => 'A snapshot is a point-in-time backup of a disk. Snapshots can be used to back up data, recover data after misoperations on servers, recover data after network attacks, and create custom images.'."\n"
- ."\n"
- .'> You are not charged for creating snapshots in Simple Application Server.'."\n"
- ."\n"
- .'### [](#)Precautions'."\n"
- ."\n"
- .'* You can create up to three snapshots for each simple application server.'."\n"
- .'* The maximum number of snapshots that you create per Alibaba Cloud account is triple of the number of simple application servers that are created. The value cannot be greater than 15.'."\n"
- .'* If a simple application server is automatically released due to expiration, the snapshots created for the server are deleted.'."\n"
- .'* If you reset a simple application server after you create a snapshot for the server, the snapshot is retained but cannot be used to restore the disks of the server.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListSnapshots' => [
- 'summary' => 'Queries the information about snapshots that are created for a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
+ 'title' => 'EnableFirewallRule',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableFirewallRule'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:EnableFirewallRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/{#RuleId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'ImportKeyPair' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '20467',
- 'abilityTreeNodes' => [
- 'FEATUREswasHVUGWX',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219071',
+ 'abilityTreeNodes' => ['FEATUREswas9IJLCU'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '无越权场景',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server that corresponds to the snapshots.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- ],
- [
- 'name' => 'DiskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The disk ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd-bp14wq0149cpp2xy****',
- ],
- ],
- [
- 'name' => 'SnapshotIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The snapshot IDs. The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple snapshot IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"]',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Maximum value: 100.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The ID of the region where the Simple Application Server instance is located.'."\n"
+ .'Call [ListRegions](~~189315~~) to view a list of supported Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'SourceDiskType',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the source disk. Valid values:'."\n"
- ."\n"
- .'* system: system disk.'."\n"
- .'* data: data disk.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'System',
- ],
+ 'schema' => ['description' => 'A client token used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. **ClientToken** can contain only ASCII characters and must be no more than 64 characters long. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'Tag',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'Tag N that you want to add to the snapshot.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tags of the snapshot.',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The key of tag N that you want to add to the snapshot. A tag key can be 1 to 64 characters in length. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The value of tag N that you want to add to the snapshot. A tag value can be up to 64 characters in length. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The name of the key pair. The name must be 2 to 64 characters in length. It must start with a letter or a Chinese character. It cannot start with http\\:// or https\\://. The name can contain digits, colons (:), underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => 'KeyPairName', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'PublicKeyBody',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => 'The content of the public key of the key pair.', 'type' => 'string', 'required' => true, 'example' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****', 'title' => ''],
],
],
'responses' => [
@@ -7613,180 +6066,47 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- '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',
- ],
- 'Snapshots' => [
- 'description' => 'Details about the snapshots.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => 'The status of the snapshot. Valid values:'."\n"
- ."\n"
- .'* Progressing: The snapshot is being created.'."\n"
- .'* Accomplished: The snapshot is created.'."\n"
- .'* Failed: The snapshot failed to be created.'."\n",
- 'type' => 'string',
- 'example' => 'Accomplished',
- ],
- 'CreationTime' => [
- 'description' => 'The time when the snapshot was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2021-03-09T07:12:49Z',
- ],
- 'SourceDiskId' => [
- 'description' => 'The ID of the source disk. This parameter has a value even after the source disk is released.'."\n",
- 'type' => 'string',
- 'example' => 'd-bp14wq0149cpp2xy****',
- ],
- 'SnapshotName' => [
- 'description' => 'The name of the snapshot.'."\n",
- 'type' => 'string',
- 'example' => 'test-SnapshotName',
- ],
- 'Progress' => [
- 'description' => 'The progress of snapshot creation.'."\n",
- 'type' => 'string',
- 'example' => '100%',
- ],
- 'Remark' => [
- 'description' => 'The remarks of the snapshot.'."\n",
- 'type' => 'string',
- 'example' => 'test-Remark',
- ],
- 'SnapshotId' => [
- 'description' => 'The snapshot ID.'."\n",
- 'type' => 'string',
- 'example' => 's-bp16oazlsold4dks****',
- ],
- 'SourceDiskType' => [
- 'description' => 'The type of the source disk. Valid values:'."\n"
- ."\n"
- .'* system: system disk.'."\n"
- .'* data: data disk.'."\n",
- 'type' => 'string',
- 'example' => 'System',
- ],
- 'RegionId' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server.'."\n"
- ."\n"
- .'Note: This parameter has a value returned for only system disk snapshots.'."\n",
- 'type' => 'string',
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- 'Tags' => [
- 'description' => 'The tags of the snapshot.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tags of the snapshot.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key of the snapshot.'."\n",
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value of the snapshot.'."\n",
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- ],
- ],
- ],
- 'RollbackTime' => [
- 'description' => 'The time when the last disk rollback was performed.'."\n",
- 'type' => 'string',
- 'example' => '2021-03-09T07:12:49Z',
- ],
- 'ResourceGroupId' => [
- 'description' => 'The ID of the resource group to which the snapshot belongs.'."\n",
- 'type' => 'string',
- 'example' => 'rg-aek2bti7cf7****',
- ],
- ],
- 'description' => 'The details about snapshots.'."\n",
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'KeyPairName' => ['description' => 'The name of the key pair. The name must be 2 to 64 characters in length. It must start with a letter or a Chinese character. It cannot start with http\\:// or https\\://. The name can contain digits, colons (:), underscores (\\_), and hyphens (-).', 'type' => 'string', 'example' => 'KeyPairName', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'InvalidParam',
- 'errorMessage' => 'The specified parameter value is invalid.',
- ],
+ ['errorCode' => 'KeyPairNameAlreadyExist', 'errorMessage' => 'The keyPair name already exist.', 'description' => ''],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ImportKeyPair',
+ 'summary' => 'Imports an existing key pair.',
+ 'description' => 'You can import an existing key pair to the console to log on to your Simple Application Server instances. The key pair must use a supported encryption method. For more information, see [Q2: What encryption methods are supported for importing an existing key pair?](~~59085~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- [
- 'errorCode' => 'InvalidDiskId.NotFound',
- 'errorMessage' => 'The specified DiskId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:ImportKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Snapshots\\": [\\n {\\n \\"Status\\": \\"Accomplished\\",\\n \\"CreationTime\\": \\"2021-03-09T07:12:49Z\\",\\n \\"SourceDiskId\\": \\"d-bp14wq0149cpp2xy****\\",\\n \\"SnapshotName\\": \\"test-SnapshotName\\",\\n \\"Progress\\": \\"100%\\",\\n \\"Remark\\": \\"test-Remark\\",\\n \\"SnapshotId\\": \\"s-bp16oazlsold4dks****\\",\\n \\"SourceDiskType\\": \\"System\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceId\\": \\"2ad1ae67295445f598017499dc****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"RollbackTime\\": \\"2021-03-09T07:12:49Z\\",\\n \\"ResourceGroupId\\": \\"rg-aek2bti7cf7****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSnapshotsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Snapshots>\\n <Status>Accomplished</Status>\\n <CreationTime>2021-03-09T07:12:49Z</CreationTime>\\n <SourceDiskId>d-bp14wq0149cpp2xy****</SourceDiskId>\\n <SnapshotName>test-SnapshotName</SnapshotName>\\n <Progress>100%</Progress>\\n <Remark>test-Remark</Remark>\\n <SnapshotId>s-bp16oazlsold4dks****</SnapshotId>\\n <SourceDiskType>System</SourceDiskType>\\n <RegionId>cn-hangzhou</RegionId>\\n </Snapshots>\\n</ListSnapshotsResponse>","errorExample":""}]',
- 'title' => 'ListSnapshots',
- 'description' => 'The `InstanceId`, `DiskId`, `SnapshotIds`, and `ResourceGroupId` parameters are optional. However, you can specify them as filter conditions and combine them with the logical AND operator to filter snapshots that you want to query.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"KeyPairName\\": \\"KeyPairName\\"\\n}","type":"json"}]',
],
- 'UpdateSnapshotAttribute' => [
- 'summary' => 'Modifies the remarks of a snapshot of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'InstallCloudAssistant' => [
+ 'summary' => 'Installs the Cloud Assistant client on simple application servers at a time.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7794,95 +6114,69 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'SnapshotId',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The snapshot ID. You can call the ListSnapshots operation to query the snapshot ID.'."\n",
- 'type' => 'string',
+ 'description' => 'The IDs of the simple application servers.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the simple application server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
'required' => true,
- 'docRequired' => true,
- 'example' => 's-bp16oazlsold4dks****',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
- ],
- [
- 'name' => 'Remark',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The remarks of the snapshot of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
+ 'maxItems' => 50,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidSnapshotId.NotFound',
- 'errorMessage' => 'The specified SnapshotId does not exist.',
- ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","errorExample":""},{"type":"xml","example":"<InstallCloudAssistantResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n</InstallCloudAssistantResponse>","errorExample":""}]',
+ 'title' => 'InstallCloudAssistant',
+ 'description' => 'To run commands on your simple application servers, you must install the Cloud Assistant client on your servers. You can call the [DescribeCloudAssistantStatus](~~439512~~) operation to check whether the Cloud Assistant client is installed on your simple application servers. If you have not installed the Cloud Assistant client, you can call the InstallCloudAssistant operation to install the client. Then, you can call the [RebootInstance](~~190443~~) operation to restart the servers to allow the client to take effect.'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2022-06-21T07:24:04.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'InstallCloudAssistant'],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:InstallCloudAssistant',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****\\"\\n}","type":"json"}]',
- 'title' => 'UpdateSnapshotAttribute',
],
- 'DeleteSnapshot' => [
- 'summary' => 'Deletes a snapshot of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'InstallCloudMonitorAgent' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7890,41 +6184,31 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the snapshot.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'SnapshotId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The snapshot ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-bp16oazlsold4dks****',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => '9ae7106e68eb4402b0dcbd48a9de****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Force',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to forcibly install the CloudMonitor agent. Valid values:'."\n"
+ ."\n"
+ .'- true (default value): forcibly installs the CloudMonitor agent.'."\n"
+ ."\n"
+ .'- false: does not forcibly install the CloudMonitor agent.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
@@ -7932,192 +6216,187 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidSnapshotId.NotFound',
- 'errorMessage' => 'The specified SnapshotId does not exist.',
- ],
- ],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSnapshotResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n</DeleteSnapshotResponse>","errorExample":""}]',
- 'title' => 'DeleteSnapshot',
- 'description' => 'You can delete a snapshot if you no longer need it.'."\n"
- ."\n"
- .'> If a custom image was created from the snapshot, delete the custom image before you delete the snapshot.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteSnapshots' => [
- 'summary' => 'Deletes snapshots of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'InstallCloudMonitorAgent',
+ 'summary' => 'Installs the CloudMonitor agent for a simple application server.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'InstallCloudMonitorAgent'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:InstallCloudMonitorAgent',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\"\\n}","type":"json"}]',
+ ],
+ 'InvokeCommand' => [
+ 'summary' => 'Runs a Command Assistant command for one or more simple application servers.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswasHVUGWX',
- ],
+ 'abilityTreeNodes' => ['FEATUREswasWZKIOQ'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'SnapshotIds',
+ 'name' => 'CommandId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The snapshot IDs. The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple snapshot IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"]',
- ],
+ 'schema' => ['description' => 'The command ID. You can call the DescribeCommands operation to query all available command IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-sh02yh0932w****', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Parameters',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => 'The key-value pairs of custom parameters to specify when the custom parameter feature is enabled.'."\n"
+ ."\n"
+ .'* You can specify up to 10 custom parameters. Each key in a Map collection cannot be an empty string and can be up to 64 characters in length.'."\n"
+ .'* Values in a Map collection can be empty strings. The total length of the custom parameters and the original command cannot exceed 18 KB after they are encoded in Base64.'."\n"
+ .'* The custom parameter names that you specify for the Parameters parameter must be included in the custom parameter names that you specified when you created the command.'."\n"
+ .'* You can use empty strings to represent the custom parameters that are not specified. If you want to disable the custom parameter feature, you can leave this parameter empty.'."\n", 'type' => 'object', 'required' => false, 'example' => '{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}', 'title' => ''],
+ ],
+ [
+ 'name' => 'Username',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the user who runs the command in a simple application server. The username cannot exceed 255 characters in length.'."\n"
+ ."\n"
+ .'* For Linux servers, the default value is the root username.'."\n"
+ .'* For Windows servers, the default value is the system username.'."\n"
+ ."\n"
+ .'You can change the user to run the command only for Linux simple application servers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 50 IDs of simple application servers. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'InvokeId' => ['description' => 'The execution ID of the command.'."\n", 'type' => 'string', 'example' => 't-bj02prjhw1n****', 'title' => ''],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidSnapshotId.NotFound',
- 'errorMessage' => 'The specified SnapshotId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"InvokeId\\": \\"t-bj02prjhw1n****\\"\\n}","type":"json"}]',
+ 'title' => 'InvokeCommand',
+ 'description' => '* The simple application servers for which you want to call the operation must meet the following conditions. If a simple application server cannot meet the conditions, you must call this operation again.'."\n"
+ ."\n"
+ .' * The simple application servers are in the `Running` state. You can call the [ListInstances](~~2361065~~) operation to query the status of simple application servers.'."\n"
+ .' * Cloud Assistant Agent is installed on the simple application servers. For more information, see [InstallCloudAssistant](~~2361030~~).'."\n"
+ .' * If you run a PowerShell command, make sure that the PowerShell module is configured for the simple application servers.'."\n"
+ ."\n"
+ .'* The command may fail to be run due to the abnormal states of simple application servers, network exceptions, or exceptions in Cloud Assistant Agent. If the command fails to be run, no execution information is generated.'."\n"
+ ."\n"
+ .'* If you enable the custom parameter feature when you create a command, you must set the `Parameters` parameter to specify custom parameters when you run the command.'."\n"
+ ."\n"
+ .'* When you call this operation, you can select only one common command or a custom command that you have created.'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:InvokeCommand',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2DE174B-7196-5778-A00D-6EA2601B****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteSnapshots',
],
- 'UpdateDiskAttribute' => [
- 'summary' => 'Modifies the remarks for the data disk that is attached to a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListCustomImageShareAccounts' => [
+ 'summary' => 'Queries information about custom images that are shared across Alibaba Cloud accounts in a region.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '225369',
+ 'abilityTreeNodes' => ['FEATUREswasJBABCT', 'FEATUREswasSHBOLC'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DiskId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The disk ID. You can call the ListDisks operation to query the ID of data disk.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'd-bp18kjxg9ebrhsgi****',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure the idempotence of a request?](~~25693~~)', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The ID of the shared custom image.', 'type' => 'string', 'required' => true, 'example' => 'm-2zehv38jjmwva1ee****', 'title' => ''],
],
[
- 'name' => 'Remark',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The remarks of the data disk.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'Maximum value: 50.'."\n"
+ ."\n"
+ .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
@@ -8125,185 +6404,159 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28D****534F ',
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ImageShareUsers' => [
+ 'description' => 'The information about the shared custom images.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the shared custom images.',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['description' => 'The ID of the Alibaba Cloud account whose custom image is shared.', 'type' => 'integer', 'format' => 'int64', 'example' => '125111425233****', 'title' => ''],
+ 'SharedTime' => ['description' => 'The time when the custom image is shared.', 'type' => 'string', 'example' => '2024-07-15 13:59:21.0', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus.ResetDisk',
- 'errorMessage' => 'Rolling back the disk requires the instance to operate in a stopped state.',
- ],
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListCustomImageShareAccounts',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidDiskId.NotFound',
- 'errorMessage' => 'The specified DiskId does not exist.',
- ],
- [
- 'errorCode' => 'InvalidSnapshotId.NotFound',
- 'errorMessage' => 'The specified SnapshotId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListCustomImageShareAccounts',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28D****534F\\\\t\\"\\n}","type":"json"}]',
- 'title' => 'UpdateDiskAttribute',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ImageShareUsers\\": [\\n {\\n \\"UserId\\": 0,\\n \\"SharedTime\\": \\"2024-07-15 13:59:21.0\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'ListDisks' => [
- 'summary' => 'Queries the information about disks in a region.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListCustomImages' => [
+ 'summary' => 'Queries the information about custom images in a region.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '20461',
- 'abilityTreeNodes' => [
- 'FEATUREswasD9DN3T',
- ],
+ 'abilityTreeCode' => '178226',
+ 'abilityTreeNodes' => ['FEATUREswasJBABCT'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the disks.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers corresponding to the custom images. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
- 'name' => 'DiskIds',
+ 'name' => 'ImageIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The IDs of the disks. The value can be a JSON array that consists of up to 100 disk IDs. Separate multiple disk IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["d-bp14wq0149cpp2x****", "d-bp14wq0149cpp2y****"]',
- ],
+ 'schema' => ['description' => 'The image IDs of the simple application server. The value can be a JSON array that consists of up to 100 image IDs. Separate multiple image IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'Maximum value: 100.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'- Maximum value: 100.'."\n"
+ ."\n"
+ .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'DiskType',
+ 'name' => 'ImageNames',
'in' => 'query',
- 'schema' => [
- 'description' => 'The disk type. Valid values:'."\n"
- ."\n"
- .'* system: system disk'."\n"
- .'* data: data disk'."\n"
- ."\n"
- .'By default, system disks and data disks are both queried.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'System',
- ],
+ 'schema' => ['description' => 'The image names of the simple application servers. The value can be a JSON array that consists of up to 100 image names. Separate multiple image names with commas (,).', 'type' => 'string', 'required' => false, 'example' => '["test1****", "test2****"]', 'title' => ''],
+ ],
+ [
+ 'name' => 'SystemSnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the system disk snapshot.', 'type' => 'string', 'required' => false, 'example' => 's-bp14m09pq8***0g6', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataSnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the data disk snapshot.', 'type' => 'string', 'required' => false, 'example' => 's-acscasca****', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The tags that are added to the disks.'."\n",
+ 'description' => 'Tag N of the custom image.',
'type' => 'array',
'items' => [
- 'description' => 'The tags of the disk.',
+ 'description' => 'The tags of the custom image.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The tag key. The tag key can be up to 64 characters in length. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value. The tag value can be up to 64 characters in length. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => 'The key of tag N. A tag key can be 1 to 64 characters in length. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The value of tag N. A tag value can be up to 64 characters in length. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7yj2i', 'title' => ''],
+ ],
+ [
+ 'name' => 'Share',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to query shared images. Valid values:'."\n"
+ ."\n"
+ .'- False: do not query shared images. The shared images are not included in the response.'."\n"
+ ."\n"
+ .'- True: query shared images. The shared images are included in the response.'."\n"
+ ."\n"
+ .'If you do not specify this parameter, all images are returned.', 'type' => 'boolean', 'required' => false, 'example' => 'False', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the simple application server from which the image is derived.', 'type' => 'string', 'required' => false, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
],
'responses' => [
@@ -8311,419 +6564,209 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- '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',
- ],
- 'Disks' => [
- 'description' => 'The queried disks.'."\n",
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'CustomImages' => [
+ 'description' => 'The array of queried custom images.',
'type' => 'array',
'items' => [
+ 'description' => 'The information about the array object.',
'type' => 'object',
'properties' => [
- 'CreationTime' => [
- 'description' => 'The time when the disk was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2021-03-08T05:31:06Z',
- ],
- 'Status' => [
- 'description' => 'The status of the disk. Valid values:'."\n"
- ."\n"
- .'* ReIniting: The disk is being initialized.'."\n"
- .'* Creating: The disk is being created.'."\n"
- .'* In_use: The disk is in use.'."\n"
- .'* Available: The disk can be attached.'."\n"
- .'* Attaching: The disk is being attached.'."\n"
- .'* Detaching: The disk is being detached.'."\n",
- 'type' => 'string',
- 'example' => 'In_use',
- ],
- 'Device' => [
- 'description' => 'The device name of the disk after the disk is attached to the simple application server.'."\n",
- 'type' => 'string',
- 'example' => '/dev/xvda',
- ],
- 'Size' => [
- 'description' => 'The size of the disk. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'DiskName' => [
- 'description' => 'The name of the disk.'."\n",
- 'type' => 'string',
- 'example' => 'SystemDisk',
- ],
- 'DiskChargeType' => [
- 'description' => 'The billing method of the disk.'."\n",
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'DiskType' => [
- 'description' => 'The disk type. Valid values:'."\n"
- ."\n"
- .'* system: system disk'."\n"
- .'* data: data disk'."\n",
- 'type' => 'string',
- 'example' => 'System',
- ],
- 'Category' => [
- 'description' => 'The category of the disk. Valid values:'."\n"
- ."\n"
- .'* ESSD: enhanced SSD (ESSD) of PL0'."\n"
- .'* SSD: standard SSD'."\n"
- .'* CLOUD_EFFICIENCY: ultra disk'."\n",
- 'type' => 'string',
- 'example' => 'ESSD',
- ],
- 'DiskId' => [
- 'description' => 'The disk ID.'."\n",
- 'type' => 'string',
- 'example' => 'd-bp14wq0149cpp2x****',
- ],
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server to which the disk is attached.'."\n",
- 'type' => 'string',
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- 'RegionId' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'Remark' => [
- 'description' => 'The remarks of the disk.'."\n",
- 'type' => 'string',
- 'example' => 'remark',
- ],
+ 'CreationTime' => ['description' => 'The time when the snapshot was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.', 'type' => 'string', 'example' => '2022-10-09T02:28:06Z', 'title' => ''],
+ 'DataSnapshotName' => ['description' => 'The name of the data disk snapshot.', 'type' => 'string', 'example' => 'Data disk snapshot', 'title' => ''],
+ 'SystemSnapshotId' => ['description' => 'The ID of the system disk snapshot.', 'type' => 'string', 'example' => 's-bp1h173hj21puxb***', 'title' => ''],
+ 'InShare' => ['description' => 'Indicates whether the custom image is shared to Elastic Compute Service (ECS).', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'InShareUser' => ['description' => 'Indicates whether the custom image is shared across accounts.', 'type' => 'boolean', 'example' => 'False', 'title' => ''],
+ 'InstanceId' => ['description' => 'The ID of the simple application server from which the image is derived.', 'type' => 'string', 'example' => '2d06ee0520b44de1ae88d4be****', 'title' => ''],
+ 'DataSnapshotId' => ['description' => 'The ID of the data disk snapshot.', 'type' => 'string', 'example' => 's-bp19rn9u8eqzlfb***', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'SystemSnapshotName' => ['description' => 'The name of the system disk snapshot.', 'type' => 'string', 'example' => 'System disk snapshot', 'title' => ''],
+ 'Description' => ['description' => 'The description of the custom image.', 'type' => 'string', 'example' => 'Custom image-1', 'title' => ''],
+ 'Name' => ['description' => 'The name of the custom image.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'ImageId' => ['description' => 'The ID of the custom image.', 'type' => 'string', 'example' => 'm-bp1e79zktg26n2b***', 'title' => ''],
+ 'Status' => ['description' => 'The status of the custom image. Valid values:'."\n"
+ ."\n"
+ .'- 0: copying'."\n"
+ ."\n"
+ .'- 1: available'."\n"
+ ."\n"
+ .'- 2: unavailable'."\n"
+ ."\n"
+ .'- 3: creation failed'."\n"
+ ."\n"
+ .'- 4: creating', 'type' => 'string', 'example' => '1', 'title' => ''],
'Tags' => [
- 'description' => 'The tags that are added to the disks.'."\n",
+ 'description' => 'The tags of the custom image.',
'type' => 'array',
'items' => [
- 'description' => 'The tags of the disk.'."\n",
+ 'description' => 'The tags of the custom image.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => 'The tag key of the custom image.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value of the custom image.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'InstanceName' => [
- 'description' => 'The name of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'myInstance',
- ],
- 'ResourceGroupId' => [
- 'description' => 'The ID of the resource group to which the disk belongs.'."\n",
- 'type' => 'string',
- 'example' => 'rg-aek2bti7cf7****',
+ 'InstanceName' => ['description' => 'The name of the simple application server.', 'type' => 'string', 'example' => 'swas-asdf23***', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-acfm2h2lvp3ublq', 'title' => ''],
+ 'CreateInstances' => [
+ 'description' => 'The simple application servers created from the image.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the simple application server created from the image.', 'type' => 'string', 'example' => '9ffb716db6ae406ca78a476c0c81****', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'UserId' => ['description' => 'The ID of the Alibaba Cloud account to which the image belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '180185828710****', 'title' => ''],
+ 'OsType' => ['description' => 'The operating system type of the image.', 'type' => 'string', 'example' => 'Linux', 'title' => ''],
+ 'RequiredSystemDiskSize' => ['description' => 'The size of the image system disk. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'RequiredDataDiskSize' => ['description' => 'The size of the image data disk. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'SourceImageName' => ['description' => 'The name of the source image that is used to create the simple application server.', 'type' => 'string', 'example' => 'CentOS', 'title' => ''],
+ 'SourceImageVersion' => ['description' => 'The version of the source image that is used to create the simple application server.', 'type' => 'string', 'example' => '8.0', 'title' => ''],
],
- 'description' => 'The information about the disks.'."\n",
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '4', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Disks\\": [\\n {\\n \\"CreationTime\\": \\"2021-03-08T05:31:06Z\\",\\n \\"Status\\": \\"In_use\\",\\n \\"Device\\": \\"/dev/xvda\\",\\n \\"Size\\": 50,\\n \\"DiskName\\": \\"SystemDisk\\",\\n \\"DiskChargeType\\": \\"PrePaid\\",\\n \\"DiskType\\": \\"System\\",\\n \\"Category\\": \\"ESSD\\",\\n \\"DiskId\\": \\"d-bp14wq0149cpp2x****\\",\\n \\"InstanceId\\": \\"2ad1ae67295445f598017499dc****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Remark\\": \\"remark\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"InstanceName\\": \\"myInstance\\",\\n \\"ResourceGroupId\\": \\"rg-aek2bti7cf7****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDisksResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Disks>\\n <CreationTime>2021-03-08T05:31:06Z</CreationTime>\\n <Status>In_use</Status>\\n <Device>/dev/xvda</Device>\\n <Size>50</Size>\\n <DiskName>SystemDisk</DiskName>\\n <DiskChargeType>PrePaid</DiskChargeType>\\n <DiskType>System</DiskType>\\n <Category>ESSD</Category>\\n <DiskId>d-bp14wq0149cpp2x****</DiskId>\\n <InstanceId>2ad1ae67295445f598017499dc****</InstanceId>\\n <RegionId>cn-hangzhou</RegionId>\\n <Remark>dataDisk</Remark>\\n <InstanceName>myInstance</InstanceName>\\n </Disks>\\n</ListDisksResponse>","errorExample":""}]',
- 'title' => 'ListDisks',
- 'description' => 'The `InstanceId`, `DiskIds`, and `ResourceGroupId` parameters are optional. However, you can specify them as filter conditions and combine them with the logical AND operator to filter disks that you want to query.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ResetDisk' => [
- 'summary' => 'Rolls back a disk based on a snapshot.',
- 'methods' => [
- 'post',
- 'get',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"CustomImages\\": [\\n {\\n \\"CreationTime\\": \\"2022-10-09T02:28:06Z\\",\\n \\"DataSnapshotName\\": \\"Data disk snapshot\\",\\n \\"SystemSnapshotId\\": \\"s-bp1h173hj21puxb***\\",\\n \\"InShare\\": false,\\n \\"InShareUser\\": true,\\n \\"InstanceId\\": \\"2d06ee0520b44de1ae88d4be****\\",\\n \\"DataSnapshotId\\": \\"s-bp19rn9u8eqzlfb***\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SystemSnapshotName\\": \\"System disk snapshot\\",\\n \\"Description\\": \\"Custom image-1\\",\\n \\"Name\\": \\"test\\",\\n \\"ImageId\\": \\"m-bp1e79zktg26n2b***\\",\\n \\"Status\\": \\"1\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"InstanceName\\": \\"swas-asdf23***\\",\\n \\"ResourceGroupId\\": \\"rg-acfm2h2lvp3ublq\\",\\n \\"CreateInstances\\": [\\n \\"9ffb716db6ae406ca78a476c0c81****\\"\\n ],\\n \\"UserId\\": 0,\\n \\"OsType\\": \\"Linux\\",\\n \\"RequiredSystemDiskSize\\": 20,\\n \\"RequiredDataDiskSize\\": 20,\\n \\"SourceImageName\\": \\"CentOS\\",\\n \\"SourceImageVersion\\": \\"8.0\\"\\n }\\n ],\\n \\"TotalCount\\": \\"4\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\"\\n}","type":"json"}]',
+ 'title' => 'ListCustomImages',
+ 'changeSet' => [
+ ['createdAt' => '2024-10-09T09:23:10.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-07-02T08:00:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-02-20T03:36:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCustomImages'],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server for which the snapshot is created.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'DiskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the disk to be rolled back.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'd-bp14wq0149cpp2xy****',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
- ],
- [
- 'name' => 'SnapshotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The snapshot ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-bp16oazlsold4dks****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListCustomImages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/*'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#CustomImageId}'],
],
- 'description' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus.ResetDisk',
- 'errorMessage' => 'Rolling back the disk requires the instance to operate in a stopped state.',
- ],
- ],
- [
- [
- 'errorCode' => 'InvalidDiskId.NotFound',
- 'errorMessage' => 'The specified DiskId does not exist.',
- ],
- [
- 'errorCode' => 'InvalidSnapshotId.NotFound',
- 'errorMessage' => 'The specified SnapshotId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetDiskResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n</ResetDiskResponse>","errorExample":""}]',
- 'title' => 'ResetDisk',
- 'description' => '* You can call this operation only if the associated simple application server is in the Stopped state.'."\n"
- .'* If you restore a disk from a snapshot, the incremental data after the snapshot is created is lost. We recommend that you back up the data before you perform this operation.'."\n"
- ."\n"
- .'### [](#)Precautions'."\n"
- ."\n"
- .'Resetting the system or changing the image of a simple application server clears the disk data on the server. Snapshots created before the reset or change are retained but cannot be used to restore disks.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'translator' => 'manual',
],
- 'CreateCustomImage' => [
- 'summary' => 'Creates a custom image based on a snapshot of a simple application server.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDisks' => [
+ 'summary' => 'Queries the information about disks in a region.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '65793',
- 'abilityTreeNodes' => [
- 'FEATUREswas5OS8L3',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '20461',
+ 'abilityTreeNodes' => ['FEATUREswasD9DN3T'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the database. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The region ID of the disks.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => false, 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
],
[
- 'name' => 'ImageName',
+ 'name' => 'DiskIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the custom image. The name must be 2 to 128 characters in length, and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter or a digit. This parameter is empty by default.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'customImage-test',
- ],
+ 'schema' => ['description' => 'The IDs of the disks. The value can be a JSON array that consists of up to 100 disk IDs. Separate multiple disk IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '["d-bp14wq0149cpp2x****", "d-bp14wq0149cpp2y****"]', 'title' => ''],
],
[
- 'name' => 'SystemSnapshotId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the system disk snapshot.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-acscasca****',
- ],
+ 'schema' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'Maximum value: 100.'."\n"
+ ."\n"
+ .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The description of the custom image.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'DataSnapshotId',
+ 'name' => 'DiskType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the data disk snapshot.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-acscasca****',
- ],
+ 'schema' => ['description' => 'The disk type. Valid values:'."\n"
+ ."\n"
+ .'- system: system disk'."\n"
+ ."\n"
+ .'- data: data disk'."\n"
+ ."\n"
+ .'By default, system disks and data disks are both queried.', 'type' => 'string', 'required' => false, 'example' => 'system', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The tags that you want to add to the custom image. You can specify up to 20 tags.'."\n",
+ 'description' => 'The tags that are added to the disks.',
'type' => 'array',
'items' => [
- 'description' => 'The tags of the custom image.',
+ 'description' => 'The tags of the disk.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The key of tag N that you want to add to the custom image. Valid values of N: 1 to 20.'."\n"
- ."\n"
- .'The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The value of tag N that you want to add to the custom image. Valid values of N: 1 to 20.'."\n"
- ."\n"
- .'The tag value can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => 'The tag key. The tag key can be up to 64 characters in length. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value. The tag value can be up to 64 characters in length. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The resource group ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****', 'title' => ''],
],
],
'responses' => [
@@ -8731,261 +6774,188 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****',
- ],
- 'ImageId' => [
- 'description' => 'The custom image ID.'."\n",
- 'type' => 'string',
- 'example' => 'm-csaascsaccscs****',
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Disks' => [
+ 'description' => 'The queried disks.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CreationTime' => ['description' => 'The time when the disk was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2021-03-08T05:31:06Z', 'title' => ''],
+ 'Status' => ['description' => 'The status of the disk. Valid values:'."\n"
+ ."\n"
+ .'- ReIniting: The disk is being initialized.'."\n"
+ ."\n"
+ .'- Creating: The disk is being created.'."\n"
+ ."\n"
+ .'- In\\_use: The disk is in use.'."\n"
+ ."\n"
+ .'- Available: The disk can be attached.'."\n"
+ ."\n"
+ .'- Attaching: The disk is being attached.'."\n"
+ ."\n"
+ .'- Detaching: The disk is being detached.', 'type' => 'string', 'example' => 'In_use', 'title' => ''],
+ 'Device' => ['description' => 'The device name of the disk after the disk is attached to the simple application server.', 'type' => 'string', 'example' => '/dev/xvda', 'title' => ''],
+ 'Size' => ['description' => 'The size of the disk. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'DiskName' => ['description' => 'The name of the disk.', 'type' => 'string', 'example' => 'SystemDisk', 'title' => ''],
+ 'DiskChargeType' => ['description' => 'The billing method of the disk.', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''],
+ 'DiskType' => ['description' => 'The disk type. Valid values:'."\n"
+ ."\n"
+ .'- system: system disk'."\n"
+ ."\n"
+ .'- data: data disk', 'type' => 'string', 'example' => 'System', 'title' => ''],
+ 'Category' => ['description' => 'The category of the disk. Valid values:'."\n"
+ ."\n"
+ .'- ESSD: enhanced SSD (ESSD) of PL0'."\n"
+ ."\n"
+ .'- SSD: standard SSD'."\n"
+ ."\n"
+ .'- CLOUD\\_EFFICIENCY: ultra disk', 'type' => 'string', 'example' => 'ESSD', 'title' => ''],
+ 'DiskId' => ['description' => 'The disk ID.', 'type' => 'string', 'example' => 'd-bp14wq0149cpp2x****', 'title' => ''],
+ 'InstanceId' => ['description' => 'The ID of the simple application server to which the disk is attached.', 'type' => 'string', 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks of the disk.', 'type' => 'string', 'example' => 'remark', 'title' => ''],
+ 'Tags' => [
+ 'description' => 'The tags that are added to the disks.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags of the disk.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'InstanceName' => ['description' => 'The name of the simple application server.', 'type' => 'string', 'example' => 'myInstance', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the disk belongs.', 'type' => 'string', 'example' => 'rg-aek2bti7cf7****', 'title' => ''],
+ ],
+ 'description' => 'The information about the disks.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParam.DataSnapshotIdNotFound',
- 'errorMessage' => 'The specified parameter dataSnapshotId is not found.',
- ],
- [
- 'errorCode' => 'InvalidParam.SystemSnapshotIdNotFound',
- 'errorMessage' => 'The specified parameter systemSnapshotId is not found.',
- ],
- [
- 'errorCode' => 'InvalidParam.IllegalImageName',
- 'errorMessage' => 'The specified parameter imageName is illegal.',
- ],
- [
- 'errorCode' => 'ImageNameAlreadyExist',
- 'errorMessage' => 'The image name already exists.',
- ],
- [
- 'errorCode' => 'CustomImageQuotaLimit',
- 'errorMessage' => 'The maximum number of custom image in this region is exceeded.',
- ],
- [
- 'errorCode' => 'InvalidParam.SystemSnapshotIdNotSupport',
- 'errorMessage' => 'You cannot create custom images in the specified parameter system snapshotId.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus',
- 'errorMessage' => 'The state of the current instance does not support this operation.',
- ],
- ],
- [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"ImageId\\": \\"m-csaascsaccscs****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCustomImageResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <ImageId>m-csaascsaccscs****</ImageId>\\n</CreateCustomImageResponse>","errorExample":""}]',
- 'title' => 'CreateCustomImage',
- 'description' => 'A custom image is created from a snapshot of a simple application server. You can use a custom image to create multiple simple application servers that have the same configurations. You can also share custom images to ECS and use the shared images to create ECS instances or replace the OSs of existing ECS instances. For more information about custom images, see [Overview of custom images](~~199375~~).'."\n"
- ."\n"
- .'You must create a system disk snapshot of a simple application server before you create a custom image based on the snapshot. For more information, see [CreateSnapshot](~~190452~~).'."\n"
- ."\n"
- .'> If you need the data on the data disk of a simple application server when you create a custom image, create a snapshot for the data disk first.'."\n"
- ."\n"
- .'Before you create a custom image, take note of the following items:'."\n"
- ."\n"
- .'* The custom image and the corresponding simple application server must reside in the same region.'."\n"
- .'* The maximum number of custom images that you can create is 3 times the number of simple application servers that you have, but cannot exceed 15.'."\n"
- .'* You can directly create a custom image only based on the system disk snapshot of a simple application server. If you want a custom image to contain the data on the data disk of the simple application server, you must select a data disk snapshot in addition to a system disk snapshot when you create the custom image.'."\n"
- .'* If a simple application server is released due to expiration or refunds, the custom images that are created based on the server are also released.'."\n"
- .'* Resetting the system or changing the image of a simple application server clears the disk data on the server. Back up the data as needed.'."\n",
+ 'title' => 'ListDisks',
+ 'description' => 'The `InstanceId`, `DiskIds`, and `ResourceGroupId` parameters are optional. However, you can specify them as filter conditions and combine them with the logical AND operator to filter disks that you want to query.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListCustomImages' => [
- 'summary' => 'Queries the information about custom images in a region.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-29T02:22:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-02-20T03:36:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2023-05-25T10:47:56.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2021-08-23T11:45:06.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDisks'],
+ ],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListDisks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Disk', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:disk/{#DiskId}'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Disk', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:disk/*'],
+ ],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '178226',
- 'abilityTreeNodes' => [
- 'FEATUREswasJBABCT',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Disks\\": [\\n {\\n \\"CreationTime\\": \\"2021-03-08T05:31:06Z\\",\\n \\"Status\\": \\"In_use\\",\\n \\"Device\\": \\"/dev/xvda\\",\\n \\"Size\\": 50,\\n \\"DiskName\\": \\"SystemDisk\\",\\n \\"DiskChargeType\\": \\"PrePaid\\",\\n \\"DiskType\\": \\"System\\",\\n \\"Category\\": \\"ESSD\\",\\n \\"DiskId\\": \\"d-bp14wq0149cpp2x****\\",\\n \\"InstanceId\\": \\"2ad1ae67295445f598017499dc****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Remark\\": \\"remark\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"InstanceName\\": \\"myInstance\\",\\n \\"ResourceGroupId\\": \\"rg-aek2bti7cf7****\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListFirewallRules' => [
+ 'summary' => 'Queries the firewall rules of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
],
],
+ 'operationType' => 'read',
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers corresponding to the custom images. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
- ],
- [
- 'name' => 'ImageIds',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The image IDs of the simple application server. The value can be a JSON array that consists of up to 100 image IDs. Separate multiple image IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'* Maximum value: 100.'."\n"
- .'* Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'Maximum value: 100.'."\n"
+ ."\n"
+ .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'ImageNames',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The image names of the simple application servers. The value can be a JSON array that consists of up to 100 image names. Separate multiple image names with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["test1****", "test2****"]',
- ],
- ],
- [
- 'name' => 'SystemSnapshotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the system disk snapshot.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bp14m09pq8***0g6',
- ],
- ],
- [
- 'name' => 'DataSnapshotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the data disk snapshot.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-acscasca****',
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Pages start from page 1.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'Tag N of the custom image.'."\n",
+ 'description' => 'The tags of the firewall rule.',
'type' => 'array',
'items' => [
- 'description' => 'The tags of the custom image.',
+ 'description' => 'The tag of the firewall rule.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The key of tag N. A tag key can be 1 to 64 characters in length. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The value of tag N. A tag value can be up to 64 characters in length. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => 'The tag key. A tag key must be 1 to 64 characters in length. You can add up to 20 tags.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value. A tag value must be 1 to 64 characters in length. You can add up to 20 tags.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7yj2i',
- ],
- ],
- [
- 'name' => 'Share',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to query shared images. Valid values:'."\n"
- ."\n"
- .'* False: do not query shared images. The shared images are not included in the response.'."\n"
- .'* True: query shared images. The shared images are included in the response.'."\n"
- ."\n"
- .'If you do not specify this parameter, all images are returned.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'False',
- ],
- ],
- [
- 'name' => 'InstanceId',
+ 'name' => 'FirewallRuleId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server from which the image is derived.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The ID of the firewall rule.', 'type' => 'string', 'required' => false, 'example' => '1a16263ab0f541288312a15fa64280de', 'title' => ''],
],
],
'responses' => [
@@ -8993,263 +6963,145 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'CustomImages' => [
- 'description' => 'The array of queried custom images.'."\n",
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'FirewallRules' => [
+ 'description' => 'Details of the firewall rules.',
'type' => 'array',
'items' => [
- 'description' => 'The information about the array object.'."\n",
'type' => 'object',
'properties' => [
- 'CreationTime' => [
- 'description' => 'The time when the snapshot was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2022-10-09T02:28:06Z',
- ],
- 'DataSnapshotName' => [
- 'description' => 'The name of the data disk snapshot.'."\n",
- 'type' => 'string',
- 'example' => 'data disk snapshot',
- ],
- 'SystemSnapshotId' => [
- 'description' => 'The ID of the system disk snapshot.'."\n",
- 'type' => 'string',
- 'example' => 's-bp1h173hj21puxb***',
- ],
- 'InShare' => [
- 'description' => 'Indicates whether the custom image is shared to Elastic Compute Service (ECS).'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'InShareUser' => [
- 'description' => 'Indicates whether the custom image is shared across accounts.'."\n",
- 'type' => 'boolean',
- 'example' => 'False',
- ],
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server from which the image is derived.'."\n",
- 'type' => 'string',
- 'example' => '2d06ee0520b44de1ae88d4be****',
- ],
- 'DataSnapshotId' => [
- 'description' => 'The ID of the data disk snapshot.'."\n",
- 'type' => 'string',
- 'example' => 's-bp19rn9u8eqzlfb***',
- ],
- 'RegionId' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'SystemSnapshotName' => [
- 'description' => 'The name of the system disk snapshot.'."\n",
- 'type' => 'string',
- 'example' => 'system disk snapshot',
- ],
- 'Description' => [
- 'description' => 'The description of the custom image.'."\n",
- 'type' => 'string',
- 'example' => 'test-custom-image',
- ],
- 'Name' => [
- 'description' => 'The name of the custom image.'."\n",
- 'type' => 'string',
- 'example' => 'hua',
- ],
- 'ImageId' => [
- 'description' => 'The ID of the custom image.'."\n",
- 'type' => 'string',
- 'example' => 'm-bp1e79zktg26n2b***',
- ],
- 'Status' => [
- 'description' => 'The status of the custom image. Valid values:'."\n"
- ."\n"
- .'* 0: copying'."\n"
- .'* 1: available'."\n"
- .'* 2: unavailable'."\n"
- .'* 3: creation failed'."\n"
- .'* 4: creating'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'Remark' => ['description' => 'The remarks of the firewall rule.', 'type' => 'string', 'example' => 'Test - MySQL server default port', 'title' => ''],
+ 'Port' => ['description' => 'The port range.', 'type' => 'string', 'example' => '3306', 'title' => ''],
+ 'RuleId' => ['description' => 'The ID of the firewall rule.', 'type' => 'string', 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****', 'title' => ''],
+ 'RuleProtocol' => ['description' => 'The transport layer protocol. Valid values:'."\n"
+ ."\n"
+ .'- TCP'."\n"
+ ."\n"
+ .'- UDP'."\n"
+ ."\n"
+ .'- TCP+UDP', 'type' => 'string', 'example' => 'TCP', 'title' => ''],
+ 'Policy' => ['description' => 'The firewall policy. Valid values:'."\n"
+ ."\n"
+ .'- accept: Access is allowed.'."\n"
+ ."\n"
+ .'- drop: Access is refused.', 'type' => 'string', 'example' => 'accept', 'title' => ''],
'Tags' => [
- 'description' => 'The tags of the custom image.'."\n",
+ 'description' => 'The tags of the firewall rule.',
'type' => 'array',
'items' => [
- 'description' => 'The tags of the custom image.',
+ 'description' => 'The tag of the firewall rule.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The tag key of the custom image.'."\n",
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value of the custom image.'."\n",
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'InstanceName' => [
- 'description' => 'The name of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'swas-asdf23***',
- ],
- 'ResourceGroupId' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'example' => 'rg-acfm2h2lvp3ublq',
- ],
- 'CreateInstances' => [
- 'description' => 'The simple application servers created from the image.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the simple application server created from the image.'."\n",
- 'type' => 'string',
- 'example' => '9ffb716db6ae406ca78a476c0c81****',
- ],
- ],
- 'UserId' => [
- 'description' => 'The ID of the Alibaba Cloud account to which the image belongs.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '180185828710****',
- ],
- 'OsType' => [
- 'description' => 'The operating system type of the image.'."\n",
- 'type' => 'string',
- 'example' => 'Linux',
- ],
- 'RequiredSystemDiskSize' => [
- 'description' => 'The size of the image system disk. Unit: GiB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'RequiredDataDiskSize' => [
- 'description' => 'The size of the image data disk. Unit: GiB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'SourceImageName' => [
- 'description' => 'The name of the source image that is used to create the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'CentOS',
- ],
- 'SourceImageVersion' => [
- 'description' => 'The version of the source image that is used to create the simple application server.'."\n",
- 'type' => 'string',
- 'example' => '8.0',
- ],
+ 'SourceCidrIp' => ['description' => 'The source CIDR block.', 'type' => 'string', 'example' => '0.0.0.0/0', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'string',
- 'example' => '4',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'string',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'string',
- 'example' => '1',
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter value is invalid.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 4,\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"FirewallRules\\": [\\n {\\n \\"Remark\\": \\"Test - MySQL server default port\\",\\n \\"Port\\": \\"3306\\",\\n \\"RuleId\\": \\"eeea34d9867b4d55a4ff8d5fcfbd****\\",\\n \\"RuleProtocol\\": \\"TCP\\",\\n \\"Policy\\": \\"accept\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"SourceCidrIp\\": \\"0.0.0.0/0\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListFirewallRules',
+ 'description' => 'You can call the ListFirewallRules operation to query the firewall rule details of a simple application server, including the port range, firewall rule ID, and transport layer protocol.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-02-20T03:36:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2023-05-25T10:51:19.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-08-23T11:45:06.000Z', 'description' => 'Request parameters changed'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"CustomImages\\": [\\n {\\n \\"CreationTime\\": \\"2022-10-09T02:28:06Z\\",\\n \\"DataSnapshotName\\": \\"数据盘快照\\",\\n \\"SystemSnapshotId\\": \\"s-bp1h173hj21puxb***\\",\\n \\"InShare\\": false,\\n \\"InShareUser\\": true,\\n \\"InstanceId\\": \\"2d06ee0520b44de1ae88d4be****\\",\\n \\"DataSnapshotId\\": \\"s-bp19rn9u8eqzlfb***\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SystemSnapshotName\\": \\"系统盘快照\\",\\n \\"Description\\": \\"自定义镜像-1\\",\\n \\"Name\\": \\"test\\",\\n \\"ImageId\\": \\"m-bp1e79zktg26n2b***\\",\\n \\"Status\\": \\"1\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"InstanceName\\": \\"swas-asdf23***\\",\\n \\"ResourceGroupId\\": \\"rg-acfm2h2lvp3ublq\\",\\n \\"CreateInstances\\": [\\n \\"9ffb716db6ae406ca78a476c0c81****\\"\\n ],\\n \\"UserId\\": 0,\\n \\"OsType\\": \\"Linux\\",\\n \\"RequiredSystemDiskSize\\": 20,\\n \\"RequiredDataDiskSize\\": 20,\\n \\"SourceImageName\\": \\"CentOS\\",\\n \\"SourceImageVersion\\": \\"8.0\\"\\n }\\n ],\\n \\"TotalCount\\": \\"4\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\"\\n}","type":"json"}]',
- 'title' => 'ListCustomImages',
- ],
- 'ModifyImageShareStatus' => [
- 'summary' => 'Shares or unshares a custom image to Elastic Compute Service (ECS).',
- 'methods' => [
- 'post',
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListFirewallRules'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListFirewallRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'ListImages' => [
+ 'summary' => 'Queries the information about images in a region.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswas8F6GI9'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the custom image. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The region ID of the images. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ImageId',
+ 'name' => 'ImageIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The image ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-saacssasc****',
- ],
+ 'schema' => ['description' => 'The image IDs. The value can be a JSON array that consists of up to 50 image IDs. Format: `["xxx", "yyy", … "zzz"]`. Separate multiple image IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]', 'title' => ''],
],
[
- 'name' => 'Operation',
+ 'name' => 'ImageType',
'in' => 'query',
- 'schema' => [
- 'description' => 'Valid values:'."\n"
- ."\n"
- .'* Share'."\n"
- .'* UnShare'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Share',
- ],
+ 'schema' => ['description' => 'The type of the images. Valid values:'."\n"
+ ."\n"
+ .'- system: OS images'."\n"
+ ."\n"
+ .'- app: application images'."\n"
+ ."\n"
+ .'- custom: custom images', 'type' => 'string', 'required' => false, 'example' => 'system', 'title' => ''],
],
],
'responses' => [
@@ -9257,161 +7109,195 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'Images' => [
+ 'description' => 'Details of the queried images.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the image.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageType' => ['description' => 'The type of the image. Valid values:'."\n"
+ ."\n"
+ .'- system'."\n"
+ ."\n"
+ .'- app'."\n"
+ ."\n"
+ .'- custom', 'type' => 'string', 'example' => 'app', 'title' => ''],
+ 'Description' => ['description' => 'The description of the image.', 'type' => 'string', 'example' => 'WordPress is a popular and powerful platform that allows you to build blogs and content management websites and implement custom features by using third-party templates and plug-ins. This WordPress image is built based on CentOS 7.9, PHP 7.4, MySQL 5.7, and Apache 2.4.', 'title' => ''],
+ 'ImageName' => ['description' => 'The name of the image.', 'type' => 'string', 'example' => 'WordPress-4.8.1', 'title' => ''],
+ 'ImageId' => ['description' => 'The ID of the image.', 'type' => 'string', 'example' => '794c230fd3e64ea19f83f4d7a0ad****', 'title' => ''],
+ 'Platform' => ['description' => 'The operating system type of the image. Valid values:'."\n"
+ ."\n"
+ .'- Linux'."\n"
+ ."\n"
+ .'- Windows', 'type' => 'string', 'example' => 'Linux', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParam.OperationIllegal',
- 'errorMessage' => 'The specified parameter operation is illegal.',
- ],
+ ['errorCode' => 'InvalidImageType.ValueNotSupported', 'errorMessage' => 'The specified parameter ImageType is invalid.', 'description' => ''],
],
- 404 => [
- [
- 'errorCode' => 'InvalidImageId.NotFound',
- 'errorMessage' => 'The specified ImageId does not exist.',
- ],
+ 403 => [
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter value is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyImageShareStatusResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****</RequestId>\\n</ModifyImageShareStatusResponse>","errorExample":""}]',
- 'title' => 'ModifyImageShareStatus',
- 'description' => 'Custom images can be shared to ECS. If the configurations of your simple application server cannot meet your business requirements, or you want to deploy your business on ECS instances, you can share your custom image to ECS to transfer your business from Simple Application Server to ECS.'."\n"
- ."\n"
- .'> The region in which the shared image resides in ECS is the same as the region in which the custom image resides in Simple Application Server.'."\n"
- ."\n"
- .'You can unshare a custom image based on your business requirements or when you want to delete the custom image. After you unshare a custom image, take note of the following items:'."\n"
- ."\n"
- .'* You cannot query or use the custom image by using the ECS console or API.'."\n"
- .'* You cannot re-initialize the disks of the ECS instances that were created based on the shared image.'."\n",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"Images\\": [\\n {\\n \\"ImageType\\": \\"app\\",\\n \\"Description\\": \\"WordPress is a popular and powerful platform that allows you to build blogs and content management websites and implement custom features by using third-party templates and plug-ins. This WordPress image is built based on CentOS 7.9, PHP 7.4, MySQL 5.7, and Apache 2.4.\\",\\n \\"ImageName\\": \\"WordPress-4.8.1\\",\\n \\"ImageId\\": \\"794c230fd3e64ea19f83f4d7a0ad****\\",\\n \\"Platform\\": \\"Linux\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListImages',
+ 'description' => 'You can query details about one or more images in a specified region, including the IDs, names, and types of the images.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'AddCustomImageShareAccount' => [
- 'summary' => 'Shares a custom image with other Alibaba Cloud accounts in the same region to quickly deploy the same environment configurations for multiple simple application servers at a time. This improves deployment efficiency.',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListImages'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListImages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'ListInstancePlansModification' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227269',
- 'abilityTreeNodes' => [
- 'FEATUREswasJBABCT',
- ],
+ 'abilityTreeNodes' => ['FEATUREswasOLUWJH'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
- ],
- [
- 'name' => 'ImageId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the custom image.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-saacssasc****',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Account',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The IDs of the Alibaba Cloud accounts with which you want to share the custom image.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the Alibaba Cloud account with which you want to share the custom image.'."\n"
- ."\n"
- .'> You can share a custom image with a maximum of 10 Alibaba Cloud accounts at a time.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '125111425233****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'The ID of the Simple Application Server instance.', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The schema of response.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'Plans' => [
+ 'description' => 'The array of plans.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Core' => ['description' => 'The number of vCPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Bandwidth' => ['description' => 'The peak bandwidth. Unit: Mbps.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'DiskSize' => ['description' => 'The disk capacity. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''],
+ 'Flow' => ['description' => 'The monthly traffic. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''],
+ 'Memory' => ['description' => 'The memory size. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PlanId' => ['description' => 'The plan ID.', 'type' => 'string', 'example' => 'swas.s2.c2m1s40b3t04', 'title' => ''],
+ 'DiskType' => ['description' => 'The disk type. Valid values:'."\n"
+ ."\n"
+ .'- SSD: a standard SSD.'."\n"
+ ."\n"
+ .'- ESSD: an Enhanced SSD (ESSD) at performance level (PL) 0.'."\n"
+ ."\n"
+ .'- CLOUD\\_EFFICIENCY: an ultra disk.', 'type' => 'string', 'example' => 'ESSD', 'title' => ''],
+ 'OriginPrice' => ['description' => 'The price of the plan.', 'type' => 'number', 'format' => 'double', 'example' => '60', 'title' => ''],
+ 'Currency' => ['description' => 'The unit of the price. Valid values:'."\n"
+ ."\n"
+ .'- CNY: Chinese Yuan'."\n"
+ ."\n"
+ .'- USD: US Dollar', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'SupportPlatform' => ['description' => 'The operating systems supported by the plan.', 'type' => 'string', 'example' => '["Linux","Windows"]', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => 'AddCustomImageShareAccount',
- 'description' => '* Before you share a custom image, make sure that all sensitive data and files are removed from the image.'."\n"
- .'* The IDs of the Alibaba Cloud accounts with which you want to share the image is obtained. Move the pointer over the profile in the upper-right corner of the Simple Application Server console. In the card that appears, if Main Account is displayed, the showed account ID is the Alibaba Cloud account ID.'."\n",
- ],
- 'ListCustomImageShareAccounts' => [
- 'summary' => 'Queries information about custom images that are shared across Alibaba Cloud accounts in a region.',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => 'ListInstancePlansModification',
+ 'summary' => 'This topic describes the list of plans to which a specified simple application server can be upgraded.',
+ 'description' => 'As your business grows, the resources of a purchased server may no longer meet your requirements. Retrieve the list of plans to which the current server can be upgraded, then call the [UpgradeInstance](~~190445~~) to upgrade.'."\n"
+ ."\n"
+ .'> We recommend that you create a snapshot of the disk of the server to back up data before you upgrade the instance. For more information, see [CreateSnapshot](~~190452~~).'."\n"
+ ."\n"
+ .'For more information about the limits on instance configuration upgrades, see [Upgrade instance configurations](~~61433~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListInstancePlansModification'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListInstancePlansModification',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Plans\\": [\\n {\\n \\"Core\\": 2,\\n \\"Bandwidth\\": 200,\\n \\"DiskSize\\": 40,\\n \\"Flow\\": 400,\\n \\"Memory\\": 1,\\n \\"PlanId\\": \\"swas.s2.c2m1s40b3t04\\",\\n \\"DiskType\\": \\"ESSD\\",\\n \\"OriginPrice\\": 60,\\n \\"Currency\\": \\"CNY\\",\\n \\"SupportPlatform\\": \\"[\\\\\\"Linux\\\\\\",\\\\\\"Windows\\\\\\"]\\"\\n }\\n ],\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
+ ],
+ 'ListInstanceStatus' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9419,71 +7305,27 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'abilityTreeCode' => '225369',
- 'abilityTreeNodes' => [
- 'FEATUREswasJBABCT',
- 'FEATUREswasSHBOLC',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure the idempotence of a request?](~~25693~~)'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]', 'title' => ''],
],
[
- 'name' => 'ImageId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the shared custom image.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-2zehv38jjmwva1ee****',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'Maximum value: 50.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -9491,310 +7333,474 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- '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',
- ],
- 'ImageShareUsers' => [
- 'description' => 'The information about the shared custom images.'."\n",
+ 'InstanceStatuses' => [
+ 'description' => 'The ID of the simple application server.',
'type' => 'array',
'items' => [
- 'description' => 'The information about the shared custom images.'."\n",
+ 'description' => 'The status information of the instances.',
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'description' => 'The ID of the Alibaba Cloud account whose custom image is shared.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '125111425233****',
- ],
- 'SharedTime' => [
- 'description' => 'The time when the custom image is shared.'."\n",
- 'type' => 'string',
- 'example' => '2024-07-15 13:59:21.0',
- ],
+ 'Status' => ['description' => 'The status of the simple application server. Valid values:'."\n"
+ ."\n"
+ .'- Pending'."\n"
+ ."\n"
+ .'- Starting'."\n"
+ ."\n"
+ .'- Running'."\n"
+ ."\n"
+ .'- Stopping'."\n"
+ ."\n"
+ .'- Stopped'."\n"
+ ."\n"
+ .'- Resetting'."\n"
+ ."\n"
+ .'- Upgrading'."\n"
+ ."\n"
+ .'- Disabled', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'InstanceId' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'example' => 'a9a6474b935d41bcb531250bb5d****', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '54', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ImageShareUsers\\": [\\n {\\n \\"UserId\\": 0,\\n \\"SharedTime\\": \\"2024-07-15 13:59:21.0\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListCustomImageShareAccounts',
- ],
- 'RemoveCustomImageShareAccount' => [
- 'summary' => 'Unshares a custom image that is shared across Alibaba Cloud accounts.',
- 'methods' => [
- 'post',
+ 'title' => 'ListInstanceStatus',
+ 'summary' => 'Queries the status of simple application servers.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListInstanceStatus'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListInstanceStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceStatuses\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"InstanceId\\": \\"a9a6474b935d41bcb531250bb5d****\\"\\n }\\n ],\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 54\\n}","type":"json"}]',
+ ],
+ 'ListInstances' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
- 'abilityTreeCode' => '227271',
- 'abilityTreeNodes' => [
- 'FEATUREswasSHBOLC',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '20464',
+ 'abilityTreeNodes' => ['FEATUREswas8F6GI9'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The instance IDs of the simple application servers. The value can be a JSON array that consists of up to 100 instance IDs. Separate multiple IDs with commas (,).'."\n"
+ ."\n"
+ .'> If you specify both `InstanceIds` and `PublicIpAddresses`, the instance IDs and public IP addresses must belong to the same simple application server. Otherwise, an empty result is returned.', 'type' => 'string', 'required' => false, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]', 'title' => ''],
],
[
- 'name' => 'ImageId',
+ 'name' => 'ChargeType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the shared custom image.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-2zehv38jjmwva1ee****',
- ],
+ 'schema' => ['description' => 'The billing method of the instances. Valid values: PrePaid. Only subscription is supported.'."\n"
+ ."\n"
+ .'Default value: PrePaid.', 'type' => 'string', 'required' => false, 'example' => 'PrePaid', 'title' => ''],
],
[
- 'name' => 'Account',
+ 'name' => 'PublicIpAddresses',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The public IP addresses of the simple application servers. The value can be a JSON array that consists of up to 100 public IP addresses. Separate multiple addresses with commas (,).'."\n"
+ ."\n"
+ .'> If you specify both `InstanceIds` and `PublicIpAddresses`, the instance IDs and public IP addresses must belong to the same simple application server. Otherwise, an empty result is returned.', 'type' => 'string', 'required' => false, 'example' => '["42.1.**.**", "42.2.**.**"]', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number of the simple application server list.'."\n"
+ ."\n"
+ .'Default value: 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page for paging. Maximum value: 100.'."\n"
+ ."\n"
+ .'Default value: 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance status. Valid values:'."\n"
+ ."\n"
+ .'- Pending: being prepared.'."\n"
+ .'- Starting: starting.'."\n"
+ .'- Running: running.'."\n"
+ .'- Stopping: stopping.'."\n"
+ .'- Stopped: stopped.'."\n"
+ .'- Resetting: being reset.'."\n"
+ .'- Upgrading: being upgraded.'."\n"
+ .'- Disabled: unavailable.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The IDs of the Alibaba Cloud accounts with which you want to unshare the image.'."\n",
+ 'description' => 'The tags of the instances.',
'type' => 'array',
'items' => [
- 'description' => 'The ID of the Alibaba Cloud account with which you want to unshare the image.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => 'The tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key of the instance. The tag key must be 1 to 64 characters in length. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value of the instance. The tag value must be 1 to 64 characters in length. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
+ ],
'required' => false,
- 'example' => '125111425233****',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => true,
+ 'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The schema of response.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => 'RemoveCustomImageShareAccount',
- ],
- 'DeleteCustomImage' => [
- 'summary' => 'Deletes a custom image.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the custom image. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The resource group ID of the simple application servers.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The name of the simple application server instance. Wildcard character (*) is supported for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'ImageId',
+ 'name' => 'PlanType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The custom image ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-2zehv38jjmwva1ee****',
- ],
+ 'schema' => ['description' => 'The plan type. Valid values:'."\n"
+ ."\n"
+ .'- NORMAL: general-purpose.'."\n"
+ .'- CAPACITY: storage-optimized.'."\n"
+ .'- PREVIOUS: previous generation.'."\n"
+ .'- MULTI_IP: multiple public IP addresses.'."\n"
+ .'- INTERNATIONAL: international.'."\n"
+ ."\n"
+ .'> For more information, see [Instance family](~~2861773~~).', 'type' => 'string', 'required' => false, 'example' => 'NORMAL', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The instance information.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'Instances' => [
+ 'description' => 'The array of simple application server information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The array of simple application server information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The instance status. Valid values:'."\n"
+ ."\n"
+ .'- Pending: being prepared.'."\n"
+ .'- Starting: starting.'."\n"
+ .'- Running: running.'."\n"
+ .'- Stopping: stopping.'."\n"
+ .'- Stopped: stopped.'."\n"
+ .'- Resetting: being reset.'."\n"
+ .'- Upgrading: being upgraded.'."\n"
+ .'- Disabled: unavailable.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'CreationTime' => ['description' => 'The creation time. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC+0.', 'type' => 'string', 'example' => '2021-03-08T05:31:06Z', 'title' => ''],
+ 'InnerIpAddress' => ['description' => 'The private IP address.', 'type' => 'string', 'example' => '172.26.XX.XX', 'title' => ''],
+ 'ChargeType' => ['description' => 'The billing method.', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
+ 'PlanId' => ['description' => 'The plan ID.', 'type' => 'string', 'example' => 'swas.s2.c2m2s50b4t08', 'title' => ''],
+ 'PublicIpAddress' => ['description' => 'The public IP address.', 'type' => 'string', 'example' => '42.1.XX.XX', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'The expiration time. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC+0.', 'type' => 'string', 'example' => '2021-05-08T16:00:00Z', 'title' => ''],
+ 'InstanceName' => ['description' => 'The server name.', 'type' => 'string', 'example' => 'test-InstanceName', 'title' => ''],
+ 'BusinessStatus' => ['description' => 'The server status. Valid values:'."\n"
+ ."\n"
+ .'- Normal: normal.'."\n"
+ .'- Expired: expired.'."\n"
+ .'- Overdue: overdue payment.', 'type' => 'string', 'example' => 'Normal', 'title' => ''],
+ 'DdosStatus' => ['description' => 'The DDoS status. Valid values:'."\n"
+ ."\n"
+ .'- Normal: normal.'."\n"
+ .'- BlackHole: blackhole filtering status.'."\n"
+ .'- Defense: traffic scrubbing status.', 'type' => 'string', 'example' => 'Normal', 'title' => ''],
+ 'ImageId' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'fe9c66133a9d4688872869726b52****', 'title' => ''],
+ 'DisableReason' => ['description' => 'The reason why the resource is disabled. Valid values:'."\n"
+ ."\n"
+ .'- FINANCIAL: locked due to overdue payment.'."\n"
+ .'- SECURITY: locked for security reasons.'."\n"
+ .'- EXPIRED: the instance has expired.', 'type' => 'string', 'example' => 'EXPIRED', 'title' => ''],
+ 'Combination' => ['description' => 'Indicates whether the instance uses a combination plan.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'CombinationInstanceId' => ['description' => 'The combination plan instance ID.', 'type' => 'string', 'example' => 'com-f6c9a22****45b5b8de68ad608af1ba', 'title' => ''],
+ 'Uuid' => ['description' => 'The UUID of the instance.', 'type' => 'string', 'example' => '41f30524-5df7-49c9-9c6e-32****489001', 'title' => ''],
+ 'ResourceSpec' => [
+ 'description' => 'The resource specifications.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DiskCategory' => ['description' => 'The disk type. Valid values:'."\n"
+ ."\n"
+ .'- ESSD: ESSD at performance level (PL) PL0.'."\n"
+ .'- SSD: standard SSD.'."\n"
+ .'- CLOUD_EFFICIENCY: ultra cloud disk.', 'type' => 'string', 'example' => 'ESSD', 'title' => ''],
+ 'Cpu' => ['description' => 'The number of vCPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Bandwidth' => ['description' => 'The bandwidth. Unit: Mbit/s.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'DiskSize' => ['description' => 'The disk size. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
+ 'Memory' => ['description' => 'The memory size. Unit: GiB.', 'type' => 'number', 'format' => 'double', 'example' => '2', 'title' => ''],
+ 'Flow' => ['description' => 'The traffic allowance.'."\n"
+ ."\n"
+ .'- A value of 0 indicates a bandwidth-based instance.'."\n"
+ .'- A non-zero value indicates a traffic-based instance.', 'type' => 'number', 'format' => 'double', 'example' => '818', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Image' => [
+ 'description' => 'The image information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OsType' => ['description' => 'The operating system type.', 'type' => 'string', 'example' => 'windows', 'title' => ''],
+ 'ImageName' => ['description' => 'The image name.', 'type' => 'string', 'example' => 'test-custom-1686536882356', 'title' => ''],
+ 'ImageVersion' => ['description' => 'The image version.', 'type' => 'string', 'example' => 'V3.5', 'title' => ''],
+ 'ImageType' => ['description' => 'The image type. Valid values:'."\n"
+ ."\n"
+ .'- system: system image.'."\n"
+ .'- app: application image.'."\n"
+ .'- custom: custom image.', 'type' => 'string', 'example' => 'system', 'title' => ''],
+ 'ImageIconUrl' => ['description' => 'The image icon URL.', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg', 'title' => ''],
+ 'ImageContact' => ['description' => 'The image provider.', 'type' => 'string', 'example' => 'https://selfs****e.console.aliyun.com/ticket/createIndex', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Tags' => [
+ 'description' => 'The tags of the instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key of the instance.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value of the instance.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Disks' => [
+ 'description' => 'The array of disk information for the simple application server.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The disk information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreationTime' => ['description' => 'The instance creation time. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC+0.', 'type' => 'string', 'example' => '2023-02-24T02:20:10Z', 'title' => ''],
+ 'Status' => ['description' => 'The disk status. Valid values:'."\n"
+ ."\n"
+ .'- ReIniting: being initialized.'."\n"
+ .'- Creating: being created.'."\n"
+ .'- In_use: in use.'."\n"
+ .'- Available: to be attached.'."\n"
+ .'- Attaching: being attached.'."\n"
+ .'- Detaching: being detached.', 'type' => 'string', 'example' => 'In_use', 'title' => ''],
+ 'Device' => ['description' => 'The device name of the disk on the server.', 'type' => 'string', 'example' => '/dev/xvda', 'title' => ''],
+ 'Size' => ['description' => 'The disk size. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'DiskName' => ['description' => 'The disk name.', 'type' => 'string', 'example' => 'SystemDisk', 'title' => ''],
+ 'DiskChargeType' => ['description' => 'The billing method of the disk.', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''],
+ 'DiskType' => ['description' => 'The disk type. Valid values:'."\n"
+ ."\n"
+ .'- system: system cloud disk.'."\n"
+ .'- data: data cloud disk.', 'type' => 'string', 'example' => 'system', 'title' => ''],
+ 'Category' => ['description' => 'The disk type. Valid values:'."\n"
+ ."\n"
+ .'- ESSD: ESSD at performance level (PL) PL0.'."\n"
+ .'- SSD: standard SSD.'."\n"
+ .'- CLOUD_EFFICIENCY: ultra cloud disk.', 'type' => 'string', 'example' => 'ESSD', 'title' => ''],
+ 'DiskId' => ['description' => 'The disk ID.', 'type' => 'string', 'example' => 'd-bp14wq0149cpp2x****', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'Remark' => ['description' => 'The disk remarks.', 'type' => 'string', 'example' => 'remark', 'title' => ''],
+ 'DiskTags' => [
+ 'description' => 'The tag information of the disk.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ResourceGroupId' => ['description' => 'The resource group ID of the disk.', 'type' => 'string', 'example' => 'rg-aek2bti7cf7****', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ResourceGroupId' => ['description' => 'The resource group ID of the instance.', 'type' => 'string', 'example' => 'rg-aekz7jmhg5s****', 'title' => ''],
+ 'NetworkAttributes' => [
+ 'description' => 'The network information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The network information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PublicIpAddress' => ['description' => 'The public IP address.', 'type' => 'string', 'example' => '116.62.XX.XX', 'title' => ''],
+ 'PrivateIpAddress' => ['description' => 'The private IP address.', 'type' => 'string', 'example' => '72.25.XX.XX', 'title' => ''],
+ 'PeakBandwidth' => ['description' => 'The peak public bandwidth. Unit: Mbit/s.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'PublicIpDdosStatus' => ['description' => 'The DDoS status of the public IP address.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'PlanType' => ['description' => 'The plan type. Valid values:'."\n"
+ ."\n"
+ .'- NORMAL: general-purpose.'."\n"
+ .'- CAPACITY: storage-optimized.'."\n"
+ .'- PREVIOUS: previous generation.'."\n"
+ .'- MULTI_IP: multiple public IP addresses.'."\n"
+ .'- INTERNATIONAL: international.'."\n"
+ ."\n"
+ .'> For more information, see [Instance family](~~2861773~~).', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''],
+ 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'The total number of instances returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page for paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the simple application server list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
- 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CustomImageInShare',
- 'errorMessage' => 'The custom image is being shared. Please disable sharing first and then delete it.',
- ],
+ ['errorCode' => 'InvalidChargeType.ValueNotSupported', 'errorMessage' => 'The specified parameter ChargeType is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidPublicIpAddresses.ValueNotSupported', 'errorMessage' => 'The specified parameter PublicIpAddresses is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidPublicIpAddresses', 'errorMessage' => 'The specified parameter PublicIpAddresses value is not valid.', 'description' => 'The specified parameter PublicIpAddresses value is invalid.'],
],
404 => [
- [
- 'errorCode' => 'InvalidImageId.NotFound',
- 'errorMessage' => 'The specified ImageId does not exist.',
- ],
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomImageResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n</DeleteCustomImageResponse>","errorExample":""}]',
- 'title' => 'DeleteCustomImage',
- 'description' => 'You can delete a custom image that you no longer need. After the custom image is deleted, you cannot use the custom image to reset the simple application servers that were created based on the custom image.'."\n"
- ."\n"
- .'> To delete a shared image, you must unshare the image before you can delete it. After a custom image is unshared, you cannot query the custom image by using the Elastic Compute Service (ECS) console or API. If you want to use a custom image to create ECS instances, we recommend that you copy the custom image before you delete it. For more information, see [Copy a shared image of a simple application server in the ECS console](~~199378~~).'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteCustomImages' => [
- 'summary' => 'Deletes custom images. If you no longer require a custom image, you can call this operation to delete the custom image. You can also call this operation to delete multiple custom images at the same time. After a custom image is deleted, you cannot use the custom image to reset the simple application servers that were created based on the custom image.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'List instances',
+ 'summary' => 'Queries the details of one or more simple application server instances in a specified region.',
+ 'description' => 'Queries the details of one or more simple application server instances in a specified region, including the server name, public IP address, private IP address, creation time, and expiration time.',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-20T08:18:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2025-03-14T13:14:58.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-06-17T10:54:38.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-05-29T02:22:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-02-20T03:36:58.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-01-17T06:24:05.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-07-19T07:18:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-05-25T10:52:30.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListInstances'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/*'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"CreationTime\\": \\"2021-03-08T05:31:06Z\\",\\n \\"InnerIpAddress\\": \\"172.26.XX.XX\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"InstanceId\\": \\"2ad1ae67295445f598017499dc****\\",\\n \\"PlanId\\": \\"swas.s2.c2m2s50b4t08\\",\\n \\"PublicIpAddress\\": \\"42.1.XX.XX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ExpiredTime\\": \\"2021-05-08T16:00:00Z\\",\\n \\"InstanceName\\": \\"test-InstanceName\\",\\n \\"BusinessStatus\\": \\"Normal\\",\\n \\"DdosStatus\\": \\"Normal\\",\\n \\"ImageId\\": \\"fe9c66133a9d4688872869726b52****\\",\\n \\"DisableReason\\": \\"EXPIRED\\",\\n \\"Combination\\": false,\\n \\"CombinationInstanceId\\": \\"com-f6c9a22****45b5b8de68ad608af1ba\\",\\n \\"Uuid\\": \\"41f30524-5df7-49c9-9c6e-32****489001\\",\\n \\"ResourceSpec\\": {\\n \\"DiskCategory\\": \\"ESSD\\",\\n \\"Cpu\\": 2,\\n \\"Bandwidth\\": 200,\\n \\"DiskSize\\": 60,\\n \\"Memory\\": 2,\\n \\"Flow\\": 818\\n },\\n \\"Image\\": {\\n \\"OsType\\": \\"windows\\",\\n \\"ImageName\\": \\"test-custom-1686536882356\\",\\n \\"ImageVersion\\": \\"V3.5\\",\\n \\"ImageType\\": \\"system\\",\\n \\"ImageIconUrl\\": \\"https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg\\",\\n \\"ImageContact\\": \\"https://selfs****e.console.aliyun.com/ticket/createIndex\\"\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"Disks\\": [\\n {\\n \\"CreationTime\\": \\"2023-02-24T02:20:10Z\\",\\n \\"Status\\": \\"In_use\\",\\n \\"Device\\": \\"/dev/xvda\\",\\n \\"Size\\": 50,\\n \\"DiskName\\": \\"SystemDisk\\",\\n \\"DiskChargeType\\": \\"PrePaid\\",\\n \\"DiskType\\": \\"system\\",\\n \\"Category\\": \\"ESSD\\",\\n \\"DiskId\\": \\"d-bp14wq0149cpp2x****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Remark\\": \\"remark\\",\\n \\"DiskTags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-aek2bti7cf7****\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-aekz7jmhg5s****\\",\\n \\"NetworkAttributes\\": [\\n {\\n \\"PublicIpAddress\\": \\"116.62.XX.XX\\",\\n \\"PrivateIpAddress\\": \\"72.25.XX.XX\\",\\n \\"PeakBandwidth\\": 200,\\n \\"PublicIpDdosStatus\\": \\"normal\\"\\n }\\n ],\\n \\"PlanType\\": \\"NORMAL\\",\\n \\"CommodityCode\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n}","type":"json"}]',
+ ],
+ 'ListInstancesTrafficPackages' => [
+ 'summary' => 'Queries the details about data transfer plans of simple application servers.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '215038',
- 'abilityTreeNodes' => [
- 'FEATUREswasCJL3RE',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ImageIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the custom image. The value can be a JSON array that consists of up to 15 image IDs. Separate multiple image IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '["m-2zehv38jjmwva1ee****", "m-bp1hj0zhmheyq2kz****"]',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [Ensure idempotence](~~25693~~)'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc******","2ad1ae67295445f598017499dc******"]', 'title' => ''],
],
],
'responses' => [
@@ -9802,53 +7808,84 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'InstanceTrafficPackageUsages' => [
+ 'description' => 'The data transfers that exceed the quota of the data transfer plan in the current month. Unit: bytes.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'example' => 'ccscqwqwqqqw****', 'title' => ''],
+ 'TrafficUsed' => ['description' => 'The used quota of the data transfer plan in the current month. Unit: Byte.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'TrafficPackageTotal' => ['description' => 'The quota of the data transfer plan in the current month. Unit: Byte.'."\n"
+ ."\n"
+ .'> TrafficPackageTotal = TrafficUsed + TrafficPackageRemaining', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', 'title' => ''],
+ 'TrafficPackageRemaining' => ['description' => 'The unused quota of the data transfer plan in the current month. Unit: Byte.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'TrafficOverflow' => ['description' => 'The data transfers that exceeds the quota of the data transfer plan in the current month. Unit: Byte.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CustomImageInShare',
- 'errorMessage' => 'The custom image is in sharing,please unshare first then to retry.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'InvalidImageId.NotFound',
- 'errorMessage' => 'The specified ImageId does not exist.',
- ],
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'ListInstancesTrafficPackages',
+ 'description' => 'You can query the details of data transfer plans of simple application servers, including the total quota, used quota, unused quota, and excess data transfers in the current month.'."\n"
+ ."\n"
+ .'Simple Application Server provides data transfer plans that can be used to offset data transfer fees. You are charged for excess data transfers. Take note of the following items:'."\n"
+ ."\n"
+ .'- Only outbound data transfers of simple application servers over the Internet are calculated. Outbound data transfers include the data transfer quota and the excess data transfers beyond the quota. Inbound data transfers of simple application servers over the Internet are not calculated.'."\n"
+ ."\n"
+ .'- Outbound data transfers from simple application servers to other Alibaba Cloud services over the Internet first consume data transfer quotas. If the quotas are exhausted, you are charged for excess data transfers.'."\n"
+ ."\n"
+ .'- You are not charged for data transfers between simple application servers within the same virtual private cloud (VPC).'."\n"
+ ."\n"
+ .'For more information, see [Quotas and billing of data transfers](~~86281~~).',
+ 'changeSet' => [
+ ['createdAt' => '2023-09-20T05:07:30.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-09-18T13:53:12.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-10-27T06:49:54.000Z', 'description' => 'Request parameters changed'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteCustomImages',
- 'description' => 'If a custom image is shared, you must unshare the image before you can delete it. After a custom image is unshared, you cannot query the custom image by using the Elastic Compute Service (ECS) console or by calling an ECS API operation. If you want to use a custom image to create ECS instances, we recommend that you copy the custom image before you delete it. For more information, see [Copy a custom image](~~199378~~).'."\n",
- ],
- 'DescribeCloudAssistantAttributes' => [
- 'summary' => 'Queries the Command Assistant information of simple application servers.',
- 'methods' => [
- 'post',
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListInstancesTrafficPackages'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListInstancesTrafficPackages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceTrafficPackageUsages\\": [\\n {\\n \\"InstanceId\\": \\"ccscqwqwqqqw****\\",\\n \\"TrafficUsed\\": 10000,\\n \\"TrafficPackageTotal\\": 20000,\\n \\"TrafficPackageRemaining\\": 10000,\\n \\"TrafficOverflow\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
+ ],
+ 'ListKeyPairs' => [
+ 'summary' => 'Queries the AccessKey pairs that are bound to simple application servers in a specific region.',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9858,1128 +7895,670 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '214711',
- 'abilityTreeNodes' => [
- 'FEATUREswasWZKIOQ',
- ],
+ 'abilityTreeCode' => '219096',
+ 'abilityTreeNodes' => ['FEATUREswas9IJLCU'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the specified simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from page 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The name of the AccessKey pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with http\\:// or https\\://.', 'type' => 'string', 'required' => false, 'example' => 'KeyPairName', 'title' => ''],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
- 'required' => true,
- 'maxItems' => 50,
- ],
+ 'schema' => ['description' => 'The page number. Page starts from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'CloudAssistant' => [
- 'description' => 'The Command Assistant information.'."\n",
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'KeyPairs' => [
+ 'description' => 'Details about the queried AccessKey pairs.',
'type' => 'array',
'items' => [
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => '85dbe3e7cc7b49e1a3df4af3bfa4ebbf',
- ],
- 'CloudAssistantStatus' => [
- 'description' => 'Indicates whether Command Assistant is running. Valid values:'."\n"
- ."\n"
- .'true: Heartbeats are detected in the last 2 minutes.'."\n"
- ."\n"
- .'false: Heartbeats are not detected in the last 2 minutes.'."\n",
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'LastInvokedTime' => [
- 'description' => 'The time when commands were last run.'."\n",
- 'type' => 'string',
- 'example' => '2021-03-15T08:00:00Z'."\n",
- ],
- 'CloudAssistantVersion' => [
- 'description' => 'The version number of the Command Assistant agent. Null is returned if the Command Assistant agent is not installed or is not running.'."\n",
- 'type' => 'string',
- 'example' => '2.2.0.106'."\n",
- ],
- 'ActiveTaskCount' => [
- 'description' => 'The number of active tasks in Command Assistant.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'InvocationCount' => [
- 'description' => 'The number of completed tasks in Command Assistant.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'LastHeartbeatTime' => [
- 'description' => 'The time when the last heartbeat of Command Assistant was detected. The value is updated every minute on average. The interval can be 55, 60, or 65 seconds.'."\n",
- 'type' => 'string',
- 'example' => '2021-03-15T09:00:00Z'."\n",
- ],
- 'OSType' => [
- 'description' => 'The OS type of the simple application server. Valid values:'."\n"
- ."\n"
- .'* Windows'."\n"
- .'* Linux'."\n"
- .'* FreeBSD'."\n",
- 'type' => 'string',
- 'example' => 'Linux',
- ],
- 'SupportSessionManager' => [
- 'description' => 'Indicates whether Command Assistant supports session management. If Command Assistant does not support session management, the version of the Command Assistant agent is too earlier. We recommend that you update your Command Assistant agent to the latest version.'."\n"
- ."\n"
- .'To use the session management feature, you must make sure that the version of your Command Assistant agent meets one of the following requirements:'."\n"
- ."\n"
- .'If your simple application server runs Linux, the version of the Command Assistant agent on the server must be 2.2.3.189 or later. If your simple application server runs Windows, the version of the Command Assistant agent on the server must be 2.1.3.189 or later.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'CreationTime' => ['description' => 'The time when the AccessKey pair was created.', 'type' => 'string', 'example' => '2024-05-06T02:28Z', 'title' => ''],
+ 'KeyPairName' => ['description' => 'The name of the AccessKey pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with http\\:// or https\\://.', 'type' => 'string', 'example' => 'testKeyPairName', 'title' => ''],
+ 'PublicKey' => ['description' => 'The content of the public key.', 'type' => 'string', 'example' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****', 'title' => ''],
+ 'InstanceIds' => [
+ 'description' => 'The IDs of simple application servers. A maximum of 50 IDs of simple application servers can be returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the simple application server. A maximum of 50 IDs of simple application servers can be returned.', 'type' => 'string', 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- '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',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"CloudAssistant\\": [\\n {\\n \\"InstanceId\\": \\"85dbe3e7cc7b49e1a3df4af3bfa4ebbf\\",\\n \\"CloudAssistantStatus\\": \\"true\\",\\n \\"LastInvokedTime\\": \\"2021-03-15T08:00:00Z\\\\n\\",\\n \\"CloudAssistantVersion\\": \\"2.2.0.106\\\\n\\",\\n \\"ActiveTaskCount\\": 0,\\n \\"InvocationCount\\": 4,\\n \\"LastHeartbeatTime\\": \\"2021-03-15T09:00:00Z\\\\n\\",\\n \\"OSType\\": \\"Linux\\",\\n \\"SupportSessionManager\\": true\\n }\\n ],\\n \\"TotalCount\\": 4,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n}","type":"json"}]',
- 'title' => 'DescribeCloudAssistantAttributes',
- ],
- 'UpdateCommandAttribute' => [
- 'summary' => 'Modifys the parameter of a command.',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListKeyPairs',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListKeyPairs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"KeyPairs\\": [\\n {\\n \\"CreationTime\\": \\"2024-05-06T02:28Z\\",\\n \\"KeyPairName\\": \\"testKeyPairName\\",\\n \\"PublicKey\\": \\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****\\",\\n \\"InstanceIds\\": [\\n \\"2ad1ae67295445f598017499dc****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListPlans' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '184926',
- 'abilityTreeNodes' => [
- 'FEATUREswasWZKIOQ',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '20465',
+ 'abilityTreeNodes' => ['FEATUREswasB80AJY', 'FEATUREswasUPXVQ5'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'CommandId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The command ID. You can call the [DescribeCommands](~~64843~~) operation to query all available command IDs.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-sh02yh0932w****',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the command. The name supports all character sets and can be up to 128 characters in length.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testName',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The description of the command. The description supports all character sets and can be up to 512 characters in length.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'WorkingDir',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The working directory of the command. The directory can be up to 200 characters in length.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/home/',
- ],
- ],
- [
- 'name' => 'Timeout',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The maximum timeout period for the command execution on the ECS instance. Unit: seconds. When a command that you created cannot be run, the command execution times out. When the execution times out, the command process is forcefully terminated and the PID of the command is canceled. Default value: 60.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '60',
- ],
+ 'schema' => ['description' => 'The region ID. You can call [ListRegions](~~189315~~) to query the available regions for simple application servers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****',
+ 'Plans' => [
+ 'description' => 'The plan information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The plan information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Core' => ['description' => 'The number of vCPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Bandwidth' => ['description' => 'The peak bandwidth. Unit: Mbit/s.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'DiskSize' => ['description' => 'The disk capacity. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''],
+ 'Flow' => ['description' => 'The monthly data transfer quota. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''],
+ 'Tokens' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'PlanId' => ['description' => 'The plan ID.', 'type' => 'string', 'example' => 'swas.s2.c2m1s40b3t04', 'title' => ''],
+ 'DiskType' => ['description' => 'The disk type. Valid values:'."\n"
+ ."\n"
+ .'- ESSD: ESSD cloud disk at performance level (PL) 0.'."\n"
+ .'- SSD: standard SSD.'."\n"
+ .'- CLOUD_EFFICIENCY: ultra cloud disk.', 'type' => 'string', 'example' => 'ESSD', 'title' => ''],
+ 'Currency' => ['description' => 'The currency unit. Valid values:'."\n"
+ ."\n"
+ .'- CNY: Chinese Yuan (CNY).'."\n"
+ ."\n"
+ .'- USD: US Dollar (USD).'."\n"
+ ."\n"
+ .'> The currency unit is CNY on the China site (aliyun.com) and USD on the International site (alibabacloud.com).', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'SupportPlatform' => ['description' => 'The operating system types supported by the plan.', 'type' => 'string', 'example' => '["Linux","Windows"]', 'title' => ''],
+ 'PlanType' => ['description' => 'The plan type. Valid values:'."\n"
+ ."\n"
+ .'- NORMAL: general-purpose.'."\n"
+ .'- CAPACITY: storage-optimized.'."\n"
+ .'- PREVIOUS: previous generation.'."\n"
+ .'- MULTI_IP: multiple public IP addresses.'."\n"
+ .'- INTERNATIONAL: international.'."\n"
+ ."\n"
+ .'> For more information, see [Instance family](~~2861773~~).', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''],
+ 'PublicIpNum' => ['description' => 'The number of public IP addresses.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'IspType' => ['description' => 'The public network line type.'."\n"
+ .'- **BGP** (default): BGP line.'."\n"
+ .'- **BGP_NCO**: BGP (outside the Chinese mainland) line.', 'type' => 'string', 'example' => 'BGP', 'title' => ''],
+ 'Memory' => ['description' => 'The memory size. Unit: GiB.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''],
+ 'OriginPrice' => ['description' => 'The monthly price of the simple application server plan.', 'type' => 'string', 'example' => '60', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]',
- 'title' => 'UpdateCommandAttribute',
- ],
- 'InvokeCommand' => [
- 'summary' => 'Runs a Command Assistant command for one or more simple application servers.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'Query plan information',
+ 'summary' => 'Queries all plan information for simple application servers in a specified region.',
+ 'description' => 'You can query all plan information for simple application servers in a specified region, including the plan ID, disk capacity, disk type, and plan price.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-28T03:01:46.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-03-25T08:32:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-03-25T06:22:56.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-03-20T08:18:40.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-12-09T07:23:30.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListPlans'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Plans\\": [\\n {\\n \\"Core\\": 2,\\n \\"Bandwidth\\": 200,\\n \\"DiskSize\\": 40,\\n \\"Flow\\": 400,\\n \\"Tokens\\": 0,\\n \\"PlanId\\": \\"swas.s2.c2m1s40b3t04\\",\\n \\"DiskType\\": \\"ESSD\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"SupportPlatform\\": \\"[\\\\\\"Linux\\\\\\",\\\\\\"Windows\\\\\\"]\\",\\n \\"PlanType\\": \\"NORMAL\\",\\n \\"PublicIpNum\\": \\"1\\",\\n \\"IspType\\": \\"BGP\\",\\n \\"Memory\\": 1,\\n \\"OriginPrice\\": \\"60\\"\\n }\\n ],\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
+ ],
+ 'ListRegions' => [
+ 'summary' => 'Queries all regions in which Simple Application Server is supported.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswasWZKIOQ',
- ],
+ 'abilityTreeCode' => '20466',
+ 'abilityTreeNodes' => ['FEATUREswas8F6GI9'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '公共资源，无越权问题',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou ',
- ],
- ],
- [
- 'name' => 'CommandId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The command ID. You can call the DescribeCommands operation to query all available command IDs.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-sh02yh0932w****',
- ],
- ],
- [
- 'name' => 'Parameters',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The key-value pairs of custom parameters to specify when the custom parameter feature is enabled.'."\n"
- ."\n"
- .'* You can specify up to 10 custom parameters. Each key in a Map collection cannot be an empty string and can be up to 64 characters in length.'."\n"
- .'* Values in a Map collection can be empty strings. The total length of the custom parameters and the original command cannot exceed 18 KB after they are encoded in Base64.'."\n"
- .'* The custom parameter names that you specify for the Parameters parameter must be included in the custom parameter names that you specified when you created the command.'."\n"
- .'* You can use empty strings to represent the custom parameters that are not specified. If you want to disable the custom parameter feature, you can leave this parameter empty.'."\n",
- 'type' => 'object',
- 'required' => false,
- 'example' => '{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}',
- ],
- ],
- [
- 'name' => 'Username',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the user who runs the command in a simple application server. The username cannot exceed 255 characters in length.'."\n"
- ."\n"
- .'* For Linux servers, the default value is the root username.'."\n"
- .'* For Windows servers, the default value is the system username.'."\n"
- ."\n"
- .'You can change the user to run the command only for Linux simple application servers.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'InstanceIds',
+ 'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 50 IDs of simple application servers. Separate multiple IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
+ 'schema' => ['description' => 'The language of the response. Valid values:'."\n"
+ ."\n"
+ .'- **zh-CN** (default): Chinese'."\n"
+ ."\n"
+ .'- **en-US**: English', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The information about the regions.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'InvokeId' => [
- 'description' => 'The execution ID of the command.'."\n",
- 'type' => 'string',
- 'example' => 't-bj02prjhw1n****',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'Regions' => [
+ 'description' => 'The regions.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the region.',
+ 'type' => 'object',
+ 'properties' => [
+ 'LocalName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => 'China (Hangzhou)', 'title' => ''],
+ 'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'swas.cn-hangzhou.aliyuncs.com', 'title' => ''],
+ 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"InvokeId\\": \\"t-bj02prjhw1n****\\"\\n}","type":"json"}]',
- 'title' => 'InvokeCommand',
- 'description' => '* The simple application servers for which you want to call the operation must meet the following conditions. If a simple application server cannot meet the conditions, you must call this operation again.'."\n"
- ."\n"
- .' * The simple application servers are in the `Running` state. You can call the [ListInstances](~~2361065~~) operation to query the status of simple application servers.'."\n"
- .' * Cloud Assistant Agent is installed on the simple application servers. For more information, see [InstallCloudAssistant](~~2361030~~).'."\n"
- .' * If you run a PowerShell command, make sure that the PowerShell module is configured for the simple application servers.'."\n"
- ."\n"
- .'* The command may fail to be run due to the abnormal states of simple application servers, network exceptions, or exceptions in Cloud Assistant Agent. If the command fails to be run, no execution information is generated.'."\n"
- ."\n"
- .'* If you enable the custom parameter feature when you create a command, you must set the `Parameters` parameter to specify custom parameters when you run the command.'."\n"
- ."\n"
- .'* When you call this operation, you can select only one common command or a custom command that you have created.'."\n",
- ],
- 'DescribeCommands' => [
- 'summary' => 'Queries the commands that you created or the common commands that Alibaba Cloud provides.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"Regions\\": [\\n {\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionEndpoint\\": \\"swas.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListRegions',
+ 'description' => 'The query results include all the Alibaba Cloud regions where Simple Application Server is supported on the international site (alibabacloud.com) and the China site (aliyun.com).',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-12-18T08:54:17.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListRegions'],
+ ],
],
+ 'ramActions' => [],
+ 'translator' => 'manual',
+ ],
+ 'ListSnapshots' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '184928',
- 'abilityTreeNodes' => [
- 'FEATUREswasWZKIOQ',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '20467',
+ 'abilityTreeNodes' => ['FEATUREswasHVUGWX'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server that corresponds to the snapshots.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'CommandId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The command ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c-sh02yh0932w****',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => false, 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'DiskId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The command name. Fuzzy match is not supported.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => 'The disk ID.', 'type' => 'string', 'required' => false, 'example' => 'd-bp14wq0149cpp2xy****', 'title' => ''],
],
[
- 'name' => 'Provider',
+ 'name' => 'SnapshotIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The provider of the common command. Take note of the following items:'."\n"
- ."\n"
- .'* If you set this parameter to `AlibabaCloud`, all the common commands provided by Alibaba Cloud are queried.'."\n"
- .'* If you set this parameter to `User`, all the custom commands created by you are queried.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AlibabaCloud',
- ],
+ 'schema' => ['description' => 'The snapshot IDs. The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple snapshot IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"]', 'title' => ''],
],
[
- 'name' => 'Type',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The language type of the command. Valid values:'."\n"
- ."\n"
- .'* RunBatScript: batch command, applicable to Windows instances'."\n"
- .'* RunPowerShellScript: PowerShell command, applicable to Windows instances'."\n"
- .'* RunShellScript: shell command, applicable to Linux instances'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RunShellScript',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Maximum value: 100.'."\n"
+ ."\n"
+ .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'SourceDiskType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'Maximum value: 50.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The type of the source disk. Valid values:'."\n"
+ ."\n"
+ .'- system: system disk.'."\n"
+ ."\n"
+ .'- data: data disk.', 'type' => 'string', 'required' => false, 'example' => 'Data', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The tags that are bound to the command.'."\n",
+ 'description' => 'Tag N that you want to add to the snapshot.',
'type' => 'array',
'items' => [
- 'description' => 'The tags of the command.',
+ 'description' => 'The tags of the snapshot.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The tag key of the command. A tag key can be 1 to 64 characters in length. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value of the command. A tag value can be up to 64 characters in length. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => 'The key of tag N that you want to add to the snapshot. A tag key can be 1 to 64 characters in length. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The value of tag N that you want to add to the snapshot. A tag value can be up to 64 characters in length. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The resource group ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of commands.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Commands' => [
- 'description' => 'The queried commands.'."\n",
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Snapshots' => [
+ 'description' => 'Details about the snapshots.',
'type' => 'array',
'items' => [
- 'description' => 'The commands.',
'type' => 'object',
'properties' => [
- 'CommandId' => [
- 'description' => 'The command ID.'."\n",
- 'type' => 'string',
- 'example' => 'c-gov1k1tqwi9****',
- ],
+ 'Status' => ['description' => 'The status of the snapshot. Valid values:'."\n"
+ ."\n"
+ .'- Progressing: The snapshot is being created.'."\n"
+ ."\n"
+ .'- Accomplished: The snapshot is created.'."\n"
+ ."\n"
+ .'- Failed: The snapshot failed to be created.', 'type' => 'string', 'example' => 'Accomplished', 'title' => ''],
+ 'CreationTime' => ['description' => 'The time when the snapshot was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2021-03-09T07:12:49Z', 'title' => ''],
+ 'SourceDiskId' => ['description' => 'The ID of the source disk. This parameter has a value even after the source disk is released.', 'type' => 'string', 'example' => 'd-bp14wq0149cpp2xy****', 'title' => ''],
+ 'SnapshotName' => ['description' => 'The name of the snapshot.', 'type' => 'string', 'example' => 'test-SnapshotName', 'title' => ''],
+ 'Progress' => ['description' => 'The progress of snapshot creation.', 'type' => 'string', 'example' => '100%', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks of the snapshot.', 'type' => 'string', 'example' => 'test-Remark', 'title' => ''],
+ 'SnapshotId' => ['description' => 'The snapshot ID.', 'type' => 'string', 'example' => 's-bp16oazlsold4dks****', 'title' => ''],
+ 'SourceDiskType' => ['description' => 'The type of the source disk. Valid values:'."\n"
+ ."\n"
+ .'- system: system disk.'."\n"
+ ."\n"
+ .'- data: data disk.', 'type' => 'string', 'example' => 'System', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'InstanceId' => ['description' => 'The ID of the simple application server.'."\n"
+ ."\n"
+ .'Note: This parameter has a value returned for only system disk snapshots.', 'type' => 'string', 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
'Tags' => [
- 'description' => 'The tags that are bound to the command.'."\n",
+ 'description' => 'The tags of the snapshot.',
'type' => 'array',
'items' => [
- 'description' => 'The tags of the command.',
+ 'description' => 'The tags of the snapshot.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The tag key of the command.'."\n",
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The tag value of the command.'."\n",
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => 'The tag key of the snapshot.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The tag value of the snapshot.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'CreationTime' => [
- 'description' => 'The time when the command was created.'."\n",
- 'type' => 'string',
- 'example' => '2023-01-05T06:38:53Z',
- ],
- 'Name' => [
- 'description' => 'The name of the command.'."\n",
- 'type' => 'string',
- 'example' => 'testName',
- ],
- 'Provider' => [
- 'description' => 'The provider of the command.'."\n",
- 'type' => 'string',
- 'example' => 'User',
- ],
- 'Type' => [
- 'description' => 'The type of the command.'."\n",
- 'type' => 'string',
- 'example' => 'RunShellScript',
- ],
- 'Timeout' => [
- 'description' => 'The timeout period of the command.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '60',
- ],
- 'Description' => [
- 'description' => 'The description of the command.'."\n",
- 'type' => 'string',
- 'example' => 'testDescription',
- ],
- 'WorkingDir' => [
- 'description' => 'The execution path of the command.'."\n",
- 'type' => 'string',
- 'example' => '/home',
- ],
- 'CommandContent' => [
- 'description' => 'The content of the command.'."\n",
- 'type' => 'string',
- 'example' => 'cat /etc/ssh/sshd_config',
- ],
- 'EnableParameter' => [
- 'description' => 'Indicates whether the custom parameter feature is enabled for the command.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ParameterNames' => [
- 'description' => 'The custom parameter names that are parsed from the command content specified when the command was created. The custom parameter names are returned in the list format. If the custom parameter feature is disabled, an empty list is returned.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The custom parameter name.'."\n",
- 'type' => 'string',
- 'example' => 'parameter1',
- ],
- ],
- 'ParameterDefinitions' => [
- 'description' => 'Details of the custom parameter.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The custom parameter.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Required' => [
- 'description' => 'Indicates whether the custom parameter is required. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n"
- ."\n"
- .'Default value: false.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Description' => [
- 'description' => 'The description of the custom parameter.'."\n",
- 'type' => 'string',
- 'example' => 'Command Assistant Agent Installation Package Path',
- ],
- 'DefaultValue' => [
- 'description' => 'The default value of the custom parameter.'."\n",
- 'type' => 'string',
- 'example' => 'https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm',
- ],
- 'ParameterName' => [
- 'description' => 'The name of the custom parameter.'."\n",
- 'type' => 'string',
- 'example' => 'DownloadUrl',
- ],
- 'PossibleValues' => [
- 'description' => 'The valid values of the custom parameter.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'A valid value of the custom parameter.'."\n",
- 'type' => 'string',
- 'example' => 'Linux',
- ],
- ],
- ],
- ],
- ],
- 'ResourceGroupId' => [
- 'description' => 'The resource group ID.'."\n",
- 'type' => 'string',
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'RollbackTime' => ['description' => 'The time when the last disk rollback was performed.', 'type' => 'string', 'example' => '2021-03-09T07:12:49Z', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the snapshot belongs.', 'type' => 'string', 'example' => 'rg-aek2bti7cf7****', 'title' => ''],
],
+ 'description' => 'The details about snapshots.',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Commands\\": [\\n {\\n \\"CommandId\\": \\"c-gov1k1tqwi9****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"CreationTime\\": \\"2023-01-05T06:38:53Z\\",\\n \\"Name\\": \\"testName\\",\\n \\"Provider\\": \\"User\\",\\n \\"Type\\": \\"RunShellScript\\",\\n \\"Timeout\\": 60,\\n \\"Description\\": \\"testDescription\\",\\n \\"WorkingDir\\": \\"/home\\",\\n \\"CommandContent\\": \\"cat /etc/ssh/sshd_config\\",\\n \\"EnableParameter\\": false,\\n \\"ParameterNames\\": [\\n \\"parameter1\\"\\n ],\\n \\"ParameterDefinitions\\": [\\n {\\n \\"Required\\": false,\\n \\"Description\\": \\"命令助手Agent安装包路径\\",\\n \\"DefaultValue\\": \\"https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm\\",\\n \\"ParameterName\\": \\"DownloadUrl\\",\\n \\"PossibleValues\\": [\\n \\"Linux\\"\\n ]\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-aek2bti7cf7****\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'DescribeCommands',
- ],
- 'DescribeCommandInvocations' => [
- 'summary' => 'Queries the executions and execution status of a Cloud Assistant command.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
+ ['errorCode' => 'InvalidSnapshotIds', 'errorMessage' => 'The specified SnapshotIds is not valid.', 'description' => 'The specified snapshot ID is invalid.'],
+ ],
+ 403 => [
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter value is invalid.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ['errorCode' => 'InvalidDiskId.NotFound', 'errorMessage' => 'The specified DiskId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListSnapshots',
+ 'summary' => 'Queries the information about snapshots that are created for a simple application server.',
+ 'description' => 'The `InstanceId`, `DiskId`, `SnapshotIds`, and `ResourceGroupId` parameters are optional. However, you can specify them as filter conditions and combine them with the logical AND operator to filter snapshots that you want to query.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-29T02:22:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-02-20T03:36:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2023-09-20T05:07:30.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-09-18T12:11:23.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-05-25T10:50:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2021-08-23T11:39:12.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSnapshots'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListSnapshots',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/*'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Snapshots\\": [\\n {\\n \\"Status\\": \\"Accomplished\\",\\n \\"CreationTime\\": \\"2021-03-09T07:12:49Z\\",\\n \\"SourceDiskId\\": \\"d-bp14wq0149cpp2xy****\\",\\n \\"SnapshotName\\": \\"test-SnapshotName\\",\\n \\"Progress\\": \\"100%\\",\\n \\"Remark\\": \\"test-Remark\\",\\n \\"SnapshotId\\": \\"s-bp16oazlsold4dks****\\",\\n \\"SourceDiskType\\": \\"System\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceId\\": \\"2ad1ae67295445f598017499dc****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"RollbackTime\\": \\"2021-03-09T07:12:49Z\\",\\n \\"ResourceGroupId\\": \\"rg-aek2bti7cf7****\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListTagResources' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswasV8KB6K'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
- 'name' => 'CommandId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The command ID. You can call the [DescribeCommands](~~64843~~) operation to query all available command IDs.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c-sh02yh0932w****',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'InvokeId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The execution ID of the command.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 't-hz02p9545t6****',
- ],
- ],
- [
- 'name' => 'CommandName',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The command name. If both CommandName and InstanceId are specified, CommandName does not take effect.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => 'The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [Ensure idempotence](~~25693~~)', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
- 'name' => 'InvocationStatus',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The overall execution state of the command. The value of this parameter depends on the execution status of the command on all the involved instances. Valid values:'."\n"
- ."\n"
- .'* Pending: The command is being verified or sent. When the execution state on at least one instance is Pending, the overall execution state is Pending.'."\n"
- ."\n"
- .'* Running: The command is being run on the instances. When the execution state on at least one instance is Running, the overall execution state is Running.'."\n"
- ."\n"
- .'* Success: When the execution state on at least one instance is Success and the execution state on other instances is Stopped or Success, the overall execution state is Success.'."\n"
- ."\n"
- .' * Command that is set to run immediately: The command execution is complete, and the exit code is 0.'."\n"
- ."\n"
- .'* Failed: When the execution state on all instances is Stopped or Failed, the overall execution state is Failed. When the execution state on an instance is one of the following values, Failed is returned as the overall execution state:'."\n"
- ."\n"
- .' * Invalid: The command is invalid.'."\n"
- .' * Aborted: The command fails to be sent.'."\n"
- .' * Failed: The command execution is complete, and the exit code is not 0.'."\n"
- .' * Timeout: The command execution times out.'."\n"
- .' * Error: An error occurs when the command is being run.'."\n"
- ."\n"
- .'* Stopping: The command task is being stopped. When the execution state on at least one instance is Stopping, the overall execution state is Stopping.'."\n"
- ."\n"
- .'* Stopped: The command task is stopped. When the execution state on all instances is Stopped, the overall execution state is Stopped. When the execution state on an instance is one of the following values, Stopped is returned as the overall execution state:'."\n"
- ."\n"
- .' * Cancelled: The command task is canceled.'."\n"
- .' * Terminated: The command task is terminated.'."\n"
- ."\n"
- .'* PartialFailed: The command execution succeeds on some instances and fails on other instances. When the execution state on some instances is Success and the execution state on other instances is Failed or Stopped, the overall execution state is PartialFailed.'."\n"
- ."\n"
- .'> The value of the `InvokeStatus` response parameter is similar to the value of InvocationStatus. We recommend that you ignore InvokeStatus and check the value of InvocationStatus.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Success',
- ],
+ 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***'],
],
[
- 'name' => 'CommandType',
+ 'name' => 'ResourceType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The command type. Valid values:'."\n"
- ."\n"
- .'* RunBatScript: batch command, applicable to Windows instances'."\n"
- .'* RunPowerShellScript: PowerShell command, applicable to Windows instances'."\n"
- .'* RunShellScript: shell command, applicable to Linux instances'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RunPowerShellScript',
- ],
+ 'schema' => ['description' => 'The resource type. Valid values:'."\n"
+ ."\n"
+ .'- instance'."\n"
+ ."\n"
+ .'- snapshot'."\n"
+ ."\n"
+ .'- customimage'."\n"
+ ."\n"
+ .'- command'."\n"
+ ."\n"
+ .'- firewallrule'."\n"
+ ."\n"
+ .'- disk', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'instance'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ResourceId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The page number. Pages start from 1. Default value: 1.'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The ID of the resource. You can specify up to 50 resource IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 's-bw526m1vi6x20c6g****', 'title' => ''],
'required' => false,
- 'example' => '1',
+ 'maxItems' => 51,
+ 'example' => '',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'Maximum value: 50.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The list of tags. You can specify up to 20 tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag that is added to a resource.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of the tag that you want to add to a resource. The tag key can be 1 to 64 characters in length.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => 'The value of the tag that you want to add to a resource. The tag value can be 1 to 64 characters in length.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'TestValue'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '10',
+ 'maxItems' => 21,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Schema of response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'CommandInvocations' => [
- 'description' => 'The command executions.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'InvokeId' => [
- 'description' => 'The execution ID of the command.'."\n",
- 'type' => 'string',
- 'example' => 't-hz0373jyzxt****',
- ],
- 'CreationTime' => [
- 'description' => 'The time when the command was created.'."\n",
- 'type' => 'string',
- 'example' => '2023-04-27T10:11:58',
- ],
- 'CommandId' => [
- 'description' => 'The command ID.'."\n",
- 'type' => 'string',
- 'example' => 'c-hy0338xh28r****',
- ],
- 'InvocationStatus' => [
- 'description' => 'The overall execution state of the command. Valid values:'."\n"
- ."\n"
- .'* Pending: The command is being verified or sent.'."\n"
- .'* Invalid: The specified command type or parameter is invalid.'."\n"
- .'* Aborted: The command failed to be sent to the instances. To send a command to an instance, make sure that the instance is in the Running state and the command is sent to the instance within 1 minute.'."\n"
- .'* Running: The command is being run on the instances.'."\n"
- .'* Success: The command execution is complete, and the exit code is 0.'."\n"
- .'* Failed: The command execution is complete, and the exit code is not 0.'."\n"
- .'* Error: The command execution cannot proceed due to an exception.'."\n"
- .'* Timeout: The command execution timed out.'."\n"
- .'* Cancelled: The command execution is canceled, and the command is not started.'."\n"
- .'* Stopping: The command in the Running state is being stopped.'."\n"
- .'* Terminated: The command is terminated when it is being run.'."\n",
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'CommandName' => [
- 'description' => 'The command name.'."\n",
- 'type' => 'string',
- 'example' => 'testCommandName',
- ],
- 'CommandType' => [
- 'description' => 'The command type.'."\n",
- 'type' => 'string',
- 'example' => 'RunShellScript',
- ],
- 'CommandDescription' => [
- 'description' => 'The description of the command.'."\n",
- 'type' => 'string',
- 'example' => 'testDescription',
- ],
- 'Username' => [
- 'description' => 'The username that is used to run the command.'."\n",
- 'type' => 'string',
- 'example' => 'root',
- ],
- 'WorkingDir' => [
- 'description' => 'The working directory of the command.'."\n",
- 'type' => 'string',
- 'example' => 'c:\\wwwroot',
- ],
- 'Timeout' => [
- 'description' => 'The timeout period. Unit: seconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '60',
- ],
- 'CommandContent' => [
- 'description' => 'The content of the command.'."\n",
- 'type' => 'string',
- 'example' => 'echo 123',
- ],
- 'Parameters' => [
- 'description' => 'The custom parameters in the command. If no custom parameter exists in the command, the default value is {}.'."\n",
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'InvokeInstances' => [
- 'description' => 'The instances on which the command is run.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => '2445f4aecdac4b71ba2c7e3a7ccf****',
- ],
- 'StartTime' => [
- 'description' => 'The beginning of the time range during which the command is run on the instance.'."\n",
- 'type' => 'string',
- 'example' => '2023-05-09T03:32:24Z',
- ],
- 'FinishTime' => [
- 'description' => 'The end of the time range during which the command is run on the instance.'."\n",
- 'type' => 'string',
- 'example' => '2023-04-03T02:42:29Z',
- ],
- 'InvocationStatus' => [
- 'description' => 'The execution state of the command on a single instance. Valid values:'."\n"
- ."\n"
- .'* Pending: The command is being verified or sent.'."\n"
- ."\n"
- .'* Invalid: The specified command type or parameter is invalid.'."\n"
- ."\n"
- .'* Aborted: The command failed to be sent to the instance. To send a command to an instance, make sure that the instance is in the Running state and the command is sent to the instance within 1 minute.'."\n"
- ."\n"
- .'* Running: The command is being run on the instance.'."\n"
- ."\n"
- .'* Success:'."\n"
- ."\n"
- .' * Command that is set to run only once: The command execution is complete, and the exit code is 0.'."\n"
- .' * Command that is set to run on a schedule: The previous command execution is complete, the exit code is 0, and the specified cycle ends.'."\n"
- ."\n"
- .'* Failed:'."\n"
- ."\n"
- .' * Command that is set to run only once: The command execution is complete, and the exit code is not 0.'."\n"
- .' * Command that is set to run on a schedule: The previous command execution is complete, the exit code is not 0, and the specified cycle is about to end.'."\n"
- ."\n"
- .'* Error: The command execution cannot proceed due to an exception.'."\n"
- ."\n"
- .'* Timeout: The command execution timed out.'."\n"
- ."\n"
- .'* Cancelled: The command execution is canceled, and the command is not started.'."\n"
- ."\n"
- .'* Stopping: The command task is being stopped.'."\n"
- ."\n"
- .'* Terminated: The command is terminated when it is being run.'."\n",
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'Output' => [
- 'description' => 'The command output.'."\n",
- 'type' => 'string',
- 'example' => 'OutputMsg',
- ],
- 'ExitCode' => [
- 'description' => 'The exit code of the command.'."\n"
- ."\n"
- .'* For Linux instances, the exit code is the exit code of the shell command.'."\n"
- .'* For Windows instances, the exit code is the exit code of the batch or PowerShell command.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'ErrorInfo' => [
- 'description' => 'The error message returned if the command failed to be sent or run. Valid values:'."\n"
- ."\n"
- .'* null: The command is run as expected.'."\n"
- .'* the specified instance does not exists: The specified instance does not exist or is released.'."\n"
- .'* the instance has released when create task: The instance is released when the command is being run.'."\n"
- .'* the instance is not running when create task: The instance is not in the Running state when the command is being run.'."\n"
- .'* the command is not applicable: The command is not applicable to the specified instance.'."\n"
- .'* the specified account does not exists: The specified account does not exist.'."\n"
- .'* the specified directory does not exists: The specified directory does not exist.'."\n"
- .'* the cron job expression is invalid: The specified CRON expression for the execution schedule is invalid.'."\n"
- .'* the aliyun service is not running on the instance: Cloud Assistant Agent is not running.'."\n"
- .'* the aliyun service in the instance does not response: Cloud Assistant Agent does not respond to your request.'."\n"
- .'* the aliyun service in the instance is upgrading now: Cloud Assistant Agent is being updated.'."\n"
- .'* the aliyun service in the instance need upgrade: Cloud Assistant Agent needs to be updated.'."\n"
- .'* the command delivery has been timeout: The request to send the command timed out.'."\n"
- .'* the command execution has been timeout: The command execution timed out.'."\n"
- .'* the command execution got an exception: An exception occurred when the command was being run.'."\n"
- .'* the command execution has been interrupted: The command execution is interrupted.'."\n"
- .'* the command execution exit code is not zero: The command execution is complete, and the exit code is not 0.'."\n",
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'the specified instance does not exists',
- ],
- 'ErrorCode' => [
- 'description' => 'The error code returned if the command failed to be sent or run.'."\n"
- ."\n"
- .'* null: The command is run as expected.'."\n"
- .'* InstanceNotExists: The specified instance does not exist or is released.'."\n"
- .'* InstanceReleased: The instance is released when the command is being run.'."\n"
- .'* InstanceNotRunning: The instance is not in the Running state when the command is being run.'."\n"
- .'* CommandNotApplicable: The command is not applicable to the specified instance.'."\n"
- .'* AccountNotExists: The specified account does not exist.'."\n"
- .'* DirectoryNotExists: The specified directory does not exist.'."\n"
- .'* BadCronExpression: The specified CRON expression for the execution schedule is invalid.'."\n"
- .'* ClientNotRunning: Cloud Assistant Agent is not running.'."\n"
- .'* ClientNotResponse: Cloud Assistant Agent does not respond to your request.'."\n"
- .'* ClientIsUpgrading: Cloud Assistant Agent is being updated.'."\n"
- .'* ClientNeedUpgrade: Cloud Assistant Agent needs to be updated.'."\n"
- .'* DeliveryTimeout: The request to send the command timed out.'."\n"
- .'* ExecutionTimeout: The command execution timed out.'."\n"
- .'* ExecutionException: An exception occurred when the command was being run.'."\n"
- .'* ExecutionInterrupted: The command execution is interrupted.'."\n"
- .'* ExitCodeNonzero: The command execution is complete, and the exit code is not 0.'."\n",
- 'type' => 'string',
- 'example' => 'InstanceNotExists',
- ],
- ],
+ 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.', 'type' => 'string', 'title' => '', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ', 'title' => ''],
+ 'TagResources' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'TagResource' => [
+ 'title' => '',
+ 'description' => 'A collection of resources and the tags of the resources. The information includes the resource IDs, resource types, and key-value pairs of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the resource and its tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => ['description' => 'The type of the resource. Valid values:'."\n"
+ ."\n"
+ .'- instance'."\n"
+ ."\n"
+ .'- snapshot'."\n"
+ ."\n"
+ .'- customimage'."\n"
+ ."\n"
+ .'- command'."\n"
+ ."\n"
+ .'- firewallrule'."\n"
+ ."\n"
+ .'- disk', 'type' => 'string', 'title' => '', 'example' => 'instance'],
+ 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => 'TestValue'],
+ 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'title' => '', 'example' => 's-bw526m1vi6x20c6g****'."\n"],
+ 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'TestKey'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"CommandInvocations\\": [\\n {\\n \\"InvokeId\\": \\"t-hz0373jyzxt****\\",\\n \\"CreationTime\\": \\"2023-04-27T10:11:58\\",\\n \\"CommandId\\": \\"c-hy0338xh28r****\\",\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"CommandName\\": \\"testCommandName\\",\\n \\"CommandType\\": \\"RunShellScript\\",\\n \\"CommandDescription\\": \\"testDescription\\",\\n \\"Username\\": \\"root\\",\\n \\"WorkingDir\\": \\"c:\\\\\\\\wwwroot\\",\\n \\"Timeout\\": 60,\\n \\"CommandContent\\": \\"echo 123\\",\\n \\"Parameters\\": \\"{}\\",\\n \\"InvokeInstances\\": [\\n {\\n \\"InstanceId\\": \\"2445f4aecdac4b71ba2c7e3a7ccf****\\",\\n \\"StartTime\\": \\"2023-05-09T03:32:24Z\\",\\n \\"FinishTime\\": \\"2023-04-03T02:42:29Z\\",\\n \\"InvocationStatus\\": \\"Running\\",\\n \\"Output\\": \\"OutputMsg\\",\\n \\"ExitCode\\": 0,\\n \\"ErrorInfo\\": \\"the specified instance does not exists\\",\\n \\"ErrorCode\\": \\"InstanceNotExists\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'DescribeCommandInvocations',
- ],
- 'DeleteCommand' => [
- 'summary' => 'Deletes a Command Assistant command.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'ListTagResources',
+ 'summary' => 'Queries the tags that are added to simple resources, such as instances, snapshots, disks, images, commands, and firewall rules.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***\\",\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"instance\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"s-bw526m1vi6x20c6g****\\\\n\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'LoginInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10988,61 +8567,103 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '140734',
+ 'abilityTreeNodes' => ['FEATUREswasN19LXQ', 'FEATUREswasK6WJ0Q'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'CommandId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The command ID. You can call the [DescribeCommands](~~64843~~) operation to query all available command IDs.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-sh02yh0932w****',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => '9ae7106e68eb4402b0dcbd48a9de****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Username',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The username of the simple application server.'."\n"
+ ."\n"
+ .'- For a Linux server, you do not need to enter a username.'."\n"
+ ."\n"
+ .'- For a Windows server, the default username `administrator` is used.', 'type' => 'string', 'required' => false, 'example' => 'administrator', 'title' => ''],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The password that corresponds to the username.'."\n"
+ ."\n"
+ .'- For a Linux server, you do not need to enter a password.'."\n"
+ ."\n"
+ .'- For a Windows server, enter the password that you set. If you have not set a password for the simple application server, set a password. For more information, see [Reset the password](~~60055~~).', 'type' => 'string', 'required' => false, 'example' => 'Test****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The port number that is used to log on to the simple application server by using Workbench.'."\n"
+ ."\n"
+ .'- Linux servers: The default value is 22.'."\n"
+ ."\n"
+ .'- Windows servers: The default value is 3389.'."\n"
+ ."\n"
+ .'> If you want to connect to a server by using a custom port, you must modify the default remote connection port. For more information, see [Configure a custom remote connection port](~~2807402~~).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3389', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Schema of response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****'],
+ 'RedirectUrl' => ['description' => 'The URL that you use to log on to the server.', 'type' => 'string', 'example' => 'https://ecs-workbench.aliyun.com/view/instance/single/gbktfz****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteCommand',
- 'description' => 'You cannot delete commands that are being run.'."\n",
- ],
- 'CreateCommand' => [
- 'summary' => 'Creates a Cloud Assistant command.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'INSTANCE_LOGIN_FAILURE', 'errorMessage' => 'Instance login failure.', 'description' => 'Instance login failed.'],
+ ],
+ ],
+ 'title' => 'LoginInstance',
+ 'summary' => 'Logs on to a simple application server on Workbench.',
+ 'description' => 'After you create a simple application server, you can log on to the simple application server to build environments and applications on the server.',
+ 'changeSet' => [
+ ['createdAt' => '2024-06-24T02:14:24.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-06-21T07:24:04.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LoginInstance'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:LoginInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:Instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2DE174B-7196-5778-A00D-6EA2601B****\\",\\n \\"RedirectUrl\\": \\"https://ecs-workbench.aliyun.com/view/instance/single/gbktfz****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyDatabaseInstanceDescription' => [
+ 'summary' => 'Modifies the description of a lightweight database instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11051,293 +8672,287 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '184909',
- 'abilityTreeNodes' => [
- 'FEATUREswasWZKIOQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
'autoTest' => false,
- 'notSupportAutoTestReason' => '创建类接口，不涉及越权等场景',
+ 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region where the lightweight database instance is located. Call the [ListRegions](~~189315~~) operation for a list of available regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the command. The name supports all character sets and can be up to 128 characters in length.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => 'The ID of the lightweight database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The description of the command. The description supports all character sets and can be up to 512 characters in length.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'A client-generated token to ensure the idempotence of the request. The token must be unique for each request, contain only ASCII characters, and not exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'Type',
+ 'name' => 'DatabaseInstanceDescription',
'in' => 'query',
+ 'schema' => ['description' => 'The new description of the lightweight database instance.', 'type' => 'string', 'example' => 'This is a lightweight database instance.', 'required' => true, 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The language type of the command. Valid values:'."\n"
- ."\n"
- .'* RunBatScript: batch command, applicable to Windows instances'."\n"
- .'* RunPowerShellScript: PowerShell command, applicable to Windows instances'."\n"
- .'* RunShellScript: shell command, applicable to Linux instances'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RunShellScript',
+ 'title' => 'Schema of Response',
+ 'description' => 'The response data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ 'title' => 'ModifyDatabaseInstanceDescription',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-22T03:40:41.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDatabaseInstanceDescription'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'CommandContent',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The command content. When you specify this parameter, take note of the following items:'."\n"
- ."\n"
- .'* When `EnableParameter` is set to true, the custom parameter feature is enabled, and you can configure custom parameters in the command based on the following rules:'."\n"
- .'* Define custom parameters in the {{}} format. Within `{{}}`, the spaces and line feeds before and after the parameter names are ignored.'."\n"
- .'* You can specify up to 20 custom parameters.'."\n"
- .'* The name of a custom parameter can contain only letters, digits, underscores (\\_), and hyphens (-). The name is case-insensitive.'."\n"
- .'* The name of a custom parameter cannot exceed 64 bytes in length.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ifconfig -s',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyDatabaseInstanceDescription',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
],
],
+ ],
+ 'translator' => 'machine',
+ ],
+ 'ModifyDatabaseInstanceParameter' => [
+ 'summary' => 'After you create a Simple Application Server database service instance, you can view and modify its parameters.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'WorkingDir',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The working directory of the command on the ECS instance.'."\n"
- ."\n"
- .'Default values:'."\n"
- ."\n"
- .'* For a Linux instance, the default value is the home directory of the root user, which is the `/root` directory.'."\n"
- .'* For a Windows instance, the default value is the directory where the Cloud Assistant client process resides. Example: `C:\\Windows\\System32`.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/root/',
- ],
+ 'schema' => ['description' => 'The region ID of the database instance. Call [ListRegions](~~189315~~) to view the supported Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Timeout',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The timeout period for the command execution on the instance.'."\n"
- ."\n"
- .'If a command execution task times out, Command Assistant forcefully terminates the task process. Valid values: 10 to 86400. Unit: seconds. The period of 86400 seconds is equal to 24 hours.'."\n"
- ."\n"
- .'Default value: 60.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '60',
- ],
+ 'schema' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
[
- 'name' => 'EnableParameter',
+ 'name' => 'Parameters',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to use custom parameters in the command.'."\n"
- ."\n"
- .'Default value: false.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'A JSON string that specifies the database parameters and their values. The value for each parameter must be a string. Format: `{"ParameterName1":"Value1","ParameterName2":"Value2",...}`.', 'type' => 'string', 'required' => true, 'example' => '{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}', 'title' => ''],
],
[
- 'name' => 'Tag',
+ 'name' => 'ForceRestart',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'The tags that you want to add to the command. You can specify up to 20 tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tags of the command.',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The key of tag N that you want to add to the command. Valid values of N: 1 to 20.'."\n"
- ."\n"
- .'The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'The value of tag N that you want to add to the command. Valid values of N: 1 to 20.'."\n"
- ."\n"
- .'The tag value can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => 'Specifies whether to restart the database for the parameter changes to take effect. Valid values:'."\n"
+ ."\n"
+ .'- true: Forces a restart. Set this to true if any modified parameter requires a restart to take effect. Otherwise, the change will not take effect.'."\n"
+ ."\n"
+ .'- false: Do not force a restart.'."\n"
+ ."\n"
+ .'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => 'A client-generated token to ensure request idempotence. You must ensure that the token is unique for each request. It can contain only ASCII characters and cannot be longer than 64 characters. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response.'."\n",
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4****',
- ],
- 'CommandId' => [
- 'description' => 'The command ID.'."\n",
- 'type' => 'string',
- 'example' => 'c-sh02yh0932w****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\",\\n \\"CommandId\\": \\"c-sh02yh0932w****\\"\\n}","type":"json"}]',
- 'title' => 'CreateCommand',
- ],
- 'StartTerminalSession' => [
- 'summary' => 'Creates a session for a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'ModifyDatabaseInstanceParameter',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-22T03:40:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDatabaseInstanceParameter'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyDatabaseInstanceParameter',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyFirewallRule' => [
+ 'summary' => 'Modifies the firewall rule of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswasN19LXQ',
- 'FEATUREswasK6WJ0Q',
- ],
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'CommandLine',
+ 'name' => 'RuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ssh root@192.168.0.***',
- ],
+ 'schema' => ['description' => 'The ID of the firewall rule.', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****', 'title' => ''],
+ ],
+ [
+ 'name' => 'RuleProtocol',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The transport layer protocol. Valid values:'."\n"
+ ."\n"
+ .'- TCP: the TCP protocol'."\n"
+ ."\n"
+ .'- UDP: the UDP protocol'."\n"
+ ."\n"
+ .'- TCP+UDP: the TCP and UDP protocols', 'type' => 'string', 'required' => true, 'example' => 'TCP', 'title' => ''],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The port range. Valid values: 165535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 10241055.', 'type' => 'string', 'required' => true, 'example' => '3306', 'title' => ''],
+ ],
+ [
+ 'name' => 'SourceCidrIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IP address or CIDR block that is allowed in the firewall rule.', 'type' => 'string', 'required' => false, 'example' => '10.147.33.**', 'title' => ''],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The remarks of the firewall rule.', 'type' => 'string', 'example' => 'Custom', 'required' => false, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'SessionId' => [
- 'description' => 'The session ID.'."\n",
- 'type' => 'string',
- 'example' => 'ffb90b6e-b18a-4a33-88cf-86fb88****',
- ],
- 'SecurityToken' => [
- 'description' => 'The security token included in the WebSocket request header. The system uses this token to authenticate the request.'."\n",
- 'type' => 'string',
- 'example' => 'token-xxxaaz',
- ],
- 'WebSocketUrl' => [
- 'description' => 'The URL of the WebSocket session that is used to connect to the server. The URL contains the session ID (`SessionId`) and the authentication token (`SecurityToken`).'."\n",
- 'type' => 'string',
- 'example' => 'wss://xxxx',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"SessionId\\": \\"ffb90b6e-b18a-4a33-88cf-86fb88****\\",\\n \\"SecurityToken\\": \\"token-xxxaaz\\",\\n \\"WebSocketUrl\\": \\"wss://xxxx\\"\\n}","type":"json"}]',
- 'title' => 'StartTerminalSession',
- ],
- 'InstallCloudAssistant' => [
- 'summary' => 'Installs the Cloud Assistant client on simple application servers at a time.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidProtocol.ValueNotSupported', 'errorMessage' => 'The specified parameter Protocol is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidPort.ValueNotSupported', 'errorMessage' => 'The specified parameter Port is invalid.', 'description' => ''],
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
+ ['errorCode' => 'InvalidIpProtocol.ValueNotSupported', 'errorMessage' => 'The parameter Permissions.1.IpProtocol must be specified with case insensitive TCP, UDP, ICMP, GRE or All.', 'description' => 'Parameter Permissions. 1. The IpProtocol must be specified as case-insensitive TCP, UDP, ICMP, GRE, or All.'],
+ ],
+ 403 => [
+ ['errorCode' => 'FirewallRuleLimitExceed', 'errorMessage' => 'The maximum number of firewall rules in an instance is exceeded.', 'description' => ''],
+ ['errorCode' => 'FirewallRuleAlreadyExist', 'errorMessage' => 'The specified Rule already exist', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E1FEE\\"\\n}","type":"json"}]',
+ 'title' => 'ModifyFirewallRule',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyFirewallRule'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyFirewallRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/{#RuleId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'ModifyFirewallTemplate' => [
+ 'summary' => 'Modifies the firewall rule in a firewall template. You can apply the new firewall rule to simple application servers.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11346,682 +8961,580 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '219662',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
+ ],
+ [
+ 'name' => 'FirewallTemplateId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the firewall template.', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the firewall template.', 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the firewall template.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'FirewallTemplateRule',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The IDs of the simple application servers.'."\n",
+ 'description' => 'The firewall rule in the template.',
'type' => 'array',
'items' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'FirewallTemplateRuleId' => ['description' => 'The ID of the firewall rule.', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****', 'title' => ''],
+ 'RuleProtocol' => ['description' => 'The transport layer protocol that the rule supports. Valid values:'."\n"
+ ."\n"
+ .'- TCP'."\n"
+ ."\n"
+ .'- UDP'."\n"
+ ."\n"
+ .'- TCP+UDP'."\n"
+ ."\n"
+ .'- ICMP', 'type' => 'string', 'required' => false, 'example' => 'TCP', 'title' => ''],
+ 'Port' => ['description' => 'The port range. Valid values: 1 to 65535. Specify a port range in the format of \\<start port number>/\\<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055.'."\n"
+ ."\n"
+ .'> If you set RuleProtocol to ICMP, you must set Port to -1/-1.', 'type' => 'string', 'required' => false, 'example' => '8080', 'title' => ''],
+ 'SourceCidrIp' => ['description' => 'The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks of the firewall template rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
'required' => false,
- 'example' => 'ace0706b2ac4454d984295a94213****',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => true,
- 'maxItems' => 50,
+ 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'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' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","errorExample":""},{"type":"xml","example":"<InstallCloudAssistantResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n</InstallCloudAssistantResponse>","errorExample":""}]',
- 'title' => 'InstallCloudAssistant',
- 'description' => 'To run commands on your simple application servers, you must install the Cloud Assistant client on your servers. You can call the [DescribeCloudAssistantStatus](~~439512~~) operation to check whether the Cloud Assistant client is installed on your simple application servers. If you have not installed the Cloud Assistant client, you can call the InstallCloudAssistant operation to install the client. Then, you can call the [RebootInstance](~~190443~~) operation to restart the servers to allow the client to take effect.'."\n",
- ],
- 'DescribeCloudAssistantStatus' => [
- 'summary' => 'Queries whether the Cloud Assistant client is installed on simple application servers.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'ModifyFirewallTemplate',
+ 'description' => 'Modifying a firewall template does not affect the firewall rules that have been applied to simple application servers.',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-12T06:36:03.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyFirewallTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyImageShareStatus' => [
+ 'summary' => 'Shares or unshares a custom image to Elastic Compute Service (ECS).',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application servers.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the custom image. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from page 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'Maximum value: 50.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'm-saacssasc****', 'title' => ''],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'Operation',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The IDs of the simple application servers.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- 'required' => false,
- 'maxItems' => 50,
- ],
+ 'schema' => ['description' => 'Valid values:'."\n"
+ ."\n"
+ .'- Share'."\n"
+ ."\n"
+ .'- UnShare', 'type' => 'string', 'required' => true, 'example' => 'Share', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'CloudAssistantStatus' => [
- 'description' => 'Indicates whether the Cloud Assistant client is installed on the server.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- 'Status' => [
- 'description' => 'Indicates whether the Cloud Assistant client is installed on the server.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'Maximum value: 50.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from page 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"CloudAssistantStatus\\": [\\n {\\n \\"InstanceId\\": \\"ace0706b2ac4454d984295a94213****\\",\\n \\"Status\\": true\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeCloudAssistantStatusResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n <CloudAssistantStatus>\\n <InstanceId>ace0706b2ac4454d984295a94213****</InstanceId>\\n <Status>true</Status>\\n </CloudAssistantStatus>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n</DescribeCloudAssistantStatusResponse>","errorExample":""}]',
- 'title' => 'DescribeCloudAssistantStatus',
- 'description' => 'By default, the Cloud Assistant client is installed on simple application servers. If you have manually uninstalled the client, you must reinstall the client. Otherwise, you cannot run commands on the servers.'."\n",
- ],
- 'DescribeInvocationResult' => [
- 'summary' => 'Queries the execution result of a command.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParam.OperationIllegal', 'errorMessage' => 'The specified parameter operation is illegal.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'ModifyImageShareStatus',
+ 'description' => 'Custom images can be shared to ECS. If the configurations of your simple application server cannot meet your business requirements, or you want to deploy your business on ECS instances, you can share your custom image to ECS to transfer your business from Simple Application Server to ECS.'."\n"
+ ."\n"
+ .'> The region in which the shared image resides in ECS is the same as the region in which the custom image resides in Simple Application Server.'."\n"
+ ."\n"
+ .'You can unshare a custom image based on your business requirements or when you want to delete the custom image. After you unshare a custom image, take note of the following items:'."\n"
+ ."\n"
+ .'- You cannot query or use the custom image by using the ECS console or API.'."\n"
+ ."\n"
+ .'- You cannot re-initialize the disks of the ECS instances that were created based on the shared image.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImageShareStatus'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyImageShareStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyInstanceVncPassword' => [
+ 'summary' => 'Changes the VNC password of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswas8GRVRI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'InvokeId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The execution ID. You can call the [DescribeInvocations](~~439368~~) operation to query execution IDs.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 't-bj02prjhw1n****',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'VncPassword',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The VNC connection password.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'InvocationResult' => [
- 'description' => 'The execution results.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'StartTime' => [
- 'description' => 'The time when the execution started.'."\n",
- 'type' => 'string',
- 'example' => '2022-07-11T06:37:16Z',
- ],
- 'FinishedTime' => [
- 'description' => 'The time when the execution ended.'."\n",
- 'type' => 'string',
- 'example' => '2022-07-11T06:37:17Z',
- ],
- 'InvocationStatus' => [
- 'description' => 'The status of the execution progress. Valid values:'."\n"
- ."\n"
- .'* Pending: The command is being verified or sent.'."\n"
- .'* Invalid: The specified command type or parameter is invalid.'."\n"
- .'* Aborted: The command fails to be sent to the server. To send a command to a server, make sure that the server is in the Running state and the command can be sent within 1 minute.'."\n"
- .'* Running: The command is being executed on the server.'."\n"
- .'* Success: The execution is completed, and the exit code is 0.'."\n"
- .'* Failed: The execution is completed, and the exit code is not 0.'."\n"
- .'* Error: The execution cannot proceed due to an exception.'."\n"
- .'* Timeout: The execution times out.'."\n"
- .'* Cancelled: The execution is canceled, and the command is not executed.'."\n"
- .'* Stopping: The command in the Running state is being stopped.'."\n"
- .'* Terminated: The command is terminated while it is being executed.'."\n",
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'ExitCode' => [
- 'description' => 'The exit code of the command.'."\n"
- ."\n"
- .'* For Linux instances, the exit code is the exit code of the shell command.'."\n"
- .'* For Windows instances, the exit code is the exit code of the batch or PowerShell command.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'ErrorInfo' => [
- 'description' => 'The error message returned when the command is not successfully sent or executed. Valid values:'."\n"
- ."\n"
- .'* If this parameter is empty, the command is executed normally.'."\n"
- .'* the specified instance does not exists: The specified server does not exist or is released.'."\n"
- .'* the instance has released when create task: The server was released while the command was being executed on the server.'."\n"
- .'* the instance is not running when create task: The server is not in the Running state while the command is being executed.'."\n"
- .'* the command is not applicable: The command is not applicable to the specified server.'."\n"
- .'* the specified account does not exists: The specified account does not exist.'."\n"
- .'* the specified directory does not exists: The specified directory does not exist.'."\n"
- .'* the cron job expression is invalid: The specified cron expression is invalid.'."\n"
- .'* the aliyun service is not running on the instance: The Cloud Assistance client is not running.'."\n"
- .'* the aliyun service in the instance does not response: The Cloud Assistant client does not respond to your request.'."\n"
- .'* the aliyun service in the instance is upgrading now: The Cloud Assistant client is being upgraded.'."\n"
- .'* the aliyun service in the instance need upgrade: The Cloud Assistant client needs to be upgraded.'."\n"
- .'* the command delivery has been timeout: Command sending times out.'."\n"
- .'* the command execution has been timeout: The execution times out.'."\n"
- .'* the command execution got an exception: An exception occurs while the command is being executed.'."\n"
- .'* the command execution has been interrupted: The execution is interrupted.'."\n"
- .'* the command execution exit code is not zero: The execution is complete, and the exit code is not 0.'."\n",
- 'type' => 'string',
- 'example' => 'the specified instance does not exists',
- ],
- 'ErrorCode' => [
- 'description' => 'The error code that is returned if the command failed to be sent or executed.'."\n"
- ."\n"
- .'* If this parameter is empty, the command is executed normally.'."\n"
- .'* InstanceNotExists: The specified server does not exist or is released.'."\n"
- .'* InstanceReleased: The server was released while the command was being executed on the server.'."\n"
- .'* InstanceNotRunning: The server is not in the Running state while the command is being executed.'."\n"
- .'* CommandNotApplicable: The command is not applicable to the specified server.'."\n"
- .'* AccountNotExists: The specified account does not exist.'."\n"
- .'* DirectoryNotExists: The specified directory does not exist.'."\n"
- .'* BadCronExpression: The specified cron expression for the execution schedule is invalid.'."\n"
- .'* ClientNotRunning: The Cloud Assistant client is not running.'."\n"
- .'* ClientNotResponse: The Cloud Assistant client does not respond.'."\n"
- .'* ClientIsUpgrading: The Cloud Assistant client is being upgraded.'."\n"
- .'* ClientNeedUpgrade: The Cloud Assistant client needs to be upgraded.'."\n"
- .'* DeliveryTimeout: Command sending times out.'."\n"
- .'* ExecutionTimeout: The execution times out.'."\n"
- .'* ExecutionException: An exception occurs while the command is being executed.'."\n"
- .'* ExecutionInterrupted: The execution is interrupted.'."\n"
- .'* ExitCodeNonzero: The execution is complete, but the exit code is not 0.'."\n",
- 'type' => 'string',
- 'example' => 'InstanceNotExists',
- ],
- 'InvokeId' => [
- 'description' => 'The execution ID.'."\n",
- 'type' => 'string',
- 'example' => 't-bj02prjje65****',
- ],
- 'InvokeRecordStatus' => [
- 'description' => 'The status of the execution. Valid values:'."\n"
- ."\n"
- .'* Running'."\n"
- .'* Finished'."\n"
- .'* Failed'."\n"
- .'* Stopped'."\n",
- 'type' => 'string',
- 'example' => 'Finished',
- ],
- 'InvokeUser' => [
- 'description' => 'The username who executes the command on the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'root',
- ],
- 'Output' => [
- 'description' => 'The command output.'."\n",
- 'type' => 'string',
- 'example' => 'YWRtaW4K',
- ],
- 'InstanceId' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"InvocationResult\\": {\\n \\"StartTime\\": \\"2022-07-11T06:37:16Z\\",\\n \\"FinishedTime\\": \\"2022-07-11T06:37:17Z\\",\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"ExitCode\\": 0,\\n \\"ErrorInfo\\": \\"the specified instance does not exists\\",\\n \\"ErrorCode\\": \\"InstanceNotExists\\",\\n \\"InvokeId\\": \\"t-bj02prjje65****\\",\\n \\"InvokeRecordStatus\\": \\"Finished\\",\\n \\"InvokeUser\\": \\"root\\",\\n \\"Output\\": \\"YWRtaW4K\\",\\n \\"InstanceId\\": \\"ace0706b2ac4454d984295a94213****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeInvocationResultResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n <InvocationResult>\\n <StartTime>2022-07-11T06:37:16Z</StartTime>\\n <FinishedTime>2022-07-11T06:37:17Z</FinishedTime>\\n <InvocationStatus>Success</InvocationStatus>\\n <ExitCode>0</ExitCode>\\n <ErrorInfo>the specified instance does not exists</ErrorInfo>\\n <ErrorCode>InstanceNotExists</ErrorCode>\\n <InvokeId>t-bj02prjje65****</InvokeId>\\n <InvokeRecordStatus>Finished</InvokeRecordStatus>\\n <InvokeUser>root</InvokeUser>\\n <Output>YWRtaW4K</Output>\\n <InstanceId>ace0706b2ac4454d984295a94213****</InstanceId>\\n </InvocationResult>\\n</DescribeInvocationResultResponse>","errorExample":""}]',
- 'title' => 'DescribeInvocationResult',
- 'description' => '* After you execute a command, the command may not succeed or return the expected results. You can call this operation to query the execution result of a command.'."\n"
- .'* You can query the execution results that were generated within the last two weeks. A maximum of 100,000 entries of execution results can be retained.'."\n",
- ],
- 'RunCommand' => [
- 'summary' => 'Runs commands on a simple application server.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidPassword.ValueNotSupported', 'errorMessage' => 'The specified parameter Password is invalid.', 'description' => ''],
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'ModifyInstanceVncPassword',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceVncPassword'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyInstanceVncPassword',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
+ ],
+ 'RebootInstance' => [
+ 'summary' => 'Restarts a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswasWZKIOQ',
- ],
+ 'abilityTreeCode' => '20468',
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
],
'parameters' => [
[
- 'name' => 'CommandContent',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The content of the command. Take note of the following items:'."\n"
- ."\n"
- .'* If you set `EnableParameter` to true, the custom parameter feature is enabled in the command content and you can configure custom parameters based on the following rules:'."\n"
- .'* Define custom parameters in the {{}} format. Within `{{}}`, the spaces and line feeds before and after the parameter names are ignored.'."\n"
- .'* The number of custom parameters cannot be greater than 20.'."\n"
- .'* A custom parameter name can contain only letters, digits, underscores (\\_), and hyphens (-). The name is case-insensitive.'."\n"
- .'* Each custom parameter name cannot exceed 64 bytes in length.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ifconfig -s',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'WorkingDir',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The execution path of the command. Custom paths are supported. Default execution paths vary based on the operating systems of the servers.'."\n"
- ."\n"
- .'* For Linux servers, the default path is /root of the root user.'."\n"
- .'* For Windows servers, the default path is C:\\Windows\\system32.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/home/',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ClientToken',
'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The state of the current instance does not support this operation.', 'description' => ''],
+ ],
[
- 'name' => 'Timeout',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The timeout period of the command on the server.'."\n"
- ."\n"
- .'If a command execution task times out, Command Assistant forcibly terminates the task process. Valid values: 10 to 86400. Unit: seconds. The period of 86400 seconds is equal to 24 hours.'."\n"
- ."\n"
- .'Default value: 60.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '60',
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'RebootInstance',
+ 'description' => '- Only simple application servers that are in the Running state can be restarted.'."\n"
+ ."\n"
+ .'- After you restart a simple application server, it enters the Starting state.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebootInstance'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:RebootInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
+ ],
+ 'RebootInstances' => [
+ 'summary' => 'Restarts simple application servers.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
[
- 'name' => 'Type',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The language type of the command. Valid values:'."\n"
- ."\n"
- .'* RunBatScript: batch commands (applicable to Windows servers).'."\n"
- .'* RunPowerShellScript: PowerShell commands (applicable to Windows servers).'."\n"
- .'* RunShellScript: shell commands (applicable to Linux servers).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RunShellScript',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'EnableParameter',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable the custom parameter feature.'."\n"
- ."\n"
- .'Default value: false.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'Parameters',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]', 'title' => ''],
+ ],
+ [
+ 'name' => 'ForceReboot',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to forcibly restart the servers. Valid values:'."\n"
+ ."\n"
+ .'- true: forcibly restarts the servers. This operation is equivalent to the typical power-off operation. Cache data that is not written to storage devices on the server will be lost.'."\n"
+ ."\n"
+ .'- false: normally restarts the instance.'."\n"
+ ."\n"
+ .'Default value: false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The custom parameters in the key-value pair format that are to be passed in when the command includes custom parameters. For example, if the command content is `echo {{name}}`, you can use `Parameters` to pass in the `{"name":"Jack"}` key-value pair. The `name` key of the custom parameter is automatically replaced with the paired Jack value to generate a new command. As a result, the `echo Jack` command is executed.'."\n"
- ."\n"
- .'You can specify up to 20 custom parameters. Take note of the following items:'."\n"
- ."\n"
- .'* The key of a custom parameter can be up to 64 characters in length and cannot be an empty string.'."\n"
- .'* The value of a custom parameter can be an empty string.'."\n"
- .'* The size of the command (including custom parameters and original command content) after Base64 encoding cannot exceed 16 KB.'."\n"
- .'* The custom parameter names that are specified by Parameters must be included in the custom parameter names that you specified when you created the command. You can use empty strings to represent the parameters that are not passed in.'."\n"
- ."\n"
- .'This parameter is left empty by default, which indicates that the custom parameter feature is disabled.'."\n",
'type' => 'object',
- 'required' => false,
- 'example' => '{"name":"Jack", "accessKey":"LTAI****************"}',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The state of the current instance does not support this operation.', 'description' => ''],
+ ],
[
- 'name' => 'WorkingUser',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'A user of the server who runs the command. We recommend that you run the command as a regular user to reduce security risks. Default values:'."\n"
- ."\n"
- .'* For Linux servers, the default value is root.'."\n"
- .'* For Windows servers, the default value is system.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'root',
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'RebootInstances',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebootInstances'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:RebootInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
+ ],
+ 'ReleasePublicConnection' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'WindowsPasswordName',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswasIU54HN'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '轻量数据库服务走下线流程',
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the password used to run the command on a Windows simple application server.'."\n"
- ."\n"
- .'If you want to use a username other than the default "system" username to run the command on a Windows server, you must specify both the WindowsPasswordName and WorkingUser parameters. The password is hosted in plaintext in the parameter repository of CloudOps Orchestration Service (OOS) to mitigate the risk of password leaks. Only the name of the password is passed in by using WindowsPasswordName.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'axtSecretPassword',
- ],
+ 'schema' => ['description' => 'The region ID of the lightweight database instance. You can call [ListRegions](~~189315~~) to query for supported Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => 'The ID of the lightweight database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the command.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => 'A client-generated token to ensure request idempotence. You must ensure that this token is unique for each request. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Response body',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****',
- ],
- 'InvokeId' => [
- 'description' => 'The execution ID.'."\n",
- 'type' => 'string',
- 'example' => 't-hz02p9545t6****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"InvokeId\\": \\"t-hz02p9545t6****\\"\\n}","errorExample":""},{"type":"xml","example":"<RunCommandResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <InvokeId>t-hz02p9545t6****</InvokeId>\\n</RunCommandResponse>","errorExample":""}]',
- 'title' => 'RunCommand',
- 'description' => 'Command Assistant is an automated O\\&M tool for Simple Application Server. You can maintain simple application servers by running shell, PowerShell, and batch commands in the Simple Application Server console without remotely logging on to the servers.'."\n"
- ."\n"
- .'Before you use Command Assistant, take note of the following items:'."\n"
- ."\n"
- .'* The simple application server must be in the Running state.'."\n"
- .'* The Cloud Assistant client is installed on the server. By default, the Cloud Assistant client is installed on simple application servers. If you have manually uninstalled the client, you must reinstall it. For more information, see [Install the Cloud Assistant Agent](~~64921~~).'."\n",
- ],
- 'DescribeInvocations' => [
- 'summary' => 'Queries details about command execution.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'ReleasePublicConnection',
+ 'summary' => 'Releases the public endpoint of a lightweight database instance if you no longer need to access it from the internet.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-22T03:40:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReleasePublicConnection'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:ReleasePublicConnection',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'RemoveCustomImageShareAccount' => [
+ 'summary' => 'Unshares a custom image that is shared across Alibaba Cloud accounts.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '227271',
+ 'abilityTreeNodes' => ['FEATUREswasSHBOLC'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the simple application server.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '3a658ca270df4df39f22e289b338****',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from page 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'Maximum value: 50.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The ID of the shared custom image.'."\n", 'type' => 'string', 'required' => true, 'example' => 'm-2zehv38jjmwva1ee****', 'title' => ''],
],
[
- 'name' => 'InvokeStatus',
+ 'name' => 'Account',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The status of the command execution. Valid values:'."\n"
- ."\n"
- .'* Running: The command is being executed.'."\n"
- .'* Finished: The execution is complete.'."\n"
- .'* Failed: The execution fails.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Finished',
+ 'description' => 'The IDs of the Alibaba Cloud accounts with which you want to unshare the image.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the Alibaba Cloud account with which you want to unshare the image.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '125111425233****', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -12029,233 +9542,128 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The schema of response.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'Invocations' => [
- 'description' => 'The command name.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CreationTime' => [
- 'description' => 'The time when the command was created.'."\n",
- 'type' => 'string',
- 'example' => '2022-07-11T06:37:16Z',
- ],
- 'InvocationStatus' => [
- 'description' => 'The status of the command. Valid values:'."\n"
- ."\n"
- .'* Pending: The command is being verified or sent.'."\n"
- .'* Invalid: The specified command type or parameter is invalid.'."\n"
- .'* Aborted: The command failed to be sent. To send a command to an instance, make sure that the instance is in the Running state and the command is sent to the instance within 1 minute.'."\n"
- .'* Running: The command is being run on the instance.'."\n"
- .'* Success: The command finishes running, and the exit code is 0.'."\n"
- .'* Failed: The command finishes running, but the exit code is not 0.'."\n"
- .'* Error: The running of the command cannot proceed due to an exception.'."\n"
- .'* Timeout: The running of the command times out.'."\n"
- .'* Cancelled: The running is canceled, and the command is not run.'."\n"
- .'* Stopping: The command that is running is being stopped.'."\n"
- .'* Terminated: The command is terminated while it is being run.'."\n",
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'CommandType' => [
- 'description' => 'The type of the command. Valid values:'."\n"
- ."\n"
- .'* RunBatScript: batch command (applicable to Windows instances).'."\n"
- .'* RunPowerShellScript: PowerShell command (applicable to Windows instances).'."\n"
- .'* RunShellScript: shell command (applicable to Linux instances).'."\n",
- 'type' => 'string',
- 'example' => 'RunShellScript',
- ],
- 'CommandContent' => [
- 'description' => 'The content of the command, which is Base64-encoded.'."\n",
- 'type' => 'string',
- 'example' => 'bHM=',
- ],
- 'Parameters' => [
- 'description' => 'The custom parameters in the command. If no custom parameter exists in the command, the default value is {}.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
- 'InvokeStatus' => [
- 'description' => 'The status of the command. Valid values:'."\n"
- ."\n"
- .'* Running: The command is running.'."\n"
- .'* Finished: The command finishes running.'."\n"
- .'* Failed: The running of the command failed.'."\n"
- .'* Stopped: The running is stopped.'."\n",
- 'type' => 'string',
- 'example' => 'Finished',
- ],
- 'InvokeId' => [
- 'description' => 'The ID of the command task.'."\n",
- 'type' => 'string',
- 'example' => 't-hz02p9545t6****',
- ],
- 'CommandName' => [
- 'description' => 'The name of the command.'."\n",
- 'type' => 'string',
- 'example' => 'testname',
- ],
- ],
- ],
- ],
- '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',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"Invocations\\": [\\n {\\n \\"CreationTime\\": \\"2022-07-11T06:37:16Z\\",\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"CommandType\\": \\"RunShellScript\\",\\n \\"CommandContent\\": \\"bHM=\\",\\n \\"Parameters\\": {},\\n \\"InvokeStatus\\": \\"Finished\\",\\n \\"InvokeId\\": \\"t-hz02p9545t6****\\",\\n \\"CommandName\\": \\"testname\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 10\\n}","errorExample":""},{"type":"xml","example":"<DescribeInvocationsResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n <Invocations>\\n <CreationTime>2022-07-11T06:37:16Z</CreationTime>\\n <InvocationStatus>Success</InvocationStatus>\\n <CommandType>RunShellScript</CommandType>\\n <CommandContent>bHM=</CommandContent>\\n <InvokeStatus>Finished</InvokeStatus>\\n <InvokeId>t-hz02p9545t6****</InvokeId>\\n <CommandName>testname</CommandName>\\n </Invocations>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <TotalCount>10</TotalCount>\\n</DescribeInvocationsResponse>","errorExample":""}]',
- 'title' => 'DescribeInvocations',
- 'description' => '* After you execute a command, the command may not succeed or return the expected results. You can call this operation to query the actual execution results.'."\n"
- .'* You can query the execution results that were generated within the last two weeks. Up to 100,000 entries of execution results can be retained.'."\n",
- ],
- 'ModifyDatabaseInstanceParameter' => [
- 'summary' => 'After you create a Simple Database Service instance, you can view the parameters of the instance or modify the parameters of the instance based on your business requirements.',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ 'title' => 'RemoveCustomImageShareAccount',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:RemoveCustomImageShareAccount',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RenewInstance' => [
+ 'summary' => 'Renews a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
- 'tenantRelevance' => 'publicInformation',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREswasOLUWJH'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => 'The region ID of the server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Parameters',
+ 'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => 'The JSON strings that consist of instance parameters and the values of the instance parameters. The parameter values are of the string type. Format: {"Parameter name 1":"Parameter value 1","Parameter name 2":"Parameter value 2"...}.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}',
- ],
- ],
- [
- 'name' => 'ForceRestart',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to forcibly restart the instance after parameters are modified. Valid values:'."\n"
- ."\n"
- .'* true: forcibly restarts the instance. If a new parameter value takes effect only after the instance restarts, you must set this parameter to true. Otherwise, the new parameter value cannot take effect.'."\n"
- .'* false: does not forcibly restart the instance.'."\n"
- ."\n"
- .'Default value: false.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The renewal period. Unit: month. Valid values: 1, 3, 6, 12, 24, and 36.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '36', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDatabaseInstanceParameterResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n</ModifyDatabaseInstanceParameterResponse>","errorExample":""}]',
- 'title' => 'ModifyDatabaseInstanceParameter',
- 'description' => 'After you create a Simple Database Service instance, you can view the parameters of the instance or modify the parameters of the instance based on your business requirements.'."\n"
- ."\n"
- .'### QPS limit'."\n"
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidPeriod.ValueNotSupported', 'errorMessage' => 'The specified parameter Period is invalid.', 'description' => ''],
+ ['errorCode' => 'CSS_SYSTEM_ERROR', 'errorMessage' => 'The sales system encountered an error.', 'description' => 'There was an error in the selling system.'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'RenewInstance',
+ 'description' => '- Before you call this operation, we recommend that you understand the billing of Simple Application Server. For more information, see [Billable items](~~58623~~).'."\n"
."\n"
- .'You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~347607~~).'."\n",
- ],
- 'StopDatabaseInstance' => [
- 'summary' => 'Stops a Simple Database Service instance.',
- 'methods' => [
- 'post',
- 'get',
+ .'- Before you call this operation, make sure that the balance in your account is sufficient. If the balance in your account is insufficient, the renewal fails.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:RenewInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
+ ],
+ 'ResetDatabaseAccountPassword' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -12267,9 +9675,7 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
+ 'abilityTreeNodes' => ['FEATUREswas8GRVRI'],
'autoTest' => false,
'notSupportAutoTestReason' => '轻量数据库，走下线流程',
'tenantRelevance' => 'publicInformation',
@@ -12278,202 +9684,209 @@
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the lightweight database instance. You can call the [ListRegions](~~189315~~) operation to query the supported Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => 'The ID of the lightweight database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AccountPassword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The new password for the administrator account.', 'type' => 'string', 'required' => true, 'example' => 'Password****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request. The token must be unique for each request, contain only ASCII characters, and not exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopDatabaseInstanceResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n</StopDatabaseInstanceResponse>","errorExample":""}]',
- 'title' => 'StopDatabaseInstance',
- 'description' => 'You can call this operation to stop a Simple Database Service instance that is in the Running state. After the instance is stopped, you cannot log on to or access the instance.'."\n",
- ],
- 'StartDatabaseInstance' => [
- 'summary' => 'Starts a Simple Database Service instance.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'ResetDatabaseAccountPassword',
+ 'summary' => 'Use this operation to reset the password for the administrator account of a database. For enhanced security, change your password regularly.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-22T03:40:41.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetDatabaseAccountPassword'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ResetDatabaseAccountPassword',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'ResetDisk' => [
+ 'summary' => 'Rolls back a disk based on a snapshot.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server for which the snapshot is created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'DiskId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => 'The ID of the disk to be rolled back.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp14wq0149cpp2xy****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The snapshot ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-bp16oazlsold4dks****', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartDatabaseInstanceResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n</StartDatabaseInstanceResponse>","errorExample":""}]',
- 'title' => 'StartDatabaseInstance',
- 'description' => 'You can call this operation to start a Simple Database Service instance that is in the Stopped state.'."\n",
- ],
- 'ModifyDatabaseInstanceDescription' => [
- 'summary' => 'Modifies the description of a Simple Database Service instance.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus.ResetDisk', 'errorMessage' => 'Rolling back the disk requires the instance to operate in a stopped state.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidDiskId.NotFound', 'errorMessage' => 'The specified DiskId does not exist.', 'description' => ''],
+ ['errorCode' => 'InvalidSnapshotId.NotFound', 'errorMessage' => 'The specified SnapshotId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ResetDisk',
+ 'description' => '- You can call this operation only if the associated simple application server is in the Stopped state.'."\n"
+ ."\n"
+ .'- If you restore a disk from a snapshot, the incremental data after the snapshot is created is lost. We recommend that you back up the data before you perform this operation.'."\n"
+ ."\n"
+ .'### [](#)Precautions'."\n"
+ ."\n"
+ .'Resetting the system or changing the image of a simple application server clears the disk data on the server. Snapshots created before the reset or change are retained but cannot be used to restore disks.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetDisk'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ResetDisk',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DiskId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
+ ],
+ 'ResetSystem' => [
+ 'summary' => 'Resets a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '20471',
+ 'abilityTreeNodes' => ['FEATUREswasI9F3VX'],
],
'parameters' => [
[
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => 'The ID of the destination image. If you do not specify this parameter, the current image is reset.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '794c230fd3e64ea19f83f4d7a0ad****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [Ensure idempotence](~~25693~~)', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
],
[
- 'name' => 'DatabaseInstanceDescription',
+ 'name' => 'LoginCredentials',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'The description of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
+ 'description' => 'The information about the logon credentials.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Password' => ['description' => 'The password that corresponds to the administrator.'."\n"
+ ."\n"
+ .'- For Windows servers, the default administrator account is Administrator.'."\n"
+ ."\n"
+ .'- Linux servers, the default administrator account is root.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''],
+ 'KeyPairName' => ['description' => 'The name of the key pair that you want to bind to the simple application server. Only Linux simple application servers support key pairs.', 'type' => 'string', 'required' => false, 'example' => 'aliyunkey', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
'example' => '',
],
],
@@ -12481,52 +9894,110 @@
'responses' => [
200 => [
'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' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDatabaseInstanceDescriptionResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n</ModifyDatabaseInstanceDescriptionResponse>","errorExample":""}]',
- 'title' => 'ModifyDatabaseInstanceDescription',
- 'description' => 'You can call this operation to modify the description of a Simple Database Service instance.'."\n"
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidImageId.NotSupport', 'errorMessage' => 'The specified ImageId does not support the operation.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'ResetSystem',
+ 'description' => 'You can reset a simple application server to re-install its applications or operating system and re-initialize the server. You can reset a simple application server by resetting the current system or changing the image.'."\n"
."\n"
- .'### QPS limit'."\n"
+ .'- Reset the current system: You can re-install the operating system without changing the image.'."\n"
."\n"
- .'You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~347607~~).'."\n",
- ],
- 'DescribeDatabaseSlowLogRecords' => [
- 'summary' => 'Queries the slow query log details of a Simple Database Service instance.',
- 'methods' => [
- 'post',
- 'get',
+ .'- Change the image: You can select another Alibaba Cloud image or a custom image to re-install the operating system.'."\n"
+ ."\n"
+ .'### [](#)Precautions'."\n"
+ ."\n"
+ .'- Resetting the system or changing the image of a simple application server clears the disk data on the server. Back up the data as needed.'."\n"
+ ."\n"
+ .'- After you reset a simple application server, monitoring may fail. In this case, you can use one of the following methods to install the CloudMonitor agent on the server:'."\n"
+ ."\n"
+ .' - Connect to the server: For more information, see [Manually install the CloudMonitor agent for C++ on an ECS instance](~~183482~~).'."\n"
+ ."\n"
+ .' - Use Command Assistant: For more information, see [Use Command Assistant](~~438681~~). You can obtain the command that can be used to install CloudMonitor from the "Common commands" section of the [Use Command Assistant](~~438681~~) topic.'."\n"
+ ."\n"
+ .'### [](#)Limits'."\n"
+ ."\n"
+ .'- Snapshots that are created before the reset are retained, but the snapshots cannot be used to restore the disks of the server.'."\n"
+ ."\n"
+ .'- You cannot reset simple application servers that were created from custom images that contain data of data disks.'."\n"
+ ."\n"
+ .'- If you reset a simple application server by replacing the existing image with a custom image, the following limits apply:'."\n"
+ ."\n"
+ .' - The custom image must reside in the same region as the current server.'."\n"
+ ."\n"
+ .' - The custom image cannot be created based on the current server. If you want to restore the data on the server, you can use a snapshot of the server to restore disk data.'."\n"
+ ."\n"
+ .' - If your simple application server resides in a region outside the Chinese mainland, you cannot switch the operating system of the server between Windows Server and Linux. You cannot use a Windows Server custom image to reset a Linux simple application server. Similarly, you cannot use a Linux custom image to reset a Windows Server simple application server. You can switch the operating systems of simple application servers only between Windows Server versions or between Linux distributions.'."\n"
+ ."\n"
+ .' - The following limits apply to the disks attached to the simple application server:'."\n"
+ ."\n"
+ .' - If the custom image contains a system disk and a data disk but only a system disk is attached to the simple application server, you cannot use the custom image to reset the simple application server.'."\n"
+ ."\n"
+ .' - If the system disk size of the custom image is greater than the system disk size of the simple application server, you cannot directly use the custom image to reset the simple application server.'."\n"
+ ."\n"
+ .' - Only if the system disk size of the simple application server is greater than or equal to the system disk size of the custom image, you can use the custom image to reset the simple application server. To increase the system disk size of your server, you can upgrade the server configuration. For more information, see Upgrade a simple application server.'."\n"
+ ."\n"
+ .' - If the data disk size of the custom image is greater than the data disk size of the simple application server, you cannot use the custom image to reset the simple application server.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-02-11T08:30:25.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetSystem'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ResetSystem',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
+ ],
+ 'RestartDatabaseInstance' => [
+ 'summary' => 'Call this operation to restart a lightweight database instance in the Running state.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas8F6GI9',
- ],
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
'autoTest' => false,
'notSupportAutoTestReason' => '轻量数据库，走下线流程',
'tenantRelevance' => 'publicInformation',
@@ -12535,304 +10006,162 @@
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the lightweight database instance. Call [ListRegions](~~189315~~) to get the latest list of supported Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from page 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Valid values: 30 to 100.'."\n"
- ."\n"
- .'Maximum value: 100.'."\n"
- ."\n"
- .'Default value: 30.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '30',
- 'example' => '30',
- 'default' => '30',
- ],
- ],
- [
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query.'."\n"
- ."\n"
- .'Specify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n"
- ."\n"
- .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-07T04:04:44Z',
- ],
+ 'schema' => ['description' => 'The ID of the lightweight database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
[
- 'name' => 'EndTime',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. The end time must be later than the start time. The interval between the start time and the end time must be less than 7 days.'."\n"
- ."\n"
- .'Specify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n"
- ."\n"
- .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-08T04:04:44Z',
- ],
+ 'schema' => ['description' => 'A client-generated token to ensure request idempotency. The token must be unique for each request. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The response schema.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from page 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page. Valid values: 30 to 100.'."\n"
- ."\n"
- .'Default value: 30.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'PhysicalIORead' => [
- 'description' => 'The number of logical reads.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Engine' => [
- 'description' => 'The database engine that the instance runs.'."\n",
- 'type' => 'string',
- 'example' => 'MySQL',
- ],
- 'SlowLogs' => [
- 'description' => 'The slow query logs returned.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'HostAddress' => [
- 'description' => 'The name and IP address of the client that is connected to the database.'."\n",
- 'type' => 'string',
- 'example' => 'xxx[xxx] @ [1xx.xxx.xxx.xx]',
- ],
- 'QueryTimes' => [
- 'description' => 'The execution duration of the slow query. Unit: seconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'SQLText' => [
- 'description' => 'The details of the SQL statement.'."\n",
- 'type' => 'string',
- 'example' => 'select sleep(2)',
- ],
- 'QueryTimeMS' => [
- 'description' => 'The execution duration of the slow query. Unit: millisecond.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2001',
- ],
- 'LockTimes' => [
- 'description' => 'The lock duration of the SQL statement. Unit: seconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'ExecutionStartTime' => [
- 'description' => 'The time when the execution of the SQL statement started. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n"
- ."\n"
- .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n",
- 'type' => 'string',
- 'example' => '2022-09-08T01:40:44Z',
- ],
- 'ReturnRowCounts' => [
- 'description' => 'The number of rows returned by the SQL statement.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'ParseRowCounts' => [
- 'description' => 'The number of rows parsed by the SQL statement.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'DBName' => [
- 'description' => 'The name of the database.'."\n",
- 'type' => 'string',
- 'example' => 'testDB',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 20,\\n \\"PhysicalIORead\\": 200,\\n \\"Engine\\": \\"MySQL\\",\\n \\"SlowLogs\\": [\\n {\\n \\"HostAddress\\": \\"xxx[xxx] @ [1xx.xxx.xxx.xx]\\",\\n \\"QueryTimes\\": 2,\\n \\"SQLText\\": \\"select sleep(2)\\",\\n \\"QueryTimeMS\\": 2001,\\n \\"LockTimes\\": 0,\\n \\"ExecutionStartTime\\": \\"2022-09-08T01:40:44Z\\",\\n \\"ReturnRowCounts\\": 1,\\n \\"ParseRowCounts\\": 1,\\n \\"DBName\\": \\"testDB\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDatabaseSlowLogRecordsResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>20</TotalCount>\\n <PhysicalIORead>200</PhysicalIORead>\\n <Engine>MySQL</Engine>\\n <SlowLogs>\\n <HostAddress>xxx[xxx] @ [1xx.xxx.xxx.xx]</HostAddress>\\n <QueryTimes>2</QueryTimes>\\n <SQLText>select sleep(2)</SQLText>\\n <QueryTimeMS>2001</QueryTimeMS>\\n <LockTimes>0</LockTimes>\\n <ExecutionStartTime>2022-09-08T01:40:44Z</ExecutionStartTime>\\n <ReturnRowCounts>1</ReturnRowCounts>\\n <ParseRowCounts>1</ParseRowCounts>\\n <DBName>testDB</DBName>\\n </SlowLogs>\\n</DescribeDatabaseSlowLogRecordsResponse>","errorExample":""}]',
- 'title' => 'DescribeDatabaseSlowLogRecords',
- 'description' => 'You can query the slow query log details of a Simple Database Service instance and locate faults based on the log details.'."\n"
- ."\n"
- .'> Slow query log details are retained for 7 days.'."\n",
- ],
- 'DescribeDatabaseErrorLogs' => [
- 'summary' => 'Queries error logs of databases in a Simple Database Service instance.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'RestartDatabaseInstance',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-22T03:40:41.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestartDatabaseInstance'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:RestartDatabaseInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'RunCommand' => [
+ 'summary' => 'Runs commands on a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas8F6GI9',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREswasWZKIOQ'],
],
'parameters' => [
[
+ 'name' => 'CommandContent',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The content of the command. Take note of the following items:'."\n"
+ ."\n"
+ .'* If you set `EnableParameter` to true, the custom parameter feature is enabled in the command content and you can configure custom parameters based on the following rules:'."\n"
+ .'* Define custom parameters in the {{}} format. Within `{{}}`, the spaces and line feeds before and after the parameter names are ignored.'."\n"
+ .'* The number of custom parameters cannot be greater than 20.'."\n"
+ .'* A custom parameter name can contain only letters, digits, underscores (\\_), and hyphens (-). The name is case-insensitive.'."\n"
+ .'* Each custom parameter name cannot exceed 64 bytes in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ifconfig -s', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkingDir',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The execution path of the command. Custom paths are supported. Default execution paths vary based on the operating systems of the servers.'."\n"
+ ."\n"
+ .'* For Linux servers, the default path is /root of the root user.'."\n"
+ .'* For Windows servers, the default path is C:\\Windows\\system32.'."\n", 'type' => 'string', 'required' => false, 'example' => '/root', 'title' => ''],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance.'."\n"
- ."\n"
- .'You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'Timeout',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => 'The timeout period of the command on the server.'."\n"
+ ."\n"
+ .'If a command execution task times out, Command Assistant forcibly terminates the task process. Valid values: 10 to 86400. Unit: seconds. The period of 86400 seconds is equal to 24 hours.'."\n"
+ ."\n"
+ .'Default value: 60.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The language type of the command. Valid values:'."\n"
+ ."\n"
+ .'* RunBatScript: batch commands (applicable to Windows servers).'."\n"
+ .'* RunPowerShellScript: PowerShell commands (applicable to Windows servers).'."\n"
+ .'* RunShellScript: shell commands (applicable to Linux servers).'."\n", 'type' => 'string', 'required' => true, 'example' => 'RunShellScript', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'EnableParameter',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '30',
- 'example' => '30',
- 'default' => '30',
- ],
+ 'schema' => ['description' => 'Specifies whether to enable the custom parameter feature.'."\n"
+ ."\n"
+ .'Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
- 'name' => 'StartTime',
+ 'name' => 'Parameters',
'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n"
- ."\n"
- .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-07T04:04Z',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => 'The custom parameters in the key-value pair format that are to be passed in when the command includes custom parameters. For example, if the command content is `echo {{name}}`, you can use `Parameters` to pass in the `{"name":"Jack"}` key-value pair. The `name` key of the custom parameter is automatically replaced with the paired Jack value to generate a new command. As a result, the `echo Jack` command is executed.'."\n"
+ ."\n"
+ .'You can specify up to 20 custom parameters. Take note of the following items:'."\n"
+ ."\n"
+ .'* The key of a custom parameter can be up to 64 characters in length and cannot be an empty string.'."\n"
+ .'* The value of a custom parameter can be an empty string.'."\n"
+ .'* The size of the command (including custom parameters and original command content) after Base64 encoding cannot exceed 16 KB.'."\n"
+ .'* The custom parameter names that are specified by Parameters must be included in the custom parameter names that you specified when you created the command. You can use empty strings to represent the parameters that are not passed in.'."\n"
+ ."\n"
+ .'This parameter is left empty by default, which indicates that the custom parameter feature is disabled.'."\n", 'type' => 'object', 'required' => false, 'example' => '{"name":"Jack", "accessKey":"LTAI****************"}', 'title' => ''],
],
[
- 'name' => 'EndTime',
+ 'name' => 'WorkingUser',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time.'."\n"
- ."\n"
- .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-08T04:04Z',
- ],
+ 'schema' => ['description' => 'A user of the server who runs the command. We recommend that you run the command as a regular user to reduce security risks. Default values:'."\n"
+ ."\n"
+ .'* For Linux servers, the default value is root.'."\n"
+ .'* For Windows servers, the default value is system.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root', 'title' => ''],
+ ],
+ [
+ 'name' => 'WindowsPasswordName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the password used to run the command on a Windows simple application server.'."\n"
+ ."\n"
+ .'If you want to use a username other than the default "system" username to run the command on a Windows server, you must specify both the WindowsPasswordName and WorkingUser parameters. The password is hosted in plaintext in the parameter repository of CloudOps Orchestration Service (OOS) to mitigate the risk of password leaks. Only the name of the password is passed in by using WindowsPasswordName.'."\n", 'type' => 'string', 'required' => false, 'example' => 'axtSecretPassword', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the simple application server.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the command.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testName', 'title' => ''],
],
],
'responses' => [
@@ -12842,84 +10171,59 @@
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'ErrorLogs' => [
- 'description' => 'The time when the error log entry was generated. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n"
- ."\n"
- .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ErrorInfo' => [
- 'description' => 'The error message returned.'."\n",
- 'type' => 'string',
- 'example' => 'spid52 DBCC TRACEON 3499, server process ID (SPID) 52. This is an informational message only; no user action is required',
- ],
- 'CreateTime' => [
- 'description' => 'The time when the resource was created. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2022-09-08T12:11:04Z',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'],
+ 'InvokeId' => ['description' => 'The execution ID.'."\n", 'type' => 'string', 'example' => 't-hz02p9545t6****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 20,\\n \\"ErrorLogs\\": [\\n {\\n \\"ErrorInfo\\": \\"spid52 DBCC TRACEON 3499, server process ID (SPID) 52. This is an informational message only; no user action is required\\",\\n \\"CreateTime\\": \\"2022-09-08T12:11:04Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDatabaseErrorLogsResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>20</TotalCount>\\n <ErrorLogs>\\n <ErrorInfo>spid52 DBCC TRACEON 3499, server process ID (SPID) 52. This is an informational message only; no user action is required</ErrorInfo>\\n <CreateTime>2022-09-08T12:11:04Z</CreateTime>\\n </ErrorLogs>\\n</DescribeDatabaseErrorLogsResponse>","errorExample":""}]',
- 'title' => 'DescribeDatabaseErrorLogs',
- 'description' => 'You can call this operation to query the error logs of databases in a Simple Database Service instance and locate faults based on the error logs.'."\n",
- ],
- 'DescribeDatabaseInstanceMetricData' => [
- 'summary' => 'Queries the monitoring information about a Simple Database Service instance.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"InvokeId\\": \\"t-hz02p9545t6****\\"\\n}","errorExample":""},{"type":"xml","example":"<RunCommandResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <InvokeId>t-hz02p9545t6****</InvokeId>\\n</RunCommandResponse>","errorExample":""}]',
+ 'title' => 'RunCommand',
+ 'description' => 'Command Assistant is an automated O\\&M tool for Simple Application Server. You can maintain simple application servers by running shell, PowerShell, and batch commands in the Simple Application Server console without remotely logging on to the servers.'."\n"
+ ."\n"
+ .'Before you use Command Assistant, take note of the following items:'."\n"
+ ."\n"
+ .'* The simple application server must be in the Running state.'."\n"
+ .'* The Cloud Assistant client is installed on the server. By default, the Cloud Assistant client is installed on simple application servers. If you have manually uninstalled the client, you must reinstall it. For more information, see [Install the Cloud Assistant Agent](~~64921~~).'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2022-06-21T07:24:04.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RunCommand'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:RunCommand',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#CommandId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'StartDatabaseInstance' => [
+ 'summary' => 'Starts a database instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas8F6GI9',
- ],
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
'autoTest' => false,
'notSupportAutoTestReason' => '轻量数据库，走下线流程',
'tenantRelevance' => 'publicInformation',
@@ -12928,550 +10232,214 @@
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the database instance. You can call the [ListRegions](~~189315~~) operation to obtain the latest list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
- ],
- [
- 'name' => 'MetricName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the metric. Valid values:'."\n"
- ."\n"
- .'* MySQL_MemCpuUsage: The CPU utilization and memory usage of the instance within the entire operating system.'."\n"
- .'* MySQL_DetailedSpaceUsage: The total space usage, data space, log space, temporary space, and system space of the instance.'."\n"
- .'* MySQL_Sessions : The total number of active connections.'."\n"
- .'* MySQL_IOPS: The IOPS of the instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MySQL_MemCpuUsage',
- ],
+ 'schema' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
[
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n"
- ."\n"
- .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-06T04:04Z',
- ],
- ],
- [
- 'name' => 'EndTime',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n"
- ."\n"
- .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-07T04:04Z',
- ],
+ 'schema' => ['description' => 'A client-generated token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'MetricName' => [
- 'description' => 'The name of the metric. Valid values:'."\n"
- ."\n"
- .'* MySQL_MemCpuUsage: The CPU utilization and memory usage of the instance within the entire operating system.'."\n"
- .'* MySQL_DetailedSpaceUsage: The total space usage, data space, log space, temporary space, and system space of the instance.'."\n"
- .'* MySQL_Sessions : The total number of active connections.'."\n"
- .'* MySQL_IOPS: The IOPS of the instance.'."\n",
- 'type' => 'string',
- 'example' => 'MySQL_MemCpuUsage',
- ],
- 'Unit' => [
- 'description' => 'The unit of the monitoring metric.'."\n"
- ."\n"
- .'* %'."\n"
- .'* int'."\n"
- .'* MB'."\n",
- 'type' => 'string',
- 'example' => '%',
- ],
- 'DataFormat' => [
- 'description' => 'The data format. Valid values:'."\n"
- ."\n"
- .'* cpuusage\\&memusage'."\n"
- .'* active_session\\&total_session'."\n"
- .'* ins_size\\&data_size\\&log_size\\&tmp_size\\&other_size'."\n"
- .'* io'."\n",
- 'type' => 'string',
- 'example' => 'cpuusage&memusage',
- ],
- 'MetricData' => [
- 'description' => 'The monitoring data.'."\n",
- 'type' => 'string',
- 'example' => '[ { \\"date"\\: " 2022-09-06T04:04:00Z",\\"value\\":\\"0.77&3.69\\" } ]',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"MetricName\\": \\"MySQL_MemCpuUsage\\",\\n \\"Unit\\": \\"%\\",\\n \\"DataFormat\\": \\"cpuusage&memusage\\",\\n \\"MetricData\\": \\"[ { \\\\\\\\\\\\\\"date\\\\\\"\\\\\\\\: \\\\\\" 2022-09-06T04:04:00Z\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.77&3.69\\\\\\\\\\\\\\" } ]\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDatabaseInstanceMetricDataResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n <MetricName>MySQL_MemCpuUsage</MetricName>\\n <Unit>%</Unit>\\n <DataFormat>cpuusage&amp;memusage</DataFormat>\\n <MetricData>[ { \\\\\\"date\\"\\\\: \\" 2022-09-06T04:04:00Z\\",\\\\\\"value\\\\\\":\\\\\\"0.77&amp;3.69\\\\\\" } ]</MetricData>\\n</DescribeDatabaseInstanceMetricDataResponse>","errorExample":""}]',
- 'title' => 'DescribeDatabaseInstanceMetricData',
- 'description' => 'After you create a Simple Database Service instance, you can query the details about the instance, including CPU, memory, and disk usage, storage IOPS, and total number of connections.'."\n",
- ],
- 'DescribeDatabaseInstanceParameters' => [
- 'summary' => 'Queries the parameters of a Simple Database Service instance.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'StartDatabaseInstance',
+ 'description' => 'This operation starts a database instance that is in the stopped state.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-22T03:40:41.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartDatabaseInstance'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StartDatabaseInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'StartInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas8F6GI9',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '20472',
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
],
'parameters' => [
[
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'Engine' => [
- 'description' => 'The database engine that the instance runs. The value must be MySQL.'."\n",
- 'type' => 'string',
- 'example' => 'MySQL',
- ],
- 'EngineVersion' => [
- 'description' => 'The version of the database engine. Valid values:'."\n"
- ."\n"
- .'* 5.7: MySQL 5.7.'."\n"
- .'* 8.0: MySQL 8.0.'."\n",
- 'type' => 'string',
- 'example' => '5.5',
- ],
- 'ConfigParameters' => [
- 'description' => 'The range of ParameterValue.'."\n"
- ."\n"
- .'> The value of CheckingCode varies based on the value of ParameterName.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The settings of parameters that are being configured.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'ParameterDescription' => [
- 'description' => 'The description of the parameter.'."\n",
- 'type' => 'string',
- 'example' => 'Auto-increment columns are incremented by this',
- ],
- 'ParameterName' => [
- 'description' => 'The name of the parameter.'."\n",
- 'type' => 'string',
- 'example' => 'auto_increment_increment',
- ],
- 'ParameterValue' => [
- 'description' => 'The value of the parameter.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'ForceModify' => [
- 'description' => 'Does it support modifying parameter values. Possible values:'."\n"
- ."\n"
- .'- true:Support modifying parameter values.'."\n"
- ."\n"
- .'- false:Modifying parameter values is not supported.',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'ForceRestart' => [
- 'description' => 'Specifies whether to forcibly restart the instance after parameters are modified. Valid values:'."\n"
- ."\n"
- .'* true: forcibly restarts the instance. If a new parameter value takes effect only after the instance restarts, you must set this parameter to true. Otherwise, the new parameter value cannot take effect.'."\n"
- .'* false: does not forcibly restart the instance.'."\n"
- ."\n"
- .'Default value: false.'."\n",
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'CheckingCode' => [
- 'description' => 'The check code that indicates the valid values of the parameter.'."\n",
- 'type' => 'string',
- 'example' => '[1-65535]',
- ],
- ],
- ],
- ],
- 'RunningParameters' => [
- 'description' => 'The range of ParameterValue.'."\n"
- ."\n"
- .'> The value of CheckingCode varies based on the value of ParameterName.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about the array object.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'ParameterDescription' => [
- 'description' => 'The description of the parameter.'."\n",
- 'type' => 'string',
- 'example' => 'When this variable has a value of 1 (the default), the server automatically grants the EXECUTE and ALTER ROUTINE privileges to the creator of a stored routine, if the user cannot already execute and alter or drop the routine. (The ALTER ROUTINE privilege is required to drop the routine.) The server also automatically drops those privileges from the creator when the routine is dropped. If automatic_sp_privileges is 0, the server does not automatically add or drop these privileges.',
- ],
- 'ParameterName' => [
- 'description' => 'The name of the parameter.'."\n",
- 'type' => 'string',
- 'example' => 'autocommit',
- ],
- 'ParameterValue' => [
- 'description' => 'The value of the parameter.'."\n",
- 'type' => 'string',
- 'example' => 'ON',
- ],
- 'ForceModify' => [
- 'description' => 'Does it support modifying parameter values. Possible values:'."\n"
- ."\n"
- .'- true:Support modifying parameter values.'."\n"
- ."\n"
- .'- false:Modifying parameter values is not supported.',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'ForceRestart' => [
- 'description' => 'Specifies whether to forcibly restart the instance after parameters are modified. Valid values:'."\n"
- ."\n"
- .'* true: forcibly restarts the instance. If a new parameter value takes effect only after the instance restarts, you must set this parameter to true. Otherwise, the new parameter value cannot take effect.'."\n"
- .'* false: does not forcibly restart the instance.'."\n"
- ."\n"
- .'Default value: false.'."\n",
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'CheckingCode' => [
- 'description' => 'The check code that indicates the valid values of the parameter.'."\n",
- 'type' => 'string',
- 'example' => '[ON|OFF]',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"5.5\\",\\n \\"ConfigParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"Auto-increment columns are incremented by this\\",\\n \\"ParameterName\\": \\"auto_increment_increment\\",\\n \\"ParameterValue\\": \\"1\\",\\n \\"ForceModify\\": \\"true\\",\\n \\"ForceRestart\\": \\"false\\",\\n \\"CheckingCode\\": \\"[1-65535]\\"\\n }\\n ],\\n \\"RunningParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"When this variable has a value of 1 (the default), the server automatically grants the EXECUTE and ALTER ROUTINE privileges to the creator of a stored routine, if the user cannot already execute and alter or drop the routine. (The ALTER ROUTINE privilege is required to drop the routine.) The server also automatically drops those privileges from the creator when the routine is dropped. If automatic_sp_privileges is 0, the server does not automatically add or drop these privileges.\\",\\n \\"ParameterName\\": \\"autocommit\\",\\n \\"ParameterValue\\": \\"ON\\",\\n \\"ForceModify\\": \\"true\\",\\n \\"ForceRestart\\": \\"false\\",\\n \\"CheckingCode\\": \\"[ON|OFF]\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDatabaseInstanceParametersResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n <Engine>MySQL</Engine>\\n <EngineVersion>5.5</EngineVersion>\\n <ConfigParameters>\\n <ParameterDescription>Auto-increment columns are incremented by this</ParameterDescription>\\n <ParameterName>auto_increment_increment</ParameterName>\\n <ParameterValue>1</ParameterValue>\\n <ForceModify>true</ForceModify>\\n <ForceRestart>false</ForceRestart>\\n <CheckingCode>[1-65535]</CheckingCode>\\n </ConfigParameters>\\n <RunningParameters>\\n <ParameterDescription>When this variable has a value of 1 (the default), the server automatically grants the EXECUTE and ALTER ROUTINE privileges to the creator of a stored routine, if the user cannot already execute and alter or drop the routine. (The ALTER ROUTINE privilege is required to drop the routine.) The server also automatically drops those privileges from the creator when the routine is dropped. If automatic_sp_privileges is 0, the server does not automatically add or drop these privileges.</ParameterDescription>\\n <ParameterName>autocommit</ParameterName>\\n <ParameterValue>ON</ParameterValue>\\n <ForceModify>true</ForceModify>\\n <ForceRestart>false</ForceRestart>\\n <CheckingCode>[ON|OFF]</CheckingCode>\\n </RunningParameters>\\n</DescribeDatabaseInstanceParametersResponse>","errorExample":""}]',
- 'title' => 'DescribeDatabaseInstanceParameters',
- 'description' => 'You can call this operation to query the information about parameters of a Simple Database Service instance.'."\n",
- ],
- 'DescribeDatabaseInstances' => [
- 'summary' => 'Queries the information about Simple Database Service instances.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The state of the current instance does not support this operation.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'StartInstance',
+ 'summary' => 'Starts a simple application server.',
+ 'description' => 'You can call this operation to start a simple application server that is in the Stopped state.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StartInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
+ ],
+ 'StartInstances' => [
+ 'summary' => 'Starts simple application servers.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instances.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'DatabaseInstanceIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The IDs of the Simple Database Service instances. The value can be a JSON array that consists of up to 100 Simple Database Service instance IDs. Separate multiple instance IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["swasdb-xxx******","swasdb-yyy******"]',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'Pages start from page 1.'."\n"
- ."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'Maximum value: 100.'."\n"
- ."\n"
- .'Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '20758A-585D-4A41-A9B2-28DA8F4****',
- ],
- 'DatabaseInstances' => [
- 'description' => 'The information about the Simple Database Service instances.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RegionId' => [
- 'description' => 'The region ID of the Simple Database Service instances.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'DatabaseInstanceId' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
- 'DatabaseInstanceName' => [
- 'description' => 'The name of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'example' => '',
- ],
- 'DatabaseInstanceEdition' => [
- 'description' => 'The plan edition ID of the Simple Database Service instance. Valid values:'."\n"
- ."\n"
- .'* swas.db.c1m1s25: CNY 35/month.'."\n"
- .'* swas.db.c1m2s80: CNY 100/month.'."\n"
- .'* swas.db.c2m4s120: CNY 200/month.'."\n"
- .'* swas.db.c2m8s240: CNY 300/month.'."\n",
- 'type' => 'string',
- 'example' => 'swas.db.c1m1s25',
- ],
- 'DatabaseVersion' => [
- 'description' => 'The database engine version of the instance. Valid values:'."\n"
- ."\n"
- .'* 5.7: MySQL 5.7.'."\n"
- .'* 8.0: MySQL 8.0.'."\n",
- 'type' => 'string',
- 'example' => '5.7',
- ],
- 'Cpu' => [
- 'description' => 'The number of vCPUs.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Memory' => [
- 'description' => 'The memory size of the instance. Unit: GB.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Storage' => [
- 'description' => 'The size of the enhanced SSD (ESSD). Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '25',
- ],
- 'PrivateConnection' => [
- 'description' => 'The private endpoint.'."\n",
- 'type' => 'string',
- 'example' => 'rm-bp1d39opj7906****.mysql.rds.aliyuncs.com',
- ],
- 'PublicConnection' => [
- 'description' => 'The public endpoint.'."\n"
- ."\n"
- .'> This parameter is displayed only after you apply for a public endpoint for the instance and a public endpoint is assigned to the instance. You can call [AllocatePublicConnection](~~451413~~) to apply for a public endpoint for the instance.'."\n",
- 'type' => 'string',
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com',
- ],
- 'DatabaseInstanceStatus' => [
- 'description' => 'The status of the Simple Database Service instance. Valid values:'."\n"
- ."\n"
- .'* Pending: The instance is being created.'."\n"
- .'* Restarting: The instance is being restarted.'."\n"
- .'* Running: The instance is running.'."\n"
- .'* Stopping: The instance is being stopped.'."\n"
- .'* Stopped: The instance is stopped.'."\n"
- .'* UPGRADING: The instance is being upgraded.'."\n"
- .'* DISABLED: The instance is disabled.'."\n",
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'BusinessStatus' => [
- 'description' => 'The business status of the instance. Valid values:'."\n"
- ."\n"
- .'* normal'."\n"
- .'* expired'."\n"
- .'* overdue'."\n",
- 'type' => 'string',
- 'example' => 'normal',
- ],
- 'CreationTime' => [
- 'description' => 'The time when the instance was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2022-09-01T02:39:46Z',
- ],
- 'ExpiredTime' => [
- 'description' => 'The time when the instance expires. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n"
- ."\n"
- .'> The time displayed in the Simple Application Server console is in the format of UTC+8.'."\n",
- 'type' => 'string',
- 'example' => '2022-10-01T16:00:00Z',
- ],
- 'ChargeType' => [
- 'description' => 'The billing method of the Simple Database Service instance. Set the value to PrePaid. This value indicates the subscription billing method.'."\n"
- ."\n"
- .'Default value: PrePaid.'."\n",
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'SuperAccountName' => [
- 'description' => 'The name of the super administrator account of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'example' => 'administrator',
- ],
- ],
- ],
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\",\\n \\"DatabaseInstances\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DatabaseInstanceId\\": \\"db-38263fa955774501a2ae1bdaed6f****\\",\\n \\"DatabaseInstanceName\\": \\"我的数据库\\",\\n \\"DatabaseInstanceEdition\\": \\"swas.db.c1m1s25\\",\\n \\"DatabaseVersion\\": \\"5.7\\",\\n \\"Cpu\\": \\"1\\",\\n \\"Memory\\": \\"1\\",\\n \\"Storage\\": 25,\\n \\"PrivateConnection\\": \\"rm-bp1d39opj7906****.mysql.rds.aliyuncs.com\\",\\n \\"PublicConnection\\": \\"db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com\\",\\n \\"DatabaseInstanceStatus\\": \\"Running\\",\\n \\"BusinessStatus\\": \\"normal\\",\\n \\"CreationTime\\": \\"2022-09-01T02:39:46Z\\",\\n \\"ExpiredTime\\": \\"2022-10-01T16:00:00Z\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"SuperAccountName\\": \\"administrator\\"\\n }\\n ],\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 10,\\n \\"TotalCount\\": 5\\n}","errorExample":""},{"type":"xml","example":"<DescribeDatabaseInstancesResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4****</RequestId>\\n <DatabaseInstances>\\n <RegionId>cn-hangzhou</RegionId>\\n <DatabaseInstanceId>db-38263fa955774501a2ae1bdaed6f****</DatabaseInstanceId>\\n <DatabaseInstanceName>我的数据库</DatabaseInstanceName>\\n <DatabaseInstanceEdition>swas.db.c1m1s25</DatabaseInstanceEdition>\\n <DatabaseVersion>5.7</DatabaseVersion>\\n <Cpu>1</Cpu>\\n <Memory>1</Memory>\\n <Storage>25</Storage>\\n <PrivateConnection>rm-bp1d39opj7906****.mysql.rds.aliyuncs.com</PrivateConnection>\\n <PublicConnection>db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com</PublicConnection>\\n <DatabaseInstanceStatus>Running</DatabaseInstanceStatus>\\n <BusinessStatus>normal</BusinessStatus>\\n <CreationTime>2022-09-01T02:39:46Z</CreationTime>\\n <ExpiredTime>2022-10-01T16:00:00Z</ExpiredTime>\\n <ChargeType>PrePaid</ChargeType>\\n <SuperAccountName>administrator</SuperAccountName>\\n </DatabaseInstances>\\n <PageSize>1</PageSize>\\n <PageNumber>10</PageNumber>\\n <TotalCount>5</TotalCount>\\n</DescribeDatabaseInstancesResponse>","errorExample":""}]',
- 'title' => 'DescribeDatabaseInstances',
- 'description' => 'You can call this operation to query the details of Simple Database Service instances in a region, including the IDs, names, plans, database versions, public endpoints, internal endpoints, creation time, and expiration time of the instances.'."\n",
- ],
- 'AllocatePublicConnection' => [
- 'summary' => 'Applies for a public endpoint for a Simple Database Service instance.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'StartInstances',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartInstances'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StartInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\"\\n}","type":"json"}]',
+ ],
+ 'StartTerminalSession' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13480,84 +10448,76 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREswasN19LXQ', 'FEATUREswasK6WJ0Q'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~2361076~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the Simple Application Server instance. You can call the [ListRegions](~~189315~~) operation to query the most recent list of Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => 'The ID of the Simple Application Server instance.', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'CommandLine',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The command to run after the session is started. The command can be up to 512 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ssh root@192.168.0.***', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'PublicConnection' => [
- 'description' => 'The public endpoint that is assigned to the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'ffb90b6e-b18a-4a33-88cf-86fb88****', 'title' => ''],
+ 'SecurityToken' => ['description' => 'The security token that is included in the request header of the WebSocket request for authentication.', 'type' => 'string', 'example' => 'token-xxxaaz', 'title' => ''],
+ 'WebSocketUrl' => ['description' => 'The URL of the WebSocket session that is used to remotely connect to the Simple Application Server instance. The URL contains the session ID (`SessionId`) and the security token (`SecurityToken`) that is used for authentication.', 'type' => 'string', 'example' => 'wss://xxxx', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PublicConnection\\": \\"db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com\\"\\n}","type":"json"}]',
- 'title' => 'AllocatePublicConnection',
- 'description' => 'By default, no public endpoints are assigned to Simple Database Service instances. If you want to access the databases of a Simple Database Service instance over the Internet by using Simple Container Service or Data Management (DMS), you must apply for a public endpoint for the Simple Database Service instance.'."\n",
- ],
- 'RestartDatabaseInstance' => [
- 'summary' => 'You can call this operation to restart a Simple Database Service instance that is in the Running state.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'UserBehaviour.SessionManagerDisabled', 'errorMessage' => 'The API is disabled by user behaviour.', 'description' => 'User remote connection via session management is turned off.'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'StartTerminalSession',
+ 'summary' => 'Starts a session to log on to a Simple Application Server instance.',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-17T07:01:56.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:StartTerminalSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"SessionId\\": \\"ffb90b6e-b18a-4a33-88cf-86fb88****\\",\\n \\"SecurityToken\\": \\"token-xxxaaz\\",\\n \\"WebSocketUrl\\": \\"wss://xxxx\\"\\n}","type":"json"}]',
+ ],
+ 'StopDatabaseInstance' => [
+ 'summary' => 'Stops a lightweight database instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13569,9 +10529,7 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
'autoTest' => false,
'notSupportAutoTestReason' => '轻量数据库，走下线流程',
'tenantRelevance' => 'publicInformation',
@@ -13580,249 +10538,234 @@
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the lightweight database instance. You can call [ListRegions](~~189315~~) to view the supported Alibaba Cloud regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => 'The ID of the lightweight database instance.', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'A client-generated token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","errorExample":""},{"type":"xml","example":"<RestartDatabaseInstanceResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n</RestartDatabaseInstanceResponse>","errorExample":""}]',
- 'title' => 'RestartDatabaseInstance',
- 'description' => 'You can call this operation to restart a Simple Database Service instance that is in the Running state.'."\n"
- ."\n"
- .'### QPS limit'."\n"
- ."\n"
- .'You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~347607~~).'."\n",
- ],
- 'ResetDatabaseAccountPassword' => [
- 'summary' => 'If the password of your Simple Database Service instance is not strong, you can call this operation to change the password of the administrator account of the instance. To ensure security of the instance, we recommend that you regularly change the password of the instance.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'StopDatabaseInstance',
+ 'description' => 'This operation stops a lightweight database instance that is in the running state. After the instance is stopped, you cannot log on to or access it.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-22T03:40:41.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopDatabaseInstance'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StopDatabaseInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'StopInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas8GRVRI',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '轻量数据库，走下线流程',
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '20473',
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
],
[
- 'name' => 'AccountPassword',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The password of the administrator account of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Password****',
- ],
+ 'schema' => ['description' => 'The region ID of the server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetDatabaseAccountPasswordResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n</ResetDatabaseAccountPasswordResponse>","errorExample":""}]',
- 'title' => 'ResetDatabaseAccountPassword',
- 'description' => 'If the password of your Simple Database Service instance is not strong, you can call this operation to change the password of the administrator account of the instance. To ensure security of the instance, we recommend that you regularly change the password of the instance.'."\n"
- ."\n"
- .'### QPS limit'."\n"
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The state of the current instance does not support this operation.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'StopInstance',
+ 'summary' => 'Stops a simple application server.',
+ 'description' => 'You can stop a simple application server that you do not use for the time being.'."\n"
."\n"
- .'You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~347607~~).'."\n",
- ],
- 'ReleasePublicConnection' => [
- 'summary' => 'If you no longer need to use a public endpoint to access a Simple Database Service instance, you can release the public endpoint.',
- 'methods' => [
- 'post',
- 'get',
+ .'> Stopping a simple application server may interrupt your business. We recommend that you perform this operation during off-peak hours.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StopInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
+ ],
+ 'StopInstances' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswasIU54HN',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '轻量数据库服务走下线流程',
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the Simple Database Service instance. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application servers. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the Simple Database Service instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]', 'title' => ''],
+ ],
+ [
+ 'name' => 'ForceStop',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to forcibly stop the servers.'."\n"
+ ."\n"
+ .'- **true**: forcibly stops the servers.'."\n"
+ ."\n"
+ .'- **false**: normally stops the servers. This is the default value.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'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' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","errorExample":""},{"type":"xml","example":"<ReleasePublicConnectionResponse>\\n <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>\\n</ReleasePublicConnectionResponse>","errorExample":""}]',
- 'title' => 'ReleasePublicConnection',
- 'description' => 'If you no longer need to use a public endpoint to access a Simple Database Service instance, you can release the public endpoint.'."\n"
- ."\n"
- .'### QPS limit'."\n"
- ."\n"
- .'You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~347607~~).'."\n",
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'StopInstances',
+ 'summary' => 'Stops simple application servers.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopInstances'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StopInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2DE174B-7196-5778-A00D-6EA2601B****\\"\\n}","type":"json"}]',
],
'TagResources' => [
'summary' => 'Adds tags to simple application servers, snapshots, custom images, commands, firewall rules, and disks to facilitate the viewing and management of the preceding resources.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13834,66 +10777,43 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswasVU1KX6',
- ],
+ 'abilityTreeNodes' => ['FEATUREswasVU1KX6'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [Ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [Ensure idempotence](~~25693~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
- 'schema' => [
- 'title' => '资源类型',
- 'description' => 'The resource type. Valid values:'."\n"
- ."\n"
- .'* instance'."\n"
- .'* snapshot'."\n"
- .'* customimage'."\n"
- .'* command'."\n"
- .'* firewallrule'."\n"
- .'* disk'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
+ 'schema' => ['title' => '', 'description' => 'The resource type. Valid values:'."\n"
+ ."\n"
+ .'* instance'."\n"
+ .'* snapshot'."\n"
+ .'* customimage'."\n"
+ .'* command'."\n"
+ .'* firewallrule'."\n"
+ .'* disk'."\n", 'type' => 'string', 'required' => true, 'example' => 'instance'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '资源ID,最多 50个子项',
+ 'title' => '',
'description' => 'The resource IDs. You can specify up to 50 resource IDs.'."\n",
'type' => 'array',
- 'items' => [
- 'description' => 'The resource ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bp1e2fsl57knvuug****',
- ],
+ 'items' => ['description' => 'The resource ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bp1e2fsl57knvuug****', 'title' => ''],
'required' => true,
'maxItems' => 51,
+ 'example' => '',
],
],
[
@@ -13901,36 +10821,27 @@
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '标签列表，最多包含20个子项',
+ 'title' => '',
'description' => 'The list of tags. You can specify up to 20 tags.'."\n",
'type' => 'array',
'items' => [
'description' => 'The tag. You can add up to 20 tags to a resource.'."\n",
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签键',
- 'description' => 'The key of tag N that you want to add to a resource.'."\n"
- ."\n"
- .'You cannot specify an empty string as a tag key. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'title' => '标签值',
- 'description' => 'The value of tag N that you want to add to a resource.'."\n"
- ."\n"
- .'You can specify an empty string as a tag value. The tag value can be up to 64 characters in length and cannot contain http:// or https://.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['title' => '', 'description' => 'The key of tag N that you want to add to a resource.'."\n"
+ ."\n"
+ .'You cannot specify an empty string as a tag key. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['title' => '', 'description' => 'The value of tag N that you want to add to a resource.'."\n"
+ ."\n"
+ .'You can specify an empty string as a tag value. The tag value can be up to 64 characters in length and cannot contain http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => true,
'maxItems' => 21,
+ 'example' => '',
],
],
],
@@ -13940,510 +10851,525 @@
'description' => 'The returned result.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
'title' => 'TagResources',
- ],
- 'ListTagResources' => [
- 'summary' => 'Queries the tags that are added to simple resources, such as instances, snapshots, disks, images, commands, and firewall rules.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:TagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UntagResources' => [
+ 'summary' => 'Unbinds and deletes tags from specified lightweight resources, such as instances, snapshots, disks, images, commands, and firewall rules.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswasV8KB6K',
- ],
+ 'abilityTreeNodes' => ['FEATUREswasV8KB6K'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [Ensure idempotence](~~25693~~)'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => 'The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [Ensure idempotence](~~25693~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ResourceType',
'in' => 'query',
- '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' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***',
- ],
+ 'schema' => ['title' => '', 'description' => 'The resource type. Valid values:'."\n"
+ ."\n"
+ .'* instance'."\n"
+ .'* snapshot'."\n"
+ .'* customimage'."\n"
+ .'* command'."\n"
+ .'* firewallrule'."\n"
+ .'* disk'."\n", 'type' => 'string', 'required' => true, 'example' => 'instance'],
],
[
- 'name' => 'ResourceType',
+ 'name' => 'All',
'in' => 'query',
- 'schema' => [
- 'title' => '资源类型',
- 'description' => 'The resource type. Valid values:'."\n"
- ."\n"
- .'* instance'."\n"
- .'* snapshot'."\n"
- .'* customimage'."\n"
- .'* command'."\n"
- .'* firewallrule'."\n"
- .'* disk'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to remove all tags from the specified one or more resources. This parameter takes effect only if the TagKey.N parameter is not set. Valid values:'."\n"
+ ."\n"
+ .'* true: deletes all tags that are added to the specific lightweight resource. If no tags are added to the specific lightweight resource, the deletion operation is ignored.'."\n"
+ .'* false: does not delete the tags that are added to the specific lightweight resource.'."\n"
+ ."\n"
+ .'Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '资源ID,最多 50个子项',
- 'description' => 'The ID of the resource. You can specify up to 50 resource IDs.'."\n",
+ 'title' => '',
+ 'description' => 'The resource IDs. You can specify up to 50 resource IDs.'."\n",
'type' => 'array',
- 'items' => [
- 'description' => 'The resource ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bw526m1vi6x20c6g****',
- ],
- 'required' => false,
+ 'items' => ['description' => 'The resource ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bw526m1vi6x20c6g****', 'title' => ''],
+ 'required' => true,
'maxItems' => 51,
+ 'example' => '',
],
],
[
- 'name' => 'Tag',
+ 'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '标签列表，最多包含20个子项',
- 'description' => 'The list of tags. You can specify up to 20 tags.'."\n",
+ 'title' => '',
+ 'description' => 'The key of tag N. Valid values of N: 1 to 20.'."\n",
'type' => 'array',
- 'items' => [
- 'description' => 'The tag that is added to a resource.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签键',
- 'description' => 'The key of the tag that you want to add to a resource. The tag key can be 1 to 64 characters in length.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'title' => '标签值',
- 'description' => 'The value of the tag that you want to add to a resource. The tag value can be 1 to 64 characters in length.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
+ 'items' => ['description' => 'The key of tag N. Tag keys are case-sensitive. Valid values of N: 1 to 20.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
'required' => false,
'maxItems' => 21,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of response.'."\n",
+ 'description' => 'The returned result.'."\n",
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'title' => '下一个查询开始Token，NextToken为空说明没有下一个',
- 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n",
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
- ],
- 'TagResources' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'TagResource' => [
- 'title' => '资源列表',
- 'description' => 'A collection of resources and the tags of the resources. The information includes the resource IDs, resource types, and key-value pairs of tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about the resource and its tag.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'ResourceType' => [
- 'title' => '资源类型',
- 'description' => 'The type of the resource. Valid values:'."\n"
- ."\n"
- .'* instance'."\n"
- .'* snapshot'."\n"
- .'* customimage'."\n"
- .'* command'."\n"
- .'* firewallrule'."\n"
- .'* disk'."\n",
- 'type' => 'string',
- 'example' => 'ALIYUN::SWAS::INSTANCE',
- ],
- 'TagValue' => [
- 'title' => '标签值',
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- 'ResourceId' => [
- 'title' => '资源ID',
- 'description' => 'The resource ID.'."\n",
- 'type' => 'string',
- 'example' => 's-bw526m1vi6x20c6g****'."\n",
- ],
- 'TagKey' => [
- 'title' => '标签键',
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***\\",\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"instance\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"s-bw526m1vi6x20c6g****\\\\n\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'ListTagResources',
- ],
- 'UntagResources' => [
- 'summary' => 'Unbinds and deletes tags from specified lightweight resources, such as instances, snapshots, disks, images, commands, and firewall rules.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
+ 'title' => 'UntagResources',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:UntagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateCommandAttribute' => [
+ 'summary' => 'Modifys the parameter of a command.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswasV8KB6K',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '184926',
+ 'abilityTreeNodes' => ['FEATUREswasWZKIOQ'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'CommandId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [Ensure idempotence](~~25693~~).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => 'The command ID. You can call the [DescribeCommands](~~64843~~) operation to query all available command IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c-sh02yh0932w****', 'title' => ''],
],
[
- 'name' => 'ResourceType',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'title' => '资源类型',
- 'description' => 'The resource type. Valid values:'."\n"
- ."\n"
- .'* instance'."\n"
- .'* snapshot'."\n"
- .'* customimage'."\n"
- .'* command'."\n"
- .'* firewallrule'."\n"
- .'* disk'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
+ 'schema' => ['description' => 'The name of the command. The name supports all character sets and can be up to 128 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''],
],
[
- 'name' => 'All',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false ,默认是 false',
- 'description' => 'Specifies whether to remove all tags from the specified one or more resources. This parameter takes effect only if the TagKey.N parameter is not set. Valid values:'."\n"
- ."\n"
- .'* true: deletes all tags that are added to the specific lightweight resource. If no tags are added to the specific lightweight resource, the deletion operation is ignored.'."\n"
- .'* false: does not delete the tags that are added to the specific lightweight resource.'."\n"
- ."\n"
- .'Default value: false.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The description of the command. The description supports all character sets and can be up to 512 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'WorkingDir',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['description' => 'The working directory of the command. The directory can be up to 200 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/', 'title' => ''],
+ ],
+ [
+ 'name' => 'Timeout',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum timeout period for the command execution on the ECS instance. Unit: seconds. When a command that you created cannot be run, the command execution times out. When the execution times out, the command process is forcefully terminated and the PID of the command is canceled. Default value: 60.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '资源ID，最多50个子项',
- 'description' => 'The resource IDs. You can specify up to 50 resource IDs.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The resource ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bw526m1vi6x20c6g****',
+ '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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'],
],
- 'required' => true,
- 'maxItems' => 51,
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]',
+ 'title' => 'UpdateCommandAttribute',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TagKey',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '标签键，最多20个子项',
- 'description' => 'The key of tag N. Valid values of N: 1 to 20.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The key of tag N. Tag keys are case-sensitive. Valid values of N: 1 to 20.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:UpdateCommandAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/{#CommandId}'],
],
- 'required' => false,
- 'maxItems' => 21,
],
],
],
+ ],
+ 'UpdateDiskAttribute' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'DiskId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The disk ID. You can call the ListDisks operation to query the ID of data disk.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp18kjxg9ebrhsgi****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The remarks of the data disk.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The returned result.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28D****534F ', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
- 'title' => 'UntagResources',
- ],
- 'ListRegions' => [
- 'summary' => 'Queries all regions in which Simple Application Server is supported.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus.ResetDisk', 'errorMessage' => 'Rolling back the disk requires the instance to operate in a stopped state.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidDiskId.NotFound', 'errorMessage' => 'The specified DiskId does not exist.', 'description' => ''],
+ ['errorCode' => 'InvalidSnapshotId.NotFound', 'errorMessage' => 'The specified SnapshotId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'UpdateDiskAttribute',
+ 'summary' => 'Modifies the remarks for the data disk that is attached to a simple application server.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateDiskAttribute'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:UpdateDiskAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DiskId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28D****534F\\\\t\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateInstanceAttribute' => [
+ 'summary' => 'Modifies the information of a simple application server, including the server name and the password that you use to log on to the server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '20466',
- 'abilityTreeNodes' => [
- 'FEATUREswas8F6GI9',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '公共资源，无越权问题',
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREswas28FLWX'],
],
'parameters' => [
[
- 'name' => 'AcceptLanguage',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The language of the response. Valid values:'."\n"
- ."\n"
- .'* **zh-CN** (default): Chinese'."\n"
- .'* **en-US**: English'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- ],
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The new password of the simple application server. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported:'."\n"
+ ."\n"
+ .'```'."\n"
+ .'()`~!@#$%^&*-_+=|{}[]:;\'<>,.?/'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For Windows instances, the password cannot start with a forward slash (/).'."\n"
+ ."\n"
+ .'> For security reasons, we recommend that you use HTTPS to send requests if `Password` is specified.', 'type' => 'string', 'required' => false, 'example' => 'Test123!', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the simple application server. The name must be 2 to 50 characters in length. It can contain letters, digits, underscores (\\_), and hyphens (-). It must start with a letter or digit. Domain names are supported.', 'type' => 'string', 'required' => false, 'example' => 'test-InstanceName', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The information about the regions.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'Regions' => [
- 'description' => 'The regions.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about the region.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'LocalName' => [
- 'description' => 'The name of the region.'."\n",
- 'type' => 'string',
- 'example' => 'China (hangzhou)',
- ],
- 'RegionEndpoint' => [
- 'description' => 'The endpoint of the region.'."\n",
- 'type' => 'string',
- 'example' => 'swas.cn-hangzhou.aliyuncs.com',
- ],
- 'RegionId' => [
- 'description' => 'The ID of the region.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidPassword.ValueNotSupported', 'errorMessage' => 'The specified parameter Password is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidInstanceName.ValueNotSupported', 'errorMessage' => 'The specified parameter InstanceName is invalid.', 'description' => ''],
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
+ ],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"Regions\\": [\\n {\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"RegionEndpoint\\": \\"swas.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRegionsResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n <Regions>\\n <RegionId>cn-qingdao</RegionId>\\n <RegionEndpoint>swas.cn-qingdao.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北 1</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-beijing</RegionId>\\n <RegionEndpoint>swas.cn-beijing.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北 2</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-zhangjiakou</RegionId>\\n <RegionEndpoint>swas.cn-zhangjiakou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北 3</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-huhehaote</RegionId>\\n <RegionEndpoint>swas.cn-huhehaote.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北 5</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionEndpoint>swas.cn-hangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东 1</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-shanghai</RegionId>\\n <RegionEndpoint>swas.cn-shanghai.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东 2</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-shenzhen</RegionId>\\n <RegionEndpoint>swas.cn-shenzhen.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南 1</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-hongkong</RegionId>\\n <RegionEndpoint>swas.cn-hongkong.aliyuncs.com</RegionEndpoint>\\n <LocalName>中国（香港）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>ap-southeast-1</RegionId>\\n <RegionEndpoint>swas.ap-southeast-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>新加坡</LocalName>\\n </Regions>\\n</ListRegionsResponse>","errorExample":""}]',
- 'title' => 'ListRegions',
- 'description' => 'The query results include all the Alibaba Cloud regions where Simple Application Server is supported on the international site (alibabacloud.com) and the China site (aliyun.com).'."\n",
+ 'title' => 'UpdateInstanceAttribute',
+ 'description' => '## [](#)Usage notes'."\n"
+ ."\n"
+ .'After you change the password of a simple application server, you must restart the server by calling the [RebootInstance](~~190443~~) operation for the new password to take effect.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateInstanceAttribute'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:UpdateInstanceAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
],
- 'ListImages' => [
- 'summary' => 'Queries the information about images in a region.',
- 'methods' => [
- 'post',
- 'get',
+ 'UpdateSnapshotAttribute' => [
+ 'summary' => 'Modifies the remarks of a snapshot of a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The snapshot ID. You can call the ListSnapshots operation to query the snapshot ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-bp16oazlsold4dks****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 ', 'title' => ''],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The remarks of the snapshot of the simple application server.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidSnapshotId.NotFound', 'errorMessage' => 'The specified SnapshotId does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'UpdateSnapshotAttribute',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateSnapshotAttribute'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:UpdateSnapshotAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****\\"\\n}","type":"json"}]',
+ ],
+ 'UpgradeInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas8F6GI9',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREswasOLUWJH'],
],
'parameters' => [
[
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****', 'title' => ''],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the images. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ImageIds',
+ 'name' => 'PlanId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The image IDs. The value can be a JSON array that consists of up to 50 image IDs. Format: `["xxx", "yyy", … "zzz"]`. Separate multiple image IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]',
- ],
+ 'schema' => ['description' => 'The ID of the new plan. You can call the [ListPlans](~~189314~~) operation to query the plans provided by Simple Application Server.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'swas.s2.c2m2s50b4t08', 'title' => ''],
],
[
- 'name' => 'ImageType',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the images. Valid values:'."\n"
- ."\n"
- .'* system: OS images'."\n"
- .'* app: application images'."\n"
- .'* custom: custom images'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'system',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
@@ -14451,125 +11377,94 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'Images' => [
- 'description' => 'Details of the queried images.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about the image.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'ImageType' => [
- 'description' => 'The type of the image. Valid values:'."\n"
- ."\n"
- .'* system'."\n"
- .'* app'."\n"
- .'* custom'."\n",
- 'type' => 'string',
- 'example' => 'app',
- ],
- 'Description' => [
- 'description' => 'The description of the image.'."\n",
- 'type' => 'string',
- 'example' => "\n"
- .'Apps ImageOS ImageCustom Images'."\n"
- .'WordPress is a popular and powerful platform that allows you to build blogs and content management websites and implement custom features by using third-party templates and plug-ins. This WordPress image is built based on CentOS 7.9, PHP 7.4, MySQL 5.7, and Apache 2.4.',
- ],
- 'ImageName' => [
- 'description' => 'The name of the image.'."\n",
- 'type' => 'string',
- 'example' => 'WordPress-4.8.1',
- ],
- 'ImageId' => [
- 'description' => 'The ID of the image.'."\n",
- 'type' => 'string',
- 'example' => '794c230fd3e64ea19f83f4d7a0ad****',
- ],
- 'Platform' => [
- 'description' => 'The operating system type of the image. Valid values:'."\n"
- ."\n"
- .'* Linux'."\n"
- .'* Windows'."\n",
- 'type' => 'string',
- 'example' => 'Linux',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidImageType.ValueNotSupported',
- 'errorMessage' => 'The specified parameter ImageType is invalid.',
- ],
+ ['errorCode' => 'InvalidPlanIdUpgrade.ValueNotSupported', 'errorMessage' => 'The specification of the specified planId is lower than the current server specification.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'InvalidParam',
- 'errorMessage' => 'The specified parameter value is invalid.',
- ],
+ ['errorCode' => 'PaymentFailed', 'errorMessage' => 'Payment failed. Please check your account balance.', 'description' => ''],
+ ['errorCode' => 'InvalidInstance.UnPaidOrder', 'errorMessage' => 'The specified Instance has an unpaid order.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidPlanId.NotFound', 'errorMessage' => 'The specified PlanId does not exist.', 'description' => ''],
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ['errorCode' => 'NotEnoughUpgradeStock', 'errorMessage' => 'The upgrade stock is insufficient.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"Images\\": [\\n {\\n \\"ImageType\\": \\"app\\",\\n \\"Description\\": \\"WordPress是目前非常流行、强大的博客和内容管理网站的工具平台，借助第三方开发的模板、插件，用户可实现多样化的个性化功能。该镜像基于CentOS 7.9，PHP 7.4，MySQL 5.7，Apache 2.4。\\",\\n \\"ImageName\\": \\"WordPress-4.8.1\\",\\n \\"ImageId\\": \\"794c230fd3e64ea19f83f4d7a0ad****\\",\\n \\"Platform\\": \\"Linux\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListImagesResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n <Images>\\n <ImageType>app</ImageType>\\n <Description>WordPress是博客和内容管理网站的工具平台，借助第三方开发的模板、插件，用户可实现多样化的个性化功能。该镜像基于CentOS 7.3 64位操作系统。</Description>\\n <ImageName>WordPress-4.8.1</ImageName>\\n <ImageId>794c230fd3e64ea19f83f4d7a0ad****</ImageId>\\n <Platform>Linux</Platform>\\n </Images>\\n</ListImagesResponse>","errorExample":""}]',
- 'title' => 'ListImages',
- 'description' => 'You can query details about one or more images in a specified region, including the IDs, names, and types of the images.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListPlans' => [
- 'summary' => 'Queries the details of all Simple Application Server plans in a specified region.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'UpgradeInstance',
+ 'summary' => 'Upgrades the plan for a simple application server.',
+ 'description' => '- The plan of a simple application server can only be upgraded. For more information about plans, see [Billable items](~~58623~~).'."\n"
+ ."\n"
+ .'- Before you call this operation, make sure that the balance in your account is sufficient. If the balance in your account is insufficient, the upgrade fails.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:UpgradeInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
+ ],
+ 'UploadInstanceKeyPair' => [
+ 'summary' => 'Imports a key pair for a simple application server.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '20465',
- 'abilityTreeNodes' => [
- 'FEATUREswasB80AJY',
- 'FEATUREswasUPXVQ5',
- ],
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the plans. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the simple application server. You can call the [ListRegions](~~189315~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the simple application server.', 'type' => 'string', 'required' => true, 'example' => '2ad1ae67295445f598017499dc****', 'title' => ''],
+ ],
+ [
+ 'name' => 'KeyPairName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the key pair.', 'type' => 'string', 'required' => false, 'example' => 'test_gin', 'title' => ''],
+ ],
+ [
+ 'name' => 'PublicKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The public key.', 'type' => 'string', 'required' => false, 'example' => 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID5aQ5bM0Am3mWe+upjSXqisUT4DLR6ExwvA0***** **@**.com', 'title' => ''],
],
],
'responses' => [
@@ -14577,245 +11472,1772 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Plans' => [
- 'description' => 'The queried instance plans.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The queried instance plan.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Core' => [
- 'description' => 'The number of vCPUs.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Bandwidth' => [
- 'description' => 'The peak bandwidth. Unit: Mbit/s.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'DiskSize' => [
- 'description' => 'The size of the disk. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
- 'Flow' => [
- 'description' => 'The monthly data transfer quota. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'PlanId' => [
- 'description' => 'The ID of the plan.'."\n",
- 'type' => 'string',
- 'example' => 'swas.s2.c2m1s40b3t04',
- ],
- 'DiskType' => [
- 'description' => 'The category of the disk. Valid values:'."\n"
- ."\n"
- .'* SSD: standard SSDs'."\n"
- .'* ESSD: enhanced SSDs'."\n",
- 'type' => 'string',
- 'example' => 'ESSD',
- ],
- 'Currency' => [
- 'description' => 'The unit of the plan price. Valid values:'."\n"
- ."\n"
- .'* CNY'."\n"
- .'* USD'."\n"
- ."\n"
- .'> CNY is for the China site (aliyun.com). USD is for the international site (alibabacloud.com).'."\n",
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'SupportPlatform' => [
- 'description' => 'The operating system types supported by the plan.'."\n",
- 'type' => 'string',
- 'example' => '["Linux","Windows"]',
- ],
- 'PlanType' => [
- 'description' => 'The type of the instance plan. Valid values:'."\n"
- ."\n"
- .'* NORMAL: a general-purpose plan.'."\n"
- .'* CAPACITY: a larger-storage plan.'."\n"
- .'* PREVIOUS: a previous generation plan.'."\n"
- .'* MULTI_IP: a multiple-IP plan.'."\n"
- .'* INTERNATIONAL: an international plan.'."\n"
- ."\n"
- .'> For more information, see [Overview of instance families](~~2861773~~).'."\n",
- 'type' => 'string',
- 'example' => 'NORMAL',
- ],
- 'PublicIpNum' => [
- 'description' => 'The number of public IP addresses.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'IspType' => [
- 'description' => 'ISP. Default value: BGP.'."\n"
- ."\n"
- .'* **BGP: BGP**'."\n"
- .'* **BGP_NCO**: BGP (Non-China Optimized)'."\n",
- 'type' => 'string',
- 'example' => 'BGP',
- ],
- 'Memory' => [
- 'description' => 'The memory size contained in the plan. Unit: GB.'."\n",
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '1',
- ],
- 'OriginPrice' => [
- 'description' => 'The monthly price of the plan.'."\n",
- 'type' => 'string',
- 'example' => '60',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
- ],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'UploadInstanceKeyPair',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadInstanceKeyPair'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:UploadInstanceKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Plans\\": [\\n {\\n \\"Core\\": 2,\\n \\"Bandwidth\\": 200,\\n \\"DiskSize\\": 40,\\n \\"Flow\\": 400,\\n \\"PlanId\\": \\"swas.s2.c2m1s40b3t04\\",\\n \\"DiskType\\": \\"ESSD\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"SupportPlatform\\": \\"[\\\\\\"Linux\\\\\\",\\\\\\"Windows\\\\\\"]\\",\\n \\"PlanType\\": \\"NORMAL\\",\\n \\"PublicIpNum\\": \\"1\\",\\n \\"IspType\\": \\"BGP\\",\\n \\"Memory\\": 1,\\n \\"OriginPrice\\": \\"60\\"\\n }\\n ],\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","errorExample":""},{"type":"xml","example":"<ListPlansResponse>\\n <Plans>\\n <Memory>1</Memory>\\n <PlanId>swas.s2.c2m1s40b3t04</PlanId>\\n <Bandwidth>3</Bandwidth>\\n <DiskSize>40</DiskSize>\\n <Core>2</Core>\\n <Flow>400</Flow>\\n </Plans>\\n <Plans>\\n <Memory>1</Memory>\\n <PlanId>swas.s2.c2m1s50b4t06</PlanId>\\n <Bandwidth>4</Bandwidth>\\n <DiskSize>50</DiskSize>\\n <Core>2</Core>\\n <Flow>600</Flow>\\n </Plans>\\n <Plans>\\n <Memory>2</Memory>\\n <PlanId>swas.s2.c2m2s50b4t08</PlanId>\\n <Bandwidth>4</Bandwidth>\\n <DiskSize>50</DiskSize>\\n <Core>2</Core>\\n <Flow>800</Flow>\\n </Plans>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n</ListPlansResponse>","errorExample":""}]',
- 'title' => 'ListPlans',
- 'description' => 'You can query the details of all plans provided by Simple Application Server in a region, including the IDs, prices, disk sizes, and disk categories of the plans.'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.ap-northeast-1.aliyuncs.com', 'endpoint' => 'swas.ap-northeast-1.aliyuncs.com', 'vpc' => 'swas-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.ap-northeast-2.aliyuncs.com', 'endpoint' => 'swas.ap-northeast-2.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.ap-southeast-1.aliyuncs.com', 'endpoint' => 'swas.ap-southeast-1.aliyuncs.com', 'vpc' => 'swas-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.ap-southeast-3.aliyuncs.com', 'endpoint' => 'swas.ap-southeast-3.aliyuncs.com', 'vpc' => 'swas-vpc.ap-southeast-3.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.ap-southeast-5.aliyuncs.com', 'endpoint' => 'swas.ap-southeast-5.aliyuncs.com', 'vpc' => 'swas-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.ap-southeast-6.aliyuncs.com', 'endpoint' => 'swas.ap-southeast-6.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.ap-southeast-7.aliyuncs.com', 'endpoint' => 'swas.ap-southeast-7.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-beijing.aliyuncs.com', 'endpoint' => 'swas.cn-beijing.aliyuncs.com', 'vpc' => 'swas-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-chengdu.aliyuncs.com', 'endpoint' => 'swas.cn-chengdu.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-fuzhou.aliyuncs.com', 'endpoint' => 'swas.cn-fuzhou.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-guangzhou.aliyuncs.com', 'endpoint' => 'swas.cn-guangzhou.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-hangzhou.aliyuncs.com', 'endpoint' => 'swas.cn-hangzhou.aliyuncs.com', 'vpc' => 'swas-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-heyuan.aliyuncs.com', 'endpoint' => 'swas.cn-heyuan.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-hongkong.aliyuncs.com', 'endpoint' => 'swas.cn-hongkong.aliyuncs.com', 'vpc' => 'swas-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-huhehaote.aliyuncs.com', 'endpoint' => 'swas.cn-huhehaote.aliyuncs.com', 'vpc' => 'swas-vpc.cn-huhehaote.aliyuncs.com'],
+ ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-nanjing.aliyuncs.com', 'endpoint' => 'swas.cn-nanjing.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-qingdao.aliyuncs.com', 'endpoint' => 'swas.cn-qingdao.aliyuncs.com', 'vpc' => 'swas-vpc.cn-qingdao.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-shanghai.aliyuncs.com', 'endpoint' => 'swas.cn-shanghai.aliyuncs.com', 'vpc' => 'swas-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-shenzhen.aliyuncs.com', 'endpoint' => 'swas.cn-shenzhen.aliyuncs.com', 'vpc' => 'swas-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-wuhan-lr', 'regionName' => 'China (Wuhan - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'swas.cn-wuhan-lr.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'swas.cn-wulanchabu.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'swas.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'swas.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'swas-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'swas.us-west-1.aliyuncs.com', 'endpoint' => 'swas.us-west-1.aliyuncs.com', 'vpc' => 'swas-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'swas.us-east-1.aliyuncs.com', 'endpoint' => 'swas.us-east-1.aliyuncs.com', 'vpc' => 'swas-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'swas.eu-west-1.aliyuncs.com', 'endpoint' => 'swas.eu-west-1.aliyuncs.com', 'vpc' => 'swas-vpc.eu-west-1.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'swas.eu-central-1.aliyuncs.com', 'endpoint' => 'swas.eu-central-1.aliyuncs.com', 'vpc' => 'swas-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'swas.me-central-1.aliyuncs.com', 'endpoint' => 'swas.me-central-1.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'CustomImageInShare', 'message' => 'The custom image is being shared. Please disable sharing first and then delete it.', 'http_code' => 400, 'description' => 'The custom image is being shared. To delete this custom image, disable its sharing first.'],
+ ['code' => 'CustomImageInShare', 'message' => 'The custom image is in sharing,please unshare first then to retry.', 'http_code' => 400, 'description' => 'The custom image is being shared, please unshare.'],
+ ['code' => 'CustomImageQuotaLimit', 'message' => 'The maximum number of custom image in this region is exceeded.', 'http_code' => 400, 'description' => 'The maximum number of custom images within this region has been reached.'],
+ ['code' => 'DomainQuotaExceed', 'message' => 'Too many domains adding.', 'http_code' => 400, 'description' => 'The number of domains added exceeds the limit.'],
+ ['code' => 'ExceedAccountQuota', 'message' => 'The total number of instance including the instances created by this order has exceeded the quota set by the account.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'FirewallRuleAlreadyExist', 'message' => 'The specified Rule already exist', 'http_code' => 403, 'description' => ''],
+ ['code' => 'FirewallRuleLimitExceed', 'message' => 'The maximum number of firewall rules in an instance is exceeded.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'ImageNameAlreadyExist', 'message' => 'The image name already exists.', 'http_code' => 400, 'description' => 'The specified image name already exists.'],
+ ['code' => 'IncorrectDiskStatus.CreatingSnapshot', 'message' => 'A snapshot is being created in the specified disk. Please try again later.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IncorrectInstanceStatus', 'message' => 'The state of the current instance does not support this operation.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IncorrectInstanceStatus.ResetDisk', 'message' => 'Rolling back the disk requires the instance to operate in a stopped state.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IncorrectStatus', 'message' => 'The state of the disk or instance does not currently support snapshot creation.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InternalError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'InvalidAmount.ValueNotSupported', 'message' => 'The specified parameter Amount is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidAutoRenewPeriod.ValueNotSupported', 'message' => 'The specified parameter AutoRenewPeriod is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidChargeType.ValueNotSupported', 'message' => 'The specified parameter ChargeType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidCommandContent', 'message' => 'The specified parameter CommandContent value is not valid.', 'http_code' => 400, 'description' => 'The specified parameter CommandContent is invalid.'],
+ ['code' => 'InvalidDataDiskSize.ValueNotSupported', 'message' => 'The specified parameter DataDiskSize is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidDiskId.NotFound', 'message' => 'The specified DiskId does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidFirewallRule.NotFound', 'message' => 'The specified FirewallRule does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidImageId.NotFound', 'message' => 'The specified ImageId does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidImageId.NotSupport', 'message' => 'The specified ImageId does not support the operation.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidImageType.ValueNotSupported', 'message' => 'The specified parameter ImageType is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidInstance.UnPaidOrder', 'message' => 'The specified Instance has an unpaid order.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'InvalidInstanceId.NotFound', 'message' => 'The specified Instance Id does not exist.', 'http_code' => 404, 'description' => 'The specified instance ID does not exist.'],
+ ['code' => 'InvalidInstanceId.NotFound', 'message' => 'The specified InstanceId does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidInstanceName.ValueNotSupported', 'message' => 'The specified parameter InstanceName is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParam', 'message' => 'The specified parameter value is invalid.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'InvalidParam.DataSnapshotIdNotFound', 'message' => 'The specified parameter dataSnapshotId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParam.IllegalImageName', 'message' => 'The specified parameter imageName is illegal.', 'http_code' => 400, 'description' => 'The specified image name is invalid.'],
+ ['code' => 'InvalidParam.OperationIllegal', 'message' => 'The specified parameter operation is illegal.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParam.SystemSnapshotIdNotFound', 'message' => 'The specified parameter systemSnapshotId is not found.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParam.SystemSnapshotIdNotSupport', 'message' => 'You cannot create custom images in the specified parameter system snapshotId.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPassword.ValueNotSupported', 'message' => 'The specified parameter Password is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPeriod.ValueNotSupported', 'message' => 'The specified parameter Period is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPlanId.NotFound', 'message' => 'The specified PlanId does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidPlanIdSize.ValueNotSupported', 'message' => 'The system disk size in the specified planId does not support the image.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPlanIdUpgrade.ValueNotSupported', 'message' => 'The specification of the specified planId is lower than the current server specification.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPlanMemorySize.ValueNotSupported', 'message' => 'The memory size in the specified planId does not support the image.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPort.ValueNotSupported', 'message' => 'The specified parameter Port is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidProtocol.ValueNotSupported', 'message' => 'The specified parameter Protocol is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidPublicIpAddresses.ValueNotSupported', 'message' => 'The specified parameter PublicIpAddresses is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRemark.Duplicate', 'message' => 'The specified Remark already exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRemark.ValueNotSupported', 'message' => 'The specified parameter Remark is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidRuleId.NotFound', 'message' => 'The specified RuleId does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidSnapshotId.NotFound', 'message' => 'The specified SnapshotId does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidSnapshotName.Duplicate', 'message' => 'The specified SnapshotName already exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidSnapshotName.ValueNotSupported', 'message' => 'The specified SnapshotName is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'NotEnoughStock', 'message' => 'The stock is insufficient.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'NotEnoughUpgradeStock', 'message' => 'The upgrade stock is insufficient.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'NotFoundCommand', 'message' => 'Cannot find resource according to your specified CommandId.', 'http_code' => 404, 'description' => 'Cannot find resource according to your specified CommandId.'],
+ ['code' => 'NotFoundInstance', 'message' => 'Cannot find resource according to your specified Instance.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'PaymentFailed', 'message' => 'Payment failed. Please check your account balance.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'PlatformNotMatch', 'message' => 'The platform of specified ImageId and PlanId does not match.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'RegionIdNotMatchHost', 'message' => 'The parameter regionId does not match the endpoint host.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'SnapshotExistCustomImage', 'message' => 'The snapshot has been used to create custom images and cannot be deleted. Please delete the custom images in this snapshot first and then try again.', 'http_code' => 400, 'description' => 'The specified snapshot has been used to create custom images. To delete this snapshot, delete the custom images created from this snapshot first.'],
+ ['code' => 'SnapshotLimitExceed', 'message' => 'The maximum number of snapshots in an instance is exceeded.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'VpcPeerAlreadyExists', 'message' => 'The specified vpc peer already exists. Please change Vpc.', 'http_code' => 400, 'description' => 'The current VPC has been configured for intranet interconnection, please select again.'],
+ ['code' => 'VPC_PEER_ALREADY_EXISTS', 'message' => 'The specified vpc peer already exists. Please change Vpc.', 'http_code' => 400, 'description' => 'The specified vpc peer already exists. Please change Vpc.'],
+ ['code' => 'NotFoundfirewallRuleId', 'message' => 'The incoming firewallRuleId does not exist.', 'http_code' => 404, 'description' => 'The incoming firewallRuleId does not exist.'],
+ ['code' => 'NotFound%s', 'message' => 'Cannot find resource according to your specified %s.', 'http_code' => 404, 'description' => 'The resource was not found based on the data you specified.'],
+ ['code' => 'InvalidFormatResourceIds', 'message' => 'The specified resource ID format is incorrect.', 'http_code' => 400, 'description' => 'The specified resource ID is not in the correct format'."\n"],
+ ['code' => 'InvalidSnapshotName.Malformed', 'message' => 'The specified SnapshotName is wrongly formed.', 'http_code' => 400, 'description' => 'The specified SnapshotName is in the wrong format.'],
+ ['code' => 'IncorrectDiskStatus', 'message' => 'The specified disk status is incorrect.', 'http_code' => 400, 'description' => 'The specified disk status is incorrect'],
+ ['code' => 'InvalidInstanceIds', 'message' => 'The specified instance ID is invalid.', 'http_code' => 400, 'description' => 'The specified instance ID is invalid'."\n"],
+ ['code' => 'SALES_LIMIT_REACHED', 'message' => 'Sales limit reached.', 'http_code' => 400, 'description' => 'Sales limit reached'],
+ ['code' => 'PAY.INSUFFICIENT_BALANCE', 'message' => 'Insufficient available funds.', 'http_code' => 400, 'description' => 'Not enough available gold'],
+ ['code' => 'UserBehaviour.SessionManagerDisabled', 'message' => 'The API is disabled by user behaviour.', 'http_code' => 400, 'description' => 'User remote connection via session management is turned off.'],
+ ['code' => 'INSTANCE_LOGIN_FAILURE', 'message' => 'Instance login failure.', 'http_code' => 500, 'description' => 'Instance login failed.'],
+ ['code' => 'InvalidIpProtocol.ValueNotSupported', 'message' => 'The parameter Permissions.1.IpProtocol must be specified with case insensitive TCP, UDP, ICMP, GRE or All.', 'http_code' => 400, 'description' => 'Parameter Permissions. 1. The IpProtocol must be specified as case-insensitive TCP, UDP, ICMP, GRE, or All.'],
+ ['code' => 'InvalidPublicIpAddresses', 'message' => 'The specified parameter PublicIpAddresses value is not valid.', 'http_code' => 400, 'description' => 'The specified parameter PublicIpAddresses value is invalid.'],
+ ['code' => 'InvalidSnapshotIds', 'message' => 'The specified SnapshotIds is not valid.', 'http_code' => 400, 'description' => 'The specified snapshot ID is invalid.'],
+ ['code' => 'CSS_SYSTEM_ERROR', 'message' => 'The sales system encountered an error.', 'http_code' => 400, 'description' => 'There was an error in the selling system.'],
+ ['code' => 'UserBehavior.SessionManagerDisabled', 'message' => 'The API is disabled by user behaviour.', 'http_code' => 400, 'description' => 'User remote connection via session management is turned off.'],
+ ['code' => 'SWAS_NOT_ENOUGH_ACTIVITY_STOCK', 'message' => 'The configuration you selected is sold out in the current region. Please try to select another configuration or region.', 'http_code' => 400, 'description' => 'The configuration you selected is sold out in the current region. Please try to select another configuration or region.'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'swas.cn-qingdao.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListCustomImages'],
+ ],
+ 'createdAt' => '2024-10-09T09:23:38.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'swas.cn-beijing.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ApplyFirewallTemplate'],
+ ['description' => 'Request parameters changed', 'api' => 'DeleteFirewallTemplateRules'],
+ ['description' => 'Request parameters changed', 'api' => 'DeleteFirewallTemplates'],
+ ['description' => 'Request parameters changed', 'api' => 'DescribeFirewallTemplateApplyResults'],
+ ['description' => 'Request parameters changed', 'api' => 'ModifyFirewallTemplate'],
+ ],
+ 'createdAt' => '2024-08-12T06:36:20.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'swas.cn-zhangjiakou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateCustomImage'],
+ ],
+ 'createdAt' => '2024-08-08T02:10:46.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'swas.cn-huhehaote.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListCustomImages'],
+ ],
+ 'createdAt' => '2024-07-02T08:01:05.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'swas.cn-wulanchabu.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'LoginInstance'],
+ ],
+ 'createdAt' => '2024-06-24T02:14:35.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'swas.cn-hangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListInstances'],
+ ],
+ 'createdAt' => '2024-06-17T10:54:52.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'swas.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateCommand'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateCustomImage'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateSnapshot'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeCommands'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListDisks'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListInstances'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSnapshots'],
+ ],
+ 'createdAt' => '2024-05-29T02:22:33.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-nanjing',
- 'endpoint' => 'swas.cn-nanjing.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AttachKeyPair'],
+ ['description' => 'Request parameters changed', 'api' => 'DetachKeyPair'],
+ ],
+ 'createdAt' => '2024-05-28T05:41:07.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-fuzhou',
- 'endpoint' => 'swas.cn-fuzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateCustomImage'],
+ ],
+ 'createdAt' => '2024-04-17T05:49:06.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'swas.cn-shenzhen.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateCommand'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateCustomImage'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateFirewallRules'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateSnapshot'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeCommands'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListCustomImages'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListDisks'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListFirewallRules'],
+ ['description' => 'Response parameters changed', 'api' => 'ListInstances'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSnapshots'],
+ ],
+ 'createdAt' => '2024-02-20T03:37:08.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-heyuan',
- 'endpoint' => 'swas.cn-heyuan.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListInstances'],
+ ],
+ 'createdAt' => '2024-01-17T06:24:17.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'swas.cn-guangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListRegions'],
+ ],
+ 'createdAt' => '2023-12-18T08:54:26.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'swas.cn-chengdu.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'DescribeDatabaseSlowLogRecords'],
+ ['description' => 'Request parameters changed', 'api' => 'ListInstancesTrafficPackages'],
+ ['description' => 'Request parameters changed', 'api' => 'ListSnapshots'],
+ ],
+ 'createdAt' => '2023-09-20T05:07:40.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-wuhan-lr',
- 'endpoint' => 'swas.cn-wuhan-lr.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListInstancesTrafficPackages'],
+ ],
+ 'createdAt' => '2023-09-18T13:53:14.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'swas.cn-hongkong.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListSnapshots'],
+ ],
+ 'createdAt' => '2023-09-18T12:11:27.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'swas.ap-northeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'DescribeDatabaseSlowLogRecords'],
+ ],
+ 'createdAt' => '2023-09-18T11:38:32.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-northeast-2',
- 'endpoint' => 'swas.ap-northeast-2.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListInstances'],
+ ],
+ 'createdAt' => '2023-07-19T07:19:13.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'swas.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'DeleteSnapshot'],
+ ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'ListDisks'],
+ ['description' => 'Response parameters changed', 'api' => 'ListFirewallRules'],
+ ['description' => 'Response parameters changed', 'api' => 'ListInstances'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSnapshots'],
+ ],
+ 'createdAt' => '2023-05-25T10:54:17.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'swas.ap-southeast-3.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AllocatePublicConnection'],
+ ['description' => 'OpenAPI offline', 'api' => 'ModifyDatabaseInstanceDescription'],
+ ['description' => 'Request parameters changed', 'api' => 'ModifyDatabaseInstanceParameter'],
+ ['description' => 'Request parameters changed', 'api' => 'ReleasePublicConnection'],
+ ['description' => 'Request parameters changed', 'api' => 'ResetDatabaseAccountPassword'],
+ ['description' => 'Request parameters changed', 'api' => 'RestartDatabaseInstance'],
+ ['description' => 'Request parameters changed', 'api' => 'StartDatabaseInstance'],
+ ['description' => 'Request parameters changed', 'api' => 'StopDatabaseInstance'],
+ ],
+ 'createdAt' => '2022-07-22T03:40:55.000Z',
+ 'description' => '暂时不需要',
],
[
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'swas.ap-southeast-5.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeDatabaseInstanceParameters'],
+ ],
+ 'createdAt' => '2022-07-18T09:22:22.000Z',
+ 'description' => '无需',
],
[
- 'regionId' => 'ap-southeast-6',
- 'endpoint' => 'swas.ap-southeast-6.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeDatabaseErrorLogs'],
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeDatabaseInstanceMetricData'],
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeDatabaseInstances'],
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeDatabaseSlowLogRecords'],
+ ],
+ 'createdAt' => '2022-07-15T09:30:36.000Z',
+ 'description' => '暂时不需要',
],
[
- 'regionId' => 'us-east-1',
- 'endpoint' => 'swas.us-east-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeCloudAssistantStatus'],
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeInvocationResult'],
+ ['description' => 'OpenAPI offline', 'api' => 'DescribeInvocations'],
+ ['description' => 'OpenAPI offline', 'api' => 'InstallCloudAssistant'],
+ ['description' => 'OpenAPI offline', 'api' => 'LoginInstance'],
+ ['description' => 'OpenAPI offline', 'api' => 'RunCommand'],
+ ],
+ 'createdAt' => '2022-06-21T07:24:41.000Z',
+ 'description' => '待文档更新完毕后展示',
],
[
- 'regionId' => 'us-west-1',
- 'endpoint' => 'swas.us-west-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateInstances'],
+ ],
+ 'createdAt' => '2021-12-24T06:31:47.000Z',
+ 'description' => '新增错误码，InvalidPlanMemorySize.ValueNotSupported',
],
[
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'swas.eu-west-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListInstancesTrafficPackages'],
+ ],
+ 'createdAt' => '2021-11-03T13:43:38.000Z',
+ 'description' => '修改传参InstanceIds为必选',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'swas.eu-central-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateCustomImage'],
+ ],
+ 'createdAt' => '2021-10-28T02:35:53.000Z',
+ 'description' => '错误码更新',
],
[
- 'regionId' => 'ap-southeast-7',
- 'endpoint' => 'swas.ap-southeast-7.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateCustomImage'],
+ ],
+ 'createdAt' => '2021-10-27T07:02:40.000Z',
+ 'description' => '创建自定义镜像',
],
[
- 'regionId' => 'me-central-1',
- 'endpoint' => 'swas.me-central-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListDisks'],
+ ['description' => 'Request parameters changed', 'api' => 'ListFirewallRules'],
+ ],
+ 'createdAt' => '2021-08-23T11:46:44.000Z',
+ 'description' => '无需',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabaseSlowLogRecords'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateInstanceAttribute'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RunCommand'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopInstances'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCommand'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCustomImage'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceVncUrl'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabaseErrorLogs'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopInstance'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateSnapshotAttribute'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewInstance'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDatabaseInstanceDescription'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshots'],
+ ['threshold' => '50', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateInstances'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyFirewallRule'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReleasePublicConnection'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSnapshot'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInvocationResult'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstancePasswordsSetting'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DisableFirewallRule'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadInstanceKeyPair'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateFirewallRule'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeInstance'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateDiskAttribute'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudMonitorAgentStatuses'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetDisk'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableFirewallRule'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetDatabaseAccountPassword'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInvocations'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListInstancePlansModification'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImageShareStatus'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabaseInstances'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListInstanceStatus'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDatabaseInstanceParameter'],
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListInstancesTrafficPackages'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSnapshots'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'InstallCloudMonitorAgent'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListInstances'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateFirewallRules'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LoginInstance'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartDatabaseInstance'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCustomImages'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetSystem'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabaseInstanceMetricData'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDisks'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCommand'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListFirewallRules'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceVncPassword'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebootInstances'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopDatabaseInstance'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateInstanceKeyPair'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartInstance'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartInstances'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudAssistantStatus'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceKeyPair'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeMonitorData'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebootInstance'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListImages'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListRegions'],
+ ['threshold' => '50', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AllocatePublicConnection'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListPlans'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCustomImage'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestartDatabaseInstance'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSecurityAgentStatus'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteFirewallRule'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'InstallCloudAssistant'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabaseInstanceParameters'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteInstanceKeyPair'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'SimpleApplicationServer',
+ 'productName' => 'Simple Application Server '."\n",
+ 'ramCodes' => ['swas', 'swas-open'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'CreateInstanceKeyPair',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateInstanceKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddCustomImageShareAccount',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:AddCustomImageShareAccount',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisableFirewallRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:DisableFirewallRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/{#RuleId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RenewInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:RenewInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartDatabaseInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StartDatabaseInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribePrice',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AllocatePublicConnection',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:AllocatePublicConnection',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCloudAssistantAttributes',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCloudAssistantAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateFirewallRule',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateFirewallRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TagResources',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:TagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteSnapshots',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteSnapshots',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotIds}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDatabaseInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeDatabaseInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateOrder',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ReleasePublicConnection',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:ReleasePublicConnection',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateFirewallRules',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateFirewallRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteFirewallTemplateRules',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteFirewallTemplateRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCloudAssistantStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCloudAssistantStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopDatabaseInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StopDatabaseInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RebootInstances',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:RebootInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StartInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDatabaseInstanceMetricData',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeDatabaseInstanceMetricData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstanceVncUrl',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeInstanceVncUrl',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'LoginInstance',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:LoginInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:Instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyFirewallRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyFirewallRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/{#RuleId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadInstanceKeyPair',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:UploadInstanceKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCommand',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateCommand',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResetDisk',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ResetDisk',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DiskId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ImportKeyPair',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:ImportKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInvocations',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeInvocations',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListFirewallRules',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListFirewallRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateInstanceAttribute',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:UpdateInstanceAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCustomImage',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteCustomImage',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InvokeCommand',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:InvokeCommand',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeSecurityAgentStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeSecurityAgentStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInvocationResult',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeInvocationResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCommands',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCommands',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/*'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/{#CommandId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteKeyPairs',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteKeyPairs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeMonitorData',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeMonitorData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListKeyPairs',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListKeyPairs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DetachKeyPair',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:DetachKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateInstances',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstanceKeyPair',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeInstanceKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteSnapshot',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteSnapshot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopInstances',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StopInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InstallCloudMonitorAgent',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:InstallCloudMonitorAgent',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateCommandAttribute',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:UpdateCommandAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/{#CommandId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunCommand',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:RunCommand',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#CommandId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDatabaseInstanceParameters',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeDatabaseInstanceParameters',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteFirewallRule',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteFirewallRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/{#RuleId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/*'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInstanceStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListInstanceStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListImages',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListImages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableFirewallRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:EnableFirewallRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/{#RuleId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInstancePlansModification',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListInstancePlansModification',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDisks',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListDisks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Disk', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:disk/{#DiskId}'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Disk', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:disk/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RebootInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:RebootInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCloudMonitorAgentStatuses',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCloudMonitorAgentStatuses',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartInstances',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StartInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDatabaseInstanceParameter',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyDatabaseInstanceParameter',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCommand',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteCommand',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#CommandId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyInstanceVncPassword',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyInstanceVncPassword',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResetDatabaseAccountPassword',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ResetDatabaseAccountPassword',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteFirewallRules',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteFirewallRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:StopInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCustomImages',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListCustomImages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/*'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#CustomImageId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDiskAttribute',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:UpdateDiskAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DiskId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InstallCloudAssistant',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:InstallCloudAssistant',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ApplyFirewallTemplate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ApplyFirewallTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDatabaseErrorLogs',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeDatabaseErrorLogs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCustomImage',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateCustomImage',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSnapshots',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListSnapshots',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/*'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResetSystem',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ResetSystem',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDatabaseSlowLogRecords',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeDatabaseSlowLogRecords',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeFirewallTemplates',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeFirewallTemplates',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCustomImageShareAccounts',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListCustomImageShareAccounts',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteInstanceKeyPair',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteInstanceKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateFirewallTemplateRules',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateFirewallTemplateRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplatId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveCustomImageShareAccount',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:RemoveCustomImageShareAccount',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateSnapshotAttribute',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:UpdateSnapshotAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteFirewallTemplates',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteFirewallTemplates',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateSnapshot',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateSnapshot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AttachKeyPair',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:AttachKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyFirewallTemplate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyFirewallTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpgradeInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:UpgradeInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTagResources',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateKeyPair',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateKeyPair',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeFirewallTemplateApplyResults',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeFirewallTemplateApplyResults',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyImageShareStatus',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyImageShareStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDatabaseInstanceDescription',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:ModifyDatabaseInstanceDescription',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RestartDatabaseInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:RestartDatabaseInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCustomImages',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteCustomImages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageIds}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeFirewallTemplateRulesApplyResult',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeFirewallTemplateRulesApplyResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCommandInvocations',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCommandInvocations',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartTerminalSession',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:StartTerminalSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UntagResources',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:UntagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateFirewallTemplate',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateFirewallTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstancePasswordsSetting',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeInstancePasswordsSetting',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInstancesTrafficPackages',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListInstancesTrafficPackages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}'],
+ ['validationType' => 'always', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}'],
+ ['validationType' => 'always', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/{#RuleId}'],
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}'],
+ ['validationType' => 'always', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotIds}'],
+ ['validationType' => 'always', 'resourceType' => 'FirewallRule', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewallrule/*'],
+ ['validationType' => 'always', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}'],
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:Instance/{#InstanceId}'],
+ ['validationType' => 'always', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/*'],
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/{#DiskId}'],
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/{#InstanceId}'],
+ ['validationType' => 'always', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:command/{#CommandId}'],
+ ['validationType' => 'always', 'resourceType' => 'KeyPair', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:Keypair/*'],
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:instance/*'],
+ ['validationType' => 'always', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}'],
+ ['validationType' => 'always', 'resourceType' => 'Command', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:{#CommandId}'],
+ ['validationType' => 'always', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/*'],
+ ['validationType' => 'always', 'resourceType' => 'Disk', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:disk/{#DiskId}'],
+ ['validationType' => 'always', 'resourceType' => 'Disk', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:disk/*'],
+ ['validationType' => 'always', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#CustomImageId}'],
+ ['validationType' => 'always', 'resourceType' => 'Snapshot', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:snapshot/*'],
+ ['validationType' => 'always', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:FirewallTemplate/*'],
+ ['validationType' => 'always', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:FirewallTemplate/{#FirewallTempalteId}'],
+ ['validationType' => 'always', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplatId}'],
+ ['validationType' => 'always', 'resourceType' => 'CustomImage', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageIds}'],
+ ['validationType' => 'always', 'resourceType' => 'FirewallTemplate', 'arn' => 'acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/*'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 22:32:27 +0000