summaryrefslogtreecommitdiff
path: root/data/zh_cn/swas-open/2020-06-01
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/swas-open/2020-06-01
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/swas-open/2020-06-01')
-rw-r--r--data/zh_cn/swas-open/2020-06-01/api-docs.php19197
1 files changed, 8463 insertions, 10734 deletions
diff --git a/data/zh_cn/swas-open/2020-06-01/api-docs.php b/data/zh_cn/swas-open/2020-06-01/api-docs.php
index 63b3b48..9621943 100644
--- a/data/zh_cn/swas-open/2020-06-01/api-docs.php
+++ b/data/zh_cn/swas-open/2020-06-01/api-docs.php
@@ -1,202 +1,84 @@
<?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' => '实例',
+ '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' => '实例',
+ 'id' => 81307,
],
[
- 'id' => 183180,
- 'title' => '密钥对',
+ 'children' => ['CreateInstanceKeyPair', 'UploadInstanceKeyPair', 'DescribeInstanceKeyPair', 'ListKeyPairs', 'DeleteInstanceKeyPair'],
'type' => 'directory',
- 'children' => [
- 'CreateInstanceKeyPair',
- 'CreateKeyPair',
- 'UploadInstanceKeyPair',
- 'ImportKeyPair',
- 'DescribeInstanceKeyPair',
- 'ListKeyPairs',
- 'AttachKeyPair',
- 'DetachKeyPair',
- 'DeleteInstanceKeyPair',
- 'DeleteKeyPairs',
- ],
+ 'title' => '密钥对',
+ 'id' => 81382,
],
[
- 'id' => 193202,
- 'title' => '防火墙模板',
+ 'children' => ['CreateFirewallTemplate', 'DescribeFirewallTemplates', 'CreateFirewallTemplateRules', 'ApplyFirewallTemplate', 'ModifyFirewallTemplate', 'DescribeFirewallTemplateApplyResults', 'DescribeFirewallTemplateRulesApplyResult', 'DeleteFirewallTemplateRules', 'DeleteFirewallTemplates'],
'type' => 'directory',
- 'children' => [
- 'CreateFirewallTemplate',
- 'DescribeFirewallTemplates',
- 'CreateFirewallTemplateRules',
- 'ApplyFirewallTemplate',
- 'ModifyFirewallTemplate',
- 'DescribeFirewallTemplateApplyResults',
- 'DescribeFirewallTemplateRulesApplyResult',
- 'DeleteFirewallTemplateRules',
- 'DeleteFirewallTemplates',
- ],
+ 'title' => '防火墙模板',
+ 'id' => 81397,
],
[
- 'id' => 100895,
- 'title' => '防火墙',
+ 'children' => ['CreateFirewallRule', 'CreateFirewallRules', 'ListFirewallRules', 'ModifyFirewallRule', 'EnableFirewallRule', 'DisableFirewallRule', 'DeleteFirewallRule'],
'type' => 'directory',
- 'children' => [
- 'DeleteFirewallRules',
- 'CreateFirewallRule',
- 'CreateFirewallRules',
- 'ListFirewallRules',
- 'ModifyFirewallRule',
- 'EnableFirewallRule',
- 'DisableFirewallRule',
- 'DeleteFirewallRule',
- ],
+ 'title' => '防火墙',
+ 'id' => 81331,
],
[
- 'id' => 100899,
- 'title' => '快照',
+ 'children' => ['ListSnapshots', 'UpdateSnapshotAttribute', 'DeleteSnapshots'],
'type' => 'directory',
- 'children' => [
- 'CreateSnapshot',
- 'ListSnapshots',
- 'UpdateSnapshotAttribute',
- 'DeleteSnapshot',
- 'DeleteSnapshots',
- ],
+ 'title' => '快照',
+ 'id' => 81340,
],
[
- 'id' => 100903,
- 'title' => '磁盘',
+ 'children' => ['UpdateDiskAttribute', 'ListDisks'],
'type' => 'directory',
- 'children' => [
- 'UpdateDiskAttribute',
- 'ListDisks',
- 'ResetDisk',
- ],
+ 'title' => '磁盘',
+ 'id' => 81346,
],
[
- 'id' => 100879,
- 'title' => '自定义镜像',
+ 'children' => ['ListCustomImages', 'ModifyImageShareStatus', 'AddCustomImageShareAccount', 'ListCustomImageShareAccounts', 'RemoveCustomImageShareAccount', 'DeleteCustomImage', 'DeleteCustomImages'],
'type' => 'directory',
- 'children' => [
- 'CreateCustomImage',
- 'ListCustomImages',
- 'ModifyImageShareStatus',
- 'AddCustomImageShareAccount',
- 'ListCustomImageShareAccounts',
- 'ListCustomImageShareAccounts',
- 'RemoveCustomImageShareAccount',
- 'DeleteCustomImage',
- 'DeleteCustomImages',
- ],
+ 'title' => '自定义镜像',
+ 'id' => 81298,
],
[
- 'id' => 182900,
- 'title' => '命令助手',
+ 'children' => ['DescribeCloudAssistantAttributes', 'UpdateCommandAttribute', 'DescribeCommandInvocations', 'DescribeInvocationResult'],
'type' => 'directory',
- 'children' => [
- 'DescribeCloudAssistantAttributes',
- 'UpdateCommandAttribute',
- 'InvokeCommand',
- 'DescribeCommands',
- 'DescribeCommandInvocations',
- 'DeleteCommand',
- 'CreateCommand',
- 'StartTerminalSession',
- 'InstallCloudAssistant',
- 'DescribeCloudAssistantStatus',
- 'DescribeInvocationResult',
- 'RunCommand',
- 'DescribeInvocations',
- ],
+ 'title' => '命令助手',
+ 'id' => 81354,
],
[
- 'id' => 182906,
- 'title' => '轻量数据库服务',
+ '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' => '轻量数据库服务',
+ 'id' => 81368,
],
[
- 'id' => 184258,
- 'title' => '标签',
+ 'children' => ['ListPlans'],
'type' => 'directory',
- 'children' => [
- 'TagResources',
- 'ListTagResources',
- 'UntagResources',
- ],
+ 'title' => '其他资源',
+ 'id' => 81350,
],
[
- 'id' => 100906,
- 'title' => '其他资源',
- 'type' => 'directory',
'children' => [
- 'ListRegions',
- 'ListImages',
- 'ListPlans',
+ 'AttachKeyPair', 'CreateCommand', 'CreateCustomImage', 'CreateInstances', 'CreateKeyPair', 'CreateOrder', 'CreateSnapshot', 'DeleteCommand', 'DeleteFirewallRules', 'DeleteKeyPairs', 'DeleteSnapshot', 'DescribeCloudAssistantStatus', 'DescribeCommands', 'DescribeInstanceVncUrl', 'DescribeInvocations', 'DescribeMonitorData', 'DescribePrice', 'DetachKeyPair', 'ImportKeyPair', 'InstallCloudAssistant',
+ 'InvokeCommand', 'ListImages', 'ListInstanceStatus', 'ListInstances', 'ListRegions', 'ListTagResources', 'LoginInstance', 'RebootInstance', 'RebootInstances', 'RenewInstance', 'ResetDisk', 'RunCommand', 'StartInstance', 'StartInstances', 'StartTerminalSession', 'StopInstance', 'StopInstances', 'TagResources', 'UntagResources',
],
+ 'title' => '其他',
+ 'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateInstances' => [
- 'summary' => '创建一台或多台包年包月的轻量应用服务器实例。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddCustomImageShareAccount' => [
+ 'summary' => '您可以将自定义镜像共享给同地域下的其他阿里云账号，快速为多个轻量应用服务器部署相同的环境配置，提高部署效率。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -205,436 +87,194 @@
'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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
- ],
- [
- 'name' => 'ImageId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '镜像ID。您可以调用[ListImages](~~189313~~)查询指定地域下可用的镜像ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'e2c9c365024a44369c9b955a998a****',
- ],
- ],
- [
- 'name' => 'PlanId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '套餐ID。您可以调用[ListPlans](~~189314~~)查询指定地域下的全部套餐信息。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'swas.s1.c1m1s40b3t05',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => '购买资源的时长。单位：月。取值范围：{"1", "3", "6", "12", "24", "36"}',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '36',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'AutoRenew',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否开启到期自动续费。取值范围：'."\n"
- ."\n"
- .'- true：开启'."\n"
- .'- false：不开启'."\n"
- ."\n"
- .'默认值：false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'AutoRenewPeriod',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '自动续费的时长，仅当`AutoRenew=true`时该参数必填。单位：月。取值范围：{"1", "3", "6", "12", "24", "36"}',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '36',
- 'minimum' => '1',
- 'example' => '3',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'DataDiskSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '挂载的数据盘容量大小。单位：GB。取值范围：0~16380，取值必须是20的整数倍。'."\n"
- ."\n"
- .'<props="china">'."\n"
- .'- 取值为0时，表示不挂载数据盘。'."\n"
- ."\n"
- .'- 如果您选择的套餐使用的是ESSD云盘（性能级别PL0），则挂载的数据盘容量最小值为40 GB。'."\n"
- ."\n"
- .'- 如果您选择的套餐使用的是SSD云盘，则挂载的数据盘容量最小值为20 GB。'."\n"
- ."\n"
- .'</props>'."\n"
- ."\n"
- .'<props="intl">'."\n"
- .'- 取值为0时，表示不挂载数据盘。'."\n"
- ."\n"
- .'- 如果您选择的套餐使用的是SSD云盘，则挂载的数据盘容量最小值为20 GB。'."\n"
- ."\n"
- .'</props>'."\n"
- ."\n"
- .'默认值：0',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '16380',
- 'minimum' => '0',
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'Amount',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => '创建轻量应用服务器的数量。取值范围：1~20'."\n"
- ."\n"
- .'默认值：1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '自定义镜像ID。', 'type' => 'string', 'required' => true, 'example' => 'm-saacssasc****'],
],
[
- 'name' => 'ChargeType',
+ 'name' => 'Account',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '计费方式。取值：PrePaid，目前仅支持包年包月计费方式。'."\n"
+ 'description' => '账户名称',
+ 'type' => 'array',
+ 'items' => ['description' => '共享自定义镜像的目标阿里云主账号ID。'."\n"
."\n"
- .'默认值：PrePaid',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PrePaid',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
+ .'> 最多同时共享给10个账号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '125111425233****'],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE',
- ],
- 'InstanceIds' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'example' => '3a658ca270df4df39f22e289b338****',
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
],
],
],
- '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' => '跨账号共享自定义镜像',
+ 'description' => '- 共享镜像前，请清除敏感数据和文件。'."\n"
+ ."\n"
+ .'- 已获取阿里云账号ID。将鼠标移至控制台右上角的用户头像，在弹出的用户信息框中，如果标识了账号为主账号，则显示的账号ID即为阿里云账号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' => '创建实例',
- 'description' => '<props="china">'."\n"
- .'- 在调用该接口前，建议您了解轻量应用服务器的计费信息。更多信息，请参见[计费项](~~58623~~)。'."\n"
- ."\n"
- .'> 如果您的阿里云账号有优惠券，则默认会优先使用优惠券支付购买轻量应用服务器实例的费用。'."\n"
- ."\n"
- .'- 同一个阿里云账号在同一个地域下，购买轻量应用服务器与轻量应用负载均衡、轻量容器服务、轻量数据库服务的总数量上限为50台。'."\n"
- ."\n"
- .'- 调用该接口创建服务器时，您需要确保您的阿里云账户余额充足，否则会创建失败。'."\n"
- ."\n"
- .'</props>'."\n"
- ."\n"
- .'<props="intl">'."\n"
- .'- 在调用该接口前，建议您了解轻量应用服务器的计费信息。更多信息，请参见[计费项](~~58623~~)。'."\n"
- ."\n"
- .'> 如果您的阿里云账号有优惠券，则默认会优先使用优惠券支付购买轻量应用服务器实例的费用。'."\n"
- ."\n"
- .'- 同一个阿里云账号在同一个地域下，购买轻量应用服务器的总数量上限为50台。'."\n"
- ."\n"
- .'- 调用该接口创建服务器时，您需要确保账户默认支付方式能够结清创建服务器所需的费用，否则会创建失败。'."\n"
- ."\n"
- .'</props>',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
],
- 'StartInstance' => [
- 'summary' => '启动一台轻量应用服务器。',
- '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' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~2361076~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PublicConnection' => ['description' => '外网访问地址。', 'type' => 'string', 'example' => 'db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus',
- 'errorMessage' => 'The state of the current instance does not support this operation.',
- ],
+ 'title' => '申请公网访问地址',
+ 'summary' => '申请公网访问地址。',
+ 'description' => '轻量数据库实例默认不提供外网地址，如果您需要通过轻量容器服务或DMS公网访问数据库，您需要申请开启外网访问地址。',
+ 'changeSet' => [],
+ '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' => '启动实例',
- 'description' => '如果轻量应服务器的实例状态为停止状态，您可以使用此接口将已停止的轻量应用服务器实例启动。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PublicConnection\\": \\"db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com\\"\\n}","type":"json"}]',
],
- 'StartInstances' => [
- 'summary' => '启动一台或多台轻量应用服务器。',
- '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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
+ ],
+ [
+ 'name' => 'FirewallTemplateId',
+ 'in' => 'query',
+ 'schema' => ['description' => '防火墙模板ID。', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
+ 'description' => '轻量应用服务器的实例ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '轻量应用服务器实例ID。最多支持10个实例ID。', 'type' => 'string', 'required' => true, 'example' => 'd9e781ff8a8f49ee812796f12799****'],
'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
+ 'maxItems' => 100,
],
],
],
@@ -643,100 +283,80 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'TaskId' => ['description' => '模板应用执行ID。', 'type' => 'string', 'example' => 'aft-ikgt0bynitvs3****'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'title' => '应用防火墙模板',
+ 'summary' => '使用防火墙模板可以同时为多台轻量应用服务器实例设置防火墙规则，提高设置防火墙规则的效率。',
+ 'description' => '如果防火墙模板中的防火墙规则的端口、协议、IP地址与实例已有规则重复，则无论当前已有规则处于启用或禁用状态，新规则均会覆盖已有规则。',
+ 'changeSet' => [],
+ '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' => '批量启动实例',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"TaskId\\": \\"aft-ikgt0bynitvs3****\\"\\n}","type":"json"}]',
],
- 'ListInstanceStatus' => [
- 'summary' => '查询一个或多个实例的状态。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AttachKeyPair' => [
+ 'summary' => '轻量应用服务器绑定密钥对。',
+ '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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
+ 'description' => '轻量应用服务器实例ID。最多支持50个实例ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '绑定SSH密钥对的实例ID。最多支持50个实例ID。', 'type' => 'string', 'required' => false, 'example' => '2ad1ae67295445f598017499dc****'],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => true, 'example' => 'test'],
],
],
'responses' => [
@@ -744,186 +364,210 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'InstanceStatuses' => [
- 'description' => '实例状态集类型（InstanceStatus）。',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'TotalCount' => ['description' => '绑定密钥对的实例总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'FailCount' => ['description' => '绑定密钥对失败的实例总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Results' => [
+ 'title' => '结果列表',
+ 'description' => '结果列表。',
'type' => 'array',
'items' => [
- 'description' => '轻量应用服务器实例状态。',
+ 'description' => '绑定密钥对成功或失败的结果集合。',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '实例状态，可能值：'."\n"
- ."\n"
- .'- Pending：准备中'."\n"
- .'- Starting：启动中'."\n"
- .'- Running：运行中'."\n"
- .'- Stopping：停止中'."\n"
- .'- Stopped：停止'."\n"
- .'- Resetting：重置中'."\n"
- .'- Upgrading：升级中'."\n"
- .'- Disabled：不可用',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'InstanceId' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'example' => 'a9a6474b935d41bcb531250bb5d****',
- ],
+ 'Code' => ['title' => '结果码', 'description' => '结果码。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '结果信息', 'description' => '结果信息。', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['title' => '是否成功', 'description' => '绑定密钥对是否成功。可能值：'."\n"
+ ."\n"
+ .'- true：绑定密钥对成功。'."\n"
+ ."\n"
+ .'- false：绑定密钥对失败。', 'type' => 'string', 'example' => 'true'],
+ 'InstanceId' => ['title' => '实例id', 'description' => '实例ID。', 'type' => 'string', 'example' => 'aa6e71ddb35c46679bc4753d6219d604'],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '54',
- ],
],
+ 'description' => '',
],
],
],
'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' => '指定的实例Id不存在'],
],
],
- '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' => '批量获取实例状态',
- ],
- 'StopInstance' => [
- 'summary' => '停止一台轻量应用服务器。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '绑定密钥对',
+ 'description' => '一台轻量应用服务器只支持在控制台绑定一个密钥对。若您选择的轻量应用服务器已经绑定过其他密钥对，新绑定的密钥对将会覆盖已绑定的密钥对。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:AttachKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', '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' => [
+ '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' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '命令名称，支持全字符集。长度不得超过128个字符。', 'type' => 'string', 'required' => true, 'example' => 'testName'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令描述，支持全字符集。长度不得超过512个字符。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令的语言类型。取值范围：'."\n"
+ ."\n"
+ .'- RunBatScript：适用于Windows实例的Bat命令。'."\n"
+ .'- RunPowerShellScript：适用于Windows实例的PowerShell命令。'."\n"
+ .'- RunShellScript：适用于Linux实例Shell命令。', 'type' => 'string', 'required' => true, 'example' => 'RunShellScript'],
+ ],
+ [
+ 'name' => 'CommandContent',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令内容。您需要注意：'."\n"
+ ."\n"
+ .'- 指定参数`EnableParameter=true`可在命令内容中启用自定义参数功能：'."\n"
+ .'- 用{{}}包含的方式定义自定义参数，在`{{}}`内参数名前后的空格以及换行符会被忽略。'."\n"
+ .'- 自定义参数个数不能超过20个。'."\n"
+ .'- 自定义参数名允许a-zA-Z0-9-_的组合，不支持其余字符，参数名不区分大小写。'."\n"
+ .'- 单个自定义参数名不能超过64字节。', 'type' => 'string', 'required' => true, 'example' => 'ifconfig -s'],
+ ],
+ [
+ 'name' => 'WorkingDir',
+ 'in' => 'query',
+ 'schema' => ['description' => '您创建的命令在ECS实例中运行的目录。'."\n"
+ ."\n"
+ .'默认值： '."\n"
+ .'- Linux实例：管理员root用户的home目录下，具体为`/root`目录。 '."\n"
+ .'- Windows实例：云助手客户端进程所在目录，例如`C:\\Windows\\System32`。', 'type' => 'string', 'required' => false, 'example' => '/root/'],
+ ],
+ [
+ 'name' => 'Timeout',
+ 'in' => 'query',
+ 'schema' => ['description' => '设置命令在服务器实例中的超时时间，单位为秒。'."\n"
+ ."\n"
+ .'当执行命令的任务超时后，命令助手将强制终止任务进程。可设定超时时间取值范围为10～86400秒（24小时）。'."\n"
+ ."\n"
+ .'默认值：60。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'],
+ ],
+ [
+ 'name' => 'EnableParameter',
+ 'in' => 'query',
+ 'schema' => ['description' => '创建的命令是否使用自定义参数。'."\n"
+ ."\n"
+ .'默认值为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
+ 'description' => '标签列表，最多包含20个子项。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '为命令指定的标签键。N 的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '为命令指定的标签值。N 的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
+ 'maxItems' => 100,
],
],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4****'],
+ 'CommandId' => ['description' => '命令ID。', 'type' => 'string', 'example' => 'c-sh02yh0932w****'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus',
- 'errorMessage' => 'The state of the current instance does not support this operation.',
- ],
+ 'title' => '创建命令',
+ 'summary' => '新建一条命令助手命令。',
+ 'changeSet' => [],
+ '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' => '停止实例',
- 'description' => '如果轻量应用服务器暂时不需要，您可以将轻量应用服务器停止。'."\n"
- ."\n"
- .'> 停止轻量应用服务器实例后，可能导致业务中断，建议您在业务低峰期执行该操作。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\",\\n \\"CommandId\\": \\"c-sh02yh0932w****\\"\\n}","type":"json"}]',
],
- 'StopInstances' => [
- 'summary' => '停止一台或多台轻量应用服务器。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateCustomImage' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -932,102 +576,156 @@
'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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
- 'name' => 'ForceStop',
+ 'name' => 'ImageName',
'in' => 'query',
+ 'schema' => ['description' => '自定义镜像名称。长度为2~128个英文或中文字符，必须以大小写字母或中文开头或数字开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n"
+ .'默认值：空', 'type' => 'string', 'required' => true, 'example' => 'customImage-test'],
+ ],
+ [
+ 'name' => 'SystemSnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => '系统盘快照ID。', 'type' => 'string', 'required' => false, 'example' => 's-acscasca****'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '镜像描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'DataSnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据盘快照ID。', 'type' => 'string', 'required' => false, 'example' => 's-acscasca****'],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '停止实例时是否强制关机策略。'."\n"
- ."\n"
- .'- **true**：强制关机。'."\n"
- ."\n"
- .'- **false**（默认）：正常关机流程。'."\n",
- 'type' => 'boolean',
+ 'description' => '标签列表，最多包含20个子项。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '为自定义镜像指定的标签键。N 的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '为自定义镜像指定的标签值。N 的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'true',
+ 'maxItems' => 100,
],
],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'],
+ 'ImageId' => ['description' => '自定义镜像ID。', 'type' => 'string', 'example' => 'm-csaascsaccscs****'],
],
+ 'description' => '',
],
],
],
'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' => '指定的镜像名称不合法。'],
+ ['errorCode' => 'ImageNameAlreadyExist', 'errorMessage' => 'The image name already exists.', 'description' => '镜像名称已存在。'],
+ ['errorCode' => 'CustomImageQuotaLimit', 'errorMessage' => 'The maximum number of custom image in this region is exceeded.', 'description' => '您的自定义镜像在该地域下已达上限。'],
+ ['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' => '指定的实例不存在，请您检查实例ID是否正确。'],
],
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' => '批量停止实例',
- ],
- 'UpdateInstanceAttribute' => [
- 'summary' => '修改实例的部分信息，包括实例名称，密码。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '创建自定义镜像',
+ 'summary' => '通过快照创建用户自定义镜像。',
+ 'description' => '自定义镜像是您通过轻量应用服务器的快照创建的镜像。您可以通过已配置好的自定义镜像创建更多包含相同配置的轻量应用服务器，也可以将自定义镜像共享至云服务器ECS，进而通过共享镜像创建ECS实例或更换操作系统。'."\n"
+ .'关于自定义镜像的更多消息，请参见[自定义镜像概述](~~199375~~)。'."\n"
+ ."\n"
+ .'创建自定义镜像之前，您需要先创建轻量应用服务器的系统盘快照。具体操作，请参见[CreateSnapshot](~~190452~~)。'."\n"
+ ."\n"
+ .'> 如果您创建自定义镜像时需要服务器的数据盘数据，请先创建一份服务器的数据盘快照。'."\n"
+ ."\n"
+ .'创建自定义镜像时，您需要先阅读以下注意事项：'."\n"
+ ."\n"
+ .'- 创建的自定义镜像所属地域与对应的轻量应用服务器所属地域相同。'."\n"
+ ."\n"
+ .'- 创建的自定义镜像数量上限为已创建的服务器数量的3倍，但最多不超过15个。'."\n"
+ ."\n"
+ .'- 只有服务器的系统盘快照可以直接创建自定义镜像。如果您需要自定义镜像中包含服务器的数据盘数据，在创建自定义镜像的过程中，需要手动选择对应的数据盘快照。'."\n"
+ ."\n"
+ .'- 如果轻量应用服务器到期或者退款后释放，该服务器对应的自定义镜像也会随之释放。'."\n"
+ ."\n"
+ .'- 重置系统或更换镜像会清除服务器上的磁盘数据，请您根据需要做好数据备份。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCustomImage'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => '[{"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":""}]',
+ ],
+ 'CreateFirewallRule' => [
+ 'summary' => '为指定的轻量应用服务器创建一条防火墙规则。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1036,73 +734,47 @@
'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' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器所属的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'Password',
+ 'name' => 'RuleProtocol',
'in' => 'query',
- 'schema' => [
- 'description' => '新的服务器密码。长度为8至30个字符，必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是：'."\n"
- ."\n"
- .'```'."\n"
- .'()`~!@#$%^&*-_+=|{}[]:;\'<>,.?/'."\n"
- .'```'."\n"
- ."\n"
- .'其中，Windows实例不能以正斜线（/）为密码首字符。'."\n"
- ."\n"
- .'> 如果传入`Password`参数，建议您使用HTTPS协议发送请求，避免密码泄露。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test123!',
- ],
+ 'schema' => ['description' => '传输层协议。取值范围：'."\n"
+ ."\n"
+ .'- TCP：TCP协议。'."\n"
+ .'- UDP：UDP协议。'."\n"
+ .'- TCP+UDP：TCP和UDP协议。'."\n"
+ .'- ICMP: ICMP协议。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TCP'],
],
[
- 'name' => 'InstanceName',
+ 'name' => 'Port',
'in' => 'query',
- 'schema' => [
- 'description' => '服务器名称。长度为2-50个字符，以大小写字母数字或中文开头，可包含数字，下划线（_）或者短划线（-），同时支持域名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-InstanceName',
- ],
+ 'schema' => ['description' => '端口范围。'."\n"
+ .'- TCP/UDP: 端口的取值范围：1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：1024/1055表示端口范围1024~1055。'."\n"
+ .'- ICMP: -1/-1。代表全部端口。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3306/3306'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'required' => false, 'example' => 'TEST'],
],
],
'responses' => [
@@ -1110,173 +782,107 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'FirewallId' => ['description' => '防火墙规则ID。', 'type' => 'string', 'example' => '8007e18c61024aafbd776d52d0****'],
],
+ 'description' => '',
],
],
],
'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' => '传入的regionId和请求的地址不匹配。'],
],
- 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' => '指定的实例不存在，请您检查实例ID是否正确。'],
],
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":"<UpdateInstanceAttributeResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n</UpdateInstanceAttributeResponse>","errorExample":""}]',
- 'title' => '修改实例部分信息',
- 'description' => '## 接口说明'."\n"
- ."\n"
- .'修改密码后，您需要重新启动（[RebootInstance](~~190443~~)）服务器才能生效。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListInstances' => [
- 'summary' => '查询指定地域下，一个或多个实例的详细信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '创建实例的防火墙规则',
+ 'description' => '防火墙可以控制轻量应用服务器的网络访问，用于在云端划分安全域。每台轻量应用服务器的防火墙默认放行了22端口（SSH服务）、80端口（HTTP服务）以及443端口（HTTPS加密访问服务），除默认放行的端口，其他端口默认是禁用状态。您可以通过添加防火墙规则来放行更多端口。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateFirewallRule'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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 \\"FirewallId\\": \\"8007e18c61024aafbd776d52d0****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateFirewallRuleResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F\\t</RequestId>\\n <FirewallId>8007e18c61024aafbd776d52d0****</FirewallId>\\n</CreateFirewallRuleResponse>","errorExample":""}]',
+ ],
+ 'CreateFirewallRules' => [
+ 'summary' => '为指定的轻量应用服务器批量创建防火墙规则。',
+ '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' => '轻量应用服务器所属的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'InstanceIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。'."\n"
- ."\n"
- .'> 同时指定`InstanceIds`和`PublicIpAddresses`参数时，必须保证对应的实例ID和公网IP属于同一台轻量应用服务器，否则返回值为空。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
- ],
- [
- 'name' => 'ChargeType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '实例的计费方式。取值：PrePaid，目前仅支持包年包月。'."\n"
- ."\n"
- .'默认值：PrePaid',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PrePaid',
- ],
- ],
- [
- 'name' => 'PublicIpAddresses',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的公网IP。取值可以由多个公网ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。'."\n"
- ."\n"
- .'> 同时指定`InstanceIds`和`PublicIpAddresses`参数时，必须保证对应的实例ID和公网IP属于同一台轻量应用服务器，否则返回值为空。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["42.1.**.**", "42.2.**.**"]',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器列表的页码。'."\n"
- ."\n"
- .'默认值：1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。最大值：100'."\n"
- ."\n"
- .'默认值：10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => '客户端token。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'Status',
+ 'name' => 'FirewallRules',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '实例状态，可能值：'."\n"
- ."\n"
- .'- Pending：准备中。'."\n"
- .'- Starting：启动中。'."\n"
- .'- Running：运行中。'."\n"
- .'- Stopping：停止中。'."\n"
- .'- Stopped：停止。'."\n"
- .'- Resetting：重置中。'."\n"
- .'- Upgrading：升级中。'."\n"
- .'- Disabled：不可用。',
- 'type' => 'string',
+ 'description' => '由防火墙规则信息组成的数组。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '由防火墙规则信息组成的数组。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleProtocol' => ['description' => '传输层协议。可能值：'."\n"
+ ."\n"
+ .'- TCP：TCP协议。'."\n"
+ .'- UDP：UDP协议。'."\n"
+ .'- TCP+UDP：TCP和UDP协议。'."\n"
+ .'- ICMP: ICMP协议。', 'type' => 'string', 'required' => false, 'example' => 'TCP'],
+ 'Port' => ['description' => '端口号。'."\n"
+ .'- TCP/UDP：取值范围为 1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
+ .'- ICMP：-1/-1。', 'type' => 'string', 'required' => false, 'example' => '3306'],
+ 'SourceCidrIp' => ['description' => '地址或地址段。', 'type' => 'string', 'required' => false, 'example' => '47.101.XX.XX'],
+ 'Remark' => ['description' => '备注。', 'type' => 'string', 'required' => false, 'example' => 'Custom firewall rule'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'Running',
],
],
[
@@ -1284,24 +890,18 @@
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '实例的标签列表。',
+ 'description' => '标签列表，最多包含20个子项。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '实例的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '实例的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '为防火墙规则指定的标签键。N 的取值范围：1~20'."\n"
+ ."\n"
+ .'一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '为防火墙规则指定的标签值。N 的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -1309,576 +909,128 @@
'maxItems' => 100,
],
],
- [
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器所属的资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
- ],
- [
- 'name' => 'InstanceName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器实例名称，支持使用通配符*进行模糊搜索。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'PlanType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '套餐类型，可能值：'."\n"
- ."\n"
- .'- NORMAL：通用型。'."\n"
- .'- CAPACITY：容量型。'."\n"
- .'- PREVIOUS：上一代。'."\n"
- .'- MULTI_IP：多公网IP型。'."\n"
- .'- INTERNATIONAL：国际型。'."\n"
- ."\n"
- .'> 更多信息，请参见[实例规格族](~~2861773~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NORMAL',
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '实例信息。',
'type' => 'object',
'properties' => [
- 'Instances' => [
- 'description' => '轻量应用服务器信息组成的数组。',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'FirewallRuleIds' => [
+ 'description' => '防火墙规则ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '轻量应用服务器信息组成的数组。',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '实例状态，可能值：'."\n"
- ."\n"
- .'- Pending：准备中。'."\n"
- .'- Starting：启动中。'."\n"
- .'- Running：运行中。'."\n"
- .'- Stopping：停止中。'."\n"
- .'- Stopped：停止。'."\n"
- .'- Resetting：重置中。'."\n"
- .'- Upgrading：升级中。'."\n"
- .'- Disabled：不可用。',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'CreationTime' => [
- 'description' => '创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2021-03-08T05:31:06Z',
- ],
- 'InnerIpAddress' => [
- 'description' => '内网IP地址。',
- 'type' => 'string',
- 'example' => '172.26.XX.XX',
- ],
- 'ChargeType' => [
- 'description' => '计费方式。',
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'InstanceId' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- 'PlanId' => [
- 'description' => '套餐ID。',
- 'type' => 'string',
- 'example' => 'swas.s2.c2m2s50b4t08',
- ],
- 'PublicIpAddress' => [
- 'description' => '公网IP地址。',
- 'type' => 'string',
- 'example' => '42.1.XX.XX',
- ],
- 'RegionId' => [
- 'description' => ' '."\n"
- .'地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'ExpiredTime' => [
- 'description' => '到期时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2021-05-08T16:00:00Z',
- ],
- 'InstanceName' => [
- 'description' => '服务器名称。',
- 'type' => 'string',
- 'example' => 'test-InstanceName',
- ],
- 'BusinessStatus' => [
- 'description' => '服务器状态。可能值：'."\n"
- ."\n"
- .'- Normal：正常。'."\n"
- .'- Expired：到期。'."\n"
- .'- Overdue：欠费。',
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- 'DdosStatus' => [
- 'description' => 'DDos状态。可能值：'."\n"
- ."\n"
- .'- Normal：正常。'."\n"
- .'- BlackHole：黑洞中。'."\n"
- .'- Defense：清洗中。',
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- 'ImageId' => [
- 'description' => ' '."\n"
- .'镜像ID。',
- 'type' => 'string',
- 'example' => 'fe9c66133a9d4688872869726b52****',
- ],
- 'DisableReason' => [
- 'description' => '资源被禁用的原因。取值范围：'."\n"
- ."\n"
- .'- FINANCIAL：因欠费被锁定。'."\n"
- .'- SECURITY：因安全原因被锁定。'."\n"
- .'- EXPIRED：实例过期。',
- 'type' => 'string',
- 'example' => 'EXPIRED',
- ],
- 'Combination' => [
- 'description' => '是否为组合套餐。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CombinationInstanceId' => [
- 'description' => '组合套餐实例ID。',
- 'type' => 'string',
- 'example' => 'com-f6c9a22****45b5b8de68ad608af1ba',
- ],
- 'Uuid' => [
- 'description' => '实例的UUID。',
- 'type' => 'string',
- 'example' => '41f30524-5df7-49c9-9c6e-32****489001',
- ],
- 'ResourceSpec' => [
- 'description' => '资源规格。',
- 'type' => 'object',
- 'properties' => [
- 'DiskCategory' => [
- 'description' => '磁盘类型，可能值：'."\n"
- ."\n"
- .'- ESSD：ESSD云盘，性能级别PL0。'."\n"
- .'- SSD：SSD云盘。'."\n"
- .'- CLOUD_EFFICIENCY：高效云盘。',
- 'type' => 'string',
- 'example' => 'ESSD',
- ],
- 'Cpu' => [
- 'description' => 'vCPU核数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Bandwidth' => [
- 'description' => '带宽大小，单位：Mbps。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'DiskSize' => [
- 'description' => '磁盘大小，单位：GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '60',
- ],
- 'Memory' => [
- 'description' => '内存大小，单位：GiB。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '2',
- ],
- 'Flow' => [
- 'description' => '流量大小。'."\n"
- ."\n"
- .'- 流量为0代表带宽型主机。'."\n"
- .'- 非0代表流量包型主机。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '818',
- ],
- ],
- ],
- 'Image' => [
- 'description' => '镜像的说明信息。',
- 'type' => 'object',
- 'properties' => [
- 'OsType' => [
- 'description' => '操作系统类型。',
- 'type' => 'string',
- 'example' => 'windows',
- ],
- 'ImageName' => [
- 'description' => '镜像名称。',
- 'type' => 'string',
- 'example' => 'test-custom-1686536882356',
- ],
- 'ImageVersion' => [
- 'description' => '镜像版本。',
- 'type' => 'string',
- 'example' => 'V3.5',
- ],
- 'ImageType' => [
- 'description' => '镜像类型。取值范围：'."\n"
- ."\n"
- .'- system：系统镜像。'."\n"
- .'- app：应用镜像。'."\n"
- .'- custom：自定义镜像。',
- 'type' => 'string',
- 'example' => 'system',
- ],
- 'ImageIconUrl' => [
- 'description' => '镜像图标URL。',
- 'type' => 'string',
- 'example' => 'https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg',
- ],
- 'ImageContact' => [
- 'description' => '镜像提供商。',
- 'type' => 'string',
- 'example' => 'https://selfs****e.console.aliyun.com/ticket/createIndex',
- ],
- ],
- ],
- 'Tags' => [
- 'description' => '实例的标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '实例的标签键。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '实例的标签值。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- ],
- ],
- ],
- 'Disks' => [
- 'description' => '轻量对应磁盘信息的数组。',
- 'type' => 'array',
- 'items' => [
- 'description' => '磁盘信息。',
- 'type' => 'object',
- 'properties' => [
- 'CreationTime' => [
- 'description' => '实例创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2023-02-24T02:20:10Z',
- ],
- 'Status' => [
- 'description' => '磁盘状态。可能值：'."\n"
- ."\n"
- .'- ReIniting：初始化中。'."\n"
- .'- Creating：创建中。'."\n"
- .'- In_use：使用中。'."\n"
- .'- Available：待挂载。'."\n"
- .'- Attaching：挂载中。'."\n"
- .'- Detaching：卸载中。',
- 'type' => 'string',
- 'example' => 'In_use',
- ],
- 'Device' => [
- 'description' => '磁盘挂载服务器中的设备名。',
- 'type' => 'string',
- 'example' => '/dev/xvda',
- ],
- 'Size' => [
- 'description' => '磁盘大小。单位：GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'DiskName' => [
- 'description' => '磁盘名称。',
- 'type' => 'string',
- 'example' => 'SystemDisk',
- ],
- 'DiskChargeType' => [
- 'description' => '磁盘的计费方式。',
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'DiskType' => [
- 'description' => '磁盘类型。可能值：'."\n"
- ."\n"
- .'- system：系统盘。'."\n"
- .'- data：数据盘。',
- 'type' => 'string',
- 'example' => 'system',
- ],
- 'Category' => [
- 'description' => '磁盘类型，可能值：'."\n"
- ."\n"
- .'- ESSD：ESSD云盘，性能级别PL0。'."\n"
- .'- SSD：SSD云盘。'."\n"
- .'- CLOUD_EFFICIENCY：高效云盘。',
- 'type' => 'string',
- 'example' => 'ESSD',
- ],
- 'DiskId' => [
- 'description' => '磁盘ID。',
- 'type' => 'string',
- 'example' => 'd-bp14wq0149cpp2x****',
- ],
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'Remark' => [
- 'description' => '磁盘备注。',
- 'type' => 'string',
- 'example' => 'remark',
- ],
- 'DiskTags' => [
- 'description' => '磁盘的标签信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签信息。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- ],
- ],
- ],
- 'ResourceGroupId' => [
- 'description' => '磁盘所属的资源组ID。',
- 'type' => 'string',
- 'example' => 'rg-aek2bti7cf7****',
- ],
- ],
- ],
- ],
- 'ResourceGroupId' => [
- 'description' => '实例所属的资源组ID。',
- 'type' => 'string',
- 'example' => 'rg-aekz7jmhg5s****',
- ],
- 'NetworkAttributes' => [
- 'description' => '网络返回信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '网络返回信息。',
- 'type' => 'object',
- 'properties' => [
- 'PublicIpAddress' => [
- 'description' => '公网IP地址。',
- 'type' => 'string',
- 'example' => '116.62.XX.XX',
- ],
- 'PrivateIpAddress' => [
- 'description' => '私网IP地址。',
- 'type' => 'string',
- 'example' => '72.25.XX.XX',
- ],
- 'PeakBandwidth' => [
- 'description' => '公网峰值带宽。单位为Mbps。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'PublicIpDdosStatus' => [
- 'description' => '公网IP的DDos状态。',
- 'type' => 'string',
- 'example' => 'normal',
- ],
- ],
- ],
- ],
- 'PlanType' => [
- 'description' => '套餐类型，可能值：'."\n"
- ."\n"
- .'- NORMAL：通用型。'."\n"
- .'- CAPACITY：容量型。'."\n"
- .'- PREVIOUS：上一代。'."\n"
- .'- MULTI_IP：多公网IP型。'."\n"
- .'- INTERNATIONAL：国际型。'."\n"
- ."\n"
- .'> 更多信息，请参见[实例规格族](~~2861773~~)。',
- 'type' => 'string',
- 'example' => 'NORMAL',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '查询到的实例总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '轻量应用服务器列表的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'items' => ['description' => '防火墙规则ID。', 'type' => 'string', 'example' => '1a16263ab0f541288312a15fa64280de'],
],
],
+ 'description' => '',
],
],
],
'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' => '传入的regionId和请求的地址不匹配。'],
],
- 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' => '指定的实例不存在，请您检查实例ID是否正确。'],
],
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' => '获取实例列表',
- 'description' => '通过此接口可查看指定地域下一个或多个实例的详细信息，包括服务器名称、公网IP地址，内网IP地址，服务器创建时间、服务器到期时间等信息。',
- ],
- 'LoginInstance' => [
- 'summary' => '使用Workbench远程登录轻量应用服务器。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"FirewallRuleIds\\": [\\n \\"1a16263ab0f541288312a15fa64280de\\"\\n ]\\n}","type":"json"}]',
+ 'title' => '批量创建实例的防火墙规则',
+ 'description' => '防火墙可以控制轻量应用服务器的网络访问，用于在云端划分安全域。每台轻量应用服务器的防火墙默认放行了22端口（SSH服务）、80端口（HTTP服务）以及443端口（HTTPS加密访问服务），除默认放行的端口，其他端口默认是禁用状态。您可以通过添加防火墙规则来放行更多端口。',
+ 'changeSet' => [],
+ '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/*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateFirewallTemplate' => [
+ 'summary' => '创建一个防火墙模板。',
+ '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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '9ae7106e68eb4402b0dcbd48a9de****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Username',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器用户名。'."\n"
- ."\n"
- .'- Linux服务器不需要输入用户名。'."\n"
- .'- Windows服务器默认用户名为`administrator`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'administrator',
- ],
+ 'schema' => ['description' => '防火墙模板名称。', 'type' => 'string', 'required' => true, 'example' => 'testName'],
],
[
- 'name' => 'Password',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器用户名对应的密码。'."\n"
- ."\n"
- .'- Linux服务器：不需要输入密码。'."\n"
- .'- Windows服务器：输入已设置的密码。如果您购买轻量应用服务器后没有设置密码，请参见[重置密码](~~60055~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test****',
- ],
+ 'schema' => ['description' => '防火墙模板描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'Port',
+ 'name' => 'FirewallRule',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '远程登录实例的端口号。'."\n"
- ."\n"
- .'- Linux服务器：默认为22。'."\n"
- ."\n"
- .'- Windows服务器：默认为3389。'."\n"
- ."\n"
- .'>如果您需要使用自定义端口连接服务器，需要先修改服务器默认远程端口。具体操作，请参见 [设置远程连接自定义端口](~~2807402~~)。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '防火墙规则。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '防火墙规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleProtocol' => ['description' => '传输层协议。可能值：'."\n"
+ ."\n"
+ .'- TCP：TCP协议。'."\n"
+ .'- UDP：UDP协议。'."\n"
+ .'- TCP+UDP：TCP和UDP协议。'."\n"
+ .'- ICMP：ICMP协议。', 'type' => 'string', 'required' => true, 'example' => 'TCP'],
+ 'Port' => ['description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
+ ."\n"
+ .'> 如果您设置的是ICMP协议，端口只能为-1/-1。', 'type' => 'string', 'required' => true, 'example' => '8080'],
+ 'SourceCidrIp' => ['description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。', 'type' => 'string', 'required' => true, 'example' => '223.166.XX.XX'],
+ 'Remark' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'required' => false, 'example' => 'Custom rule'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '3389',
+ 'maxItems' => 100,
],
],
],
@@ -1886,38 +1038,40 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应参数。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****',
- ],
- 'RedirectUrl' => [
- 'description' => '远程登录桌面地址。',
- 'type' => 'string',
- 'example' => 'https://ecs-workbench.aliyun.com/view/instance/single/gbktfz****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'FirewallTemplateId' => ['description' => '防火墙模板ID。', 'type' => 'string', 'example' => 'ft-bcf1a7hrdq717****'],
],
],
],
],
- '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' => ' 远程登录实例',
- 'description' => '创建轻量应用服务器后，您可以远程登录轻量应用服务器，在服务器上搭建环境、搭建应用等。',
- ],
- 'DescribeInstanceVncUrl' => [
- 'summary' => '获取指定轻量应用服务器的VNC连接地址。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"FirewallTemplateId\\": \\"ft-bcf1a7hrdq717****\\"\\n}","type":"json"}]',
+ 'title' => '创建防火墙模板',
+ 'description' => '防火墙模板提供了一种可以包含多条防火墙规则的模板功能，您可以通过模板同时向一个或多个实例中添加一组防火墙规则，提高设置防火墙规则的效率。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateFirewallTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateFirewallTemplateRules' => [
+ 'summary' => '对于已创建的防火墙模板，您可以根据业务需求为防火墙模板增加防火墙规则。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1926,81 +1080,109 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '219667',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'FirewallTemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '防火墙模板ID。', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'FirewallRule',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
+ 'description' => '防火墙规则。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '防火墙规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleProtocol' => ['description' => '传输层协议。可能值：'."\n"
+ ."\n"
+ .'- TCP：TCP协议。'."\n"
+ .'- UDP：UDP协议。'."\n"
+ .'- TCP+UDP：TCP和UDP协议。'."\n"
+ .'- ICMP：ICMP协议。', 'type' => 'string', 'required' => true, 'example' => 'TCP'],
+ 'Port' => ['description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
+ ."\n"
+ .'> 如果您设置的是ICMP协议，端口只能为-1/-1。', 'type' => 'string', 'required' => true, 'example' => '8080'],
+ 'SourceCidrIp' => ['description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。', 'type' => 'string', 'required' => true, 'example' => '222.70.XX.XX'],
+ 'Remark' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ 'required' => false,
+ ],
'required' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
+ 'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'VncUrl' => [
- 'description' => 'VNC登录链接。',
- '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' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'FirewallTemplateRules' => [
+ 'description' => '防火墙模板规则。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '防火墙模板规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'FirewallTemplateRuleId' => ['description' => '防火墙模板规则ID。', 'type' => 'string', 'example' => 'ft-bcf1a7hrdq717****'],
+ 'RuleProtocol' => ['description' => '传输层协议。可能值：'."\n"
+ ."\n"
+ .'- TCP：TCP协议。'."\n"
+ .'- UDP：UDP协议。'."\n"
+ .'- TCP+UDP：TCP和UDP协议。'."\n"
+ .'- ICMP：ICMP协议。', 'type' => 'string', 'example' => 'TCP'],
+ 'Port' => ['description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
+ ."\n"
+ .'> 如果您设置的是ICMP协议，端口只能为-1/-1。', 'type' => 'string', 'example' => '8080'],
+ 'SourceCidrIp' => ['description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。', 'type' => 'string', 'example' => '171.233.XX.XX'],
+ 'Remark' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'example' => 'test'],
+ ],
+ ],
],
],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'title' => '创建防火墙模板规则',
+ 'description' => '防火墙模板增加规则不会影响已应用当前模板的实例规则。',
+ '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' => '获取实例VNC连接地址',
+ '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"}]',
],
- 'ModifyInstanceVncPassword' => [
- 'summary' => '修改实例的VNC密码。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateInstanceKeyPair' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2008,57 +1190,28 @@
],
'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' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'VncPassword',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'VNC密码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
+ 'schema' => ['description' => '轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => '2ad1ae67295445f598017499dc****'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '密钥对名称。', 'type' => 'string', 'required' => true, 'example' => 'ceshi'],
],
],
'responses' => [
@@ -2066,240 +1219,136 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F '],
+ 'KeyPairName' => ['description' => '密钥对名称。', 'type' => 'string', 'example' => 'ceshi'],
+ 'Fingerprint' => ['description' => '密钥对指纹。', 'type' => 'string', 'example' => 'If2K1ItazA4GlKkWCEhdRj8Wd6czAvK9*****'],
+ 'PrivateKey' => ['description' => '私钥', 'type' => 'string', 'example' => '***'],
],
+ 'description' => '',
],
],
],
'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' => '创建实例密钥对',
+ 'summary' => '创建轻量应用服务器密钥对。',
+ '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' => '修改实例VNC密码',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\",\\n \\"KeyPairName\\": \\"ceshi\\",\\n \\"Fingerprint\\": \\"If2K1ItazA4GlKkWCEhdRj8Wd6czAvK9*****\\",\\n \\"PrivateKey\\": \\"***\\"\\n}","type":"json"}]',
],
- 'ListInstancePlansModification' => [
- 'summary' => '查询指定的轻量应用服务器，可升级的套餐列表。',
- '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '镜像ID。您可以调用[ListImages](~~189313~~)查询指定地域下可用的镜像ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e2c9c365024a44369c9b955a998a****'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Plans' => [
- 'description' => '套餐信息组成的数组。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Core' => [
- 'description' => 'vCPU核数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Bandwidth' => [
- 'description' => '峰值带宽。单位：Mbps。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'DiskSize' => [
- 'description' => '磁盘容量。单位：GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
- 'Flow' => [
- 'description' => ' '."\n"
- .'每月流量。单位：GB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'Memory' => [
- 'description' => '内存。单位：GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PlanId' => [
- 'description' => '套餐ID。',
- 'type' => 'string',
- 'example' => 'swas.s2.c2m1s40b3t04',
- ],
- 'DiskType' => [
- 'description' => '磁盘类型。可能值：'."\n"
- ."\n"
- .'- SSD：SSD云盘。'."\n"
- .'- ESSD：ESSD云盘，性能级别 PL0。'."\n"
- .'- CLOUD_EFFICIENCY：高效云盘。',
- 'type' => 'string',
- 'example' => 'ESSD',
- ],
- 'OriginPrice' => [
- 'description' => '套餐价格。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '60',
- ],
- 'Currency' => [
- 'description' => '价格单位。可能值：'."\n"
- ."\n"
- .'- CNY：元'."\n"
- .'- USD：美元',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'SupportPlatform' => [
- 'description' => '套餐支持的操作系统类型。',
- 'type' => 'string',
- 'example' => '["Linux","Windows"]',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- ],
- ],
+ [
+ 'name' => 'PlanId',
+ 'in' => 'query',
+ 'schema' => ['description' => '套餐ID。您可以调用[ListPlans](~~189314~~)查询指定地域下的全部套餐信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'swas.s1.c1m1s40b3t05'],
],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
+ [
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => '购买资源的时长。单位：月。取值范围：{"1", "3", "6", "12", "24", "36"}', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '36', 'minimum' => '1', 'example' => '1'],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启到期自动续费。取值范围：'."\n"
+ ."\n"
+ .'- true：开启'."\n"
+ .'- false：不开启'."\n"
+ ."\n"
+ .'默认值：false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
- ],
- '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' => '获取当前实例可升级的套餐列表',
- 'description' => '随着业务的发展，已购买的服务器资源可能出现不再满足业务需求的情况。您可以获取当前实例可升级的套餐列表，调用[UpgradeInstance](~~190445~~)接口为实例升级套餐。'."\n"
- ."\n"
- .'> 建议您在升级前为轻量应用服务器云盘创建快照，做好数据备份。具体操作，请参见[CreateSnapshot](~~190452~~)。'."\n"
- ."\n"
- .'关于升级配置中的注意事项，请参见[升级配置](~~61433~~)。',
- ],
- 'ListInstancesTrafficPackages' => [
- 'summary' => '查询一个或多个实例的流量包详情信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'AutoRenewPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => '自动续费的时长，仅当`AutoRenew=true`时该参数必填。单位：月。取值范围：{"1", "3", "6", "12", "24", "36"}', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '36', 'minimum' => '1', 'example' => '3'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'DataDiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '挂载的数据盘容量大小。单位：GB。取值范围：0~16380，取值必须是20的整数倍。'."\n"
+ ."\n"
+ .'<props="china">'."\n"
+ .'- 取值为0时，表示不挂载数据盘。'."\n"
+ ."\n"
+ .'- 如果您选择的套餐使用的是ESSD云盘（性能级别PL0），则挂载的数据盘容量最小值为40 GB。'."\n"
+ ."\n"
+ .'- 如果您选择的套餐使用的是SSD云盘，则挂载的数据盘容量最小值为20 GB。'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\n"
+ .'- 取值为0时，表示不挂载数据盘。'."\n"
+ ."\n"
+ .'- 如果您选择的套餐使用的是SSD云盘，则挂载的数据盘容量最小值为20 GB。'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'默认值：0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '16380', 'minimum' => '0', 'example' => '20'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'Amount',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器实例ID。取值可以由一个或多个实例ID组成一个JSON数组，最多支持100个实例ID，实例ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc******","2ad1ae67295445f598017499dc******"]',
- ],
+ 'schema' => ['description' => '创建轻量应用服务器的数量。取值范围：1~20'."\n"
+ ."\n"
+ .'默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'ChargeType',
+ 'in' => 'query',
+ 'schema' => ['description' => '计费方式。取值：PrePaid，目前仅支持包年包月计费方式。'."\n"
+ ."\n"
+ .'默认值：PrePaid', 'type' => 'string', 'required' => false, 'example' => 'PrePaid'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
@@ -2307,91 +1356,97 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'InstanceTrafficPackageUsages' => [
- 'description' => '实例流量包详情信息。',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE'],
+ 'InstanceIds' => [
+ 'description' => '轻量应用服务器的实例ID。',
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'example' => 'ccscqwqwqqqw****',
- ],
- 'TrafficUsed' => [
- 'description' => '流量包当月周期内已使用流量。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000',
- ],
- 'TrafficPackageTotal' => [
- 'description' => '流量包当月周期内的总流量。单位：Byte。'."\n"
- ."\n"
- .'> 流量包当月周期内的总流量=流量包当月周期内已使用流量+流量包当月周期内的剩余流量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20000',
- ],
- 'TrafficPackageRemaining' => [
- 'description' => '流量包当月周期内的剩余流量。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000',
- ],
- 'TrafficOverflow' => [
- 'description' => '流量包当月周期内超出流量包额度的流量。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
+ 'items' => ['description' => '轻量应用服务器的实例ID。', 'type' => 'string', 'example' => '3a658ca270df4df39f22e289b338****'],
],
],
+ 'description' => '',
],
],
],
'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' => '售卖系统出现错误。'],
+ ['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' => '您选择的配置在当前地域已售罄，请尝试选择其他配置或者地域。'],
+ ],
+ 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' => '指定的镜像不存在，请您检查镜像ID是否正确。'],
+ ['errorCode' => 'InvalidPlanId.NotFound', 'errorMessage' => 'The specified PlanId does not exist.', 'description' => '指定的套餐不存在，请您检查套餐ID是否正确。'],
],
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' => '获取指定服务器的流量包使用情况',
- 'description' => '您可以查询一个或多个实例的流量包的详情信息，包括当月周期内的总流量、剩余流量、已使用的流量、超额流量等信息。'."\n"
+ 'title' => '创建实例',
+ 'summary' => '创建一台或多台包年包月的轻量应用服务器实例。',
+ 'description' => '<props="china">'."\n"
+ .'- 在调用该接口前，建议您了解轻量应用服务器的计费信息。更多信息，请参见[计费项](~~58623~~)。'."\n"
."\n"
- .'轻量应用服务器的套餐配置中提供了固定流量配额，固定流量配额内的流量费用已包含在套餐内。如果实际使用流量超出固定流量配额，阿里云将对超额的部分收取额外的流量费用。您需要注意：'."\n"
+ .'> 如果您的阿里云账号有优惠券，则默认会优先使用优惠券支付购买轻量应用服务器实例的费用。'."\n"
."\n"
- .'- 仅服务器的出网流量属于使用流量（包括每月固定的流量配额和超出流量配额后的流量），服务器的入网流量不计费。'."\n"
- .'- 轻量应用服务器与其他阿里云服务之间通过公网产生的出网流量优先消耗服务器的固定流量配额，固定流量配额使用完毕后按超额流量计费。'."\n"
- .'- 同一局域网（即同一VPC内网）的轻量应用服务器之间的流量免费。'."\n"
+ .'- 同一个阿里云账号在同一个地域下，购买轻量应用服务器与轻量应用负载均衡、轻量容器服务、轻量数据库服务的总数量上限为50台。'."\n"
."\n"
- .'更多信息，请参见[流量配额与计费](~~86281~~)。',
- ],
- 'DescribeInstancePasswordsSetting' => [
- 'summary' => '查询轻量应用服务器是否设置过密码。',
- 'methods' => [
- 'post',
- 'get',
+ .'- 调用该接口创建服务器时，您需要确保您的阿里云账户余额充足，否则会创建失败。'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\n"
+ .'- 在调用该接口前，建议您了解轻量应用服务器的计费信息。更多信息，请参见[计费项](~~58623~~)。'."\n"
+ ."\n"
+ .'> 如果您的阿里云账号有优惠券，则默认会优先使用优惠券支付购买轻量应用服务器实例的费用。'."\n"
+ ."\n"
+ .'- 同一个阿里云账号在同一个地域下，购买轻量应用服务器的总数量上限为50台。'."\n"
+ ."\n"
+ .'- 调用该接口创建服务器时，您需要确保账户默认支付方式能够结清创建服务器所需的费用，否则会创建失败。'."\n"
+ ."\n"
+ .'</props>',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ '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' => '[{"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":""}]',
+ ],
+ 'CreateKeyPair' => [
+ 'summary' => '创建轻量应用服务器密钥对。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2400,45 +1455,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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~2361076~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => true, 'example' => 'KeyPairName'],
],
],
'responses' => [
@@ -2446,253 +1487,233 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4****',
- ],
- 'VncPasswordSetting' => [
- 'description' => '是否设置过vnc密码。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'InstancePasswordSetting' => [
- 'description' => '是否设置过轻量应用服务器密码。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'KeyPairName' => ['description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'example' => 'KeyPairName'],
+ 'PrivateKeyBody' => ['description' => '密钥对的私钥。PEM编码的PKCS#8格式的私钥部分。', 'type' => 'string', 'example' => 'MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****'],
],
+ 'description' => '',
],
],
],
'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' => '查询实例是否设置过密码',
- ],
- 'InstallCloudMonitorAgent' => [
- 'summary' => '为指定的轻量应用服务器安装云监控插件。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建密钥对',
+ 'description' => '阿里云SSH密钥对是一种安全便捷的登录认证方式，用于在SSH协议中进行身份验证和加密通信。由公钥和私钥组成，仅支持Linux实例，满足您对更高安全性、便利性的业务需求。'."\n"
+ ."\n"
+ .'- 仅支持Linux系统的轻量应用服务器设置密钥对登录的方式。'."\n"
+ .'- 一个阿里云账号在一个地域下最多可以创建10个密钥对。'."\n"
+ .'- 控制台仅支持创建RSA 2048位密钥对。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateKeyPair',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', '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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'OrderType',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '订单类型：'."\n"
+ ."\n"
+ .'- Buy'."\n"
+ ."\n"
+ .'默认值：Buy', 'type' => 'string', 'required' => false, 'example' => 'Buy', 'default' => 'Buy'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'Commodity',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
+ 'description' => '订单配件信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Period' => ['description' => '查询批量购买某种套餐的价格。取值范围：1~20。'."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ 'PeriodUnit' => ['description' => '取值范围：'."\n"
+ ."\n"
+ .'- Month：按月计费的价格单位。'."\n"
+ .'- Year：按年计费的价格单位。'."\n"
+ ."\n"
+ .'默认值：Month', 'type' => 'string', 'required' => true, 'example' => 'Month'],
+ 'PayType' => ['description' => '付费类型：'."\n"
+ ."\n"
+ .'- Prepaid：预付费（包年包月）', 'type' => 'string', 'required' => false, 'example' => 'Prepaid', 'default' => 'Prepaid'],
+ 'CommodityType' => ['description' => '资源名称。', 'type' => 'string', 'required' => false, 'example' => 'Server', 'default' => 'Server'],
+ 'PlanId' => ['description' => '套餐ID。您可以调用[ListPlans](~~189314~~)查询指定地域下的全部套餐信息。', 'type' => 'string', 'required' => true, 'example' => 'swas.s.c2m1s30b1.linux'],
+ 'ImageId' => ['description' => '镜像ID。您可以调用[ListImages](~~189313~~)查询指定地域下可用的镜像ID。', 'type' => 'string', 'required' => true, 'example' => '3e8eea0c00a04ff0b34a3ad8f1df455a'],
+ 'Amount' => ['description' => '创建轻量应用服务器的数量。取值范围：1~20'."\n"
+ ."\n"
+ .'默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ 'DataDiskSize' => ['description' => '挂载的数据盘容量大小。单位：GB。取值范围：0~16380，取值必须是20的整数倍。'."\n"
+ ."\n"
+ .'默认值：0', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'AutoPay' => ['description' => '订单是否自动支付。取值：'."\n"
+ ."\n"
+ .'- **true**：自动支付。'."\n"
+ .'- **false**：不自动支付。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'AutoRenew' => ['description' => '是否开启到期自动续费。取值范围：'."\n"
+ ."\n"
+ .'- true：开启'."\n"
+ .'- false：不开启'."\n"
+ ."\n"
+ .'默认值：false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'AutoRenewPeriod' => ['description' => '单次自动续费的续费时长。取值范围：'."\n"
+ ."\n"
+ .'- PeriodUnit=Year 时：1、2、3。'."\n"
+ .'- PeriodUnit=Month 时：1、2、3、6、12、24、36、48、60。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '60', 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ ],
'required' => true,
- 'example' => '9ae7106e68eb4402b0dcbd48a9de****',
],
],
[
- 'name' => 'Force',
+ 'name' => 'BusinessInfo',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '是否强制安装云监控插件。取值：'."\n"
- ."\n"
- .'- true（默认值）：强制安装。'."\n"
- .'- false：不强制安装。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
+ 'description' => '附加参数，业务信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4****',
+ 'UseCoupon' => ['description' => '是否使用代金券。取值：'."\n"
+ ."\n"
+ .'- **true**：使用'."\n"
+ .'- **false**：不使用'."\n"
+ ."\n"
+ .'默认值为**false**。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'OrderSource' => ['description' => '订单来源', 'type' => 'string', 'required' => false, 'example' => '-'],
+ 'PromotionOptions' => [
+ 'description' => '优惠选项信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => '802681580959'],
+ 'PromotionOptionCode' => ['description' => '促销信息，促销选项代码。', 'type' => 'string', 'required' => false, 'example' => 'youhui_quan'],
+ 'PromotionFilter' => [
+ 'description' => '优惠条件。',
+ 'type' => 'object',
+ 'properties' => [
+ 'UseCoupon' => ['description' => '是否使用代金券。取值：'."\n"
+ ."\n"
+ .'- **true**：使用'."\n"
+ .'- **false**：不使用'."\n"
+ ."\n"
+ .'默认值为**false**。', 'type' => 'boolean', 'required' => false, 'example' => 'False'],
+ ],
+ 'required' => false,
+ ],
+ 'ActivityId' => ['type' => 'string'],
+ ],
+ 'required' => false,
],
+ 'AliyunLang' => ['description' => '语言环境, 默认为中文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ 'lx_channel_cookie_value' => ['description' => '-', 'type' => 'string', 'required' => false, 'example' => 'IaEvKFpwjO1lMRzGWyJdT9KWob7ruIK%2F2zTcdPRkQ%2BIDp5GIJSQT%2FL3qUUcjJ3KQfud3NrMUlEqLaJWWIVwJgw%3D%3D'],
],
+ 'required' => false,
],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\"\\n}","type":"json"}]',
- 'title' => '安装云监控插件',
- ],
- 'DescribeCloudMonitorAgentStatuses' => [
- 'summary' => '查询轻量应用服务器云监控插件的状态。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'RegionId',
+ 'name' => 'FromApp',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '请求来源，取值说明：'."\n"
+ .'- **OpenApi**：请求来源为OpenAPI。'."\n"
+ .'- **mongo_buy**：请求来源为控制台。', 'type' => 'string', 'required' => false, 'example' => 'Buy'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'CouponNo',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
- ],
- [
- 'name' => 'InstanceIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc******","2ad1ae67295445f598017499dc******"]',
- ],
+ 'schema' => ['description' => '优惠码，默认值为：`youhuiquan_promotion_option_id_for_blank`。', 'type' => 'string', 'required' => false, 'example' => '772339720881'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE',
- ],
- 'InstanceStatusList' => [
- 'description' => '对象。',
- 'type' => 'array',
- 'items' => [
- 'description' => '对象。',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '插件的运行状态。取值：'."\n"
- ."\n"
- .'- running：运行中。'."\n"
- .'- stopped：已停止。'."\n"
- .'- installing：安装中。'."\n"
- .'- install_faild：安装失败。'."\n"
- .'- abnormal：安装异常。'."\n"
- .'- not_installed：未安装。',
- 'type' => 'string',
- 'example' => 'running',
- ],
- 'InstanceId' => [
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'example' => 'c854dc6f07e74953830bb5808d0****',
- ],
- 'AutoInstall' => [
- 'description' => '是否自动安装云监控插件。取值：'."\n"
- ."\n"
- .'- true。'."\n"
- ."\n"
- .'- false。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4D10F506-E583-517D-A937-4378BF0C665B'],
+ 'OrderId' => ['description' => '订单 Id。', 'type' => 'string', 'example' => '276025619780639'],
],
],
],
],
'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' => '售卖系统出现错误。'],
+ ['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' => '您选择的配置在当前地域已售罄，请尝试选择其他配置或者地域。'],
],
],
- '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' => '查询云监控插件状态',
- ],
- 'DescribeMonitorData' => [
- 'summary' => '获取实例监控信息（vCPU、内存、磁盘IO、流量）。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建订单',
+ 'summary' => '获取轻量产品价格信息',
+ 'description' => '阿里云SSH密钥对是一种安全便捷的登录认证方式，用于在SSH协议中进行身份验证和加密通信。由公钥和私钥组成，仅支持Linux实例，满足您对更高安全性、便利性的业务需求。'."\n"
+ ."\n"
+ .'- 仅支持Linux系统的轻量应用服务器设置密钥对登录的方式。'."\n"
+ .'- 一个阿里云账号在一个地域下最多可以创建10个密钥对。'."\n"
+ .'- 控制台仅支持创建RSA 2048位密钥对。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D10F506-E583-517D-A937-4378BF0C665B\\",\\n \\"OrderId\\": \\"276025619780639\\"\\n}","type":"json"}]',
+ ],
+ 'CreateSnapshot' => [
+ 'summary' => '为指定的磁盘创建快照。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2701,123 +1722,59 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '20458',
+ 'abilityTreeNodes' => ['FEATUREswasHVUGWX'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- ],
- [
- 'name' => 'MetricName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '监控指标名称。可能值：'."\n"
- ."\n"
- .'- MEMORY_ACTUALUSEDSPACE：内存实际使用大小，单位bytes。'."\n"
- .'- DISKUSAGE_USED：磁盘使用大小，单位bytes。'."\n"
- .'- CPU_UTILIZATION：cpu使用率，百分比。'."\n"
- .'- VPC_PUBLICIP_INTERNETOUT_RATE：网络出带宽速率，单位bits/s。'."\n"
- .'- VPC_PUBLICIP_INTERNETIN_RATE：网络入带宽速率，单位bits/s。'."\n"
- .'- DISK_READ_IOPS：磁盘读iops，单位：count/s。'."\n"
- .'- DISK_WRITE_IOPS：磁盘写iops，单位：count/s。'."\n"
- .'- FLOW_USED：流量使用，单位bytes。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DISKUSAGE_USED',
- ],
+ 'schema' => ['description' => '指定磁盘对应的轻量应用服务器所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Period',
+ 'name' => 'DiskId',
'in' => 'query',
- 'schema' => [
- 'description' => '时间间隔。'."\n"
- .'取值：60、300、900。'."\n"
- .'单位：秒。'."\n"
- .'> 当Metricname为FLOW_USED时，Period值固定为3600s（即一小时），请根据您的实际需求设置该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '60',
- ],
+ 'schema' => ['description' => '指定的磁盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp18kjxg9ebrhsgi****'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'SnapshotName',
'in' => 'query',
- 'schema' => [
- 'description' => '开始时间。支持的格式：'."\n"
- ."\n"
- .'- Unix时间戳：从1970年1月1日开始所经过的毫秒数。'."\n"
- .'- Format格式：YYYY-MM-DDThh:mm:ssZ。'."\n"
- ."\n"
- .'> 开始和结束时间执行的是左开右闭的模式，StartTime不能等于或大于EndTime。'."\n"
- .'StartTime和EndTime之间的间隔小于等于31天。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-07T04:04:44Z',
- ],
+ 'schema' => ['description' => '快照名称。长度为2~50个字符，必须以大小字母或中文开头，不能以`http://`和`https://`开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、点号（.）或者短划线（-）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-SnapshotName'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '结束时间。支持的格式：'."\n"
- .'- Unix时间戳：从1970年1月1日开始所经过的毫秒数。'."\n"
- .'- Format格式：YYYY-MM-DDThh:mm:ssZ。'."\n"
- .'> StartTime和EndTime之间的间隔小于等于31天。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-08T08:04:44Z',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值，初次调用无需配置。',
- 'type' => 'string',
+ 'description' => '标签列表，最多包含20个子项。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '为快照指定的标签键。N 的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '为快照指定的标签值。N 的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'Length',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '每页显示的记录条数，用于分页查询。取值范围：1~1440。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['description' => '指定的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****'],
],
],
'responses' => [
@@ -2825,143 +1782,129 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'Datapoints' => [
- 'description' => '监控数据列表。',
- 'type' => 'string',
- 'example' => '[]',
- ],
- 'Period' => [
- 'description' => '时间间隔。'."\n"
- .'取值：60、300、900。'."\n"
- .'单位：秒。'."\n"
- ."\n"
- .'> 当Metricname为FLOW_USED时，Period值固定为3600s（即一小时），请根据您的实际需求设置该参数。',
- 'type' => 'string',
- 'example' => '60',
- ],
- 'NextToken' => [
- 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值，初次调用无需配置。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***'."\n",
- ],
+ 'SnapshotId' => ['description' => '快照ID。', 'type' => 'string', 'example' => 's-bp16oazlsold4dks****'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F '],
],
+ 'description' => '',
],
],
],
'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' => '指定的磁盘不存在，请您检查磁盘ID是否正确。'],
+ ],
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-CC89483E****\\",\\n \\"Datapoints\\": \\"[]\\",\\n \\"Period\\": \\"60\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***\\\\n\\"\\n}","type":"json"}]',
- 'title' => '获取实例监控数据',
- ],
- 'DescribeSecurityAgentStatus' => [
- 'summary' => '查询指定轻量应用服务器的安全中心Agent插件状态。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '创建快照',
+ 'description' => '快照是某一时间点磁盘数据状态的备份文件，常用于日常数据备份、服务器数据误操作恢复、网络攻击恢复、制作自定义镜像等场景。'."\n"
+ ."\n"
+ .'> 轻量应用服务器创建快照不收取任何费用。'."\n"
+ ."\n"
+ .'### 注意事项'."\n"
+ ."\n"
+ .'- 单台轻量应用服务器最多可创建3个快照。'."\n"
+ .'- 一个阿里云账号可创建的快照数量上限为已创建的轻量应用服务器数量的3倍，但最多不超过15个。'."\n"
+ .'- 如果服务器到期释放，该服务器对应的快照会被清除。'."\n"
+ .'- 重置系统或更换镜像前创建的快照，在重置系统或更换镜像后会保留但无法支持回滚操作。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ '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' => '[{"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":""}]',
+ ],
+ 'DeleteCommand' => [
+ 'summary' => '删除一条命令助手命令。',
+ '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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
- ],
- [
- 'name' => 'InstanceId',
+ 'name' => 'CommandId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '命令ID。您可以通过接口[DescribeCommands](~~64843~~)查询所有可用的CommandId。 ', 'type' => 'string', 'required' => true, 'example' => 'c-sh02yh0932w****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'ClientStatus' => [
- 'description' => 'Agent客户端状态。取值：'."\n"
- ."\n"
- .'- pause：暂停保护'."\n"
- .'- online：保护中'."\n"
- .'- offline：未受保护',
- 'type' => 'string',
- 'example' => 'online',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'title' => '删除命令',
+ 'description' => '无法删除正在执行中的命令。',
+ '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\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"ClientStatus\\": \\"online\\"\\n}","type":"json"}]',
- 'title' => '查询安全中心Agent插件状态',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
],
- 'RebootInstance' => [
- 'summary' => '重启一台轻量应用服务器。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteCustomImage' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2969,47 +1912,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '20468',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '自定义镜像ID。', 'type' => 'string', 'required' => true, 'example' => 'm-2zehv38jjmwva1ee****'],
],
],
'responses' => [
@@ -3017,51 +1935,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus',
- 'errorMessage' => 'The state of the current instance does not support this operation.',
- ],
+ 400 => [
+ ['errorCode' => 'CustomImageInShare', 'errorMessage' => 'The custom image is being shared. Please disable sharing first and then delete it.', 'description' => '当前自定义镜像共享中，请先解除共享然后删除。'],
],
- [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => '指定的镜像不存在，请您检查镜像ID是否正确。'],
],
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' => '重启实例',
- 'description' => '- 您只能重启状态为运行中（Running）的轻量应用服务器实例。'."\n"
+ 'title' => '删除自定义镜像',
+ 'summary' => '删除指定的自定义镜像。',
+ 'description' => '如果您不再需要某个自定义镜像，可以将其删除。自定义镜像被删除后，使用该镜像创建的轻量应用服务器将无法使用该镜像重置系统。'."\n"
."\n"
- .'- 重启轻量应用服务器实例后进入启动中（Starting）状态。',
- ],
- 'RebootInstances' => [
- 'summary' => '重启一台或多台轻量应用服务器。',
- 'methods' => [
- 'post',
- 'get',
+ .'> 如果自定义镜像处于共享中，需先取消共享镜像，然后删除自定义镜像。取消共享镜像后，您将无法通过云服务器ECS管理控制台或ECS API查询到该自定义镜像。如果您在云服务器ECS中还需要使用该镜像，建议您在删除自定义镜像前，先复制镜像。具体操作，请参见[复制镜像](~~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' => '[{"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":""}]',
+ ],
+ 'DeleteCustomImages' => [
+ 'summary' => '如果您不再需要某些自定义镜像，可以将其批量删除。自定义镜像被删除后，使用该镜像创建的轻量应用服务器将无法使用该镜像重置系统。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3070,56 +1993,25 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '215038',
+ 'abilityTreeNodes' => ['FEATUREswasCJL3RE'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
- ],
- [
- 'name' => 'InstanceIds',
+ 'name' => 'ImageIds',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
+ 'schema' => ['description' => '轻量应用服务器的镜像ID。取值可以由多个实例ID组成一个JSON数组，最多支持15个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["m-2zehv38jjmwva1ee****", "m-bp1hj0zhmheyq2kz****"]'],
],
[
- 'name' => 'ForceReboot',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '是否强制重启。取值范围：'."\n"
- ."\n"
- .'- true：强制重启。相当于典型的断电操作，所有未写入存储设备的缓存数据会丢失。'."\n"
- ."\n"
- .'- false：正常重启。'."\n"
- ."\n"
- .'默认值：false',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
],
'responses' => [
@@ -3127,48 +2019,49 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'description' => '',
],
],
],
'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' => '自定义镜像正在共享，请解除共享。'],
],
- [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => '指定的镜像不存在，请您检查镜像ID是否正确。'],
],
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}","type":"json"}]',
- 'title' => '批量重启实例',
- ],
- 'UpgradeInstance' => [
- 'summary' => '为指定的轻量应用服务器升级套餐配置。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '批量删除镜像',
+ 'description' => '如果自定义镜像处于共享中，需先取消共享镜像，然后删除自定义镜像。取消共享镜像后，您将无法通过云服务器ECS管理控制台或ECS API查询到该自定义镜像。如果您在云服务器ECS中还需要使用该镜像，建议您在删除自定义镜像前，先复制镜像。具体操作，请参见[复制镜像](~~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' => '删除指定轻量应用服务器的一条防火墙规则。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3176,57 +2069,27 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREswasOLUWJH',
- ],
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器所属的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'PlanId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '升级后的套餐ID。您可以调用[ListPlans](~~189314~~)查询套餐信息。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'swas.s2.c2m2s50b4t08',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'RuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '防火墙规则ID。', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****'],
],
],
'responses' => [
@@ -3234,69 +2097,58 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
],
+ 'description' => '',
],
],
],
'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' => '传入的regionId和请求的地址不匹配。'],
],
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' => '指定的实例不存在，请您检查实例ID是否正确。'],
],
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' => '升级实例',
- 'description' => '- 仅支持升级为更高配置的套餐。关于套餐的更多信息，请参见[计费项](~~58623~~)。'."\n"
- ."\n"
- .'- 调用该接口升级服务器时，您需要确保您的阿里云账户余额充足，否则会升级失败。',
- ],
- 'RenewInstance' => [
- 'summary' => '续费一台轻量应用服务器。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '删除实例防火墙规则',
+ 'description' => '删除指定轻量应用服务器的防火墙规则后，可能导致业务无法访问，请您确保轻量应用服务器实例不再需要该防火墙规则后删除。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteFirewallRule'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => '[{"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":""}]',
+ ],
+ 'DeleteFirewallRules' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3305,58 +2157,35 @@
'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' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2ad1ae67295445f598017499dc****'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Period',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '续费时长。单位：月。取值范围：{"1", "3", "6","12", "24", "36"}',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '36',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'RuleIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
+ 'description' => '要删除的防火墙规则ID的列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '防火墙规则ID', 'type' => 'string', 'required' => false, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****'],
'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
],
@@ -3365,50 +2194,55 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidPeriod.ValueNotSupported',
- 'errorMessage' => 'The specified parameter Period 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' => '传入的regionId和请求的地址不匹配。'],
],
- 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' => '指定的实例不存在，请您检查实例ID是否正确。'],
],
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":"<RenewInstanceResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F****</RequestId>\\n</RenewInstanceResponse>","errorExample":""}]',
- 'title' => '续费实例',
- 'description' => '- 在调用接口前，请您了解轻量应用服务器的计费信息。更多信息，请参见[计费项](~~58623~~)。'."\n"
- .'- 调用该接口续费服务器时，您需要确保您的阿里云账户余额充足，否则会续费失败。',
- ],
- 'ResetSystem' => [
- 'summary' => '为指定的轻量应用服务器重置系统。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '批量删除实例防火墙规则',
+ 'summary' => '删除指定轻量应用服务器的多条防火墙规则。',
+ 'description' => '删除指定轻量应用服务器的防火墙规则后，可能导致业务无法访问，请您确保轻量应用服务器实例不再需要该防火墙规则后删除。',
+ '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' => '对于已创建的防火墙模板，您可以根据业务需求删除防火墙规则。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3417,84 +2251,37 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '20471',
- 'abilityTreeNodes' => [
- 'FEATUREswasI9F3VX',
- ],
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '219670',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'ImageId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '目标镜像ID。如果不输入目标镜像ID，默认为重置当前镜像。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '794c230fd3e64ea19f83f4d7a0ad****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'FirewallTemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '防火墙模板ID。', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****'],
],
[
- 'name' => 'LoginCredentials',
+ 'name' => 'FirewallTemplateRuleId',
'in' => 'query',
- 'style' => 'flat',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '登录凭证信息。',
- 'type' => 'object',
- 'properties' => [
- 'Password' => [
- 'description' => '输入轻量应用服务器管理员账号对应的密码。'."\n"
- ."\n"
- .'- Windows服务器：管理员账号默认为Administrator。'."\n"
- ."\n"
- .'- Linux服务器：管理员账号默认为root。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
- 'KeyPairName' => [
- 'description' => '密钥对名称。仅Linux服务器支持设置密钥对。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aliyunkey',
- ],
- ],
- 'required' => false,
+ 'description' => '防火墙模板规则ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '防火墙模板规则ID。', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****'],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
],
@@ -3503,96 +2290,37 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'description' => '',
],
],
],
- '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' => '删除防火墙模板规则',
+ 'description' => '删除防火墙模板规则不会影响已应用当前模板的实例规则。',
+ 'changeSet' => [],
+ '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-28DA8F4F534F\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetSystemResponse>\\n <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>\\n</ResetSystemResponse>","errorExample":""}]',
- 'title' => '重置系统',
- 'description' => '重置系统可以重新安装服务器的应用或者操作系统，达到重新初始化服务器的目的。重置系统有两种选择，重置当前系统和重置为其他镜像。'."\n"
- ."\n"
- .'重置系统包括以下两种方式：'."\n"
- ."\n"
- .'- 重置当前系统：不改变当前镜像，重新安装操作系统。'."\n"
- ."\n"
- .'- 重置为其他镜像：选择阿里云提供的其他镜像或者您创建的自定义镜像，重新安装操作系统。'."\n"
- ."\n"
- .'### 注意事项'."\n"
- ."\n"
- .'- 重置系统或更换镜像会清除轻量应用服务器上的磁盘数据，请您根据需要做好数据备份。'."\n"
- ."\n"
- .'- 重置系统或更换镜像后，可能会导致监控失效。如果监控出现问题，您可以手动安装云监控插件。'."\n"
- ."\n"
- .' - 远程连接服务器安装：具体操作，请参见[为阿里云主机手动安装插件](~~183482~~)。'."\n"
- ."\n"
- .' - 使用命令助手安装：具体操作，请参见[使用命令助手](~~438681~~)，安装云监控的命令，您可以从[使用命令助手](~~438681~~)文档的常用命令中获取。 '."\n"
- ."\n"
- .'### 使用限制'."\n"
- ."\n"
- .'- 重置系统或更换镜像前创建的快照会保留，但无法通过重置前创建的快照回滚磁盘。'."\n"
- ."\n"
- .'- 含有数据盘数据的自定义镜像创建的轻量应用服务器，不支持重置系统。'."\n"
- ."\n"
- .'- 选择自定义镜像重置系统时：'."\n"
- ."\n"
- .' - 仅支持选择与当前服务器同一地域下的自定义镜像。'."\n"
- ."\n"
- .' - 不支持选择当前服务器对应的自定义镜像。如果您有恢复服务器数据的需求，可以使用当前服务器对应的快照回滚磁盘数据。'."\n"
- ."\n"
- .' - 非中国内地地域不支持Windows Server系统和Linux系统互相切换，即Windows系统的自定义镜像无法重置Linux服务器；Linux系统的自定义镜像无法重置Windows服务器。仅支持Windows Server不同版本之间或Linux不同发行版本之间的更换。'."\n"
- ."\n"
- .' - 云盘存在以下限制：'."\n"
- ."\n"
- .' - 当自定义镜像中包含系统盘与数据盘，但待重置服务器中只挂载了系统盘，没有挂载数据盘时，您无法使用该自定义镜像重置系统。'."\n"
- ."\n"
- .' - 当自定义镜像中包含的系统盘容量比待重置系统的服务器中系统盘容量大时，您无法直接使用该自定义镜像重置系统。'."\n"
- ."\n"
- .' - 当服务器中系统盘容量大于等于自定义镜像中系统盘容量时，即可使用该自定义镜像重置系统。您可以为待重置系统的服务器升级配置，将服务器中系统盘容量升级。具体操作，请参见升级配置。'."\n"
- ."\n"
- .' - 当自定义镜像中包含的数据盘容量比待重置系统的服务器中数据盘容量大时，您无法使用该自定义镜像重置系统。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
],
- 'CreateInstanceKeyPair' => [
- 'summary' => '创建轻量应用服务器密钥对。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteFirewallTemplates' => [
+ 'summary' => '删除已创建的防火墙模板。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3601,49 +2329,31 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '219657',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- ],
- [
- 'name' => 'KeyPairName',
+ 'name' => 'FirewallTemplateId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '密钥对名称。',
- 'type' => 'string',
+ 'description' => '防火墙模板ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '防火墙模板ID。', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****'],
'required' => true,
- 'example' => 'ceshi',
+ 'maxItems' => 100,
],
],
],
@@ -3652,50 +2362,37 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
- ],
- 'KeyPairName' => [
- 'description' => '密钥对名称。',
- 'type' => 'string',
- 'example' => 'ceshi',
- ],
- 'Fingerprint' => [
- 'description' => '密钥对指纹。',
- 'type' => 'string',
- 'example' => 'If2K1ItazA4GlKkWCEhdRj8Wd6czAvK9*****',
- ],
- 'PrivateKey' => [
- 'description' => '私钥',
- 'type' => 'string',
- 'example' => '***',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4****'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'title' => '删除防火墙模板',
+ 'description' => '删除防火墙模板不会影响已设置轻量应用服务器实例的防火墙规则，如果您不再需要防火墙模板，可以选择删除。',
+ 'changeSet' => [],
+ '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\",\\n \\"KeyPairName\\": \\"ceshi\\",\\n \\"Fingerprint\\": \\"If2K1ItazA4GlKkWCEhdRj8Wd6czAvK9*****\\",\\n \\"PrivateKey\\": \\"***\\"\\n}","type":"json"}]',
- 'title' => '创建实例密钥对',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\"\\n}","type":"json"}]',
],
- 'CreateKeyPair' => [
- 'summary' => '创建轻量应用服务器密钥对。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteInstanceKeyPair' => [
+ 'summary' => '删除轻量应用服务器密钥对。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3703,50 +2400,23 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '219069',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '创建类接口，不涉及越权场景',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'KeyPairName',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'KeyPairName',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
],
'responses' => [
@@ -3754,54 +2424,42 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'KeyPairName' => [
- 'description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'example' => 'KeyPairName',
- ],
- 'PrivateKeyBody' => [
- 'description' => '密钥对的私钥。PEM编码的PKCS#8格式的私钥部分。',
- 'type' => 'string',
- 'example' => 'MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'KeyPairNameAlreadyExist',
- 'errorMessage' => 'The keyPair name already exist.',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"KeyPairName\\": \\"KeyPairName\\",\\n \\"PrivateKeyBody\\": \\"MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****\\"\\n}","type":"json"}]',
- 'title' => '创建密钥对',
- 'description' => '阿里云SSH密钥对是一种安全便捷的登录认证方式，用于在SSH协议中进行身份验证和加密通信。由公钥和私钥组成，仅支持Linux实例，满足您对更高安全性、便利性的业务需求。'."\n"
- ."\n"
- .'- 仅支持Linux系统的轻量应用服务器设置密钥对登录的方式。'."\n"
- .'- 一个阿里云账号在一个地域下最多可以创建10个密钥对。'."\n"
- .'- 控制台仅支持创建RSA 2048位密钥对。',
- ],
- 'UploadInstanceKeyPair' => [
- 'summary' => '为一台轻量应用服务器导入密钥对。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '删除实例密钥对',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteInstanceKeyPair'],
+ ],
],
- 'schemes' => [
- 'http',
- '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' => [],
@@ -3810,59 +2468,32 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '219072',
+ 'abilityTreeNodes' => ['FEATUREswas9IJLCU'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'KeyPairNames',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
+ 'description' => 'SSH密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。最多支持50对SSH密钥对。',
+ 'type' => 'array',
+ 'items' => ['description' => 'SSH密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。最多支持50对SSH密钥对。', 'type' => 'string', 'required' => false, 'example' => 'testKeyPair'],
'required' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- ],
- [
- 'name' => 'KeyPairName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '密钥对名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_gin',
- ],
- ],
- [
- 'name' => 'PublicKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用户公钥。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID5aQ5bM0Am3mWe+upjSXqisUT4DLR6ExwvA0***** **@**.com',
+ 'maxItems' => 100,
],
],
],
@@ -3871,35 +2502,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
- ],
+ 400 => [
+ ['errorCode' => 'InvalidParameter.KeypairAlreadyAttachedInstance', 'errorMessage' => 'The specified keyPair attached to instances can not be deleted.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
- 'title' => '导入密钥对',
- ],
- 'ImportKeyPair' => [
- 'summary' => '导入已有密钥对。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除密钥对',
+ 'summary' => '删除轻量应用服务器密钥对。',
+ 'description' => '如果密钥对不再使用，您需要先解绑密钥对，然后再删除。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'swas-open:DeleteKeyPairs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteSnapshot' => [
+ 'summary' => '删除轻量应用服务器指定的快照。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3907,60 +2547,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '219071',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '无越权场景',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'KeyPairName',
+ 'name' => 'SnapshotId',
'in' => 'query',
- 'schema' => [
- 'description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'KeyPairName',
- ],
+ 'schema' => ['description' => '快照ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-bp16oazlsold4dks****'],
],
[
- 'name' => 'PublicKeyBody',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '密钥对的公钥内容。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
],
'responses' => [
@@ -3968,45 +2570,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'KeyPairName' => [
- 'description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'example' => 'KeyPairName',
- ],
+ 'RequestId' => ['description' => '请求ID。'."\n"
+ ."\n", 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F '],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'KeyPairNameAlreadyExist',
- 'errorMessage' => 'The keyPair name already exist.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidSnapshotId.NotFound', 'errorMessage' => 'The specified SnapshotId does not exist.', 'description' => '指定的快照不存在，请您检查快照ID是否正确。'],
+ ],
+ 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' => '导入密钥对',
- 'description' => '如果您已有密钥对，可以将已有密钥对导入控制台，便于使用已有密钥对登录轻量应用服务器。但已有密钥对必须为支持的加密方式，具体说明请参见[Q2：导入已有密钥对支持哪些加密方式？](~~59085~~)。',
- ],
- 'DescribeInstanceKeyPair' => [
- 'summary' => '查询轻量应用服务器的密钥对信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '删除快照',
+ 'description' => '当您不再需要某一快照时，可以删除快照。'."\n"
+ ."\n"
+ .'> 如果快照有对应的自定义镜像，请先删除对应镜像后再删除快照。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => '[{"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":""}]',
+ ],
+ 'DeleteSnapshots' => [
+ 'summary' => '删除一个或多个已创建的快照。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4015,40 +2625,27 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREswasHVUGWX'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'SnapshotIds',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '快照ID。取值可以由多个快照ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"]'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
],
'responses' => [
@@ -4056,44 +2653,48 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'KeyPairName' => [
- 'description' => '密钥对名称。',
- 'type' => 'string',
- 'example' => 'KeyPairName',
- ],
- 'Fingerprint' => [
- 'description' => '密钥对指纹。',
- 'type' => 'string',
- 'example' => '4f:70:62:e9:0c:72:f7:ee:74:ce:e3:bf:e0:82:**:**',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidSnapshotIds', 'errorMessage' => 'The specified SnapshotIds is not valid.', 'description' => '指定的快照ID无效。'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidSnapshotId.NotFound', 'errorMessage' => 'The specified SnapshotId does not exist.', 'description' => '指定的快照不存在，请您检查快照ID是否正确。'],
+ ],
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 \\"KeyPairName\\": \\"KeyPairName\\",\\n \\"Fingerprint\\": \\"4f:70:62:e9:0c:72:f7:ee:74:ce:e3:bf:e0:82:**:**\\"\\n}","type":"json"}]',
- 'title' => '查询实例密钥对信息',
- ],
- 'ListKeyPairs' => [
- 'summary' => '密钥对列表。',
- 'methods' => [
- 'get',
+ 'title' => '批量删除快照',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshots'],
+ ],
],
- 'schemes' => [
- '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' => [],
@@ -4103,301 +2704,222 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '219096',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
+ 'abilityTreeCode' => '214711',
+ 'abilityTreeNodes' => ['FEATUREswasWZKIOQ'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'KeyPairName',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'KeyPairName',
- ],
+ 'schema' => ['description' => '当前页码。'."\n"
+ ."\n"
+ .'起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '密钥对列表的页码。起始值：1。默认值：1 。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '每页的返回结果个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ 'description' => '轻量应用服务器的实例ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'required' => false, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]'],
+ 'required' => true,
+ 'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '密钥对的总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'PageSize' => [
- 'description' => '每页的返回结果个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '当前页数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'KeyPairs' => [
- 'description' => '密钥对信息集合。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'CloudAssistant' => [
+ 'description' => '实例命令助手安装状态结果集合。',
'type' => 'array',
'items' => [
- 'description' => '密钥对信息集合。',
'type' => 'object',
'properties' => [
- 'CreationTime' => [
- 'description' => '密钥对的创建时间。',
- 'type' => 'string',
- 'example' => '2024-05-06T02:28Z',
- ],
- 'KeyPairName' => [
- 'description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'example' => 'testKeyPairName',
- ],
- 'PublicKey' => [
- 'description' => '公钥内容。',
- 'type' => 'string',
- 'example' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****',
- ],
- 'InstanceIds' => [
- 'description' => '轻量应用服务器实例ID。最多支持50个实例ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '轻量应用服务器实例ID。最多支持50个实例ID。',
- 'type' => 'string',
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- ],
+ 'InstanceId' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'example' => '85dbe3e7cc7b49e1a3df4af3bfa4ebbf'],
+ 'CloudAssistantStatus' => ['description' => '实例内的命令助手是否在运行中。可能值：'."\n"
+ ."\n"
+ .'true：2 分钟内有心跳。'."\n"
+ ."\n"
+ .'false：2 分钟内无心跳。', 'type' => 'string', 'example' => 'true'],
+ 'LastInvokedTime' => ['description' => '最近一次命令执行的时间。', 'type' => 'string', 'example' => '2021-03-15T08:00:00Z'."\n"],
+ 'CloudAssistantVersion' => ['description' => '命令助手Agent版本号，若未安装或未运行命令助手Agent，则该值为空。', 'type' => 'string', 'example' => '2.2.0.106'."\n"],
+ 'ActiveTaskCount' => ['description' => '实例内的命令助手运行中的任务数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'InvocationCount' => ['description' => '实例内的命令助手已完成的任务数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ 'LastHeartbeatTime' => ['description' => '命令助手最近一次心跳时间。该值平均每分钟（有上下 5 秒的随机浮动，最短 55 秒，最长 65 秒）更新一次。', 'type' => 'string', 'example' => '2021-03-15T09:00:00Z'."\n"],
+ 'OSType' => ['description' => '实例操作系统类型。可能值：'."\n"
+ ."\n"
+ .'- Windows。'."\n"
+ .'- Linux。'."\n"
+ .'- FreeBSD。', 'type' => 'string', 'example' => 'Linux'],
+ 'SupportSessionManager' => ['description' => '实例内的命令助手是否支持会话管理功能。若不支持，表示命令助手版本较低，请将客户端更新至最新版本。'."\n"
+ ."\n"
+ .'命令助手支持会话管理功能的最低版本如下：'."\n"
+ ."\n"
+ .'Linux：2.2.3.189'."\n"
+ .'Windows：2.1.3.189', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
+ 'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'PageSize' => ['description' => '每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- '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' => '查询密钥对',
- ],
- 'AttachKeyPair' => [
- 'summary' => '轻量应用服务器绑定密钥对。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '查询一台或者多台实例的命令助手信息',
+ 'summary' => '查询一台或者多台实例的命令助手信息。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCloudAssistantAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'DescribeCloudAssistantStatus' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '219076',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '当前页码。'."\n"
+ ."\n"
+ .'起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '轻量应用服务器实例ID。最多支持50个实例ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '绑定SSH密钥对的实例ID。最多支持50个实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。'."\n"
+ ."\n"
+ .'最大值：50。'."\n"
+ ."\n"
+ .'默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'KeyPairName',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
+ 'description' => '轻量应用服务器的实例ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '轻量应用服务器的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ace0706b2ac4454d984295a94213****'],
+ 'required' => false,
+ 'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'TotalCount' => [
- 'description' => '绑定密钥对的实例总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'FailCount' => [
- 'description' => '绑定密钥对失败的实例总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Results' => [
- 'title' => '结果列表',
- 'description' => '结果列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'CloudAssistantStatus' => [
+ 'description' => '云助手状态信息。',
'type' => 'array',
'items' => [
- 'description' => '绑定密钥对成功或失败的结果集合。',
+ 'description' => '云助手状态信息。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '结果码',
- 'description' => '结果码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '结果信息',
- 'description' => '结果信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'title' => '是否成功',
- 'description' => '绑定密钥对是否成功。可能值：'."\n"
- ."\n"
- .'- true：绑定密钥对成功。'."\n"
- ."\n"
- .'- false：绑定密钥对失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'InstanceId' => [
- 'title' => '实例id',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'aa6e71ddb35c46679bc4753d6219d604',
- ],
+ 'InstanceId' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'example' => 'ace0706b2ac4454d984295a94213****'],
+ 'Status' => ['description' => '云助手状态。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
+ 'TotalCount' => ['description' => '命令总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。'."\n"
+ ."\n"
+ .'最大值：50。'."\n"
+ ."\n"
+ .'默认值：10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '当前页码。'."\n"
+ ."\n"
+ .'起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified Instance Id does not exist.',
- ],
+ 'title' => '查询云助手安装状态',
+ 'summary' => '查询轻量云服务器是否安装云助手。',
+ 'description' => '轻量服务器默认已安装云助手，如果您已手动卸载，需重新安装云助手，否则无法使用执行命令的功能。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudAssistantStatus'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '绑定密钥对',
- 'description' => '一台轻量应用服务器只支持在控制台绑定一个密钥对。若您选择的轻量应用服务器已经绑定过其他密钥对，新绑定的密钥对将会覆盖已绑定的密钥对。',
+ '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":""}]',
],
- 'DetachKeyPair' => [
- 'summary' => '解绑轻量应用服务器的密钥对。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeCloudMonitorAgentStatuses' => [
+ 'summary' => '查询轻量应用服务器云监控插件的状态。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4405,61 +2927,23 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '219077',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器所属的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
'name' => 'InstanceIds',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '解绑SSH密钥对的实例ID。最多支持50个实例ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '解绑SSH密钥对的实例ID。最多支持50个实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'KeyPairName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '密钥对名称。必须保持名称唯一性。 长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以 http:// 和 https:// 开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'KeyPairName',
- ],
+ 'schema' => ['description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc******","2ad1ae67295445f598017499dc******"]'],
],
],
'responses' => [
@@ -4467,367 +2951,540 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'TotalCount' => [
- 'description' => '解绑密钥对的实例总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'FailCount' => [
- 'description' => '绑定密钥对失败的实例总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Results' => [
- 'title' => '结果列表',
- 'description' => '结果列表。',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE'],
+ 'InstanceStatusList' => [
+ 'description' => '对象。',
'type' => 'array',
'items' => [
- 'description' => '解绑密钥对成功或失败的结果集合。',
+ 'description' => '对象。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '结果码',
- 'description' => '结果码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '结果信息',
- 'description' => '结果信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'title' => '是否成功',
- 'description' => '密钥对解绑是否成功。可能值：'."\n"
- ."\n"
- .'- true：密钥对解绑成功。'."\n"
- ."\n"
- .'- false：密钥对解绑失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'InstanceId' => [
- 'title' => '实例id',
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'example' => 'aa6e71ddb35c46679bc4753d6219d604',
- ],
+ 'Status' => ['description' => '插件的运行状态。取值：'."\n"
+ ."\n"
+ .'- running：运行中。'."\n"
+ .'- stopped：已停止。'."\n"
+ .'- installing：安装中。'."\n"
+ .'- install_faild：安装失败。'."\n"
+ .'- abnormal：安装异常。'."\n"
+ .'- not_installed：未安装。', 'type' => 'string', 'example' => 'running'],
+ 'InstanceId' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'example' => 'c854dc6f07e74953830bb5808d0****'],
+ 'AutoInstall' => ['description' => '是否自动安装云监控插件。取值：'."\n"
+ ."\n"
+ .'- true。'."\n"
+ ."\n"
+ .'- false。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter.KeypairNotAttachedInstance',
- 'errorMessage' => 'The specified keyPair not attached to instances.',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
- 404 => [
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified Instance Id does not exist.',
- ],
+ ],
+ 'title' => '查询云监控插件状态',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudMonitorAgentStatuses'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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\\": \\"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' => '解绑密钥对',
- 'description' => '如果您需要更换密钥对或者某个用户不再需要访问特定实例，您可以解绑SSH密钥对，以提高实例的安全性或限制访问权限。',
+ '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"}]',
],
- 'DeleteInstanceKeyPair' => [
- 'summary' => '删除轻量应用服务器密钥对。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeCommandInvocations' => [
+ 'summary' => '查询命令助手执行命令的列表和状态。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'CommandId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '命令ID。您可以通过接口[DescribeCommands](~~64843~~)查询所有可用的CommandId。 ', 'type' => 'string', 'required' => false, 'example' => 'c-sh02yh0932w****'],
+ ],
+ [
+ 'name' => 'InvokeId',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令执行ID。', 'type' => 'string', 'required' => false, 'example' => 't-hz02p9545t6****'],
+ ],
+ [
+ 'name' => 'CommandName',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令名称。如果同时设置了InstanceId参数，则该参数不生效。', 'type' => 'string', 'required' => false, 'example' => 'testName'],
+ ],
+ [
+ 'name' => 'InvocationStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令执行的总执行状态，总执行状态取决于本次调用的全部实例的共同执行状态，可能值：'."\n"
+ .'- Pending：系统正在校验或发送命令。存在至少一台实例的命令执行状态为Pending，则总执行状态为Pending。'."\n"
+ .'- Running：命令正在实例上运行。存在至少一台实例的命令执行状态为Running，则总执行状态为Running。'."\n"
+ .'- Success：各个实例上的命令执行状态均为Stopped或Success，且至少一个实例的命令执行状态是Success，则总执行状态为Success。'."\n"
+ .' - 立即运行的任务：命令执行完成，且退出码为0。'."\n"
+ .'- Failed：各个实例上的命令执行状态均为Stopped或Failed，则总执行状态为Failed。实例上的命令执行状态一项或多项为以下状态时，返回值均为Failed状态：'."\n"
+ .' - 命令校验失败（Invalid）'."\n"
+ .' - 命令发送失败（Aborted）'."\n"
+ .' - 命令执行完成但退出码非0（Failed）'."\n"
+ .' - 命令执行超时（Timeout）'."\n"
+ .' - 命令执行异常（Error）'."\n"
+ .'- Stopping：正在停止任务。存在至少一台实例的命令执行状态为Stopping，则总执行状态为Stopping。'."\n"
+ .'- Stopped：任务已停止。所有实例的命令执行状态是Stopped，则总执行状态为Stopped。实例上的命令执行状态为以下状态时，返回值均为Stopped状态：'."\n"
+ .' - 任务已取消（Cancelled）'."\n"
+ .' - 任务已终止（Terminated）'."\n"
+ .'- PartialFailed：部分实例执行成功且部分实例执行失败。各个实例的命令执行状态均为Success、Failed或Stopped，则总执行状态为PartialFailed。'."\n"
+ .'> 返回参数中的`InvokeStatus`与该参数意义相似，但建议您查看该返回值。', 'type' => 'string', 'required' => false, 'example' => 'Success'],
+ ],
+ [
+ 'name' => 'CommandType',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令类型。可能值：'."\n"
+ ."\n"
+ .'- RunBatScript：适用于Windows实例的Bat命令。'."\n"
+ .'- RunPowerShellScript：适用于Windows实例的PowerShell命令。'."\n"
+ .'- RunShellScript：适用于Linux实例Shell命令。', 'type' => 'string', 'required' => false, 'example' => 'RunPowerShellScript'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前页码。起始值：1。默认值：1。', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时设置的每页行数。'."\n"
+ ."\n"
+ .'最大值：50。'."\n"
+ ."\n"
+ .'默认值：10。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '查询结果的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'CommandInvocations' => [
+ 'description' => '命令执行列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '命令执行信息结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InvokeId' => ['description' => '命令执行ID。', 'type' => 'string', 'example' => 't-hz0373jyzxt****'],
+ 'CreationTime' => ['description' => '命令创建时间。', 'type' => 'string', 'example' => '2023-04-27T10:11:58'],
+ 'CommandId' => ['description' => '命令ID。', 'type' => 'string', 'example' => 'c-hy0338xh28r****'],
+ 'InvocationStatus' => ['description' => '命令执行的状态。可能值：'."\n"
+ ."\n"
+ .'- Pending：系统正在校验或发送命令。'."\n"
+ .'- Invalid：指定命令类型或参数有误。'."\n"
+ .'- Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成。'."\n"
+ .'- Running：命令正在实例上执行。'."\n"
+ .'- Success：命令执行完成，且退出码为0。'."\n"
+ .'- Failed：命令执行完成，且退出码非0。'."\n"
+ .'- Error：命令执行时发生异常无法继续。'."\n"
+ .'- Timeout：命令执行超时。'."\n"
+ .'- Cancelled：命令的执行动作已经取消，命令未曾启动。'."\n"
+ .'- Stopping：正在停止执行的命令。'."\n"
+ .'- Terminated：命令执行时被终止。', 'type' => 'string', 'example' => 'Success'],
+ 'CommandName' => ['description' => '命令名称。', 'type' => 'string', 'example' => 'testCommandName'],
+ 'CommandType' => ['description' => '命令类型。', 'type' => 'string', 'example' => 'RunShellScript'],
+ 'CommandDescription' => ['description' => '命令描述。', 'type' => 'string', 'example' => 'testDescription'],
+ 'Username' => ['description' => '执行命令的用户名称。', 'type' => 'string', 'example' => 'root'],
+ 'WorkingDir' => ['description' => '命令执行的路径。', 'type' => 'string', 'example' => 'c:\\wwwroot'],
+ 'Timeout' => ['description' => '超时时间，单位为秒（s）。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
+ 'CommandContent' => ['description' => '命令内容。', 'type' => 'string', 'example' => 'echo 123'],
+ 'Parameters' => ['description' => '命令中包含自定义参数。如果没有参数，默认为{}.', 'type' => 'string', 'example' => '{}'],
+ 'InvokeInstances' => [
+ 'description' => '执行目标实例列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '执行目标实例信息结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '轻量应用服务器的实例ID。', 'type' => 'string', 'example' => '2445f4aecdac4b71ba2c7e3a7ccf****'],
+ 'StartTime' => ['description' => '命令在实例中开始执行的时间。', 'type' => 'string', 'example' => '2023-05-09T03:32:24Z'],
+ 'FinishTime' => ['description' => '命令进程的结束时间。', 'type' => 'string', 'example' => '2023-04-03T02:42:29Z'],
+ 'InvocationStatus' => ['description' => '单台实例的命令进度状态，可能值：'."\n"
+ .'- Pending：系统正在校验或发送命令。'."\n"
+ .'- Invalid：指定命令类型或参数有误。'."\n"
+ .'- Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成。'."\n"
+ .'- Running：命令正在实例上运行。'."\n"
+ .'- Success：'."\n"
+ .' - 单次执行的命令：命令执行完成，且退出码为0。'."\n"
+ .' - 定时执行的命令：上一次运行成功且退出码为0，且指定的时间已结束。'."\n"
+ .'- Failed：'."\n"
+ .' - 单次执行的命令：命令执行完成，且退出码非0。'."\n"
+ .' - 定时执行的命令：上一次运行成功且退出码非0，且指定的时间将中止。'."\n"
+ .'- Error：命令执行时发生异常无法继续。'."\n"
+ .'- Timeout：命令执行超时。'."\n"
+ .'- Cancelled：命令的执行动作已经取消，命令未曾启动。'."\n"
+ .'- Stopping：正在停止任务。'."\n"
+ .'- Terminated：命令运行时被终止。', 'type' => 'string', 'example' => 'Running'],
+ 'Output' => ['description' => '命令执行后的输出信息。', 'type' => 'string', 'example' => 'OutputMsg'],
+ 'ExitCode' => ['description' => '命令的退出码。'."\n"
+ ."\n"
+ .'- Linux实例为Shell命令的退出码。'."\n"
+ .'- Windows实例为Bat或者PowerShell命令的退出码。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'ErrorInfo' => [
+ 'description' => '命令的下发失败或执行失败原因的详情，可能值：'."\n"
+ ."\n"
+ .'- 空：命令执行正常。'."\n"
+ .'- the specified instance does not exists：指定的实例不存在或已释放。'."\n"
+ .'- the instance has released when create task：执行命令期间，该实例被释放。'."\n"
+ .'- the instance is not running when create task：命令执行时，该实例不在运行中。'."\n"
+ .'- the command is not applicable：命令不适用于指定的实例。'."\n"
+ .'- the specified account does not exists：指定的账号不存在。'."\n"
+ .'- the specified directory does not exists：指定的目录不存在。'."\n"
+ .'- the cron job expression is invalid：指定的周期表达式不合法。'."\n"
+ .'- the aliyun service is not running on the instance：云助手客户端未运行。'."\n"
+ .'- the aliyun service in the instance does not response：云助手客户端无响应。'."\n"
+ .'- the aliyun service in the instance is upgrading now：云助手客户端正在升级中。'."\n"
+ .'- the aliyun service in the instance need upgrade：云助手客户端需要升级。'."\n"
+ .'- the command delivery has been timeout：发送命令超时。'."\n"
+ .'- the command execution has been timeout：命令执行超时。'."\n"
+ .'- the command execution got an exception：命令执行发生异常。'."\n"
+ .'- the command execution has been interrupted：命令执行被中断。'."\n"
+ .'- the command execution exit code is not zero：命令执行结束，退出码非0。',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'the specified instance does not exists',
+ ],
+ 'ErrorCode' => ['description' => '命令的下发失败或执行失败原因的代码，可能值：'."\n"
+ ."\n"
+ .'- 空：命令执行正常。'."\n"
+ .'- InstanceNotExists：指定的实例不存在或已释放。'."\n"
+ .'- InstanceReleased：执行命令期间，该实例被释放。'."\n"
+ .'- InstanceNotRunning：命令执行时，该实例不在运行中。'."\n"
+ .'- CommandNotApplicable：命令不适用于指定的实例。'."\n"
+ .'- AccountNotExists：指定的账号不存在。'."\n"
+ .'- DirectoryNotExists：指定的目录不存在。'."\n"
+ .'- BadCronExpression：指定的周期表达式不合法。'."\n"
+ .'- ClientNotRunning：云助手客户端未运行。'."\n"
+ .'- ClientNotResponse：云助手客户端无响应。'."\n"
+ .'- ClientIsUpgrading：云助手客户端正在升级中。'."\n"
+ .'- ClientNeedUpgrade：云助手客户端需要升级。'."\n"
+ .'- DeliveryTimeout：发送命令超时。'."\n"
+ .'- ExecutionTimeout：命令执行超时。'."\n"
+ .'- ExecutionException：命令执行发生异常。'."\n"
+ .'- ExecutionInterrupted：命令执行被中断。'."\n"
+ .'- ExitCodeNonzero：命令执行结束，退出码非0。', 'type' => 'string', 'example' => 'InstanceNotExists'],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'title' => '查询命令执行列表和状态',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeCommandInvocations',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => '删除实例密钥对',
+ '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"}]',
],
- 'DeleteKeyPairs' => [
- 'summary' => '删除轻量应用服务器密钥对。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeCommands' => [
+ 'summary' => '查询您手动创建的命令或者阿里云提供的公共命令。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '219072',
- 'abilityTreeNodes' => [
- 'FEATUREswas9IJLCU',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '184928',
+ 'abilityTreeNodes' => ['FEATUREswasWZKIOQ'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'CommandId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '命令ID。', 'type' => 'string', 'required' => false, 'example' => 'c-sh02yh0932w****'],
],
[
- 'name' => 'KeyPairNames',
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令的名称，暂不支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'testName'],
+ ],
+ [
+ 'name' => 'Provider',
+ 'in' => 'query',
+ 'schema' => ['description' => '公共命令的提供者。参数值的具体说明如下：'."\n"
+ ."\n"
+ .'- 当该参数取值为`AlibabaCloud`时，查询由阿里云提供的所有公共命令。'."\n"
+ .'- 当该参数的取值为`User`时，查询由您创建的所有自定义命令。', 'type' => 'string', 'required' => true, 'example' => 'AlibabaCloud'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => '命令的语言类型。取值范围：'."\n"
+ ."\n"
+ .'- RunBatScript：适用于Windows实例的Bat命令。'."\n"
+ .'- RunPowerShellScript：适用于Windows实例的PowerShell命令。'."\n"
+ .'- RunShellScript：适用于Linux实例Shell命令。', 'type' => 'string', 'required' => false, 'example' => 'RunShellScript'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前页码。'."\n"
+ ."\n"
+ .'起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时设置的每页行数。'."\n"
+ ."\n"
+ .'最大值：50。'."\n"
+ ."\n"
+ .'默认值：10。', 'type' => 'string', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'SSH密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。最多支持50对SSH密钥对。',
+ 'description' => '命令的标签列表。',
'type' => 'array',
'items' => [
- 'description' => 'SSH密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。最多支持50对SSH密钥对。',
- 'type' => 'string',
+ 'description' => '标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '命令的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '命令的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
+ ],
'required' => false,
- 'example' => 'testKeyPair',
],
- 'required' => true,
+ 'required' => false,
'maxItems' => 100,
],
],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'TotalCount' => ['description' => '命令总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '命令列表页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Commands' => [
+ 'description' => '命令列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '命令信息结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CommandId' => ['description' => '命令ID。', 'type' => 'string', 'example' => 'c-gov1k1tqwi9****'],
+ 'Tags' => [
+ 'description' => '命令的标签列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '命令的标签键。', 'type' => 'string', 'example' => 'TestKey'],
+ 'Value' => ['description' => '命令的标签值。', 'type' => 'string', 'example' => 'TestValue'],
+ ],
+ ],
+ ],
+ 'CreationTime' => ['description' => '命令创建时间。', 'type' => 'string', 'example' => '2023-01-05T06:38:53Z'],
+ 'Name' => ['description' => '命令名称。', 'type' => 'string', 'example' => 'testName'],
+ 'Provider' => ['description' => '命令的提供者。', 'type' => 'string', 'example' => 'User'],
+ 'Type' => ['description' => '命令类型。', 'type' => 'string', 'example' => 'RunShellScript'],
+ 'Timeout' => ['description' => '超时时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
+ 'Description' => ['description' => '命令描述。', 'type' => 'string', 'example' => 'testDescription'],
+ 'WorkingDir' => ['description' => '执行路径。', 'type' => 'string', 'example' => '/home'],
+ 'CommandContent' => ['description' => '命令内容。', 'type' => 'string', 'example' => 'cat /etc/ssh/sshd_config'],
+ 'EnableParameter' => ['description' => '该命令是否启用自定义参数。'."\n", 'type' => 'boolean', 'example' => 'false'],
+ 'ParameterNames' => [
+ 'description' => '通过创建命令时的CommandContent解析出的自定义参数名列表，以列表（List）的形式返回。如未使用自定义参数功能，则返回空值列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '自定义参数。', 'type' => 'string', 'example' => 'parameter1'],
+ ],
+ 'ParameterDefinitions' => [
+ 'description' => '自定义参数详细信息列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '自定义参数详细信息结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Required' => ['description' => '该自定义参数是否必填。'."\n"
+ ."\n"
+ .'- true：是。'."\n"
+ ."\n"
+ .'- false：否。'."\n"
+ ."\n"
+ .'默认值：false。', 'type' => 'boolean', 'example' => 'false'],
+ 'Description' => ['description' => '自定义参数描述。', 'type' => 'string', 'example' => '命令助手Agent安装包路径'],
+ 'DefaultValue' => ['description' => '自定义参数的默认值。', 'type' => 'string', 'example' => 'https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm'],
+ 'ParameterName' => ['description' => '自定义参数名称。', 'type' => 'string', 'example' => 'DownloadUrl'],
+ 'PossibleValues' => [
+ 'description' => '枚举类型自定义参数的可选值。',
+ 'type' => 'array',
+ 'items' => ['description' => '枚举类型自定义参数值。', 'type' => 'string', 'example' => 'Linux'],
+ ],
+ ],
+ ],
+ ],
+ 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-aek2bti7cf7****'],
+ ],
+ ],
],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter.KeypairAlreadyAttachedInstance',
- 'errorMessage' => 'The specified keyPair attached to instances can not be deleted.',
+ 'title' => '查询命令',
+ 'changeSet' => [],
+ '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' => '删除密钥对',
- 'description' => '如果密钥对不再使用，您需要先解绑密钥对，然后再删除。',
+ '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"}]',
],
- 'CreateFirewallTemplate' => [
- 'summary' => '创建一个防火墙模板。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeDatabaseErrorLogs' => [
+ 'summary' => '查询错误日志。',
+ '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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ ."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Name',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
[
- 'name' => 'Description',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板描述信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'FirewallRule',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '防火墙规则。',
- 'type' => 'array',
- 'items' => [
- 'description' => '防火墙规则。',
- 'type' => 'object',
- 'properties' => [
- 'RuleProtocol' => [
- 'description' => '传输层协议。可能值：'."\n"
- ."\n"
- .'- TCP：TCP协议。'."\n"
- .'- UDP：UDP协议。'."\n"
- .'- TCP+UDP：TCP和UDP协议。'."\n"
- .'- ICMP：ICMP协议。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
- ."\n"
- .'> 如果您设置的是ICMP协议，端口只能为-1/-1。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '223.166.XX.XX',
- ],
- 'Remark' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自定义规则',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '每页错误日志行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '30', 'example' => '30', 'default' => '30'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询错误日志起始时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mmZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的到期时间。', 'type' => 'string', 'required' => true, 'example' => '2022-09-07T04:04Z'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询错误日志截止时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mmZ。截止时间需大于起始时间。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的到期时间。', 'type' => 'string', 'required' => true, 'example' => '2022-09-08T04:04Z'],
],
],
'responses' => [
@@ -4837,35 +3494,55 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'FirewallTemplateId' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'example' => 'ft-bcf1a7hrdq717****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PageNumber' => ['description' => '错误信息当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '错误信息每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'TotalCount' => ['description' => '错误信息总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'ErrorLogs' => [
+ 'description' => '错误日志信息集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '错误日志信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorInfo' => ['description' => '错误日志信息。', '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' => '错误日志生成时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的到期时间。', 'type' => 'string', 'example' => '2022-09-08T12:11:04Z'],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"FirewallTemplateId\\": \\"ft-bcf1a7hrdq717****\\"\\n}","type":"json"}]',
- 'title' => '创建防火墙模板',
- 'description' => '防火墙模板提供了一种可以包含多条防火墙规则的模板功能，您可以通过模板同时向一个或多个实例中添加一组防火墙规则，提高设置防火墙规则的效率。',
- ],
- 'DescribeFirewallTemplates' => [
- 'summary' => '查询防火墙模板的信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '查询错误日志',
+ 'description' => '您可以调用此接口，查询数据库的错误日志，帮助您定位问题。',
+ 'changeSet' => [],
+ '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' => '[{"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":""}]',
+ ],
+ 'DescribeDatabaseInstanceMetricData' => [
+ 'summary' => '查询数据库实例监控信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4874,76 +3551,49 @@
'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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'FirewallTemplateId',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
[
- 'name' => 'Name',
+ 'name' => 'MetricName',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => '指标名称。取值范围：'."\n"
+ ."\n"
+ .'- MySQL_MemCpuUsage：实例CPU使用率（占操作系统总数）和MySQL实例内存使用率（占操作系统总数）。'."\n"
+ .'- MySQL_DetailedSpaceUsage：实例总空间使用量、数据空间、日志空间、临时空间和系统空间。'."\n"
+ .'- MySQL_Sessions ：当前活跃连接数，当前总连接数。'."\n"
+ .'- MySQL_IOPS ：实例的IOPS（每秒IO请求次数）。', 'type' => 'string', 'required' => true, 'example' => 'MySQL_MemCpuUsage'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。'."\n"
- ."\n"
- .'起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '监控结束时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mmZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的时间。', 'type' => 'string', 'required' => true, 'example' => '2022-09-06T04:04Z'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。默认值：20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => '监控开始时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mmZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的时间。', 'type' => 'string', 'required' => true, 'example' => '2022-09-07T04:04Z'],
],
],
'responses' => [
@@ -4953,213 +3603,84 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'TotalCount' => [
- 'description' => '防火墙模板总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '当前页码。'."\n"
- ."\n"
- .'起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。默认值：20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'FirewallTemplates' => [
- 'description' => '防火墙模板信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '防火墙模板信息。',
- 'type' => 'object',
- 'properties' => [
- 'FirewallTemplateId' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- 'CreationTime' => [
- 'description' => '防火墙模板创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2024-04-10T02:10:14Z',
- ],
- 'Name' => [
- 'description' => '防火墙模板名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '防火墙模板描述信息。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'CreateTime' => [
- 'description' => '防火墙模板创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的到期时间。',
- 'type' => 'string',
- 'example' => '2024-04-29T02:01:38Z',
- ],
- 'FirewallTemplateRules' => [
- 'description' => '防火墙模板规则。',
- 'type' => 'array',
- 'items' => [
- 'description' => '防火墙模板规则。',
- 'type' => 'object',
- 'properties' => [
- 'FirewallTemplateRuleId' => [
- 'description' => '防火墙模板规则ID。',
- 'type' => 'string',
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
- 'RuleProtocol' => [
- 'description' => '传输层协议。可能值：'."\n"
- ."\n"
- .'- TCP：TCP协议。'."\n"
- .'- UDP：UDP协议。'."\n"
- .'- TCP+UDP：TCP和UDP协议。'."\n"
- .'- ICMP：ICMP协议。',
- 'type' => 'string',
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
- ."\n"
- .'> 如果您设置的是ICMP协议，端口只能为-1/-1。',
- 'type' => 'string',
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。',
- 'type' => 'string',
- 'example' => '119.145.XX.XX',
- ],
- 'Remark' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'MetricName' => ['description' => '监控指标名称。可能值：'."\n"
+ ."\n"
+ .'- MySQL_MemCpuUsage：实例CPU使用率（占操作系统总数）和MySQL实例内存使用率（占操作系统总数）。'."\n"
+ .'- MySQL_DetailedSpaceUsage：实例总空间使用量、数据空间、日志空间、临时空间和系统空间。'."\n"
+ .'- MySQL_Sessions ：当前活跃连接数，当前总连接数。'."\n"
+ .'- MySQL_IOPS ：实例的IOPS（每秒IO请求次数）。', 'type' => 'string', 'example' => 'MySQL_MemCpuUsage'],
+ 'Unit' => ['description' => '监控数据单位。'."\n"
+ ."\n"
+ .'- %'."\n"
+ .'- int'."\n"
+ .'- MB'."\n", 'type' => 'string', 'example' => '%'],
+ 'DataFormat' => ['description' => '数据格式。可能值：'."\n"
+ ."\n"
+ .'- cpuusage&memusage'."\n"
+ .'- active_session&total_session'."\n"
+ .'- ins_size&data_size&log_size&tmp_size&other_size'."\n"
+ ."\n"
+ .'- io', 'type' => 'string', 'example' => 'cpuusage&memusage'],
+ 'MetricData' => ['description' => '监控数据信息。', 'type' => 'string', 'example' => '[ { \\"date"\\: " 2022-09-06T04:04:00Z",\\"value\\":\\"0.77&3.69\\" } ]'],
],
],
],
],
- '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' => '查询防火墙模板',
- ],
- 'CreateFirewallTemplateRules' => [
- 'summary' => '对于已创建的防火墙模板，您可以根据业务需求为防火墙模板增加防火墙规则。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '查询数据库实例监控信息',
+ 'description' => '创建数据库服务后，您可以查看数据库服务的CPU、内存、磁盘空间和存储IOPS（Input/Output Operations Per Second）和当前总连接数的详细信息。',
+ 'changeSet' => [],
+ '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' => '[{"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":""}]',
+ ],
+ 'DescribeDatabaseInstanceParameters' => [
+ 'summary' => '查看轻量数据库实例的参数信息。',
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'FirewallTemplateId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- ],
- [
- 'name' => 'FirewallRule',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '防火墙规则。',
- 'type' => 'array',
- 'items' => [
- 'description' => '防火墙规则。',
- 'type' => 'object',
- 'properties' => [
- 'RuleProtocol' => [
- 'description' => '传输层协议。可能值：'."\n"
- ."\n"
- .'- TCP：TCP协议。'."\n"
- .'- UDP：UDP协议。'."\n"
- .'- TCP+UDP：TCP和UDP协议。'."\n"
- .'- ICMP：ICMP协议。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
- ."\n"
- .'> 如果您设置的是ICMP协议，端口只能为-1/-1。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '222.70.XX.XX',
- ],
- 'Remark' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
],
'responses' => [
@@ -5169,51 +3690,61 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'Engine' => ['description' => '数据库类型。目前仅支持数据库的类型为MySQL。', 'type' => 'string', 'example' => 'MySQL'],
+ 'EngineVersion' => ['description' => '数据库版本。可能值：'."\n"
+ ."\n"
+ .'- 5.7：MySQL 5.7。'."\n"
+ .'- 8.0：MySQL 8.0。', 'type' => 'string', 'example' => '5.5'],
+ 'ConfigParameters' => [
+ 'description' => '正在同步的参数列表。修改并提交参数后，需要等待实例同步参数，同步结束后从此列表删除。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '正在同步的参数列表。修改并提交参数后，需要等待实例同步参数，同步结束后从此列表删除。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterDescription' => ['description' => '参数描述信息。', 'type' => 'string', 'example' => 'Auto-increment columns are incremented by this'],
+ 'ParameterName' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'auto_increment_increment'],
+ 'ParameterValue' => ['description' => '参数值。'."\n"
+ ."\n"
+ .'> 不同参数的参数值不同。', 'type' => 'string', 'example' => '1'],
+ 'ForceModify' => ['description' => '是否支持修改参数值。可能值：'."\n"
+ ."\n"
+ .'- true ：支持修改参数值。'."\n"
+ .'- false：不支持修改参数值。', 'type' => 'string', 'example' => 'true'],
+ 'ForceRestart' => ['description' => '修改参数是否重启数据库。可能值：'."\n"
+ ."\n"
+ .'- true：强制重启（若修改的参数当中，有需要重启的参数，则必须传入true，否则修改将不生效）。'."\n"
+ .'- false：不强制重启。'."\n"
+ ."\n"
+ .'默认值：false。', 'type' => 'string', 'example' => 'false'],
+ 'CheckingCode' => ['description' => '参数值范围。'."\n"
+ .'> 不同参数的参数值范围不同。', 'type' => 'string', 'example' => '[1-65535]'],
+ ],
+ ],
],
- 'FirewallTemplateRules' => [
- 'description' => '防火墙模板规则。',
+ 'RunningParameters' => [
+ 'description' => '运行参数信息。',
'type' => 'array',
'items' => [
- 'description' => '防火墙模板规则。',
+ 'description' => '运行参数信息。',
'type' => 'object',
'properties' => [
- 'FirewallTemplateRuleId' => [
- 'description' => '防火墙模板规则ID。',
- 'type' => 'string',
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- 'RuleProtocol' => [
- 'description' => '传输层协议。可能值：'."\n"
- ."\n"
- .'- TCP：TCP协议。'."\n"
- .'- UDP：UDP协议。'."\n"
- .'- TCP+UDP：TCP和UDP协议。'."\n"
- .'- ICMP：ICMP协议。',
- 'type' => 'string',
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
- ."\n"
- .'> 如果您设置的是ICMP协议，端口只能为-1/-1。',
- 'type' => 'string',
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。',
- 'type' => 'string',
- 'example' => '171.233.XX.XX',
- ],
- 'Remark' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'example' => 'test',
- ],
+ 'ParameterDescription' => ['description' => '运行参数描述信息。', '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' => '参数名称。', 'type' => 'string', 'example' => 'autocommit'],
+ 'ParameterValue' => ['description' => '运行参数值。', 'type' => 'string', 'example' => 'ON'],
+ 'ForceModify' => ['description' => '是否支持修改参数值。可能值：'."\n"
+ ."\n"
+ .'- true ：支持修改参数值。'."\n"
+ .'- false：不支持修改参数值。', 'type' => 'string', 'example' => 'true'],
+ 'ForceRestart' => ['description' => '修改参数是否重启数据库。可能值：'."\n"
+ ."\n"
+ .'- true：强制重启（若修改的参数当中，有需要重启的参数，则必须传入true，否则修改将不生效）。'."\n"
+ .'- false：不强制重启。'."\n"
+ ."\n"
+ .'默认值：false。', 'type' => 'string', 'example' => 'false'],
+ 'CheckingCode' => ['description' => '参数值范围。'."\n"
+ .'> 不同参数的参数值范围不同。', 'type' => 'string', 'example' => '[ON|OFF]'],
],
],
],
@@ -5221,268 +3752,316 @@
],
],
],
- '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' => '创建防火墙模板规则',
- 'description' => '防火墙模板增加规则不会影响已应用当前模板的实例规则。',
- ],
- 'ApplyFirewallTemplate' => [
- 'summary' => '使用防火墙模板可以同时为多台轻量应用服务器实例设置防火墙规则，提高设置防火墙规则的效率。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '查看轻量数据库实例的参数信息',
+ 'description' => '如果您需要查看轻量数据库实例的参数的具体信息，可通过此接口查询。',
+ 'changeSet' => [],
+ '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' => '[{"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":""}]',
+ ],
+ 'DescribeDatabaseInstances' => [
+ 'summary' => '查看轻量数据库实例信息。',
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'DatabaseInstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。'."\n"
+ .'取值可以由多个轻量数据库实例ID组成一个JSON数组，最多支持100个实例ID，ID之间用英文半角逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => '["swasdb-xxx******","swasdb-yyy******"]'],
],
[
- 'name' => 'FirewallTemplateId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => '轻量数据库实例列表的页码。'."\n"
+ ."\n"
+ .'起始值：1'."\n"
+ ."\n"
+ .'默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '轻量应用服务器实例ID。最多支持10个实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'd9e781ff8a8f49ee812796f12799****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。'."\n"
+ ."\n"
+ .'最大值：100。'."\n"
+ ."\n"
+ .'默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'TaskId' => [
- 'description' => '模板应用执行ID。',
- 'type' => 'string',
- 'example' => 'aft-ikgt0bynitvs3****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4****'],
+ 'DatabaseInstances' => [
+ 'description' => '轻量数据库实例集合信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '轻量数据库实例集合信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => '轻量数据库实例所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'DatabaseInstanceId' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
+ 'DatabaseInstanceName' => ['description' => '轻量数据库实例名称。', 'type' => 'string', 'example' => 'My database'],
+ 'DatabaseInstanceEdition' => ['description' => '轻量数据库实例套餐版本ID。可能值：'."\n"
+ ."\n"
+ .'- swas.db.c1m1s25：35元/月。'."\n"
+ ."\n"
+ .'- swas.db.c1m2s80：100元/月。'."\n"
+ ."\n"
+ .'- swas.db.c2m4s120：200元/月。'."\n"
+ .'- swas.db.c2m8s240：300元/月。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'swas.db.c1m1s25'],
+ 'DatabaseVersion' => ['description' => '数据库版本。可能值：'."\n"
+ ."\n"
+ .'- 5.7：MySQL 5.7。'."\n"
+ .'- 8.0：MySQL 8.0。', 'type' => 'string', 'example' => '5.7'],
+ 'Cpu' => ['description' => 'vCPU核数。', 'type' => 'string', 'example' => '1'],
+ 'Memory' => ['description' => '内存大小，单位为GB。', 'type' => 'string', 'example' => '1'],
+ 'Storage' => ['description' => 'ESSD云盘容量，单位为GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
+ 'PrivateConnection' => ['description' => '私网链接地址。', 'type' => 'string', 'example' => 'rm-bp1d39opj7906****.mysql.rds.aliyuncs.com'],
+ 'PublicConnection' => ['description' => '公网链接地址。'."\n"
+ ."\n"
+ .'> 只有申请开通公网访问地址才显示此参数。您可以调用[AllocatePublicConnection](~~451413~~)申请外网地址。', 'type' => 'string', 'example' => 'db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com'],
+ 'DatabaseInstanceStatus' => ['description' => '轻量数据库服务实例状态：可能值'."\n"
+ ."\n"
+ .'- Pending: 创建中。'."\n"
+ .'- Restarting：重启中。'."\n"
+ .'- Running：运行中。'."\n"
+ .'- Stopping：停止中。'."\n"
+ .'- Stopped：已停止。'."\n"
+ .'- UPGRADING：升级中。'."\n"
+ .'- DISABLED：已禁用。', 'type' => 'string', 'example' => 'Running'],
+ 'BusinessStatus' => ['description' => '业务状态。可能值：'."\n"
+ ."\n"
+ .'- normal: 正常。'."\n"
+ .'- expired: 到期。'."\n"
+ .'- overdue: 欠费。', 'type' => 'string', 'example' => 'normal'],
+ 'CreationTime' => ['description' => '实例创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2022-09-01T02:39:46Z'],
+ 'ExpiredTime' => ['description' => '实例到期时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的到期时间。', 'type' => 'string', 'example' => '2022-10-01T16:00:00Z'],
+ 'ChargeType' => ['description' => '轻量数据库例的计费方式。目前只支持包年包月的计费方式，取值为PrePaid。'."\n"
+ ."\n"
+ .'默认值：PrePaid。', 'type' => 'string', 'example' => 'PrePaid'],
+ 'SuperAccountName' => ['description' => '轻量数据库实例超级账号名称。', 'type' => 'string', 'example' => 'administrator'],
+ ],
+ ],
],
+ 'PageSize' => ['description' => '轻量数据库实例列表的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageNumber' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"TaskId\\": \\"aft-ikgt0bynitvs3****\\"\\n}","type":"json"}]',
- 'title' => '应用防火墙模板',
- 'description' => '如果防火墙模板中的防火墙规则的端口、协议、IP地址与实例已有规则重复，则无论当前已有规则处于启用或禁用状态，新规则均会覆盖已有规则。',
- ],
- 'ModifyFirewallTemplate' => [
- 'summary' => '对于已创建的防火墙模板，您可以根据业务需求修改防火墙规则，并最终将这些规则通过防火墙模板设置到轻量应用服务器实例中。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"type":"json","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}","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' => '查看轻量数据库实例信息',
+ 'description' => '通过此接口可查看指定地域下一个或多个轻量数据库实例的详细信息，包括轻量数据库实例ID、名称、套餐、数据库版本、公网访问地址、内网访问地址、创建时间、到期时间等信息。',
+ 'changeSet' => [],
+ '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}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeDatabaseSlowLogRecords' => [
+ 'summary' => '查询轻量数据库慢日志明细信息。',
+ '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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
[
- 'name' => 'FirewallTemplateId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => '轻量数据库实例慢日志列表的页码。'."\n"
+ ."\n"
+ .'起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'Name',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。取值范围：30~100。'."\n"
+ ."\n"
+ .'最大值：100。'."\n"
+ ."\n"
+ .'默认值：30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '30', 'example' => '30', 'default' => '30'],
],
[
- 'name' => 'Description',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板描述信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '查询慢日志起始时间。'."\n"
+ ."\n"
+ .'按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的到期时间。', 'type' => 'string', 'required' => true, 'example' => '2022-09-07T04:04:44Z'],
],
[
- 'name' => 'FirewallTemplateRule',
+ 'name' => 'EndTime',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '防火墙规则。',
- 'type' => 'array',
- 'items' => [
- 'description' => '防火墙规则。',
- 'type' => 'object',
- 'properties' => [
- 'FirewallTemplateRuleId' => [
- 'description' => '防火墙模板规则ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
- 'RuleProtocol' => [
- 'description' => '传输层协议。可能值：'."\n"
- ."\n"
- .'- TCP：TCP协议。'."\n"
- .'- UDP：UDP协议。'."\n"
- .'- TCP+UDP：TCP和UDP协议。'."\n"
- .'- ICMP：ICMP协议。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
- ."\n"
- .'> 如果您设置的是ICMP协议，端口只能为-1/-1。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.0.0.0/0',
- ],
- 'Remark' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '查询轻量数据库实例慢日志的截止时间。截止时间需要大于查询起始时间，且与查询开始时间间隔小于7天。'."\n"
+ ."\n"
+ .'按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的到期时间。', 'type' => 'string', 'required' => true, 'example' => '2022-09-08T04:04:44Z'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PageNumber' => ['description' => '轻量数据库实例慢日志列表的页码。'."\n"
+ ."\n"
+ .'起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。可能值：30~100。'."\n"
+ ."\n"
+ .'最大值：100。'."\n"
+ ."\n"
+ .'默认值：30。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'TotalCount' => ['description' => '轻量数据库服务实例慢日志的总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'PhysicalIORead' => ['description' => '逻辑读次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Engine' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'MySQL'],
+ 'SlowLogs' => [
+ 'description' => '慢日志信息集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '慢日志信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'HostAddress' => ['description' => '连接数据库的客户端名称及地址。', 'type' => 'string', 'example' => 'xxx[xxx] @ [1xx.xxx.xxx.xx]'],
+ 'QueryTimes' => ['description' => '执行时长，单位：秒（s）。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'SQLText' => ['description' => 'SQL命令详情。', 'type' => 'string', 'example' => 'select sleep(2)'],
+ 'QueryTimeMS' => ['description' => '执行时长。单位：毫秒（ms）。', 'type' => 'integer', 'format' => 'int64', 'example' => '2001'],
+ 'LockTimes' => ['description' => '锁定时长，单位：秒（s）。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'ExecutionStartTime' => ['description' => '执行开始时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的到期时间。', 'type' => 'string', 'example' => '2022-09-08T01:40:44Z'],
+ 'ReturnRowCounts' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'ParseRowCounts' => ['description' => '解析行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testDB'],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => '修改防火墙模板',
- 'description' => '修改防火墙模板不会影响已应用当前模板的实例规则。',
- ],
- 'DescribeFirewallTemplateApplyResults' => [
- 'summary' => '查询防火墙模板应用实例结果。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '查询轻量数据库慢日志明细信息',
+ 'description' => '您可以查询轻量数据库服务实例的慢日志明细，帮助您定位故障。'."\n"
+ ."\n"
+ .'> 慢日志明细保留天数为7天。',
+ 'changeSet' => [],
+ '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' => '[{"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":""}]',
+ ],
+ 'DescribeFirewallTemplateApplyResults' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5493,42 +4072,24 @@
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '219676',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'FirewallTemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => '防火墙模板ID。', 'type' => 'string', 'required' => false, 'example' => 'ft-bcf1a7hrdq717****'],
],
[
'name' => 'TaskId',
@@ -5537,12 +4098,7 @@
'schema' => [
'description' => '模板应用执行ID。',
'type' => 'array',
- 'items' => [
- 'description' => '模板应用执行ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aft-ikgt0bynitvs3****',
- ],
+ 'items' => ['description' => '模板应用执行ID。', 'type' => 'string', 'required' => false, 'example' => 'aft-ikgt0bynitvs3****'],
'required' => false,
'maxItems' => 100,
],
@@ -5550,24 +4106,12 @@
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙规则列表的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '防火墙规则列表的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。默认值：20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。默认值：20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
@@ -5575,26 +4119,10 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。默认值：20。',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'description' => '防火墙规则的总条数。',
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PageNumber' => ['description' => '分页查询时设置的每页行数。', 'type' => 'string', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。默认值：20。', 'type' => 'string', 'example' => '20'],
+ 'TotalCount' => ['description' => '防火墙规则的总条数。', 'type' => 'string', 'example' => '1'],
'data' => [
'description' => '返回结果。',
'type' => 'array',
@@ -5602,36 +4130,16 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '模板应用执行ID。',
- 'type' => 'string',
- 'example' => 'aft-ikgt0bynitvs3****',
- ],
- 'FirewallTemplateId' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- 'Status' => [
- 'description' => '防火墙模板应用到全部实例的状态。可能值：'."\n"
- ."\n"
- .'- Running：防火墙模板正在应用中。'."\n"
- .'- Failed：防火墙模板应用全部失败。'."\n"
- .'- Success：防火墙模板应用成功。'."\n"
- .'- PartFailed：防火墙模板应用部分失败，有部分实例应用失败。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'TotalCount' => [
- 'description' => '防火墙模板应用总数。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'FailedCount' => [
- 'description' => '防火墙模板应用失败总数。',
- 'type' => 'string',
- 'example' => '0',
- ],
+ 'TaskId' => ['description' => '模板应用执行ID。', 'type' => 'string', 'example' => 'aft-ikgt0bynitvs3****'],
+ 'FirewallTemplateId' => ['description' => '防火墙模板ID。', 'type' => 'string', 'example' => 'ft-bcf1a7hrdq717****'],
+ 'Status' => ['description' => '防火墙模板应用到全部实例的状态。可能值：'."\n"
+ ."\n"
+ .'- Running：防火墙模板正在应用中。'."\n"
+ .'- Failed：防火墙模板应用全部失败。'."\n"
+ .'- Success：防火墙模板应用成功。'."\n"
+ .'- PartFailed：防火墙模板应用部分失败，有部分实例应用失败。', 'type' => 'string', 'example' => 'Success'],
+ 'TotalCount' => ['description' => '防火墙模板应用总数。', 'type' => 'string', 'example' => '1'],
+ 'FailedCount' => ['description' => '防火墙模板应用失败总数。', 'type' => 'string', 'example' => '0'],
'InstanceApplyResults' => [
'description' => '防火墙模板应用结果。',
'type' => 'array',
@@ -5639,49 +4147,49 @@
'description' => '防火墙模板应用结果。',
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'example' => '33774babccc84003a2b1ad47e8001233',
- ],
- 'Status' => [
- 'description' => '防火墙模板应用到某个实例的状态。可能值：'."\n"
- ."\n"
- .'- Running：防火墙模板正在应用中。'."\n"
- .'- Failed：防火墙模板应用全部失败。'."\n"
- .'- Success：防火墙模板应用成功。'."\n"
- .'- PartFailed：防火墙模板应用部分失败，有部分实例应用失败。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
+ 'InstanceId' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'example' => '33774babccc84003a2b1ad47e8001233'],
+ 'Status' => ['description' => '防火墙模板应用到某个实例的状态。可能值：'."\n"
+ ."\n"
+ .'- Running：防火墙模板正在应用中。'."\n"
+ .'- Failed：防火墙模板应用全部失败。'."\n"
+ .'- Success：防火墙模板应用成功。'."\n"
+ .'- PartFailed：防火墙模板应用部分失败，有部分实例应用失败。', 'type' => 'string', 'example' => 'Success'],
],
],
],
- 'CreateTime' => [
- 'description' => '防火墙模板应用执行时间。',
- 'type' => 'string',
- 'example' => 'Tue May 14 11:53:07 CST 2024',
- ],
+ 'CreateTime' => ['description' => '防火墙模板应用执行时间。', 'type' => 'string', 'example' => 'Tue May 14 11:53:07 CST 2024'],
],
],
],
],
+ 'description' => '',
],
],
],
- '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' => '查询防火墙模板应用结果',
- ],
- 'DescribeFirewallTemplateRulesApplyResult' => [
- 'summary' => '查询防火墙模板规则应用结果信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'summary' => '查询防火墙模板应用实例结果。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeFirewallTemplateApplyResults',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', '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' => [],
@@ -5692,63 +4200,34 @@
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '219677',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
'name' => 'FirewallTemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => '防火墙模板ID。', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****'],
],
[
'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '模板应用执行ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aft-ikgt0bynitvs3****',
- ],
+ 'schema' => ['description' => '模板应用执行ID。', 'type' => 'string', 'required' => true, 'example' => 'aft-ikgt0bynitvs3****'],
],
],
'responses' => [
@@ -5756,11 +4235,7 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
'data' => [
'description' => '返回结果。',
'type' => 'array',
@@ -5768,166 +4243,192 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RuleProtocol' => [
- 'description' => '传输层协议。可能值：'."\n"
- ."\n"
- .'- TCP：TCP协议。'."\n"
- .'- UDP：UDP协议。'."\n"
- .'- TCP+UDP：TCP和UDP协议。'."\n"
- .'- ICMP：ICMP协议。',
- 'type' => 'string',
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
- ."\n"
- .'> 如果您设置的是ICMP协议，端口只能为-1/-1。',
- 'type' => 'string',
- 'example' => '8080',
- ],
- 'SourceCidrIp' => [
- 'description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。',
- 'type' => 'string',
- 'example' => '119.145.XX.XX',
- ],
- 'Remark' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Success' => [
- 'description' => '防火墙模板规则应用到实例的状态，可能值：'."\n"
- ."\n"
- .'- Pending：实例尚未开始绑定规则。'."\n"
- .'- Applying：实例正在绑定规则。'."\n"
- .'- Success：实例绑定规则成功。'."\n"
- .'- PartFailed：实例存在绑定失败的规则。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '防火墙模板规则应用失败时的错误码。',
- 'type' => 'string',
- 'example' => '500',
- ],
- 'ErrorInfo' => [
- 'description' => '防火墙模板规则应用失败时的错误信息。',
- 'type' => 'string',
- 'example' => 'An error occurred while processing your request.',
- ],
+ 'RuleProtocol' => ['description' => '传输层协议。可能值：'."\n"
+ ."\n"
+ .'- TCP：TCP协议。'."\n"
+ .'- UDP：UDP协议。'."\n"
+ .'- TCP+UDP：TCP和UDP协议。'."\n"
+ .'- ICMP：ICMP协议。', 'type' => 'string', 'example' => 'TCP'],
+ 'Port' => ['description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
+ ."\n"
+ .'> 如果您设置的是ICMP协议，端口只能为-1/-1。', 'type' => 'string', 'example' => '8080'],
+ 'SourceCidrIp' => ['description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。', 'type' => 'string', 'example' => '119.145.XX.XX'],
+ 'Remark' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'example' => 'test'],
+ 'Success' => ['description' => '防火墙模板规则应用到实例的状态，可能值：'."\n"
+ ."\n"
+ .'- Pending：实例尚未开始绑定规则。'."\n"
+ .'- Applying：实例正在绑定规则。'."\n"
+ .'- Success：实例绑定规则成功。'."\n"
+ .'- PartFailed：实例存在绑定失败的规则。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrorCode' => ['description' => '防火墙模板规则应用失败时的错误码。', 'type' => 'string', 'example' => '500'],
+ 'ErrorInfo' => ['description' => '防火墙模板规则应用失败时的错误信息。', 'type' => 'string', 'example' => 'An error occurred while processing your request.'],
],
],
],
],
+ 'description' => '',
],
],
],
- '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' => '查询防火墙模板规则应用结果',
- ],
- 'DeleteFirewallTemplateRules' => [
- 'summary' => '对于已创建的防火墙模板，您可以根据业务需求删除防火墙规则。',
- 'methods' => [
- 'post',
- 'get',
+ 'summary' => '查询防火墙模板规则应用结果信息。',
+ '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' => [
+ '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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'FirewallTemplateId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
+ 'description' => '防火墙模板ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '防火墙模板ID。', 'type' => 'string', 'required' => false, 'example' => 'ft-bcf1a7hrdq717****'],
'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'FirewallTemplateId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
+ 'schema' => ['description' => '防火墙模板名称。', 'type' => 'string', 'required' => false, 'example' => 'testName'],
],
[
- 'name' => 'FirewallTemplateRuleId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '防火墙模板规则ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '防火墙模板规则ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '当前页码。'."\n"
+ ."\n"
+ .'起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时设置的每页行数。默认值：20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'TotalCount' => ['description' => '防火墙模板总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '当前页码。'."\n"
+ ."\n"
+ .'起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。默认值：20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'FirewallTemplates' => [
+ 'description' => '防火墙模板信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '防火墙模板信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'FirewallTemplateId' => ['description' => '防火墙模板ID。', 'type' => 'string', 'example' => 'ft-bcf1a7hrdq717****'],
+ 'CreationTime' => ['description' => '防火墙模板创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2024-04-10T02:10:14Z'],
+ 'Name' => ['description' => '防火墙模板名称。', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => '防火墙模板描述信息。', 'type' => 'string', 'example' => 'test'],
+ 'CreateTime' => ['description' => '防火墙模板创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的到期时间。', 'type' => 'string', 'example' => '2024-04-29T02:01:38Z'],
+ 'FirewallTemplateRules' => [
+ 'description' => '防火墙模板规则。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '防火墙模板规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'FirewallTemplateRuleId' => ['description' => '防火墙模板规则ID。', 'type' => 'string', 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****'],
+ 'RuleProtocol' => ['description' => '传输层协议。可能值：'."\n"
+ ."\n"
+ .'- TCP：TCP协议。'."\n"
+ .'- UDP：UDP协议。'."\n"
+ .'- TCP+UDP：TCP和UDP协议。'."\n"
+ .'- ICMP：ICMP协议。', 'type' => 'string', 'example' => 'TCP'],
+ 'Port' => ['description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
+ ."\n"
+ .'> 如果您设置的是ICMP协议，端口只能为-1/-1。', 'type' => 'string', 'example' => '8080'],
+ 'SourceCidrIp' => ['description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。', 'type' => 'string', 'example' => '119.145.XX.XX'],
+ 'Remark' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'example' => 'test'],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => '删除防火墙模板规则',
- 'description' => '删除防火墙模板规则不会影响已应用当前模板的实例规则。',
- ],
- 'DeleteFirewallTemplates' => [
- 'summary' => '删除已创建的防火墙模板。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '查询防火墙模板',
+ 'summary' => '查询防火墙模板的信息。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeFirewallTemplates',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'DescribeInstanceKeyPair' => [
+ 'summary' => '查询轻量应用服务器的密钥对信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5935,51 +4436,23 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '219657',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'FirewallTemplateId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '防火墙模板ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ft-bcf1a7hrdq717****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
],
'responses' => [
@@ -5987,29 +4460,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'KeyPairName' => ['description' => '密钥对名称。', 'type' => 'string', 'example' => 'KeyPairName'],
+ 'Fingerprint' => ['description' => '密钥对指纹。', 'type' => 'string', 'example' => '4f:70:62:e9:0c:72:f7:ee:74:ce:e3:bf:e0:82:**:**'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\"\\n}","type":"json"}]',
- 'title' => '删除防火墙模板',
- 'description' => '删除防火墙模板不会影响已设置轻量应用服务器实例的防火墙规则，如果您不再需要防火墙模板，可以选择删除。',
- ],
- 'DeleteFirewallRules' => [
- 'summary' => '删除指定轻量应用服务器的多条防火墙规则。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '查询实例密钥对信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceKeyPair'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => [],
@@ -6018,60 +4506,27 @@
'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' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~2361076~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'RuleIds',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'description' => '要删除的防火墙规则ID的列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '防火墙规则ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
],
'responses' => [
@@ -6079,67 +4534,46 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4****'],
+ 'VncPasswordSetting' => ['description' => '是否设置过vnc密码。', 'type' => 'boolean', 'example' => 'true'],
+ 'InstancePasswordSetting' => ['description' => '是否设置过轻量应用服务器密码。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'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' => '查询实例是否设置过密码',
+ 'summary' => '查询轻量应用服务器是否设置过密码。',
+ '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' => '批量删除实例防火墙规则',
- 'description' => '删除指定轻量应用服务器的防火墙规则后，可能导致业务无法访问，请您确保轻量应用服务器实例不再需要该防火墙规则后删除。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\",\\n \\"VncPasswordSetting\\": true,\\n \\"InstancePasswordSetting\\": true\\n}","type":"json"}]',
],
- 'CreateFirewallRule' => [
- 'summary' => '为指定的轻量应用服务器创建一条防火墙规则。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeInstanceVncUrl' => [
+ 'summary' => '获取指定轻量应用服务器的VNC连接地址。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6147,84 +4581,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '20456',
- 'abilityTreeNodes' => [
- 'FEATUREswasTHKH01',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器所属的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
- ],
- [
- 'name' => 'RuleProtocol',
- 'in' => 'query',
- 'schema' => [
- 'description' => '传输层协议。取值范围：'."\n"
- ."\n"
- .'- TCP：TCP协议。'."\n"
- .'- UDP：UDP协议。'."\n"
- .'- TCP+UDP：TCP和UDP协议。'."\n"
- .'- ICMP: ICMP协议。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'TCP',
- ],
- ],
- [
- 'name' => 'Port',
- 'in' => 'query',
- 'schema' => [
- 'description' => '端口范围。'."\n"
- .'- TCP/UDP: 端口的取值范围：1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：1024/1055表示端口范围1024~1055。'."\n"
- .'- ICMP: -1/-1。代表全部端口。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '3306/3306',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'Remark',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TEST',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => '2ad1ae67295445f598017499dc****'],
],
],
'responses' => [
@@ -6232,522 +4604,309 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'FirewallId' => [
- 'description' => '防火墙规则ID。',
- 'type' => 'string',
- 'example' => '8007e18c61024aafbd776d52d0****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'VncUrl' => ['description' => 'VNC登录链接。', 'type' => 'string', 'example' => 'wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3Dwz3L8wEMO6KMt7%252FXInEMtKVubBB%252F7rv055kOm8eUOD%252*****YlmsKjOfz6'],
],
+ 'description' => '',
],
],
],
'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' => '获取实例VNC连接地址',
+ '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' => '创建实例的防火墙规则',
- 'description' => '防火墙可以控制轻量应用服务器的网络访问，用于在云端划分安全域。每台轻量应用服务器的防火墙默认放行了22端口（SSH服务）、80端口（HTTP服务）以及443端口（HTTPS加密访问服务），除默认放行的端口，其他端口默认是禁用状态。您可以通过添加防火墙规则来放行更多端口。',
+ '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' => '为指定的轻量应用服务器批量创建防火墙规则。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeInvocationResult' => [
+ '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' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '客户端token。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
- ],
- [
- 'name' => 'FirewallRules',
+ 'name' => 'InvokeId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '由防火墙规则信息组成的数组。',
- 'type' => 'array',
- 'items' => [
- 'description' => '由防火墙规则信息组成的数组。',
- 'type' => 'object',
- 'properties' => [
- 'RuleProtocol' => [
- 'description' => '传输层协议。可能值：'."\n"
- ."\n"
- .'- TCP：TCP协议。'."\n"
- .'- UDP：UDP协议。'."\n"
- .'- TCP+UDP：TCP和UDP协议。'."\n"
- .'- ICMP: ICMP协议。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TCP',
- ],
- 'Port' => [
- 'description' => '端口号。'."\n"
- .'- TCP/UDP：取值范围为 1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
- .'- ICMP：-1/-1。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3306',
- ],
- 'SourceCidrIp' => [
- 'description' => '地址或地址段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '47.101.XX.XX',
- ],
- 'Remark' => [
- 'description' => '备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自定义的防火墙规则',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '命令执行ID。您可以通过接口[DescribeInvocations](~~439368~~)查询InvokeId。', 'type' => 'string', 'required' => true, 'example' => 't-bj02prjhw1n****'],
],
[
- 'name' => 'Tag',
+ 'name' => 'RegionId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '标签列表，最多包含20个子项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '为防火墙规则指定的标签键。N 的取值范围：1~20'."\n"
- ."\n"
- .'一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '为防火墙规则指定的标签值。N 的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[DescribeRegions](~~25609~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'FirewallRuleIds' => [
- 'description' => '防火墙规则ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '防火墙规则ID。',
- 'type' => 'string',
- 'example' => '1a16263ab0f541288312a15fa64280de',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'InvocationResult' => [
+ 'description' => '命令执行结果信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'StartTime' => ['description' => '命令在实例中开始执行的时间。', 'type' => 'string', 'example' => '2022-07-11T06:37:16Z'],
+ 'FinishedTime' => ['description' => '命令在实例中执行完成时间。', 'type' => 'string', 'example' => '2022-07-11T06:37:17Z'],
+ 'InvocationStatus' => ['description' => '实例的命令进度状态，可能值：'."\n"
+ ."\n"
+ .'- Pending：系统正在校验或发送命令。'."\n"
+ .'- Invalid：指定命令类型或参数有误。'."\n"
+ .'- Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成。'."\n"
+ .'- Running：命令正在实例上执行。'."\n"
+ .'- Success：命令执行完成，且退出码为0。'."\n"
+ .'- Failed：命令执行完成，且退出码非0。'."\n"
+ .'- Error：命令执行时发生异常无法继续。'."\n"
+ .'- Timeout：命令执行超时。'."\n"
+ .'- Cancelled：命令的执行动作已经取消，命令未曾启动。'."\n"
+ .'- Stopping：正在停止执行的命令。'."\n"
+ .'- Terminated：命令执行时被终止。', 'type' => 'string', 'example' => 'Success'],
+ 'ExitCode' => ['description' => '命令的退出码。'."\n"
+ ."\n"
+ .'- Linux实例为Shell命令的退出码。'."\n"
+ .'- Windows实例为Bat或者PowerShell命令的退出码。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'ErrorInfo' => ['description' => '命令的下发失败或执行失败原因的详情，可能值：'."\n"
+ ."\n"
+ .'- 空：命令执行正常。'."\n"
+ .'- the specified instance does not exists：指定的实例不存在或已释放。'."\n"
+ .'- the instance has released when create task：执行命令期间，该实例被释放。'."\n"
+ .'- the instance is not running when create task：命令执行时，该实例不在运行中。'."\n"
+ .'- the command is not applicable：命令不适用于指定的实例。'."\n"
+ .'- the specified account does not exists：指定的账号不存在。'."\n"
+ .'- the specified directory does not exists：指定的目录不存在。'."\n"
+ .'- the cron job expression is invalid：指定的周期表达式不合法。'."\n"
+ .'- the aliyun service is not running on the instance：云助手客户端未运行。'."\n"
+ .'- the aliyun service in the instance does not response：云助手客户端无响应。'."\n"
+ .'- the aliyun service in the instance is upgrading now：云助手客户端正在升级中。'."\n"
+ .'- the aliyun service in the instance need upgrade：云助手客户端需要升级。'."\n"
+ .'- the command delivery has been timeout：发送命令超时。'."\n"
+ .'- the command execution has been timeout：命令执行超时。'."\n"
+ .'- the command execution got an exception：命令执行发生异常。'."\n"
+ .'- the command execution has been interrupted：命令执行被中断。'."\n"
+ .'- the command execution exit code is not zero：命令执行结束，退出码非0。', 'type' => 'string', 'example' => 'the specified instance does not exists'],
+ 'ErrorCode' => ['description' => '命令的下发失败或执行失败原因的代码，可能值：'."\n"
+ ."\n"
+ .'- 空：命令执行正常。'."\n"
+ .'- InstanceNotExists：指定的实例不存在或已释放。'."\n"
+ .'- InstanceReleased：执行命令期间，该实例被释放。'."\n"
+ .'- InstanceNotRunning：命令执行时，该实例不在运行中。'."\n"
+ .'- CommandNotApplicable：命令不适用于指定的实例。'."\n"
+ .'- AccountNotExists：指定的账号不存在。'."\n"
+ .'- DirectoryNotExists：指定的目录不存在。'."\n"
+ .'- BadCronExpression：指定的周期表达式不合法。'."\n"
+ .'- ClientNotRunning：云助手客户端未运行。'."\n"
+ .'- ClientNotResponse：云助手客户端无响应。'."\n"
+ .'- ClientIsUpgrading：云助手客户端正在升级中。'."\n"
+ .'- ClientNeedUpgrade：云助手客户端需要升级。'."\n"
+ .'- DeliveryTimeout：发送命令超时。'."\n"
+ .'- ExecutionTimeout：命令执行超时。'."\n"
+ .'- ExecutionException：命令执行发生异常。'."\n"
+ .'- ExecutionInterrupted：命令执行被中断。'."\n"
+ .'- ExitCodeNonzero：命令执行结束，退出码非0。', 'type' => 'string', 'example' => 'InstanceNotExists'],
+ 'InvokeId' => ['description' => '命令执行ID。', 'type' => 'string', 'example' => 't-bj02prjje65****'],
+ 'InvokeRecordStatus' => ['description' => '命令执行状态。可能值：'."\n"
+ ."\n"
+ .'- Running：运行中。'."\n"
+ .'- Finished：已完成。'."\n"
+ .'- Failed：失败。'."\n"
+ .'- Stopped：已停止。', 'type' => 'string', 'example' => 'Finished'],
+ 'InvokeUser' => ['description' => '在轻量应用服务器实例中执行命令的用户名称。', 'type' => 'string', 'example' => 'root'],
+ 'Output' => ['description' => '命令执行后的输出信息。', 'type' => 'string', 'example' => 'YWRtaW4K'],
+ 'InstanceId' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'example' => 'ace0706b2ac4454d984295a94213****'],
],
],
],
],
],
],
- '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',
- ],
+ 'title' => '查询单个命令的执行结果',
+ 'summary' => '查询单个命令的执行结果。',
+ 'description' => '- 当您执行命令后，不代表命令一定成功执行，并且一定有预期的命令效果。您需要通过本接口查看实际的具体执行结果，以实际输出结果为准。'."\n"
+ .'- 您可以查询最近2周的执行信息，执行信息的保留上限为10万条。',
+ 'changeSet' => [],
+ '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' => '批量创建实例的防火墙规则',
- 'description' => '防火墙可以控制轻量应用服务器的网络访问，用于在云端划分安全域。每台轻量应用服务器的防火墙默认放行了22端口（SSH服务）、80端口（HTTP服务）以及443端口（HTTPS加密访问服务），除默认放行的端口，其他端口默认是禁用状态。您可以通过添加防火墙规则来放行更多端口。',
+ '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":""}]',
],
- 'ListFirewallRules' => [
- 'summary' => '查询指定轻量应用服务器的防火墙规则。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeInvocations' => [
+ 'summary' => '查看命令详细信息。',
+ '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' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器所属的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。'."\n"
- ."\n"
- .'最大值：100。'."\n"
- ."\n"
- .'默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => '轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => '3a658ca270df4df39f22e289b338****'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙规则列表的页码。'."\n"
- ."\n"
- .'起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '当前页码。'."\n"
+ ."\n"
+ .'起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Tag',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '防火墙规则的标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '防火墙规则的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '防火墙规则的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。'."\n"
+ ."\n"
+ .'最大值：50。'."\n"
+ ."\n"
+ .' 默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'FirewallRuleId',
+ 'name' => 'InvokeStatus',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙规则ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1a16263ab0f541288312a15fa64280de',
- ],
+ 'schema' => ['description' => '命令运行状态。可能值：'."\n"
+ .'- Running：命令运行中。'."\n"
+ .'- Finished：命令执行完成'."\n"
+ .'- Failed：命令运行失败。', 'type' => 'string', 'required' => false, 'example' => 'Finished'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '防火墙规则的总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '防火墙规则列表的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'FirewallRules' => [
- 'description' => '由防火墙规则信息组成的数组。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'Invocations' => [
+ 'description' => '命令执行记录。',
'type' => 'array',
'items' => [
+ 'description' => '命令执行记录。',
'type' => 'object',
'properties' => [
- 'Remark' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'example' => 'test-MySQL服务器默认端口',
- ],
- 'Port' => [
- 'description' => '端口范围。',
- 'type' => 'string',
- 'example' => '3306',
- ],
- 'RuleId' => [
- 'description' => '防火墙规则ID。',
- 'type' => 'string',
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
- 'RuleProtocol' => [
- 'description' => '传输层协议。可能值：'."\n"
- ."\n"
- .'- TCP：TCP协议。'."\n"
- .'- UDP：UDP协议。'."\n"
- .'- TCP+UDP：TCP和UDP协议。',
- 'type' => 'string',
- 'example' => 'TCP',
- ],
- 'Policy' => [
- 'description' => '防火墙策略。'."\n"
- ."\n"
- .'- accept：允许。'."\n"
- ."\n"
- .'- drop：拒绝。',
- 'type' => 'string',
- 'example' => 'accept',
- ],
- 'Tags' => [
- 'description' => '防火墙规则的标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '防火墙规则的标签键。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '防火墙规则的标签值。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- ],
- ],
- ],
- 'SourceCidrIp' => [
- 'description' => '源IP段。',
- 'type' => 'string',
- 'example' => '0.0.0.0/0',
- ],
+ 'CreationTime' => ['description' => '命令创建时间。', 'type' => 'string', 'example' => '2022-07-11T06:37:16Z'],
+ 'InvocationStatus' => ['description' => '命令执行的状态。可能值：'."\n"
+ ."\n"
+ .'- Pending：系统正在校验或发送命令。'."\n"
+ .'- Invalid：指定命令类型或参数有误。'."\n"
+ .'- Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成。'."\n"
+ .'- Running：命令正在实例上执行。'."\n"
+ .'- Success：命令执行完成，且退出码为0。'."\n"
+ .'- Failed：命令执行完成，且退出码非0。'."\n"
+ .'- Error：命令执行时发生异常无法继续。'."\n"
+ .'- Timeout：命令执行超时。'."\n"
+ .'- Cancelled：命令的执行动作已经取消，命令未曾启动。'."\n"
+ .'- Stopping：正在停止执行的命令。'."\n"
+ .'- Terminated：命令执行时被终止。', 'type' => 'string', 'example' => 'Success'],
+ 'CommandType' => ['description' => '命令类型。可能值：'."\n"
+ ."\n"
+ .'- RunBatScript：适用于Windows实例的Bat命令。'."\n"
+ .'- RunPowerShellScript：适用于Windows实例的PowerShell命令。'."\n"
+ .'- RunShellScript：适用于Linux实例Shell命令。', 'type' => 'string', 'example' => 'RunShellScript'],
+ 'CommandContent' => ['description' => '命令内容,，以Base64编码后传输。', 'type' => 'string', 'example' => 'bHM='],
+ 'Parameters' => ['description' => '命令中包含自定义参数。如果没有参数，默认为{}.', 'type' => 'object', 'example' => '{}'],
+ 'InvokeStatus' => ['description' => '命令状态。可能值：'."\n"
+ ."\n"
+ .'- Running：命令运行中。'."\n"
+ .'- Finished：命令执行完成。'."\n"
+ .'- Failed：命令执行失败。'."\n"
+ .'- Stopped：停止命令。', 'type' => 'string', 'example' => 'Finished'],
+ 'InvokeId' => ['description' => '命令执行ID。', 'type' => 'string', 'example' => 't-hz02p9545t6****'],
+ 'CommandName' => ['description' => '命令名称。', 'type' => 'string', 'example' => 'testname'],
],
],
],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalCount' => ['description' => '命令总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RegionIdNotMatchHost',
- 'errorMessage' => 'The parameter regionId does not match the endpoint host.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'InvalidParam',
- 'errorMessage' => 'The specified parameter value is invalid.',
- ],
+ 'title' => '查看命令详细信息',
+ 'description' => '- 当您执行命令后，不代表命令一定成功运行，并且一定有预期的命令效果。您需要通过接口返回值查看实际执行结果，以实际输出结果为准。'."\n"
+ .'- 您可以查询最近2周的执行信息，执行信息的保留上限为10万条。',
+ 'changeSet' => [],
+ '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' => '获取实例的防火墙规则',
- 'description' => '可您以通过此接口，查询指定轻量应用服务器的防火墙规则信息，包括端口范围、防火墙规则ID、传输层协议等信息。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ '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":""}]',
],
- 'ModifyFirewallRule' => [
- 'summary' => '修改指定轻量应用服务器的防火墙规则。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeMonitorData' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6755,96 +4914,76 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => '2ad1ae67295445f598017499dc****'],
],
[
- 'name' => 'RuleId',
+ 'name' => 'MetricName',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙规则ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
+ 'schema' => ['description' => '监控指标名称。可能值：'."\n"
+ ."\n"
+ .'- MEMORY_ACTUALUSEDSPACE：内存实际使用大小，单位bytes。'."\n"
+ .'- DISKUSAGE_USED：磁盘使用大小，单位bytes。'."\n"
+ .'- CPU_UTILIZATION：cpu使用率，百分比。'."\n"
+ .'- VPC_PUBLICIP_INTERNETOUT_RATE：网络出带宽速率，单位bits/s。'."\n"
+ .'- VPC_PUBLICIP_INTERNETIN_RATE：网络入带宽速率，单位bits/s。'."\n"
+ .'- DISK_READ_IOPS：磁盘读iops，单位：count/s。'."\n"
+ .'- DISK_WRITE_IOPS：磁盘写iops，单位：count/s。'."\n"
+ .'- FLOW_USED：流量使用，单位bytes。', 'type' => 'string', 'required' => true, 'example' => 'DISKUSAGE_USED'],
],
[
- 'name' => 'RuleProtocol',
+ 'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '传输层协议。取值范围：'."\n"
- ."\n"
- .'- TCP：TCP协议。'."\n"
- .'- UDP：UDP协议。'."\n"
- .'- TCP+UDP：TCP和UDP协议。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TCP',
- ],
+ 'schema' => ['description' => '时间间隔。'."\n"
+ .'取值：60、300、900。'."\n"
+ .'单位：秒。'."\n"
+ .'> 当Metricname为FLOW_USED时，Period值固定为3600s（即一小时），请根据您的实际需求设置该参数。', 'type' => 'string', 'required' => true, 'example' => '60'],
],
[
- 'name' => 'Port',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3306',
- ],
+ 'schema' => ['description' => '开始时间。支持的格式：'."\n"
+ ."\n"
+ .'- Unix时间戳：从1970年1月1日开始所经过的毫秒数。'."\n"
+ .'- Format格式：YYYY-MM-DDThh:mm:ssZ。'."\n"
+ ."\n"
+ .'> 开始和结束时间执行的是左开右闭的模式，StartTime不能等于或大于EndTime。'."\n"
+ .'StartTime和EndTime之间的间隔小于等于31天。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => '2022-09-07T04:04:44Z'],
],
[
- 'name' => 'SourceCidrIp',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '地址或地址段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.147.33.**',
- ],
+ 'schema' => ['description' => '结束时间。支持的格式：'."\n"
+ .'- Unix时间戳：从1970年1月1日开始所经过的毫秒数。'."\n"
+ .'- Format格式：YYYY-MM-DDThh:mm:ssZ。'."\n"
+ .'> StartTime和EndTime之间的间隔小于等于31天。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => '2022-09-08T08:04:44Z'],
],
[
- 'name' => 'Remark',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自定义',
- ],
+ 'schema' => ['description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值，初次调用无需配置。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***'],
+ ],
+ [
+ 'name' => 'Length',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页显示的记录条数，用于分页查询。取值范围：1~1440。', 'type' => 'string', 'required' => false, 'example' => '100'],
],
],
'responses' => [
@@ -6852,150 +4991,252 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'Datapoints' => ['description' => '监控数据列表。', 'type' => 'string', 'example' => '[]'],
+ 'Period' => ['description' => '时间间隔。'."\n"
+ .'取值：60、300、900。'."\n"
+ .'单位：秒。'."\n"
+ ."\n"
+ .'> 当Metricname为FLOW_USED时，Period值固定为3600s（即一小时），请根据您的实际需求设置该参数。', 'type' => 'string', 'example' => '60'],
+ 'NextToken' => ['description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值，初次调用无需配置。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***'."\n"],
],
+ 'description' => '',
],
],
],
'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' => '获取实例监控数据',
+ 'summary' => '获取实例监控信息（vCPU、内存、磁盘IO、流量）。',
+ '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' => '修改实例防火墙规则',
+ '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' => '开启指定轻量应用服务器的一条防火墙策略。',
- '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' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'CommodityType',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '资源类型，可选值：'."\n"
+ .'- Server。', 'type' => 'string', 'required' => true, 'example' => 'Server'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'PlanId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '套餐ID。您可以调用[ListPlans](~~189314~~)查询指定地域下的全部套餐信息。', 'type' => 'string', 'required' => true, 'example' => 'swas.s1.cxxxxxx3t05'],
],
[
- 'name' => 'RuleId',
+ 'name' => 'DataDiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙规则ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
+ 'schema' => ['description' => '挂载的数据盘容量大小。单位：GB。取值范围：0~16380，取值必须是20的整数倍。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '16380', 'minimum' => '20', 'example' => '20'],
],
[
- 'name' => 'Remark',
+ 'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自定义',
- ],
+ 'schema' => ['description' => '计费时长。取值范围：'."\n"
+ .'- 当参数 PriceUnit 取值为 Month 时：1~9。'."\n"
+ .'- 当参数 PriceUnit 取值为 Year 时：1~5。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'SourceCidrIp',
+ 'name' => 'PriceUnit',
'in' => 'query',
+ 'schema' => ['description' => '取值范围：'."\n"
+ .'- Month：按月计费的价格单位。'."\n"
+ .'- Year：按年计费的价格单位。'."\n"
+ ."\n"
+ .'默认值：Month。', 'type' => 'string', 'required' => false, 'example' => 'Month', 'default' => 'Month'],
+ ],
+ [
+ 'name' => 'Amount',
+ 'in' => 'query',
+ 'schema' => ['description' => '创建轻量应用服务器的数量。取值范围：1~20'."\n"
+ ."\n"
+ .'默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'PayType',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例的付费类型，取值：'."\n"
+ .'- Prepaid：预付费（包年包月）'."\n"
+ ."\n"
+ .'示例值:Prepaid。', 'type' => 'string', 'required' => false, 'example' => 'Prepaid', 'default' => 'Prepaid'],
+ ],
+ [
+ 'name' => 'PromotionOptions',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '地址或地址段。',
- 'type' => 'string',
+ 'description' => '优惠选项信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CouponNo' => ['description' => '优惠券编码。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'ActivityId' => ['type' => 'string'],
+ ],
'required' => false,
- 'example' => '10.147.33.**',
],
],
+ [
+ 'name' => 'OrderType',
+ 'in' => 'query',
+ 'schema' => ['description' => '订单类型：'."\n"
+ .'- Buy'."\n"
+ ."\n"
+ .'默认值：Buy。', 'type' => 'string', 'required' => false, 'example' => 'UPLOAD'],
+ ],
+ [
+ 'name' => 'AcceptLanguage',
+ 'in' => 'query',
+ 'schema' => ['description' => '返回值语言，取值：'."\n"
+ ."\n"
+ .'- **zh-CN**（默认值）：中文。'."\n"
+ ."\n"
+ .'- **en-US**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PriceInfo' => [
+ 'description' => '价格详细信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Rules' => [
+ 'description' => '活动规则信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '活动规则信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => '自定义参数描述。', 'type' => 'string', 'example' => '买满一年，立享官网价格xxx折扣优惠。'],
+ 'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '142'],
+ ],
+ ],
+ ],
+ 'Price' => [
+ 'description' => '价格信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalPrice' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '1580'],
+ 'DiscountPrice' => ['description' => '折减的价格。', 'type' => 'number', 'format' => 'float', 'example' => '0.0'],
+ 'StandardPrice' => ['description' => '官网折扣价or直销合同折扣价。', 'type' => 'number', 'format' => 'float', 'example' => '899'],
+ 'StandardDiscountPrice' => ['description' => '基于官网折扣的优惠价格。', 'type' => 'number', 'format' => 'float', 'example' => '85'],
+ 'IsContractPromotion' => ['description' => '是否命中优惠。', 'type' => 'boolean'],
+ 'Currency' => ['description' => '价格单位。可能值：'."\n"
+ ."\n"
+ .'- CNY：元'."\n"
+ .'- USD：美元', 'type' => 'string', 'example' => 'CNY'],
+ 'TradePrice' => ['description' => '交易价格。', 'type' => 'number', 'format' => 'float', 'example' => '267.4'],
+ 'DetailInfos' => [
+ 'description' => '配置明细价格信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配置明细价格信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalPrice' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '1850'],
+ 'DiscountPrice' => ['description' => '折扣价。', 'type' => 'number', 'format' => 'float', 'example' => '0.0'],
+ 'CommodityType' => ['description' => '资源名称。', 'type' => 'string', 'example' => 'Server'],
+ 'TradePrice' => ['description' => '成交价。', 'type' => 'number', 'format' => 'float', 'example' => '267.4'],
+ 'Promotions' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['type' => 'string'],
+ 'DiscountOff' => ['type' => 'number', 'format' => 'float'],
+ 'RuleId' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Coupons' => [
+ 'description' => '是否选中该优惠券。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券编号',
+ 'type' => 'object',
+ 'properties' => [
+ 'IsSelected' => ['description' => '是否选中该优惠券。', 'type' => 'boolean'],
+ 'CouponNo' => ['description' => '优惠码，默认值为：`youhuiquan_promotion_option_id_for_blank`。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'Description' => ['description' => '自定义参数描述。', 'type' => 'string', 'example' => 'OK'],
+ 'DiscountOff' => ['description' => '折扣、优惠。', 'type' => 'number', 'format' => 'float', 'example' => '20.0'],
+ 'OptionCode' => ['description' => '优惠id。', 'type' => 'string', 'example' => '*****'],
+ 'Name' => ['description' => '命令名称。', 'type' => 'string', 'example' => 'ACS-SWAS-GenerateRsaKeypair-windows.ps1'],
+ ],
+ ],
+ ],
+ 'Promotions' => [
+ 'description' => '促销活动信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '促销活动信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'ACS-SWAS-ResetPassword-for-linux.sh'],
+ 'DiscountOff' => ['description' => '优惠券优惠金额。', 'type' => 'number', 'format' => 'float', 'example' => '20.0'],
+ 'RuleIds' => [
+ 'description' => '优惠ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '优惠ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'a7c77d3b3e6d458996410c650ef38326'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
],
@@ -7003,55 +5244,110 @@
],
'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' => '售卖系统出现错误。'],
],
- 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' => '询价',
+ 'summary' => '获取轻量产品价格信息',
+ 'description' => '- 当您执行命令后，不代表命令一定成功运行，并且一定有预期的命令效果。您需要通过接口返回值查看实际执行结果，以实际输出结果为准。'."\n"
+ .'- 您可以查询最近2周的执行信息，执行信息的保留上限为10万条。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', '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\\": true,\\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\\": true,\\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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
+ ],
[
- [
- 'errorCode' => 'InvalidInstanceId.NotFound',
- 'errorMessage' => 'The specified InstanceId does not exist.',
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'ClientStatus' => ['description' => 'Agent客户端状态。取值：'."\n"
+ ."\n"
+ .'- pause：暂停保护'."\n"
+ .'- online：保护中'."\n"
+ .'- offline：未受保护', 'type' => 'string', 'example' => 'online'],
+ ],
+ 'description' => '',
],
],
+ ],
+ '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' => '开启实例防火墙规则',
- ],
- 'DisableFirewallRule' => [
- 'summary' => '禁用指定轻量应用服务器的一条防火墙策略。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '查询安全中心Agent插件状态',
+ 'summary' => '查询指定轻量应用服务器的安全中心Agent插件状态。',
+ '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' => '解绑轻量应用服务器的密钥对。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7061,60 +5357,36 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
+ 'abilityTreeCode' => '219077',
+ 'abilityTreeNodes' => ['FEATUREswas9IJLCU'],
],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'RuleId',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '防火墙规则ID。您可以通过调用ListFirewallRules接口获取防火墙规则ID。',
- 'type' => 'string',
+ 'description' => '解绑SSH密钥对的实例ID。最多支持50个实例ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '解绑SSH密钥对的实例ID。最多支持50个实例ID。', 'type' => 'string', 'required' => false, 'example' => '2ad1ae67295445f598017499dc****'],
'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'Remark',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙规则的备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自定义',
- ],
+ 'schema' => ['description' => '密钥对名称。必须保持名称唯一性。 长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以 http:// 和 https:// 开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => true, 'example' => 'KeyPairName'],
],
],
'responses' => [
@@ -7122,66 +5394,67 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'TotalCount' => ['description' => '解绑密钥对的实例总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FailCount' => ['description' => '绑定密钥对失败的实例总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Results' => [
+ 'title' => '结果列表',
+ 'description' => '结果列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '解绑密钥对成功或失败的结果集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '结果码', 'description' => '结果码。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '结果信息', 'description' => '结果信息。', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['title' => '是否成功', 'description' => '密钥对解绑是否成功。可能值：'."\n"
+ ."\n"
+ .'- true：密钥对解绑成功。'."\n"
+ ."\n"
+ .'- false：密钥对解绑失败。', 'type' => 'string', 'example' => 'true'],
+ 'InstanceId' => ['title' => '实例id', 'description' => '轻量应用服务器实例ID。', 'type' => 'string', 'example' => 'aa6e71ddb35c46679bc4753d6219d604'],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
'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' => '指定的实例Id不存在'],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '解绑密钥对',
+ 'description' => '如果您需要更换密钥对或者某个用户不再需要访问特定实例，您可以解绑SSH密钥对，以提高实例的安全性或限制访问权限。',
+ 'changeSet' => [],
+ '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' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\"\\n}","type":"json"}]',
- 'title' => '禁用实例防火墙规则',
+ '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' => '删除指定轻量应用服务器的一条防火墙规则。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DisableFirewallRule' => [
+ 'summary' => '禁用指定轻量应用服务器的一条防火墙策略。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7189,51 +5462,33 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
'name' => 'RuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '防火墙规则ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****',
- ],
+ 'schema' => ['description' => '防火墙规则ID。您可以通过调用ListFirewallRules接口获取防火墙规则ID。', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'required' => false, 'example' => 'Custom'],
],
],
'responses' => [
@@ -7241,70 +5496,55 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F '],
],
+ 'description' => '',
],
],
],
'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' => '传入的regionId和请求的地址不匹配。'],
],
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' => '指定的实例不存在，请您检查实例ID是否正确。'],
],
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' => '删除实例防火墙规则',
- 'description' => '删除指定轻量应用服务器的防火墙规则后，可能导致业务无法访问，请您确保轻量应用服务器实例不再需要该防火墙规则后删除。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CreateSnapshot' => [
- 'summary' => '为指定的磁盘创建快照。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\\\t\\"\\n}","type":"json"}]',
+ 'title' => '禁用实例防火墙规则',
+ '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}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'EnableFirewallRule' => [
+ 'summary' => '开启指定轻量应用服务器的一条防火墙策略。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7312,100 +5552,38 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '20458',
- 'abilityTreeNodes' => [
- 'FEATUREswasHVUGWX',
- ],
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定磁盘对应的轻量应用服务器所属的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2ad1ae67295445f598017499dc****'],
],
[
- 'name' => 'DiskId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的磁盘ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'd-bp18kjxg9ebrhsgi****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'SnapshotName',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '快照名称。长度为2~50个字符，必须以大小字母或中文开头，不能以`http://`和`https://`开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、点号（.）或者短划线（-）。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-SnapshotName',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'RuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '防火墙规则ID。', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****'],
],
[
- 'name' => 'Tag',
+ 'name' => 'Remark',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '标签列表，最多包含20个子项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '为快照指定的标签键。N 的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '为快照指定的标签值。N 的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'required' => false, 'example' => 'Custom'],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'SourceCidrIp',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => '地址或地址段。', 'type' => 'string', 'required' => false, 'example' => '10.147.33.**'],
],
],
'responses' => [
@@ -7413,228 +5591,92 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'SnapshotId' => [
- 'description' => '快照ID。',
- 'type' => 'string',
- 'example' => 's-bp16oazlsold4dks****',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
],
+ 'description' => '',
],
],
],
'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' => '传入的regionId和请求的地址不匹配。'],
],
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' => '指定的实例不存在，请您检查实例ID是否正确。'],
],
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' => '创建快照',
- 'description' => '快照是某一时间点磁盘数据状态的备份文件，常用于日常数据备份、服务器数据误操作恢复、网络攻击恢复、制作自定义镜像等场景。'."\n"
- ."\n"
- .'> 轻量应用服务器创建快照不收取任何费用。'."\n"
- ."\n"
- .'### 注意事项'."\n"
- ."\n"
- .'- 单台轻量应用服务器最多可创建3个快照。'."\n"
- .'- 一个阿里云账号可创建的快照数量上限为已创建的轻量应用服务器数量的3倍，但最多不超过15个。'."\n"
- .'- 如果服务器到期释放，该服务器对应的快照会被清除。'."\n"
- .'- 重置系统或更换镜像前创建的快照，在重置系统或更换镜像后会保留但无法支持回滚操作。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListSnapshots' => [
- 'summary' => '查询一个或多个已创建的快照信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
+ 'title' => '开启实例防火墙规则',
+ '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}'],
+ ],
+ ],
+ ],
],
+ ],
+ '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' => '快照对应的轻量应用服务器所属的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- ],
- [
- 'name' => 'DiskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定的磁盘ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd-bp14wq0149cpp2xy****',
- ],
- ],
- [
- 'name' => 'SnapshotIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => '快照ID。取值可以由多个快照ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"]',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。最大值：100。'."\n"
- ."\n"
- .'默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '快照列表的页码。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'SourceDiskType',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '快照源云盘的云盘类型。取值范围：'."\n"
- .'- System：系统盘。'."\n"
- .'- Data：数据盘。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Data',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'Tag',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '快照的标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '快照的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '快照的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => true, 'example' => 'KeyPairName'],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'PublicKeyBody',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => '密钥对的公钥内容。', 'type' => 'string', 'required' => true, 'example' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****'],
],
],
'responses' => [
@@ -7642,180 +5684,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '快照的总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '快照列表的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Snapshots' => [
- 'description' => '快照信息组成的数组。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '快照状态。可能值：'."\n"
- ."\n"
- .'- Progressing：正在创建。'."\n"
- .'- Accomplished：创建成功。'."\n"
- .'- Failed：创建失败。',
- 'type' => 'string',
- 'example' => 'Accomplished',
- ],
- 'CreationTime' => [
- 'description' => '快照创建时间。时间格式以[ISO8601](~~25696~~)为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2021-03-09T07:12:49Z',
- ],
- 'SourceDiskId' => [
- 'description' => '源磁盘ID。即使快照的源磁盘已经被释放，仍保留该返回值。'."\n",
- 'type' => 'string',
- 'example' => 'd-bp14wq0149cpp2xy****',
- ],
- 'SnapshotName' => [
- 'description' => '快照名称。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'test-SnapshotName',
- ],
- 'Progress' => [
- 'description' => '快照创建的进度。',
- 'type' => 'string',
- 'example' => '100%',
- ],
- 'Remark' => [
- 'description' => '快照备注。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'test-Remark',
- ],
- 'SnapshotId' => [
- 'description' => '快照ID。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 's-bp16oazlsold4dks****',
- ],
- 'SourceDiskType' => [
- 'description' => '快照源磁盘的磁盘类型。可能值：'."\n"
- .'- System：系统盘。'."\n"
- .'- Data：数据盘。',
- 'type' => 'string',
- 'example' => 'System',
- ],
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'InstanceId' => [
- 'description' => '轻量应用服务器实例ID。'."\n"
- ."\n"
- .'注：系统盘快照该字段有值，数据盘快照该值为空。',
- 'type' => 'string',
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- 'Tags' => [
- 'description' => '快照的标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '快照的标签键。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '快照的标签值。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- ],
- ],
- ],
- 'RollbackTime' => [
- 'description' => '最近一次回滚时间。',
- 'type' => 'string',
- 'example' => '2021-03-09T07:12:49Z',
- ],
- 'ResourceGroupId' => [
- 'description' => '快照所属的资源组ID。',
- 'type' => 'string',
- 'example' => 'rg-aek2bti7cf7****',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'KeyPairName' => ['description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'example' => 'KeyPairName'],
],
+ 'description' => '',
],
],
],
'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' => '导入密钥对',
+ 'summary' => '导入已有密钥对。',
+ 'description' => '如果您已有密钥对，可以将已有密钥对导入控制台，便于使用已有密钥对登录轻量应用服务器。但已有密钥对必须为支持的加密方式，具体说明请参见[Q2：导入已有密钥对支持哪些加密方式？](~~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' => '全部资源', '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' => '获取快照',
- 'description' => '`InstanceId`、`DiskId`、`SnapshotIds`和`ResourceGroupId`不是必需的请求参数，但是可以构建过滤器逻辑，参数之间为逻辑与（And）关系。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\",\\n \\"KeyPairName\\": \\"KeyPairName\\"\\n}","type":"json"}]',
],
- 'UpdateSnapshotAttribute' => [
- 'summary' => '修改轻量应用服务器指定快照的备注信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'InstallCloudAssistant' => [
+ 'summary' => '为轻量应用服务器安装云助手。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7823,95 +5730,64 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'SnapshotId',
+ 'name' => 'InstanceIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '快照ID。您可以调用ListSnapshots接口查看快照ID。',
- 'type' => 'string',
+ 'description' => '轻量应用服务器实例ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ace0706b2ac4454d984295a94213****'],
'required' => true,
- 'docRequired' => true,
- 'example' => 's-bp16oazlsold4dks****',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
- ],
- [
- 'name' => 'Remark',
- 'in' => 'query',
- 'schema' => [
- 'description' => '备注信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
+ 'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
],
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidSnapshotId.NotFound',
- 'errorMessage' => 'The specified SnapshotId does not exist.',
- ],
+ 'title' => '安装云助手',
+ 'description' => '执行命令必须要安装云助手，您可以通过调用[DescribeCloudAssistantStatus](~~439512~~)查看轻量应用服务器是否已安装云助手。如果没有安装，您可以调用InstallCloudAssistant接口安装云助手，并调用[RebootInstance](~~190443~~)接口重启实例，云助手客户端即可生效。',
+ 'changeSet' => [],
+ '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' => '修改快照备注信息',
+ '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":""}]',
],
- 'DeleteSnapshot' => [
- 'summary' => '删除轻量应用服务器指定的快照。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'InstallCloudMonitorAgent' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7919,41 +5795,31 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'SnapshotId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '快照ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-bp16oazlsold4dks****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'required' => true, 'example' => '9ae7106e68eb4402b0dcbd48a9de****'],
+ ],
+ [
+ 'name' => 'Force',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否强制安装云监控插件。取值：'."\n"
+ ."\n"
+ .'- true（默认值）：强制安装。'."\n"
+ .'- false：不强制安装。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -7961,193 +5827,184 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4****'],
],
+ 'description' => '',
],
],
],
'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' => '删除快照',
- 'description' => '当您不再需要某一快照时，可以删除快照。'."\n"
- ."\n"
- .'> 如果快照有对应的自定义镜像，请先删除对应镜像后再删除快照。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteSnapshots' => [
- 'summary' => '删除一个或多个已创建的快照。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '安装云监控插件',
+ 'summary' => '为指定的轻量应用服务器安装云监控插件。',
+ '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' => [
+ '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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'SnapshotIds',
+ 'name' => 'CommandId',
'in' => 'query',
- 'schema' => [
- 'description' => '快照ID。取值可以由多个快照ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"]',
- ],
+ 'schema' => ['description' => '命令ID。您可以通过接口DescribeCommands查询所有可用的CommandId。', 'type' => 'string', 'required' => true, 'example' => 'c-sh02yh0932w****'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Parameters',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => '启用自定义参数功能时，执行命令时传入的自定义参数的键值对。'."\n"
+ ."\n"
+ .'- 自定义参数的个数范围为0~10。Map的键不允许为空字符串，最多支持64个字符。'."\n"
+ ."\n"
+ .'- Map的值允许为空字符串。自定义参数与原始命令内容在Base64编码后，综合长度不能超过18KB。'."\n"
+ ."\n"
+ .'- 设置的自定义参数名集合必须为创建命令时定义的参数集的子集。'."\n"
+ ."\n"
+ .'- 对于未传入的参数，您可以使用空字符串代替。您可以取消设置该参数从而禁用自定义参数。', 'type' => 'object', 'required' => false, 'example' => '{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}'],
+ ],
+ [
+ 'name' => 'Username',
+ 'in' => 'query',
+ 'schema' => ['description' => '在轻量应用服务器中执行命令的用户名称。长度不得超过255个字符。'."\n"
+ ."\n"
+ .'- Linux系统的轻量应用服务器，默认以root用户执行命令。'."\n"
+ ."\n"
+ .'- Windows系统的轻量应用服务器，默认以System用户执行命令。'."\n"
+ ."\n"
+ .'您可以修改Linux系统执行用户，Windows系统执行用户不支持修改。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'InstanceIds',
+ 'in' => 'query',
+ 'schema' => ['description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持50个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'InvokeId' => ['description' => '命令执行ID。', 'type' => 'string', 'example' => 't-bj02prjhw1n****'],
],
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidSnapshotId.NotFound',
- 'errorMessage' => 'The specified SnapshotId does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request.',
+ 'title' => '执行命令',
+ 'summary' => '为一台或多台轻量应用服务器执行一条命令助手命令。',
+ 'description' => '- 对目标轻量应用服务器有如下限制，当您选择多台轻量应用服务器后，若其中某台轻量应用服务器不满足执行条件，需要重新调用该接口。 '."\n"
+ .' - 服务器状态必须为运行中（`Running`），您可以调用[ListInstances](~~2361065~~)查询。'."\n"
+ .' - 已预先安装[云助手Agent](~~2361030~~)。'."\n"
+ .' - 执行类型为PowerShell的命令时，必须已经配置了PowerShell模块。'."\n"
+ .'- 命令可能会因为目标服务器的状态异常，网络异常或云助手Agent异常而出现无法执行的情况，无法执行不会生成执行信息。'."\n"
+ .'- 当您创建命令启用了自定义参数时，需要在执行命令时传入自定义参数（`Parameters`）。'."\n"
+ .'- 调用此接口时您只能选择一条公共命令或您创建的自定义命令。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:InvokeCommand',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2DE174B-7196-5778-A00D-6EA2601B****\\"\\n}","type":"json"}]',
- 'title' => '批量删除快照',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"InvokeId\\": \\"t-bj02prjhw1n****\\"\\n}","type":"json"}]',
],
- 'UpdateDiskAttribute' => [
- 'summary' => '修改轻量应用服务器指定数据盘的备注信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListCustomImageShareAccounts' => [
+ 'summary' => '查询跨账号共享镜像的信息。',
+ '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' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'DiskId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的磁盘ID。您可以通过调用ListDisks接口获取数据磁盘ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'd-bp18kjxg9ebrhsgi****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '被共享的自定义镜像ID。', 'type' => 'string', 'required' => true, 'example' => 'm-2zehv38jjmwva1ee****'],
],
[
- 'name' => 'Remark',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '备注信息。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。'."\n"
+ ."\n"
+ .'最大值：50。'."\n"
+ ."\n"
+ .'默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
@@ -8155,169 +6012,123 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28D****534F ',
+ 'TotalCount' => ['description' => '实例总个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '分页查询的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ImageShareUsers' => [
+ 'description' => '共享自定义镜像的信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '共享自定义镜像的信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['description' => '共享自定义镜像的阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '125111425233****'],
+ 'SharedTime' => ['description' => '共享自定义镜像时间。', 'type' => 'string', 'example' => '2024-07-15 13:59:21.0'],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IncorrectInstanceStatus.ResetDisk',
- 'errorMessage' => 'Rolling back the disk requires the instance to operate in a stopped state.',
- ],
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查看跨账号共享镜像信息',
+ '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' => '修改数据盘备注信息',
+ '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' => '查询指定地域下一个或多个已创建的磁盘信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListCustomImages' => [
+ 'summary' => '查询指定地域下一个或多个已创建的自定义镜像信息。',
+ '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' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'DiskIds',
+ 'name' => 'ImageIds',
'in' => 'query',
- 'schema' => [
- 'description' => '磁盘ID。取值可以由多个磁盘ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["d-bp14wq0149cpp2x****", "d-bp14wq0149cpp2y****"]',
- ],
+ 'schema' => ['description' => '轻量应用服务器的镜像ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => '["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。'."\n"
- ."\n"
- .'最大值：100'."\n"
- ."\n"
- .'默认值：10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。'."\n"
+ ."\n"
+ .'- 最大值：100。'."\n"
+ .'- 默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '磁盘列表的页码。'."\n"
- ."\n"
- .'默认值：1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '快照列表的页码。'."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'DiskType',
+ 'name' => 'ImageNames',
'in' => 'query',
- 'schema' => [
- 'description' => '磁盘类型。可能值：'."\n"
- ."\n"
- .'- System：系统盘。'."\n"
- ."\n"
- .'- Data：数据盘。'."\n"
- ."\n"
- .'默认全量查询',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'system',
- ],
+ 'schema' => ['description' => '轻量应用服务器的镜像名称。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => '["test1****", "test2****"]'],
+ ],
+ [
+ 'name' => 'SystemSnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => '系统盘快照ID。', 'type' => 'string', 'required' => false, 'example' => 's-bp14m09pq8***0g6'],
+ ],
+ [
+ 'name' => 'DataSnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据盘快照ID。', 'type' => 'string', 'required' => false, 'example' => 's-acscasca****'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '磁盘的标签列表。',
+ 'description' => '自定义镜像的标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '磁盘的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '磁盘的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '自定义镜像的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '自定义镜像的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -8328,12 +6139,23 @@
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7yj2i'],
+ ],
+ [
+ 'name' => 'Share',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否查询共享镜像。取值范围：'."\n"
+ ."\n"
+ .'- False：否。表示返回结果中不包括共享镜像。'."\n"
+ ."\n"
+ .'- True：是。表示只返回共享镜像。'."\n"
+ ."\n"
+ .'不填则默认返回所有镜像。', 'type' => 'boolean', 'required' => false, 'example' => 'False'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '镜像的来源轻量应用服务器实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
],
'responses' => [
@@ -8341,400 +6163,174 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '磁盘总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '磁盘列表的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Disks' => [
- 'description' => '磁盘信息组成的数组。',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'CustomImages' => [
+ 'description' => '对象数组。',
'type' => 'array',
'items' => [
+ 'description' => '对象。',
'type' => 'object',
'properties' => [
- 'CreationTime' => [
- 'description' => '创建时间。时间格式以[ISO8601](~~25696~~)为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2021-03-08T05:31:06Z',
- ],
- 'Status' => [
- 'description' => '磁盘状态。可能值：'."\n"
- ."\n"
- .'- ReIniting：初始化中。'."\n"
- .'- Creating：创建中。'."\n"
- .'- In_use：使用中。'."\n"
- .'- Available：待挂载。'."\n"
- .'- Attaching：挂载中。'."\n"
- .'- Detaching：卸载中。',
- 'type' => 'string',
- 'example' => 'In_use',
- ],
- 'Device' => [
- 'description' => '磁盘挂载服务器中的设备名。',
- 'type' => 'string',
- 'example' => '/dev/xvda',
- ],
- 'Size' => [
- 'description' => '磁盘大小。单位：GB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'DiskName' => [
- 'description' => '磁盘名称。',
- 'type' => 'string',
- 'example' => 'SystemDisk',
- ],
- 'DiskChargeType' => [
- 'description' => '磁盘的计费方式。',
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'DiskType' => [
- 'description' => '磁盘类型。可能值：'."\n"
- ."\n"
- .'- System：系统盘。'."\n"
- .'- Data：数据盘。',
- 'type' => 'string',
- 'example' => 'System',
- ],
- 'Category' => [
- 'description' => '磁盘类型，可能值：'."\n"
- ."\n"
- .'- ESSD：ESSD云盘，性能级别PL0。'."\n"
- .'- SSD：SSD云盘。'."\n"
- .'- CLOUD_EFFICIENCY：高效云盘。',
- 'type' => 'string',
- 'example' => 'ESSD',
- ],
- 'DiskId' => [
- 'description' => '磁盘ID。',
- 'type' => 'string',
- 'example' => 'd-bp14wq0149cpp2x****',
- ],
- 'InstanceId' => [
- 'description' => '磁盘对应的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'example' => '2ad1ae67295445f598017499dc****',
- ],
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'Remark' => [
- 'description' => '磁盘备注。',
- 'type' => 'string',
- 'example' => 'remark',
- ],
+ 'CreationTime' => ['description' => '快照创建时间。时间格式以ISO8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2022-10-09T02:28:06Z'],
+ 'DataSnapshotName' => ['description' => '数据盘快照名称。', 'type' => 'string', 'example' => 'Data disk snapshot'],
+ 'SystemSnapshotId' => ['description' => '系统盘快照ID。', 'type' => 'string', 'example' => 's-bp1h173hj21puxb***'],
+ 'InShare' => ['description' => '自定义镜像是否共享至ECS。', 'type' => 'boolean', 'example' => 'false'],
+ 'InShareUser' => ['description' => '自定义镜像是否跨账号共享。', 'type' => 'boolean', 'example' => 'False'],
+ 'InstanceId' => ['description' => '镜像的来源轻量应用服务器的实例ID。', 'type' => 'string', 'example' => '2d06ee0520b44de1ae88d4be****'],
+ 'DataSnapshotId' => ['description' => '数据盘快照ID。', 'type' => 'string', 'example' => 's-bp19rn9u8eqzlfb***'],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'SystemSnapshotName' => ['description' => '系统盘快照名称。', 'type' => 'string', 'example' => 'System disk snapshot'],
+ 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'Custom image-1'],
+ 'Name' => ['description' => '自定义镜像名称。', 'type' => 'string', 'example' => 'test'],
+ 'ImageId' => ['description' => '自定义镜像ID。', 'type' => 'string', 'example' => 'm-bp1e79zktg26n2b***'],
+ 'Status' => ['description' => '自定义镜像状态。取值范围：'."\n"
+ ."\n"
+ .'- 0：复制中。'."\n"
+ ."\n"
+ .'- 1：可用。'."\n"
+ .'- 2：不可用。'."\n"
+ .'- 3：创建失败。'."\n"
+ .'- 4：创建中。', 'type' => 'string', 'example' => '1'],
'Tags' => [
- 'description' => '磁盘的标签列表。',
+ 'description' => '自定义镜像的标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '磁盘的标签键。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '磁盘的标签值。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '自定义镜像的标签键。', 'type' => 'string', 'example' => 'TestKey'],
+ 'Value' => ['description' => '自定义镜像的标签值。', 'type' => 'string', 'example' => 'TestValue'],
],
],
],
- 'InstanceName' => [
- 'description' => '轻量应用服务器名称。',
- 'type' => 'string',
- 'example' => 'myInstance',
- ],
- 'ResourceGroupId' => [
- 'description' => '磁盘所属的资源组ID。',
- 'type' => 'string',
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'InstanceName' => ['description' => '轻量应用服务器实例名称。', 'type' => 'string', 'example' => 'swas-asdf23***'],
+ 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfm2h2lvp3ublq'],
+ 'CreateInstances' => [
+ 'description' => '使用镜像创建的实例信息。',
+ 'type' => 'array',
+ 'items' => ['description' => '使用镜像创建的实例ID。', 'type' => 'string', 'example' => '9ffb716db6ae406ca78a476c0c81****'],
+ ],
+ 'UserId' => ['description' => '镜像拥有者的阿里云主账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '180185828710****'],
+ 'OsType' => ['description' => '镜像的操作系统类型。', 'type' => 'string', 'example' => 'Linux'],
+ 'RequiredSystemDiskSize' => ['description' => '镜像的系统盘大小，单位为GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'RequiredDataDiskSize' => ['description' => '镜像的数据盘大小，单位为GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'SourceImageName' => ['description' => '源镜像名称。', 'type' => 'string', 'example' => 'CentOS'],
+ 'SourceImageVersion' => ['description' => '源镜像版本。', 'type' => 'string', 'example' => '8.0'],
],
],
],
+ 'TotalCount' => ['description' => '总条数。', 'type' => 'string', 'example' => '4'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。', 'type' => 'string', 'example' => '10'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'string', 'example' => '1'],
],
+ 'description' => '',
],
],
],
'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' => '查询一个或多个磁盘信息',
- 'description' => '`InstanceId`、`DiskIds`和`ResourceGroupId`不是必需的请求参数，但是可以构建过滤器逻辑，参数之间为逻辑与（And）关系。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ResetDisk' => [
- 'summary' => '根据快照回滚磁盘。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'security' => [
- [
- 'AK' => [],
+ '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' => '查询一个或多个自定义镜像信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCustomImages'],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '快照对应的轻量应用服务器所属的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'DiskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '待回滚的磁盘ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'd-bp14wq0149cpp2xy****',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
- ],
- [
- 'name' => 'SnapshotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '快照ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-bp16oazlsold4dks****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。'."\n"
- ."\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}'],
],
],
],
],
- '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' => '回滚磁盘',
- 'description' => '- 使用快照回滚磁盘时，对应的轻量应用服务器必须为已停止状态。'."\n"
- .'- 回滚快照会丢失该快照创建之后的增量数据，如有需要请您提前做好数据备份。'."\n"
- .'### 注意事项'."\n"
- .'重置系统或更换镜像会清除服务器上的磁盘数据，重置系统或更换镜像前创建的快照会保留但无法支持回滚操作。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'CreateCustomImage' => [
- 'summary' => '通过快照创建用户自定义镜像。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDisks' => [
+ 'summary' => '查询指定地域下一个或多个已创建的磁盘信息。',
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => false, 'example' => '2ad1ae67295445f598017499dc****'],
],
[
- 'name' => 'ImageName',
+ 'name' => 'DiskIds',
'in' => 'query',
- 'schema' => [
- 'description' => '自定义镜像名称。长度为2~128个英文或中文字符，必须以大小写字母或中文开头或数字开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n"
- .'默认值：空',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'customImage-test',
- ],
+ 'schema' => ['description' => '磁盘ID。取值可以由多个磁盘ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => '["d-bp14wq0149cpp2x****", "d-bp14wq0149cpp2y****"]'],
],
[
- 'name' => 'SystemSnapshotId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '系统盘快照ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-acscasca****',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。'."\n"
+ ."\n"
+ .'最大值：100'."\n"
+ ."\n"
+ .'默认值：10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
[
- 'name' => 'Description',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '镜像描述信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '磁盘列表的页码。'."\n"
+ ."\n"
+ .'默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'DataSnapshotId',
+ 'name' => 'DiskType',
'in' => 'query',
- 'schema' => [
- 'description' => '数据盘快照ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-acscasca****',
- ],
+ 'schema' => ['description' => '磁盘类型。可能值：'."\n"
+ ."\n"
+ .'- System：系统盘。'."\n"
+ ."\n"
+ .'- Data：数据盘。'."\n"
+ ."\n"
+ .'默认全量查询', 'type' => 'string', 'required' => false, 'example' => 'system'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '标签列表，最多包含20个子项。',
+ 'description' => '磁盘的标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '为自定义镜像指定的标签键。N 的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '为自定义镜像指定的标签值。N 的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '磁盘的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '磁盘的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -8745,12 +6341,7 @@
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => '指定的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****'],
],
],
'responses' => [
@@ -8758,226 +6349,150 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****',
- ],
- 'ImageId' => [
- 'description' => '自定义镜像ID。',
- 'type' => 'string',
- 'example' => 'm-csaascsaccscs****',
+ 'TotalCount' => ['description' => '磁盘总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '磁盘列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Disks' => [
+ 'description' => '磁盘信息组成的数组。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CreationTime' => ['description' => '创建时间。时间格式以[ISO8601](~~25696~~)为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2021-03-08T05:31:06Z'],
+ 'Status' => ['description' => '磁盘状态。可能值：'."\n"
+ ."\n"
+ .'- ReIniting：初始化中。'."\n"
+ .'- Creating：创建中。'."\n"
+ .'- In_use：使用中。'."\n"
+ .'- Available：待挂载。'."\n"
+ .'- Attaching：挂载中。'."\n"
+ .'- Detaching：卸载中。', 'type' => 'string', 'example' => 'In_use'],
+ 'Device' => ['description' => '磁盘挂载服务器中的设备名。', 'type' => 'string', 'example' => '/dev/xvda'],
+ 'Size' => ['description' => '磁盘大小。单位：GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'DiskName' => ['description' => '磁盘名称。', 'type' => 'string', 'example' => 'SystemDisk'],
+ 'DiskChargeType' => ['description' => '磁盘的计费方式。', 'type' => 'string', 'example' => 'PrePaid'],
+ 'DiskType' => ['description' => '磁盘类型。可能值：'."\n"
+ ."\n"
+ .'- System：系统盘。'."\n"
+ .'- Data：数据盘。', 'type' => 'string', 'example' => 'System'],
+ 'Category' => ['description' => '磁盘类型，可能值：'."\n"
+ ."\n"
+ .'- ESSD：ESSD云盘，性能级别PL0。'."\n"
+ .'- SSD：SSD云盘。'."\n"
+ .'- CLOUD_EFFICIENCY：高效云盘。', 'type' => 'string', 'example' => 'ESSD'],
+ 'DiskId' => ['description' => '磁盘ID。', 'type' => 'string', 'example' => 'd-bp14wq0149cpp2x****'],
+ 'InstanceId' => ['description' => '磁盘对应的轻量应用服务器的实例ID。', 'type' => 'string', 'example' => '2ad1ae67295445f598017499dc****'],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'Remark' => ['description' => '磁盘备注。', 'type' => 'string', 'example' => 'remark'],
+ 'Tags' => [
+ 'description' => '磁盘的标签列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '磁盘的标签键。', 'type' => 'string', 'example' => 'TestKey'],
+ 'Value' => ['description' => '磁盘的标签值。', 'type' => 'string', 'example' => 'TestValue'],
+ ],
+ ],
+ ],
+ 'InstanceName' => ['description' => '轻量应用服务器名称。', 'type' => 'string', 'example' => 'myInstance'],
+ 'ResourceGroupId' => ['description' => '磁盘所属的资源组ID。', 'type' => 'string', 'example' => 'rg-aek2bti7cf7****'],
+ ],
+ 'description' => '',
+ ],
],
],
+ 'description' => '',
],
],
],
'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' => '创建自定义镜像',
- 'description' => '自定义镜像是您通过轻量应用服务器的快照创建的镜像。您可以通过已配置好的自定义镜像创建更多包含相同配置的轻量应用服务器，也可以将自定义镜像共享至云服务器ECS，进而通过共享镜像创建ECS实例或更换操作系统。'."\n"
- .'关于自定义镜像的更多消息，请参见[自定义镜像概述](~~199375~~)。'."\n"
- ."\n"
- .'创建自定义镜像之前，您需要先创建轻量应用服务器的系统盘快照。具体操作，请参见[CreateSnapshot](~~190452~~)。'."\n"
- ."\n"
- .'> 如果您创建自定义镜像时需要服务器的数据盘数据，请先创建一份服务器的数据盘快照。'."\n"
- ."\n"
- .'创建自定义镜像时，您需要先阅读以下注意事项：'."\n"
- ."\n"
- .'- 创建的自定义镜像所属地域与对应的轻量应用服务器所属地域相同。'."\n"
- ."\n"
- .'- 创建的自定义镜像数量上限为已创建的服务器数量的3倍，但最多不超过15个。'."\n"
- ."\n"
- .'- 只有服务器的系统盘快照可以直接创建自定义镜像。如果您需要自定义镜像中包含服务器的数据盘数据，在创建自定义镜像的过程中，需要手动选择对应的数据盘快照。'."\n"
- ."\n"
- .'- 如果轻量应用服务器到期或者退款后释放，该服务器对应的自定义镜像也会随之释放。'."\n"
- ."\n"
- .'- 重置系统或更换镜像会清除服务器上的磁盘数据，请您根据需要做好数据备份。',
+ 'title' => '查询一个或多个磁盘信息',
+ 'description' => '`InstanceId`、`DiskIds`和`ResourceGroupId`不是必需的请求参数，但是可以构建过滤器逻辑，参数之间为逻辑与（And）关系。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListCustomImages' => [
- 'summary' => '查询指定地域下一个或多个已创建的自定义镜像信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDisks'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ '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/*'],
+ ],
+ ],
+ ],
],
+ '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":""}]',
+ ],
+ 'ListFirewallRules' => [
+ 'summary' => '查询指定轻量应用服务器的防火墙规则。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '178226',
- 'abilityTreeNodes' => [
- 'FEATUREswasJBABCT',
- ],
- ],
+ 'operationType' => 'read',
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
- 'name' => 'ImageIds',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的镜像ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。'."\n"
- ."\n"
- .'- 最大值：100。'."\n"
- .'- 默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。'."\n"
+ ."\n"
+ .'最大值：100。'."\n"
+ ."\n"
+ .'默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '快照列表的页码。'."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'ImageNames',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的镜像名称。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["test1****", "test2****"]',
- ],
- ],
- [
- 'name' => 'SystemSnapshotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '系统盘快照ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bp14m09pq8***0g6',
- ],
- ],
- [
- 'name' => 'DataSnapshotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据盘快照ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-acscasca****',
- ],
+ 'schema' => ['description' => '防火墙规则列表的页码。'."\n"
+ ."\n"
+ .'起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '自定义镜像的标签列表。',
+ 'description' => '防火墙规则的标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '自定义镜像的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '自定义镜像的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '防火墙规则的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '防火墙规则的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -8986,40 +6501,9 @@
],
],
[
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7yj2i',
- ],
- ],
- [
- 'name' => 'Share',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否查询共享镜像。取值范围：'."\n"
- ."\n"
- .'- False：否。表示返回结果中不包括共享镜像。'."\n"
- ."\n"
- .'- True：是。表示只返回共享镜像。'."\n"
- ."\n"
- .'不填则默认返回所有镜像。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'False',
- ],
- ],
- [
- 'name' => 'InstanceId',
+ 'name' => 'FirewallRuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '镜像的来源轻量应用服务器实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '防火墙规则ID。', 'type' => 'string', 'required' => false, 'example' => '1a16263ab0f541288312a15fa64280de'],
],
],
'responses' => [
@@ -9027,263 +6511,126 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'CustomImages' => [
- 'description' => '对象数组。',
+ 'TotalCount' => ['description' => '防火墙规则的总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '防火墙规则列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FirewallRules' => [
+ 'description' => '由防火墙规则信息组成的数组。',
'type' => 'array',
'items' => [
- 'description' => '对象。',
'type' => 'object',
'properties' => [
- 'CreationTime' => [
- 'description' => '快照创建时间。时间格式以ISO8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-10-09T02:28:06Z',
- ],
- 'DataSnapshotName' => [
- 'description' => '数据盘快照名称。',
- 'type' => 'string',
- 'example' => '数据盘快照',
- ],
- 'SystemSnapshotId' => [
- 'description' => '系统盘快照ID。',
- 'type' => 'string',
- 'example' => 's-bp1h173hj21puxb***',
- ],
- 'InShare' => [
- 'description' => '自定义镜像是否共享至ECS。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'InShareUser' => [
- 'description' => '自定义镜像是否跨账号共享。',
- 'type' => 'boolean',
- 'example' => 'False',
- ],
- 'InstanceId' => [
- 'description' => '镜像的来源轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'example' => '2d06ee0520b44de1ae88d4be****',
- ],
- 'DataSnapshotId' => [
- 'description' => '数据盘快照ID。',
- 'type' => 'string',
- 'example' => 's-bp19rn9u8eqzlfb***',
- ],
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'SystemSnapshotName' => [
- 'description' => '系统盘快照名称。',
- 'type' => 'string',
- 'example' => '系统盘快照',
- ],
- 'Description' => [
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => '自定义镜像-1',
- ],
- 'Name' => [
- 'description' => '自定义镜像名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'ImageId' => [
- 'description' => '自定义镜像ID。',
- 'type' => 'string',
- 'example' => 'm-bp1e79zktg26n2b***',
- ],
- 'Status' => [
- 'description' => '自定义镜像状态。取值范围：'."\n"
- ."\n"
- .'- 0：复制中。'."\n"
- ."\n"
- .'- 1：可用。'."\n"
- .'- 2：不可用。'."\n"
- .'- 3：创建失败。'."\n"
- .'- 4：创建中。',
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'Remark' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'example' => 'Test - MySQL server default port'],
+ 'Port' => ['description' => '端口范围。', 'type' => 'string', 'example' => '3306'],
+ 'RuleId' => ['description' => '防火墙规则ID。', 'type' => 'string', 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****'],
+ 'RuleProtocol' => ['description' => '传输层协议。可能值：'."\n"
+ ."\n"
+ .'- TCP：TCP协议。'."\n"
+ .'- UDP：UDP协议。'."\n"
+ .'- TCP+UDP：TCP和UDP协议。', 'type' => 'string', 'example' => 'TCP'],
+ 'Policy' => ['description' => '防火墙策略。'."\n"
+ ."\n"
+ .'- accept：允许。'."\n"
+ ."\n"
+ .'- drop：拒绝。', 'type' => 'string', 'example' => 'accept'],
'Tags' => [
- 'description' => '自定义镜像的标签列表。',
+ 'description' => '防火墙规则的标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '自定义镜像的标签键。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '自定义镜像的标签值。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '防火墙规则的标签键。', 'type' => 'string', 'example' => 'TestKey'],
+ 'Value' => ['description' => '防火墙规则的标签值。', 'type' => 'string', 'example' => 'TestValue'],
],
],
],
- 'InstanceName' => [
- 'description' => '轻量应用服务器实例名称。',
- 'type' => 'string',
- 'example' => 'swas-asdf23***',
- ],
- 'ResourceGroupId' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'example' => 'rg-acfm2h2lvp3ublq',
- ],
- 'CreateInstances' => [
- 'description' => '使用镜像创建的实例信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '使用镜像创建的实例ID。',
- 'type' => 'string',
- 'example' => '9ffb716db6ae406ca78a476c0c81****',
- ],
- ],
- 'UserId' => [
- 'description' => '镜像拥有者的阿里云主账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '180185828710****',
- ],
- 'OsType' => [
- 'description' => '镜像的操作系统类型。',
- 'type' => 'string',
- 'example' => 'Linux',
- ],
- 'RequiredSystemDiskSize' => [
- 'description' => '镜像的系统盘大小，单位为GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'RequiredDataDiskSize' => [
- 'description' => '镜像的数据盘大小，单位为GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'SourceImageName' => [
- 'description' => '源镜像名称。',
- 'type' => 'string',
- 'example' => 'CentOS',
- ],
- 'SourceImageVersion' => [
- 'description' => '源镜像版本。',
- 'type' => 'string',
- 'example' => '8.0',
- ],
+ 'SourceCidrIp' => ['description' => '源IP段。', 'type' => 'string', 'example' => '0.0.0.0/0'],
],
+ 'description' => '',
],
],
- 'TotalCount' => [
- 'description' => '总条数。',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'string',
- 'example' => '1',
- ],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => '传入的regionId和请求的地址不匹配。'],
+ ],
+ 403 => [
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter value is invalid.', 'description' => '参数非法。'],
+ ],
+ [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
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 \\"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' => '查询一个或多个自定义镜像信息',
- ],
- 'ModifyImageShareStatus' => [
- 'summary' => '为指定的自定义镜像共享或取消共享到ECS。',
- 'methods' => [
- 'post',
- 'get',
+ '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 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}","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' => '获取实例的防火墙规则',
+ 'description' => '可您以通过此接口，查询指定轻量应用服务器的防火墙规则信息，包括端口范围、防火墙规则ID、传输层协议等信息。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ '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/*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListImages' => [
+ 'summary' => '查询指定地域下一个或多个镜像信息。',
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ImageId',
+ 'name' => 'ImageIds',
'in' => 'query',
- 'schema' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-saacssasc****',
- ],
+ 'schema' => ['description' => '镜像ID。取值可以由一个或多个镜像ID组成一个JSON数组。格式为`["xxx", "yyy", … "zzz"]`。支持最多50个ID，用半角逗号字符隔开。', 'type' => 'string', 'required' => false, 'example' => '["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]'],
],
[
- 'name' => 'Operation',
+ 'name' => 'ImageType',
'in' => 'query',
- 'schema' => [
- 'description' => '取值范围如下：'."\n"
- ."\n\n"
- .'- Share：共享到ECS'."\n"
- .'- UnShare：取消共享到ECS'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Share',
- ],
+ 'schema' => ['description' => '镜像类型。取值范围：'."\n"
+ ."\n"
+ .'- system：系统镜像'."\n"
+ .'- app：应用镜像'."\n"
+ .'- custom：自定义镜像', 'type' => 'string', 'required' => false, 'example' => 'system'],
],
],
'responses' => [
@@ -9291,161 +6638,178 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'Images' => [
+ 'description' => '镜像信息组成的数组。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '镜像信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageType' => ['description' => '镜像类型。可能值：'."\n"
+ ."\n"
+ .'- system：系统镜像'."\n"
+ .'- app：应用镜像'."\n"
+ .'- custom：自定义镜像', 'type' => 'string', 'example' => 'app'],
+ 'Description' => ['description' => '描述信息。', '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.'],
+ 'ImageName' => ['description' => '镜像名称。', 'type' => 'string', 'example' => 'WordPress-4.8.1'],
+ 'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => '794c230fd3e64ea19f83f4d7a0ad****'],
+ 'Platform' => ['description' => '镜像所使用的操作系统类型。可能值：'."\n"
+ ."\n"
+ .'- Linux：Linux系统'."\n"
+ ."\n"
+ .'- Windows：Windows系统', 'type' => 'string', 'example' => 'Linux'],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
'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' => '共享、解除共享自定义镜像',
- 'description' => '自定义镜像支持共享到ECS。当轻量应用服务器的配置不能再满足您的业务需要、或者您期望使用云服务器ECS部署业务时，您可以通过共享镜像将业务从轻量应用服务器转移至云服务器ECS。'."\n"
- ."\n"
- .'> 共享镜像在云服务器ECS中所属的地域，与自定义镜像所属的地域保持一致。'."\n"
- ."\n"
- .'当您不再需要共享自定义镜像或者需要删除自定义镜像时，您可以取消共享自定义镜像。'."\n"
- .'当您取消共享镜像后，请注意：'."\n"
- .'- 无法通过云服务器ECS管理控制台或ECS API查询到该自定义镜像，也无法再使用该自定义镜像。'."\n"
- .'- 已使用该共享镜像创建的实例无法重新初始化云盘。',
+ 'responseDemo' => '[{"type":"json","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}","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' => '获取镜像列表',
+ 'description' => '您可以查询指定地域下一个或多个镜像信息，包括镜像的ID、镜像名称、镜像类型等。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'AddCustomImageShareAccount' => [
- 'summary' => '您可以将自定义镜像共享给同地域下的其他阿里云账号，快速为多个轻量应用服务器部署相同的环境配置，提高部署效率。',
- '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查看最新的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ImageId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '自定义镜像ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-saacssasc****',
- ],
- ],
- [
- 'name' => 'Account',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '账户名称',
- 'type' => 'array',
- 'items' => [
- 'description' => '共享自定义镜像的目标阿里云主账号ID。'."\n"
- ."\n"
- .'> 最多同时共享给10个账号。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '125111425233****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'Plans' => [
+ 'description' => '套餐信息组成的数组。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Core' => ['description' => 'vCPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Bandwidth' => ['description' => '峰值带宽。单位：Mbps。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'DiskSize' => ['description' => '磁盘容量。单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '40'],
+ 'Flow' => ['description' => ' '."\n"
+ .'每月流量。单位：GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Memory' => ['description' => '内存。单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PlanId' => ['description' => '套餐ID。', 'type' => 'string', 'example' => 'swas.s2.c2m1s40b3t04'],
+ 'DiskType' => ['description' => '磁盘类型。可能值：'."\n"
+ ."\n"
+ .'- SSD：SSD云盘。'."\n"
+ .'- ESSD：ESSD云盘，性能级别 PL0。'."\n"
+ .'- CLOUD_EFFICIENCY：高效云盘。', 'type' => 'string', 'example' => 'ESSD'],
+ 'OriginPrice' => ['description' => '套餐价格。', 'type' => 'number', 'format' => 'double', 'example' => '60'],
+ 'Currency' => ['description' => '价格单位。可能值：'."\n"
+ ."\n"
+ .'- CNY：元'."\n"
+ .'- USD：美元', 'type' => 'string', 'example' => 'CNY'],
+ 'SupportPlatform' => ['description' => '套餐支持的操作系统类型。', 'type' => 'string', 'example' => '["Linux","Windows"]'],
+ ],
+ 'description' => '',
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => '传入的regionId和请求的地址不匹配。'],
+ ],
+ 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' => '跨账号共享自定义镜像',
- 'description' => '- 共享镜像前，请清除敏感数据和文件。'."\n"
+ 'title' => '获取当前实例可升级的套餐列表',
+ 'summary' => '查询指定的轻量应用服务器，可升级的套餐列表。',
+ 'description' => '随着业务的发展，已购买的服务器资源可能出现不再满足业务需求的情况。您可以获取当前实例可升级的套餐列表，调用[UpgradeInstance](~~190445~~)接口为实例升级套餐。'."\n"
."\n"
- .'- 已获取阿里云账号ID。将鼠标移至控制台右上角的用户头像，在弹出的用户信息框中，如果标识了账号为主账号，则显示的账号ID即为阿里云账号ID。',
- ],
- 'ListCustomImageShareAccounts' => [
- 'summary' => '查询跨账号共享镜像的信息。',
- 'methods' => [
- 'get',
- 'post',
+ .'> 建议您在升级前为轻量应用服务器云盘创建快照，做好数据备份。具体操作，请参见[CreateSnapshot](~~190452~~)。'."\n"
+ ."\n"
+ .'关于升级配置中的注意事项，请参见[升级配置](~~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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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":""}]',
+ ],
+ 'ListInstanceStatus' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9453,71 +6817,28 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'abilityTreeCode' => '225369',
- 'abilityTreeNodes' => [
- 'FEATUREswasJBABCT',
- 'FEATUREswasSHBOLC',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]'],
],
[
- 'name' => 'ImageId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '被共享的自定义镜像ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-2zehv38jjmwva1ee****',
- ],
+ 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。'."\n"
- ."\n"
- .'最大值：50。'."\n"
- ."\n"
- .'默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
],
'responses' => [
@@ -9525,308 +6846,433 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '实例总个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '分页查询的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ImageShareUsers' => [
- 'description' => '共享自定义镜像的信息。',
+ 'InstanceStatuses' => [
+ 'description' => '实例状态集类型（InstanceStatus）。',
'type' => 'array',
'items' => [
- 'description' => '共享自定义镜像的信息。',
+ 'description' => '轻量应用服务器实例状态。',
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'description' => '共享自定义镜像的阿里云账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '125111425233****',
- ],
- 'SharedTime' => [
- 'description' => '共享自定义镜像时间。',
- 'type' => 'string',
- 'example' => '2024-07-15 13:59:21.0',
- ],
+ 'Status' => ['description' => '实例状态，可能值：'."\n"
+ ."\n"
+ .'- Pending：准备中'."\n"
+ .'- Starting：启动中'."\n"
+ .'- Running：运行中'."\n"
+ .'- Stopping：停止中'."\n"
+ .'- Stopped：停止'."\n"
+ .'- Resetting：重置中'."\n"
+ .'- Upgrading：升级中'."\n"
+ .'- Disabled：不可用', 'type' => 'string', 'example' => 'Running'],
+ 'InstanceId' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'example' => 'a9a6474b935d41bcb531250bb5d****'],
],
],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '54'],
],
+ 'description' => '',
],
],
],
- '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' => '查看跨账号共享镜像信息',
- ],
- 'RemoveCustomImageShareAccount' => [
- 'summary' => '为了安全考虑，跨账号共享自定义镜像后，您可以调用RemoveCustomImageShareAccount接口取消跨账号共享自定义镜像。',
- 'methods' => [
- 'post',
+ 'title' => '批量获取实例状态',
+ 'summary' => '查询一个或多个实例的状态。',
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '轻量应用服务器所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。'."\n"
+ ."\n"
+ .'> 同时指定`InstanceIds`和`PublicIpAddresses`参数时，必须保证对应的实例ID和公网IP属于同一台轻量应用服务器，否则返回值为空。', 'type' => 'string', 'required' => false, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]'],
],
[
- 'name' => 'ImageId',
+ 'name' => 'ChargeType',
'in' => 'query',
- 'schema' => [
- 'description' => '被共享的自定义镜像ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-2zehv38jjmwva1ee****',
- ],
+ 'schema' => ['description' => '实例的计费方式。取值：PrePaid，目前仅支持包年包月。'."\n"
+ ."\n"
+ .'默认值：PrePaid', 'type' => 'string', 'required' => false, 'example' => 'PrePaid'],
],
[
- 'name' => 'Account',
+ 'name' => 'PublicIpAddresses',
+ 'in' => 'query',
+ 'schema' => ['description' => '轻量应用服务器的公网IP。取值可以由多个公网ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。'."\n"
+ ."\n"
+ .'> 同时指定`InstanceIds`和`PublicIpAddresses`参数时，必须保证对应的实例ID和公网IP属于同一台轻量应用服务器，否则返回值为空。', 'type' => 'string', 'required' => false, 'example' => '["42.1.**.**", "42.2.**.**"]'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '轻量应用服务器列表的页码。'."\n"
+ ."\n"
+ .'默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时设置的每页行数。最大值：100'."\n"
+ ."\n"
+ .'默认值：10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例状态，可能值：'."\n"
+ ."\n"
+ .'- Pending：准备中。'."\n"
+ .'- Starting：启动中。'."\n"
+ .'- Running：运行中。'."\n"
+ .'- Stopping：停止中。'."\n"
+ .'- Stopped：停止。'."\n"
+ .'- Resetting：重置中。'."\n"
+ .'- Upgrading：升级中。'."\n"
+ .'- Disabled：不可用。', 'type' => 'string', 'required' => false, 'example' => 'Running'],
+ ],
+ [
+ 'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '授权取消共享镜像的阿里云主账号ID。',
+ 'description' => '实例的标签列表。',
'type' => 'array',
'items' => [
- 'description' => '授权取消共享镜像的阿里云主账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '实例的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '实例的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
+ ],
'required' => false,
- 'example' => '125111425233****',
],
- 'required' => true,
+ 'required' => false,
'maxItems' => 100,
],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- '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' => '取消跨账号共享镜像',
- ],
- 'DeleteCustomImage' => [
- 'summary' => '删除指定的自定义镜像。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '轻量应用服务器所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceName',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '轻量应用服务器实例名称，支持使用通配符*进行模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'ImageId',
+ 'name' => 'PlanType',
'in' => 'query',
- 'schema' => [
- 'description' => '自定义镜像ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-2zehv38jjmwva1ee****',
- ],
+ 'schema' => ['description' => '套餐类型，可能值：'."\n"
+ ."\n"
+ .'- NORMAL：通用型。'."\n"
+ .'- CAPACITY：容量型。'."\n"
+ .'- PREVIOUS：上一代。'."\n"
+ .'- MULTI_IP：多公网IP型。'."\n"
+ .'- INTERNATIONAL：国际型。'."\n"
+ ."\n"
+ .'> 更多信息，请参见[实例规格族](~~2861773~~)。', 'type' => 'string', 'required' => false, 'example' => 'NORMAL'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '实例信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'Instances' => [
+ 'description' => '轻量应用服务器信息组成的数组。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '轻量应用服务器信息组成的数组。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => '实例状态，可能值：'."\n"
+ ."\n"
+ .'- Pending：准备中。'."\n"
+ .'- Starting：启动中。'."\n"
+ .'- Running：运行中。'."\n"
+ .'- Stopping：停止中。'."\n"
+ .'- Stopped：停止。'."\n"
+ .'- Resetting：重置中。'."\n"
+ .'- Upgrading：升级中。'."\n"
+ .'- Disabled：不可用。', 'type' => 'string', 'example' => 'Running'],
+ 'CreationTime' => ['description' => '创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2021-03-08T05:31:06Z'],
+ 'InnerIpAddress' => ['description' => '内网IP地址。', 'type' => 'string', 'example' => '172.26.XX.XX'],
+ 'ChargeType' => ['description' => '计费方式。', 'type' => 'string', 'example' => 'PrePaid'],
+ 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '2ad1ae67295445f598017499dc****'],
+ 'PlanId' => ['description' => '套餐ID。', 'type' => 'string', 'example' => 'swas.s2.c2m2s50b4t08'],
+ 'PublicIpAddress' => ['description' => '公网IP地址。', 'type' => 'string', 'example' => '42.1.XX.XX'],
+ 'RegionId' => ['description' => ' '."\n"
+ .'地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'ExpiredTime' => ['description' => '到期时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2021-05-08T16:00:00Z'],
+ 'InstanceName' => ['description' => '服务器名称。', 'type' => 'string', 'example' => 'test-InstanceName'],
+ 'BusinessStatus' => ['description' => '服务器状态。可能值：'."\n"
+ ."\n"
+ .'- Normal：正常。'."\n"
+ .'- Expired：到期。'."\n"
+ .'- Overdue：欠费。', 'type' => 'string', 'example' => 'Normal'],
+ 'DdosStatus' => ['description' => 'DDos状态。可能值：'."\n"
+ ."\n"
+ .'- Normal：正常。'."\n"
+ .'- BlackHole：黑洞中。'."\n"
+ .'- Defense：清洗中。', 'type' => 'string', 'example' => 'Normal'],
+ 'ImageId' => ['description' => ' '."\n"
+ .'镜像ID。', 'type' => 'string', 'example' => 'fe9c66133a9d4688872869726b52****'],
+ 'DisableReason' => ['description' => '资源被禁用的原因。取值范围：'."\n"
+ ."\n"
+ .'- FINANCIAL：因欠费被锁定。'."\n"
+ .'- SECURITY：因安全原因被锁定。'."\n"
+ .'- EXPIRED：实例过期。', 'type' => 'string', 'example' => 'EXPIRED'],
+ 'Combination' => ['description' => '是否为组合套餐。', 'type' => 'boolean', 'example' => 'false'],
+ 'CombinationInstanceId' => ['description' => '组合套餐实例ID。', 'type' => 'string', 'example' => 'com-f6c9a22****45b5b8de68ad608af1ba'],
+ 'Uuid' => ['description' => '实例的UUID。', 'type' => 'string', 'example' => '41f30524-5df7-49c9-9c6e-32****489001'],
+ 'ResourceSpec' => [
+ 'description' => '资源规格。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DiskCategory' => ['description' => '磁盘类型，可能值：'."\n"
+ ."\n"
+ .'- ESSD：ESSD云盘，性能级别PL0。'."\n"
+ .'- SSD：SSD云盘。'."\n"
+ .'- CLOUD_EFFICIENCY：高效云盘。', 'type' => 'string', 'example' => 'ESSD'],
+ 'Cpu' => ['description' => 'vCPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Bandwidth' => ['description' => '带宽大小，单位：Mbps。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'DiskSize' => ['description' => '磁盘大小，单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
+ 'Memory' => ['description' => '内存大小，单位：GiB。', 'type' => 'number', 'format' => 'double', 'example' => '2'],
+ 'Flow' => ['description' => '流量大小。'."\n"
+ ."\n"
+ .'- 流量为0代表带宽型主机。'."\n"
+ .'- 非0代表流量包型主机。', 'type' => 'number', 'format' => 'double', 'example' => '818'],
+ ],
+ ],
+ 'Image' => [
+ 'description' => '镜像的说明信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OsType' => ['description' => '操作系统类型。', 'type' => 'string', 'example' => 'windows'],
+ 'ImageName' => ['description' => '镜像名称。', 'type' => 'string', 'example' => 'test-custom-1686536882356'],
+ 'ImageVersion' => ['description' => '镜像版本。', 'type' => 'string', 'example' => 'V3.5'],
+ 'ImageType' => ['description' => '镜像类型。取值范围：'."\n"
+ ."\n"
+ .'- system：系统镜像。'."\n"
+ .'- app：应用镜像。'."\n"
+ .'- custom：自定义镜像。', 'type' => 'string', 'example' => 'system'],
+ 'ImageIconUrl' => ['description' => '镜像图标URL。', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg'],
+ 'ImageContact' => ['description' => '镜像提供商。', 'type' => 'string', 'example' => 'https://selfs****e.console.aliyun.com/ticket/createIndex'],
+ ],
+ ],
+ 'Tags' => [
+ 'description' => '实例的标签列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '实例的标签键。', 'type' => 'string', 'example' => 'TestKey'],
+ 'Value' => ['description' => '实例的标签值。', 'type' => 'string', 'example' => 'TestValue'],
+ ],
+ ],
+ ],
+ 'Disks' => [
+ 'description' => '轻量对应磁盘信息的数组。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '磁盘信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreationTime' => ['description' => '实例创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2023-02-24T02:20:10Z'],
+ 'Status' => ['description' => '磁盘状态。可能值：'."\n"
+ ."\n"
+ .'- ReIniting：初始化中。'."\n"
+ .'- Creating：创建中。'."\n"
+ .'- In_use：使用中。'."\n"
+ .'- Available：待挂载。'."\n"
+ .'- Attaching：挂载中。'."\n"
+ .'- Detaching：卸载中。', 'type' => 'string', 'example' => 'In_use'],
+ 'Device' => ['description' => '磁盘挂载服务器中的设备名。', 'type' => 'string', 'example' => '/dev/xvda'],
+ 'Size' => ['description' => '磁盘大小。单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'DiskName' => ['description' => '磁盘名称。', 'type' => 'string', 'example' => 'SystemDisk'],
+ 'DiskChargeType' => ['description' => '磁盘的计费方式。', 'type' => 'string', 'example' => 'PrePaid'],
+ 'DiskType' => ['description' => '磁盘类型。可能值：'."\n"
+ ."\n"
+ .'- system：系统盘。'."\n"
+ .'- data：数据盘。', 'type' => 'string', 'example' => 'system'],
+ 'Category' => ['description' => '磁盘类型，可能值：'."\n"
+ ."\n"
+ .'- ESSD：ESSD云盘，性能级别PL0。'."\n"
+ .'- SSD：SSD云盘。'."\n"
+ .'- CLOUD_EFFICIENCY：高效云盘。', 'type' => 'string', 'example' => 'ESSD'],
+ 'DiskId' => ['description' => '磁盘ID。', 'type' => 'string', 'example' => 'd-bp14wq0149cpp2x****'],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'Remark' => ['description' => '磁盘备注。', 'type' => 'string', 'example' => 'remark'],
+ 'DiskTags' => [
+ 'description' => '磁盘的标签信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'TestKey'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'TestValue'],
+ ],
+ ],
+ ],
+ 'ResourceGroupId' => ['description' => '磁盘所属的资源组ID。', 'type' => 'string', 'example' => 'rg-aek2bti7cf7****'],
+ ],
+ ],
+ ],
+ 'ResourceGroupId' => ['description' => '实例所属的资源组ID。', 'type' => 'string', 'example' => 'rg-aekz7jmhg5s****'],
+ 'NetworkAttributes' => [
+ 'description' => '网络返回信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '网络返回信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PublicIpAddress' => ['description' => '公网IP地址。', 'type' => 'string', 'example' => '116.62.XX.XX'],
+ 'PrivateIpAddress' => ['description' => '私网IP地址。', 'type' => 'string', 'example' => '72.25.XX.XX'],
+ 'PeakBandwidth' => ['description' => '公网峰值带宽。单位为Mbps。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'PublicIpDdosStatus' => ['description' => '公网IP的DDos状态。', 'type' => 'string', 'example' => 'normal'],
+ ],
+ ],
+ ],
+ 'PlanType' => ['description' => '套餐类型，可能值：'."\n"
+ ."\n"
+ .'- NORMAL：通用型。'."\n"
+ .'- CAPACITY：容量型。'."\n"
+ .'- PREVIOUS：上一代。'."\n"
+ .'- MULTI_IP：多公网IP型。'."\n"
+ .'- INTERNATIONAL：国际型。'."\n"
+ ."\n"
+ .'> 更多信息，请参见[实例规格族](~~2861773~~)。', 'type' => 'string', 'example' => 'NORMAL'],
+ 'CommodityCode' => ['type' => 'string'],
+ ],
+ ],
],
+ 'TotalCount' => ['description' => '查询到的实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '轻量应用服务器列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
'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' => '指定的公网IP不合法。'],
+ ['errorCode' => 'InvalidPublicIpAddresses', 'errorMessage' => 'The specified parameter PublicIpAddresses value is not valid.', 'description' => '指定的参数PublicIpAddresses值无效。'],
],
404 => [
- [
- 'errorCode' => 'InvalidImageId.NotFound',
- 'errorMessage' => 'The specified ImageId does not exist.',
- ],
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
],
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' => '删除自定义镜像',
- 'description' => '如果您不再需要某个自定义镜像，可以将其删除。自定义镜像被删除后，使用该镜像创建的轻量应用服务器将无法使用该镜像重置系统。'."\n"
- ."\n"
- .'> 如果自定义镜像处于共享中，需先取消共享镜像，然后删除自定义镜像。取消共享镜像后，您将无法通过云服务器ECS管理控制台或ECS API查询到该自定义镜像。如果您在云服务器ECS中还需要使用该镜像，建议您在删除自定义镜像前，先复制镜像。具体操作，请参见[复制镜像](~~199378~~)。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteCustomImages' => [
- 'summary' => '如果您不再需要某些自定义镜像，可以将其批量删除。自定义镜像被删除后，使用该镜像创建的轻量应用服务器将无法使用该镜像重置系统。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '获取实例列表',
+ 'summary' => '查询指定地域下，一个或多个实例的详细信息。',
+ 'description' => '通过此接口可查看指定地域下一个或多个实例的详细信息，包括服务器名称、公网IP地址，内网IP地址，服务器创建时间、服务器到期时间等信息。',
+ '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' => '[{"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 \\"CommodityCode\\": \\"\\"\\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":""}]',
+ ],
+ 'ListInstancesTrafficPackages' => [
+ 'summary' => '查询一个或多个实例的流量包详情信息。',
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ImageIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的镜像ID。取值可以由多个实例ID组成一个JSON数组，最多支持15个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '["m-2zehv38jjmwva1ee****", "m-bp1hj0zhmheyq2kz****"]',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '轻量应用服务器实例ID。取值可以由一个或多个实例ID组成一个JSON数组，最多支持100个实例ID，实例ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc******","2ad1ae67295445f598017499dc******"]'],
],
],
'responses' => [
@@ -9834,52 +7280,72 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
+ 'InstanceTrafficPackageUsages' => [
+ 'description' => '实例流量包详情信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'example' => 'ccscqwqwqqqw****'],
+ 'TrafficUsed' => ['description' => '流量包当月周期内已使用流量。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
+ 'TrafficPackageTotal' => ['description' => '流量包当月周期内的总流量。单位：Byte。'."\n"
+ ."\n"
+ .'> 流量包当月周期内的总流量=流量包当月周期内已使用流量+流量包当月周期内的剩余流量', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'],
+ 'TrafficPackageRemaining' => ['description' => '流量包当月周期内的剩余流量。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
+ 'TrafficOverflow' => ['description' => '流量包当月周期内超出流量包额度的流量。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ ],
+ 'description' => '',
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
],
+ 'description' => '',
],
],
],
'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' => '传入的regionId和请求的地址不匹配。'],
],
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',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => '批量删除镜像',
- 'description' => '如果自定义镜像处于共享中，需先取消共享镜像，然后删除自定义镜像。取消共享镜像后，您将无法通过云服务器ECS管理控制台或ECS API查询到该自定义镜像。如果您在云服务器ECS中还需要使用该镜像，建议您在删除自定义镜像前，先复制镜像。具体操作，请参见[复制镜像](~~199378~~)。',
- ],
- 'DescribeCloudAssistantAttributes' => [
- 'summary' => '查询一台或者多台实例的命令助手信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '获取指定服务器的流量包使用情况',
+ 'description' => '您可以查询一个或多个实例的流量包的详情信息，包括当月周期内的总流量、剩余流量、已使用的流量、超额流量等信息。'."\n"
+ ."\n"
+ .'轻量应用服务器的套餐配置中提供了固定流量配额，固定流量配额内的流量费用已包含在套餐内。如果实际使用流量超出固定流量配额，阿里云将对超额的部分收取额外的流量费用。您需要注意：'."\n"
+ ."\n"
+ .'- 仅服务器的出网流量属于使用流量（包括每月固定的流量配额和超出流量配额后的流量），服务器的入网流量不计费。'."\n"
+ .'- 轻量应用服务器与其他阿里云服务之间通过公网产生的出网流量优先消耗服务器的固定流量配额，固定流量配额使用完毕后按超额流量计费。'."\n"
+ .'- 同一局域网（即同一VPC内网）的轻量应用服务器之间的流量免费。'."\n"
+ ."\n"
+ .'更多信息，请参见[流量配额与计费](~~86281~~)。',
+ 'changeSet' => [],
+ '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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":""}]',
+ ],
+ 'ListKeyPairs' => [
+ 'summary' => '密钥对列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9889,538 +7355,343 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '214711',
- 'abilityTreeNodes' => [
- 'FEATUREswasWZKIOQ',
- ],
+ 'abilityTreeCode' => '219096',
+ 'abilityTreeNodes' => ['FEATUREswas9IJLCU'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。'."\n"
- ."\n"
- .'起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'KeyPairName',
'in' => 'query',
- 'schema' => [
- 'description' => '每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'KeyPairName'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
- 'required' => true,
- 'maxItems' => 50,
- ],
+ 'schema' => ['description' => '密钥对列表的页码。起始值：1。默认值：1 。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页的返回结果个数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'CloudAssistant' => [
- 'description' => '实例命令助手安装状态结果集合。',
+ 'TotalCount' => ['description' => '密钥对的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'PageSize' => ['description' => '每页的返回结果个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'KeyPairs' => [
+ 'description' => '密钥对信息集合。',
'type' => 'array',
'items' => [
+ 'description' => '密钥对信息集合。',
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'example' => '85dbe3e7cc7b49e1a3df4af3bfa4ebbf',
- ],
- 'CloudAssistantStatus' => [
- 'description' => '实例内的命令助手是否在运行中。可能值：'."\n"
- ."\n"
- .'true：2 分钟内有心跳。'."\n"
- ."\n"
- .'false：2 分钟内无心跳。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'LastInvokedTime' => [
- 'description' => '最近一次命令执行的时间。',
- 'type' => 'string',
- 'example' => '2021-03-15T08:00:00Z'."\n",
- ],
- 'CloudAssistantVersion' => [
- 'description' => '命令助手Agent版本号，若未安装或未运行命令助手Agent，则该值为空。',
- 'type' => 'string',
- 'example' => '2.2.0.106'."\n",
- ],
- 'ActiveTaskCount' => [
- 'description' => '实例内的命令助手运行中的任务数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'InvocationCount' => [
- 'description' => '实例内的命令助手已完成的任务数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'LastHeartbeatTime' => [
- 'description' => '命令助手最近一次心跳时间。该值平均每分钟（有上下 5 秒的随机浮动，最短 55 秒，最长 65 秒）更新一次。',
- 'type' => 'string',
- 'example' => '2021-03-15T09:00:00Z'."\n",
- ],
- 'OSType' => [
- 'description' => '实例操作系统类型。可能值：'."\n"
- ."\n"
- .'- Windows。'."\n"
- .'- Linux。'."\n"
- .'- FreeBSD。',
- 'type' => 'string',
- 'example' => 'Linux',
- ],
- 'SupportSessionManager' => [
- 'description' => '实例内的命令助手是否支持会话管理功能。若不支持，表示命令助手版本较低，请将客户端更新至最新版本。'."\n"
- ."\n"
- .'命令助手支持会话管理功能的最低版本如下：'."\n"
- ."\n"
- .'Linux：2.2.3.189'."\n"
- .'Windows：2.1.3.189',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'CreationTime' => ['description' => '密钥对的创建时间。', 'type' => 'string', 'example' => '2024-05-06T02:28Z'],
+ 'KeyPairName' => ['description' => '密钥对名称。长度为2~64个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'example' => 'testKeyPairName'],
+ 'PublicKey' => ['description' => '公钥内容。', 'type' => 'string', 'example' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****'],
+ 'InstanceIds' => [
+ 'description' => '轻量应用服务器实例ID。最多支持50个实例ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '轻量应用服务器实例ID。最多支持50个实例ID。', 'type' => 'string', 'example' => '2ad1ae67295445f598017499dc****'],
],
],
],
],
- 'TotalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'PageSize' => [
- 'description' => '每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
],
+ 'description' => '',
],
],
],
- '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' => '查询一台或者多台实例的命令助手信息',
- ],
- 'UpdateCommandAttribute' => [
- 'summary' => '修改一条命令相关参数。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询密钥对',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListKeyPairs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'CommandId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '命令ID。您可以通过接口[DescribeCommands](~~64843~~)查询所有可用的CommandId。 ',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-sh02yh0932w****',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '命令名称，支持全字符集。长度不得超过128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testName',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '命令描述，支持全字符集。长度不得超过512个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'WorkingDir',
- 'in' => 'query',
- 'schema' => [
- 'description' => '执行路径。长度不得超过200个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/home/',
- ],
- ],
- [
- 'name' => 'Timeout',
- 'in' => 'query',
- 'schema' => [
- 'description' => '您创建的命令在ECS实例中执行时最大的超时时间，单位为秒。当因为某种原因无法运行您创建的命令时，会出现超时现象。超时后，会强制终止命令进程，即取消命令的PID。默认值：60。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '60',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****',
+ 'Plans' => [
+ 'description' => '套餐信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '套餐信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Core' => ['description' => 'vCPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Bandwidth' => ['description' => '峰值带宽。单位：Mbps。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'DiskSize' => ['description' => '磁盘容量。单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '40'],
+ 'Flow' => ['description' => '每月流量。单位：GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Tokens' => ['type' => 'integer', 'format' => 'int32'],
+ 'PlanId' => ['description' => '套餐ID。', 'type' => 'string', 'example' => 'swas.s2.c2m1s40b3t04'],
+ 'DiskType' => ['description' => '磁盘类型，可能值：'."\n"
+ ."\n"
+ .'- ESSD：ESSD云盘，性能级别 PL0。'."\n"
+ .'- SSD：SSD云盘。'."\n"
+ .'- CLOUD_EFFICIENCY：高效云盘。', 'type' => 'string', 'example' => 'ESSD'],
+ 'Currency' => ['description' => '价格单位。可能值：'."\n"
+ ."\n"
+ .'- CNY：元'."\n"
+ ."\n"
+ .'- USD：美元'."\n"
+ ."\n"
+ .'> 中国站价格单位为CNY，国际站价格单位为USD。', 'type' => 'string', 'example' => 'CNY'],
+ 'SupportPlatform' => ['description' => '套餐支持的操作系统类型。', 'type' => 'string', 'example' => '["Linux","Windows"]'],
+ 'PlanType' => ['description' => '套餐类型，可能值：'."\n"
+ ."\n"
+ .'- NORMAL：通用型。'."\n"
+ .'- CAPACITY：容量型。'."\n"
+ .'- PREVIOUS：上一代。'."\n"
+ .'- MULTI_IP：多公网IP型。'."\n"
+ .'- INTERNATIONAL：国际型。'."\n"
+ ."\n"
+ .'> 更多信息，请参见[实例规格族](~~2861773~~)。', 'type' => 'string', 'example' => 'NORMAL'],
+ 'PublicIpNum' => ['description' => '公网IP数量。', 'type' => 'string', 'example' => '1'],
+ 'IspType' => ['description' => '公网线路类型。'."\n"
+ .'- **BGP**（默认值）：BGP线路。'."\n"
+ .'- **BGP_NCO**：BGP（非中国优化）线路。', 'type' => 'string', 'example' => 'BGP'],
+ 'Memory' => ['description' => '内存。单位：GiB。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'OriginPrice' => ['description' => '轻量应用服务器套餐的包月价格。', 'type' => 'string', 'example' => '60'],
+ ],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]',
- 'title' => '修改命令',
- ],
- 'InvokeCommand' => [
- 'summary' => '为一台或多台轻量应用服务器执行一条命令助手命令。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => '传入的regionId和请求的地址不匹配。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '获取套餐信息',
+ 'summary' => '查询指定地域下，轻量应用服务器所有的套餐信息。',
+ 'description' => '您可以查询指定地域下轻量应用服务器所有的套餐信息，包括套餐ID、磁盘容量、磁盘类型、套餐价格等。',
+ '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' => '[{"type":"json","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}","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":""}]',
+ ],
+ 'ListRegions' => [
+ 'summary' => '查询轻量服务器所有可用地域列表。',
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou ',
- ],
- ],
- [
- 'name' => 'CommandId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '命令ID。您可以通过接口DescribeCommands查询所有可用的CommandId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-sh02yh0932w****',
- ],
- ],
- [
- 'name' => 'Parameters',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '启用自定义参数功能时，执行命令时传入的自定义参数的键值对。'."\n"
- ."\n"
- .'- 自定义参数的个数范围为0~10。Map的键不允许为空字符串，最多支持64个字符。'."\n"
- ."\n"
- .'- Map的值允许为空字符串。自定义参数与原始命令内容在Base64编码后，综合长度不能超过18KB。'."\n"
- ."\n"
- .'- 设置的自定义参数名集合必须为创建命令时定义的参数集的子集。'."\n"
- ."\n"
- .'- 对于未传入的参数，您可以使用空字符串代替。您可以取消设置该参数从而禁用自定义参数。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}',
- ],
- ],
- [
- 'name' => 'Username',
- 'in' => 'query',
- 'schema' => [
- 'description' => '在轻量应用服务器中执行命令的用户名称。长度不得超过255个字符。'."\n"
- ."\n"
- .'- Linux系统的轻量应用服务器，默认以root用户执行命令。'."\n"
- ."\n"
- .'- Windows系统的轻量应用服务器，默认以System用户执行命令。'."\n"
- ."\n"
- .'您可以修改Linux系统执行用户，Windows系统执行用户不支持修改。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'InstanceIds',
+ 'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持50个ID，ID之间用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]',
- ],
+ 'schema' => ['description' => '返回值语言，取值：'."\n"
+ ."\n"
+ .'- **zh-CN**（默认值）：中文。'."\n"
+ ."\n"
+ .'- **en-US**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '支持的地域信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'InvokeId' => [
- 'description' => '命令执行ID。',
- 'type' => 'string',
- 'example' => 't-bj02prjhw1n****',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'Regions' => [
+ 'description' => '地域信息组成的数组。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '地域信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'LocalName' => ['description' => '地域名称。', 'type' => 'string', 'example' => 'China (Hangzhou)'],
+ 'RegionEndpoint' => ['description' => '地域对应的接入地址（Endpoint）。', 'type' => 'string', 'example' => 'swas.cn-hangzhou.aliyuncs.com'],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\",\\n \\"InvokeId\\": \\"t-bj02prjhw1n****\\"\\n}","type":"json"}]',
- 'title' => '执行命令',
- 'description' => '- 对目标轻量应用服务器有如下限制，当您选择多台轻量应用服务器后，若其中某台轻量应用服务器不满足执行条件，需要重新调用该接口。 '."\n"
- .' - 服务器状态必须为运行中（`Running`），您可以调用[ListInstances](~~2361065~~)查询。'."\n"
- .' - 已预先安装[云助手Agent](~~2361030~~)。'."\n"
- .' - 执行类型为PowerShell的命令时，必须已经配置了PowerShell模块。'."\n"
- .'- 命令可能会因为目标服务器的状态异常，网络异常或云助手Agent异常而出现无法执行的情况，无法执行不会生成执行信息。'."\n"
- .'- 当您创建命令启用了自定义参数时，需要在执行命令时传入自定义参数（`Parameters`）。'."\n"
- .'- 调用此接口时您只能选择一条公共命令或您创建的自定义命令。',
- ],
- 'DescribeCommands' => [
- 'summary' => '查询您手动创建的命令或者阿里云提供的公共命令。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"type":"json","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}","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' => '查询可用地域列表',
+ 'description' => '查询结果包含了轻量应用服务器中国站与国际站的全部可用地域。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListRegions'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ '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' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '快照对应的轻量应用服务器所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'CommandId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '命令ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c-sh02yh0932w****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => false, 'example' => '2ad1ae67295445f598017499dc****'],
],
[
- 'name' => 'Name',
+ 'name' => 'DiskId',
'in' => 'query',
- 'schema' => [
- 'description' => '命令的名称，暂不支持模糊查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => '指定的磁盘ID。', 'type' => 'string', 'required' => false, 'example' => 'd-bp14wq0149cpp2xy****'],
],
[
- 'name' => 'Provider',
+ 'name' => 'SnapshotIds',
'in' => 'query',
- 'schema' => [
- 'description' => '公共命令的提供者。参数值的具体说明如下：'."\n"
- ."\n"
- .'- 当该参数取值为`AlibabaCloud`时，查询由阿里云提供的所有公共命令。'."\n"
- .'- 当该参数的取值为`User`时，查询由您创建的所有自定义命令。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AlibabaCloud',
- ],
+ 'schema' => ['description' => '快照ID。取值可以由多个快照ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => '["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"]'],
],
[
- 'name' => 'Type',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '命令的语言类型。取值范围：'."\n"
- ."\n"
- .'- RunBatScript：适用于Windows实例的Bat命令。'."\n"
- .'- RunPowerShellScript：适用于Windows实例的PowerShell命令。'."\n"
- .'- RunShellScript：适用于Linux实例Shell命令。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RunShellScript',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。最大值：100。'."\n"
+ ."\n"
+ .'默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。'."\n"
- ."\n"
- .'起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '快照列表的页码。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'SourceDiskType',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。'."\n"
- ."\n"
- .'最大值：50。'."\n"
- ."\n"
- .'默认值：10。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '快照源云盘的云盘类型。取值范围：'."\n"
+ .'- System：系统盘。'."\n"
+ .'- Data：数据盘。', 'type' => 'string', 'required' => false, 'example' => 'Data'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '命令的标签列表。',
+ 'description' => '快照的标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '命令的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '命令的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '快照的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '快照的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -10431,565 +7702,255 @@
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => '指定的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bti7cf7****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'TotalCount' => [
- 'description' => '命令总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '命令列表页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Commands' => [
- 'description' => '命令列表。',
+ 'TotalCount' => ['description' => '快照的总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '快照列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Snapshots' => [
+ 'description' => '快照信息组成的数组。',
'type' => 'array',
'items' => [
- 'description' => '命令信息结构体。',
'type' => 'object',
'properties' => [
- 'CommandId' => [
- 'description' => '命令ID。',
- 'type' => 'string',
- 'example' => 'c-gov1k1tqwi9****',
- ],
+ 'Status' => ['description' => '快照状态。可能值：'."\n"
+ ."\n"
+ .'- Progressing：正在创建。'."\n"
+ .'- Accomplished：创建成功。'."\n"
+ .'- Failed：创建失败。', 'type' => 'string', 'example' => 'Accomplished'],
+ 'CreationTime' => ['description' => '快照创建时间。时间格式以[ISO8601](~~25696~~)为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2021-03-09T07:12:49Z'],
+ 'SourceDiskId' => ['description' => '源磁盘ID。即使快照的源磁盘已经被释放，仍保留该返回值。'."\n", 'type' => 'string', 'example' => 'd-bp14wq0149cpp2xy****'],
+ 'SnapshotName' => ['description' => '快照名称。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'test-SnapshotName'],
+ 'Progress' => ['description' => '快照创建的进度。', 'type' => 'string', 'example' => '100%'],
+ 'Remark' => ['description' => '快照备注。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'test-Remark'],
+ 'SnapshotId' => ['description' => '快照ID。'."\n"
+ ."\n", 'type' => 'string', 'example' => 's-bp16oazlsold4dks****'],
+ 'SourceDiskType' => ['description' => '快照源磁盘的磁盘类型。可能值：'."\n"
+ .'- System：系统盘。'."\n"
+ .'- Data：数据盘。', 'type' => 'string', 'example' => 'System'],
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'InstanceId' => ['description' => '轻量应用服务器实例ID。'."\n"
+ ."\n"
+ .'注：系统盘快照该字段有值，数据盘快照该值为空。', 'type' => 'string', 'example' => '2ad1ae67295445f598017499dc****'],
'Tags' => [
- 'description' => '命令的标签列表。',
+ 'description' => '快照的标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '命令的标签键。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '命令的标签值。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- ],
- ],
- ],
- 'CreationTime' => [
- 'description' => '命令创建时间。',
- 'type' => 'string',
- 'example' => '2023-01-05T06:38:53Z',
- ],
- 'Name' => [
- 'description' => '命令名称。',
- 'type' => 'string',
- 'example' => 'testName',
- ],
- 'Provider' => [
- 'description' => '命令的提供者。',
- 'type' => 'string',
- 'example' => 'User',
- ],
- 'Type' => [
- 'description' => '命令类型。',
- 'type' => 'string',
- 'example' => 'RunShellScript',
- ],
- 'Timeout' => [
- 'description' => '超时时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '60',
- ],
- 'Description' => [
- 'description' => '命令描述。',
- 'type' => 'string',
- 'example' => 'testDescription',
- ],
- 'WorkingDir' => [
- 'description' => '执行路径。',
- 'type' => 'string',
- 'example' => '/home',
- ],
- 'CommandContent' => [
- 'description' => '命令内容。',
- 'type' => 'string',
- 'example' => 'cat /etc/ssh/sshd_config',
- ],
- 'EnableParameter' => [
- 'description' => '该命令是否启用自定义参数。'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ParameterNames' => [
- 'description' => '通过创建命令时的CommandContent解析出的自定义参数名列表，以列表（List）的形式返回。如未使用自定义参数功能，则返回空值列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '自定义参数。',
- 'type' => 'string',
- 'example' => 'parameter1',
- ],
- ],
- 'ParameterDefinitions' => [
- 'description' => '自定义参数详细信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '自定义参数详细信息结构体。',
- 'type' => 'object',
- 'properties' => [
- 'Required' => [
- 'description' => '该自定义参数是否必填。'."\n"
- ."\n"
- .'- true：是。'."\n"
- ."\n"
- .'- false：否。'."\n"
- ."\n"
- .'默认值：false。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Description' => [
- 'description' => '自定义参数描述。',
- 'type' => 'string',
- 'example' => '命令助手Agent安装包路径',
- ],
- 'DefaultValue' => [
- 'description' => '自定义参数的默认值。',
- 'type' => 'string',
- 'example' => 'https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm',
- ],
- 'ParameterName' => [
- 'description' => '自定义参数名称。',
- 'type' => 'string',
- 'example' => 'DownloadUrl',
- ],
- 'PossibleValues' => [
- 'description' => '枚举类型自定义参数的可选值。',
- 'type' => 'array',
- 'items' => [
- 'description' => '枚举类型自定义参数值。',
- 'type' => 'string',
- 'example' => 'Linux',
- ],
- ],
+ 'Key' => ['description' => '快照的标签键。', 'type' => 'string', 'example' => 'TestKey'],
+ 'Value' => ['description' => '快照的标签值。', 'type' => 'string', 'example' => 'TestValue'],
],
],
],
- 'ResourceGroupId' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'RollbackTime' => ['description' => '最近一次回滚时间。', 'type' => 'string', 'example' => '2021-03-09T07:12:49Z'],
+ 'ResourceGroupId' => ['description' => '快照所属的资源组ID。', 'type' => 'string', 'example' => 'rg-aek2bti7cf7****'],
],
+ 'description' => '',
],
],
],
+ 'description' => '',
],
],
],
- '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' => '查询命令',
- ],
- 'DescribeCommandInvocations' => [
- 'summary' => '查询命令助手执行命令的列表和状态。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RegionIdNotMatchHost', 'errorMessage' => 'The parameter regionId does not match the endpoint host.', 'description' => '传入的regionId和请求的地址不匹配。'],
+ ['errorCode' => 'InvalidSnapshotIds', 'errorMessage' => 'The specified SnapshotIds is not valid.', 'description' => '指定的快照ID无效。'],
+ ],
+ 403 => [
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter value is invalid.', 'description' => '参数非法。'],
+ ],
+ [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ['errorCode' => 'InvalidDiskId.NotFound', 'errorMessage' => 'The specified DiskId does not exist.', 'description' => '指定的磁盘不存在，请您检查磁盘ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取快照',
+ 'summary' => '查询一个或多个已创建的快照信息。',
+ 'description' => '`InstanceId`、`DiskId`、`SnapshotIds`和`ResourceGroupId`不是必需的请求参数，但是可以构建过滤器逻辑，参数之间为逻辑与（And）关系。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ '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' => '[{"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":""}]',
+ ],
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- [
- 'name' => 'CommandId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '命令ID。您可以通过接口[DescribeCommands](~~64843~~)查询所有可用的CommandId。 ',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c-sh02yh0932w****',
- ],
- ],
- [
- 'name' => 'InvokeId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '命令执行ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 't-hz02p9545t6****',
- ],
- ],
- [
- 'name' => 'CommandName',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '命令名称。如果同时设置了InstanceId参数，则该参数不生效。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'InvocationStatus',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '命令执行的总执行状态，总执行状态取决于本次调用的全部实例的共同执行状态，可能值：'."\n"
- .'- Pending：系统正在校验或发送命令。存在至少一台实例的命令执行状态为Pending，则总执行状态为Pending。'."\n"
- .'- Running：命令正在实例上运行。存在至少一台实例的命令执行状态为Running，则总执行状态为Running。'."\n"
- .'- Success：各个实例上的命令执行状态均为Stopped或Success，且至少一个实例的命令执行状态是Success，则总执行状态为Success。'."\n"
- .' - 立即运行的任务：命令执行完成，且退出码为0。'."\n"
- .'- Failed：各个实例上的命令执行状态均为Stopped或Failed，则总执行状态为Failed。实例上的命令执行状态一项或多项为以下状态时，返回值均为Failed状态：'."\n"
- .' - 命令校验失败（Invalid）'."\n"
- .' - 命令发送失败（Aborted）'."\n"
- .' - 命令执行完成但退出码非0（Failed）'."\n"
- .' - 命令执行超时（Timeout）'."\n"
- .' - 命令执行异常（Error）'."\n"
- .'- Stopping：正在停止任务。存在至少一台实例的命令执行状态为Stopping，则总执行状态为Stopping。'."\n"
- .'- Stopped：任务已停止。所有实例的命令执行状态是Stopped，则总执行状态为Stopped。实例上的命令执行状态为以下状态时，返回值均为Stopped状态：'."\n"
- .' - 任务已取消（Cancelled）'."\n"
- .' - 任务已终止（Terminated）'."\n"
- .'- PartialFailed：部分实例执行成功且部分实例执行失败。各个实例的命令执行状态均为Success、Failed或Stopped，则总执行状态为PartialFailed。'."\n"
- .'> 返回参数中的`InvokeStatus`与该参数意义相似，但建议您查看该返回值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Success',
- ],
+ 'schema' => ['title' => '下一个查询开始Token', 'description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***'],
],
[
- 'name' => 'CommandType',
+ 'name' => 'ResourceType',
'in' => 'query',
- 'schema' => [
- 'description' => '命令类型。可能值：'."\n"
- ."\n"
- .'- RunBatScript：适用于Windows实例的Bat命令。'."\n"
- .'- RunPowerShellScript：适用于Windows实例的PowerShell命令。'."\n"
- .'- RunShellScript：适用于Linux实例Shell命令。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RunPowerShellScript',
- ],
+ 'schema' => ['title' => '资源类型', 'description' => '资源类型，取值范围：'."\n"
+ ."\n"
+ .'- instance：实例。'."\n"
+ .'- snapshot：快照。'."\n"
+ .'- customimage：镜像。'."\n"
+ .'- command：命令。'."\n"
+ .'- firewallrule：防火墙规则。'."\n"
+ .'- disk：磁盘。', 'type' => 'string', 'required' => true, 'example' => 'instance'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ResourceId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '当前页码。起始值：1。默认值：1。',
- 'type' => 'string',
+ 'title' => '资源ID,最多 50个子项',
+ 'description' => '资源ID，最多50个资源ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '轻量资源ID。', 'type' => 'string', 'required' => false, 'example' => 's-bw526m1vi6x20c6g****'],
'required' => false,
- 'example' => '1',
+ 'maxItems' => 51,
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '分页查询时设置的每页行数。'."\n"
- ."\n"
- .'最大值：50。'."\n"
- ."\n"
- .'默认值：10。',
- 'type' => 'string',
+ 'title' => '标签列表，最多包含20个子项',
+ 'description' => '标签列表，最多包含20个标签。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '资源所绑定的标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '标签键', 'description' => '轻量资源的标签键。标签键长度的取值范围：1~64。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['title' => '标签值', 'description' => '轻量资源的标签值。标签值长度的取值范围：1~64。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '10',
+ 'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'TotalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '查询结果的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'CommandInvocations' => [
- 'description' => '命令执行列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '命令执行信息结构体。',
- 'type' => 'object',
- 'properties' => [
- 'InvokeId' => [
- 'description' => '命令执行ID。',
- 'type' => 'string',
- 'example' => 't-hz0373jyzxt****',
- ],
- 'CreationTime' => [
- 'description' => '命令创建时间。',
- 'type' => 'string',
- 'example' => '2023-04-27T10:11:58',
- ],
- 'CommandId' => [
- 'description' => '命令ID。',
- 'type' => 'string',
- 'example' => 'c-hy0338xh28r****',
- ],
- 'InvocationStatus' => [
- 'description' => '命令执行的状态。可能值：'."\n"
- ."\n"
- .'- Pending：系统正在校验或发送命令。'."\n"
- .'- Invalid：指定命令类型或参数有误。'."\n"
- .'- Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成。'."\n"
- .'- Running：命令正在实例上执行。'."\n"
- .'- Success：命令执行完成，且退出码为0。'."\n"
- .'- Failed：命令执行完成，且退出码非0。'."\n"
- .'- Error：命令执行时发生异常无法继续。'."\n"
- .'- Timeout：命令执行超时。'."\n"
- .'- Cancelled：命令的执行动作已经取消，命令未曾启动。'."\n"
- .'- Stopping：正在停止执行的命令。'."\n"
- .'- Terminated：命令执行时被终止。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'CommandName' => [
- 'description' => '命令名称。',
- 'type' => 'string',
- 'example' => 'testCommandName',
- ],
- 'CommandType' => [
- 'description' => '命令类型。',
- 'type' => 'string',
- 'example' => 'RunShellScript',
- ],
- 'CommandDescription' => [
- 'description' => '命令描述。',
- 'type' => 'string',
- 'example' => 'testDescription',
- ],
- 'Username' => [
- 'description' => '执行命令的用户名称。',
- 'type' => 'string',
- 'example' => 'root',
- ],
- 'WorkingDir' => [
- 'description' => '命令执行的路径。',
- 'type' => 'string',
- 'example' => 'c:\\wwwroot',
- ],
- 'Timeout' => [
- 'description' => '超时时间，单位为秒（s）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '60',
- ],
- 'CommandContent' => [
- 'description' => '命令内容。',
- 'type' => 'string',
- 'example' => 'echo 123',
- ],
- 'Parameters' => [
- 'description' => '命令中包含自定义参数。如果没有参数，默认为{}.',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'InvokeInstances' => [
- 'description' => '执行目标实例列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '执行目标实例信息结构体。',
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'example' => '2445f4aecdac4b71ba2c7e3a7ccf****',
- ],
- 'StartTime' => [
- 'description' => '命令在实例中开始执行的时间。',
- 'type' => 'string',
- 'example' => '2023-05-09T03:32:24Z',
- ],
- 'FinishTime' => [
- 'description' => '命令进程的结束时间。',
- 'type' => 'string',
- 'example' => '2023-04-03T02:42:29Z',
- ],
- 'InvocationStatus' => [
- 'description' => '单台实例的命令进度状态，可能值：'."\n"
- .'- Pending：系统正在校验或发送命令。'."\n"
- .'- Invalid：指定命令类型或参数有误。'."\n"
- .'- Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成。'."\n"
- .'- Running：命令正在实例上运行。'."\n"
- .'- Success：'."\n"
- .' - 单次执行的命令：命令执行完成，且退出码为0。'."\n"
- .' - 定时执行的命令：上一次运行成功且退出码为0，且指定的时间已结束。'."\n"
- .'- Failed：'."\n"
- .' - 单次执行的命令：命令执行完成，且退出码非0。'."\n"
- .' - 定时执行的命令：上一次运行成功且退出码非0，且指定的时间将中止。'."\n"
- .'- Error：命令执行时发生异常无法继续。'."\n"
- .'- Timeout：命令执行超时。'."\n"
- .'- Cancelled：命令的执行动作已经取消，命令未曾启动。'."\n"
- .'- Stopping：正在停止任务。'."\n"
- .'- Terminated：命令运行时被终止。',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'Output' => [
- 'description' => '命令执行后的输出信息。',
- 'type' => 'string',
- 'example' => 'OutputMsg',
- ],
- 'ExitCode' => [
- 'description' => '命令的退出码。'."\n"
- ."\n"
- .'- Linux实例为Shell命令的退出码。'."\n"
- .'- Windows实例为Bat或者PowerShell命令的退出码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'ErrorInfo' => [
- 'description' => '命令的下发失败或执行失败原因的详情，可能值：'."\n"
- ."\n"
- .'- 空：命令执行正常。'."\n"
- .'- the specified instance does not exists：指定的实例不存在或已释放。'."\n"
- .'- the instance has released when create task：执行命令期间，该实例被释放。'."\n"
- .'- the instance is not running when create task：命令执行时，该实例不在运行中。'."\n"
- .'- the command is not applicable：命令不适用于指定的实例。'."\n"
- .'- the specified account does not exists：指定的账号不存在。'."\n"
- .'- the specified directory does not exists：指定的目录不存在。'."\n"
- .'- the cron job expression is invalid：指定的周期表达式不合法。'."\n"
- .'- the aliyun service is not running on the instance：云助手客户端未运行。'."\n"
- .'- the aliyun service in the instance does not response：云助手客户端无响应。'."\n"
- .'- the aliyun service in the instance is upgrading now：云助手客户端正在升级中。'."\n"
- .'- the aliyun service in the instance need upgrade：云助手客户端需要升级。'."\n"
- .'- the command delivery has been timeout：发送命令超时。'."\n"
- .'- the command execution has been timeout：命令执行超时。'."\n"
- .'- the command execution got an exception：命令执行发生异常。'."\n"
- .'- the command execution has been interrupted：命令执行被中断。'."\n"
- .'- the command execution exit code is not zero：命令执行结束，退出码非0。',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'the specified instance does not exists',
- ],
- 'ErrorCode' => [
- 'description' => '命令的下发失败或执行失败原因的代码，可能值：'."\n"
- ."\n"
- .'- 空：命令执行正常。'."\n"
- .'- InstanceNotExists：指定的实例不存在或已释放。'."\n"
- .'- InstanceReleased：执行命令期间，该实例被释放。'."\n"
- .'- InstanceNotRunning：命令执行时，该实例不在运行中。'."\n"
- .'- CommandNotApplicable：命令不适用于指定的实例。'."\n"
- .'- AccountNotExists：指定的账号不存在。'."\n"
- .'- DirectoryNotExists：指定的目录不存在。'."\n"
- .'- BadCronExpression：指定的周期表达式不合法。'."\n"
- .'- ClientNotRunning：云助手客户端未运行。'."\n"
- .'- ClientNotResponse：云助手客户端无响应。'."\n"
- .'- ClientIsUpgrading：云助手客户端正在升级中。'."\n"
- .'- ClientNeedUpgrade：云助手客户端需要升级。'."\n"
- .'- DeliveryTimeout：发送命令超时。'."\n"
- .'- ExecutionTimeout：命令执行超时。'."\n"
- .'- ExecutionException：命令执行发生异常。'."\n"
- .'- ExecutionInterrupted：命令执行被中断。'."\n"
- .'- ExitCodeNonzero：命令执行结束，退出码非0。',
- 'type' => 'string',
- 'example' => 'InstanceNotExists',
- ],
- ],
+ 'NextToken' => ['title' => '下一个查询开始Token，NextToken为空说明没有下一个', 'description' => '下一个查询开始Token，NextToken为空说明没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F '],
+ 'TagResources' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'TagResource' => [
+ 'title' => '资源列表',
+ 'description' => '由轻量资源及其标签组成的集合，包含了资源 ID、资源类型和标签键值等信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '轻量资源及其标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => ['title' => '资源类型', 'description' => '资源类型。可能值：'."\n"
+ ."\n"
+ .'- instance：实例。'."\n"
+ .'- snapshot：快照。'."\n"
+ .'- customimage：自定义镜像。'."\n"
+ .'- command：命令。'."\n"
+ .'- firewallrule：防火墙规则。'."\n"
+ .'- disk：磁盘。', 'type' => 'string', 'example' => 'instance'],
+ 'TagValue' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'example' => 'TestValue'],
+ 'ResourceId' => ['title' => '资源ID', 'description' => '资源ID。', 'type' => 'string', 'example' => 's-bw526m1vi6x20c6g****'."\n"],
+ 'TagKey' => ['title' => '标签键', 'description' => '标签键。', 'type' => 'string', 'example' => 'TestKey'],
],
],
],
],
+ 'description' => '',
],
],
],
],
],
- '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' => '查询命令执行列表和状态',
- ],
- 'DeleteCommand' => [
- 'summary' => '删除一条命令助手命令。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '查询标签列表',
+ 'summary' => '调用ListTagResources查询一个或多个轻量资源（实例、快照、磁盘、镜像、命令、防火墙规则）已经绑定的标签信息。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:ListTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', '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' => [],
@@ -10998,61 +7959,98 @@
'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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'CommandId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '命令ID。您可以通过接口[DescribeCommands](~~64843~~)查询所有可用的CommandId。 ',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-sh02yh0932w****',
- ],
+ 'schema' => ['description' => '轻量应用服务器实例ID。', 'type' => 'string', 'required' => true, 'example' => '9ae7106e68eb4402b0dcbd48a9de****'],
+ ],
+ [
+ 'name' => 'Username',
+ 'in' => 'query',
+ 'schema' => ['description' => '轻量应用服务器用户名。'."\n"
+ ."\n"
+ .'- Linux服务器不需要输入用户名。'."\n"
+ .'- Windows服务器默认用户名为`administrator`。', 'type' => 'string', 'required' => false, 'example' => 'administrator'],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => ['description' => '轻量应用服务器用户名对应的密码。'."\n"
+ ."\n"
+ .'- Linux服务器：不需要输入密码。'."\n"
+ .'- Windows服务器：输入已设置的密码。如果您购买轻量应用服务器后没有设置密码，请参见[重置密码](~~60055~~)。', 'type' => 'string', 'required' => false, 'example' => 'Test****'],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => ['description' => '远程登录实例的端口号。'."\n"
+ ."\n"
+ .'- Linux服务器：默认为22。'."\n"
+ ."\n"
+ .'- Windows服务器：默认为3389。'."\n"
+ ."\n"
+ .'>如果您需要使用自定义端口连接服务器，需要先修改服务器默认远程端口。具体操作，请参见 [设置远程连接自定义端口](~~2807402~~)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3389'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '响应参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****'],
+ 'RedirectUrl' => ['description' => '远程登录桌面地址。', 'type' => 'string', 'example' => 'https://ecs-workbench.aliyun.com/view/instance/single/gbktfz****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
- 'title' => '删除命令',
- 'description' => '无法删除正在执行中的命令。',
- ],
- 'CreateCommand' => [
- 'summary' => '新建一条命令助手命令。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'INSTANCE_LOGIN_FAILURE', 'errorMessage' => 'Instance login failure.', 'description' => '实例登陆失败。'],
+ ],
+ ],
+ 'title' => ' 远程登录实例',
+ 'summary' => '使用Workbench远程登录轻量应用服务器。',
+ 'description' => '创建轻量应用服务器后，您可以远程登录轻量应用服务器，在服务器上搭建环境、搭建应用等。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LoginInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => '[{"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":""}]',
+ ],
+ 'ModifyDatabaseInstanceDescription' => [
+ 'summary' => '修改轻量数据库实例的描述信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11061,293 +8059,277 @@
'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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Name',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '命令名称，支持全字符集。长度不得超过128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
[
- 'name' => 'Description',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '命令描述，支持全字符集。长度不得超过512个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'Type',
+ 'name' => 'DatabaseInstanceDescription',
'in' => 'query',
+ 'schema' => ['description' => '轻量数据库实例描述信息。', 'type' => 'string', 'required' => true, 'example' => 'This is a lightweight database instance.'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '命令的语言类型。取值范围：'."\n"
- ."\n"
- .'- RunBatScript：适用于Windows实例的Bat命令。'."\n"
- .'- RunPowerShellScript：适用于Windows实例的PowerShell命令。'."\n"
- .'- RunShellScript：适用于Linux实例Shell命令。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RunShellScript',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
+ ],
],
],
+ ],
+ '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' => '修改轻量数据库实例的描述信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDatabaseInstanceDescription'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'CommandContent',
- 'in' => 'query',
- 'schema' => [
- 'description' => '命令内容。您需要注意：'."\n"
- ."\n"
- .'- 指定参数`EnableParameter=true`可在命令内容中启用自定义参数功能：'."\n"
- .'- 用{{}}包含的方式定义自定义参数，在`{{}}`内参数名前后的空格以及换行符会被忽略。'."\n"
- .'- 自定义参数个数不能超过20个。'."\n"
- .'- 自定义参数名允许a-zA-Z0-9-_的组合，不支持其余字符，参数名不区分大小写。'."\n"
- .'- 单个自定义参数名不能超过64字节。',
- '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}'],
+ ],
],
],
+ ],
+ ],
+ 'ModifyDatabaseInstanceParameter' => [
+ 'summary' => '轻量数据库服务创建后，您可以查看数据库的参数信息，或者根据业务需求，修改数据库参数。',
+ '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' => '您创建的命令在ECS实例中运行的目录。'."\n"
- ."\n"
- .'默认值： '."\n"
- .'- Linux实例：管理员root用户的home目录下，具体为`/root`目录。 '."\n"
- .'- Windows实例：云助手客户端进程所在目录，例如`C:\\Windows\\System32`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/root/',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Timeout',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '设置命令在服务器实例中的超时时间，单位为秒。'."\n"
- ."\n"
- .'当执行命令的任务超时后，命令助手将强制终止任务进程。可设定超时时间取值范围为10～86400秒（24小时）。'."\n"
- ."\n"
- .'默认值：60。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '60',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
[
- 'name' => 'EnableParameter',
+ 'name' => 'Parameters',
'in' => 'query',
- 'schema' => [
- 'description' => '创建的命令是否使用自定义参数。'."\n"
- ."\n"
- .'默认值为false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '数据库参数及其值的JSON串，参数的值为字符串类型。格式：{"参数名称1":"参数值1","参数名称2":"参数值2"...}。', 'type' => 'string', 'required' => true, 'example' => '{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}'],
],
[
- 'name' => 'Tag',
+ 'name' => 'ForceRestart',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '标签列表，最多包含20个子项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '为命令指定的标签键。N 的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '为命令指定的标签值。N 的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '修改参数是否重启数据库，取值范围：'."\n"
+ ."\n"
+ .'- true：强制重启（若修改的参数当中，有需要重启的参数，则必须传入true，否则修改将不生效）。'."\n"
+ .'- false：不强制重启。'."\n"
+ ."\n"
+ .'默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aek2bti7cf7****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response.',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4****',
- ],
- 'CommandId' => [
- 'description' => '命令ID。',
- 'type' => 'string',
- 'example' => 'c-sh02yh0932w****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4****\\",\\n \\"CommandId\\": \\"c-sh02yh0932w****\\"\\n}","type":"json"}]',
- 'title' => '创建命令',
- ],
- 'StartTerminalSession' => [
- 'summary' => '为轻量应用服务器提供会话登录能力。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '修改数据库参数',
+ 'changeSet' => [],
+ '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' => '[{"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":""}]',
+ ],
+ 'ModifyFirewallRule' => [
+ 'summary' => '修改指定轻量应用服务器的防火墙规则。',
+ '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' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'CommandLine',
+ 'name' => 'RuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '发起会话后，指定执行的命令内容。长度不能超过 512 个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ssh root@192.168.0.***',
- ],
+ 'schema' => ['description' => '防火墙规则ID。', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****'],
+ ],
+ [
+ 'name' => 'RuleProtocol',
+ 'in' => 'query',
+ 'schema' => ['description' => '传输层协议。取值范围：'."\n"
+ ."\n"
+ .'- TCP：TCP协议。'."\n"
+ .'- UDP：UDP协议。'."\n"
+ .'- TCP+UDP：TCP和UDP协议。', 'type' => 'string', 'required' => true, 'example' => 'TCP'],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => ['description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。', 'type' => 'string', 'required' => true, 'example' => '3306'],
+ ],
+ [
+ 'name' => 'SourceCidrIp',
+ 'in' => 'query',
+ 'schema' => ['description' => '地址或地址段。', 'type' => 'string', 'required' => false, 'example' => '10.147.33.**'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'required' => false, 'example' => 'Custom'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'SessionId' => [
- 'description' => '会话ID。',
- 'type' => 'string',
- 'example' => 'ffb90b6e-b18a-4a33-88cf-86fb88****',
- ],
- 'SecurityToken' => [
- 'description' => '附加在WebSocket的请求头部，用于系统校验本次请求。',
- 'type' => 'string',
- 'example' => 'token-xxxaaz',
- ],
- 'WebSocketUrl' => [
- 'description' => '远程连接轻量应用服务器实例的WebSocket会话对应的URL。包含了会话ID（`SessionId`）以及用于系统校验的`SecurityToken`。',
- 'type' => 'string',
- 'example' => 'wss://xxxx',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E1FEE'],
],
+ 'description' => '',
],
],
],
- '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' => '开启免密登录会话',
- ],
- 'InstallCloudAssistant' => [
- 'summary' => '为轻量应用服务器安装云助手。',
- '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' => '传入的regionId和请求的地址不匹配。'],
+ ['errorCode' => 'InvalidIpProtocol.ValueNotSupported', 'errorMessage' => 'The parameter Permissions.1.IpProtocol must be specified with case insensitive TCP, UDP, ICMP, GRE or All.', 'description' => '参数Permissions.1.IpProtocol必须指定为不区分大小写的TCP、UDP、ICMP、GRE或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' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E1FEE\\"\\n}","type":"json"}]',
+ 'title' => '修改实例防火墙规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyFirewallRule'],
+ ],
+ ],
+ '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}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyFirewallTemplate' => [
+ 'summary' => '对于已创建的防火墙模板，您可以根据业务需求修改防火墙规则，并最终将这些规则通过防火墙模板设置到轻量应用服务器实例中。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11356,568 +8338,479 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '219662',
+ 'abilityTreeNodes' => ['FEATUREswasTHKH01'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查看最新的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
+ ],
+ [
+ 'name' => 'FirewallTemplateId',
+ 'in' => 'query',
+ 'schema' => ['description' => '防火墙模板ID。', 'type' => 'string', 'required' => true, 'example' => 'ft-bcf1a7hrdq717****'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '防火墙模板名称。', 'type' => 'string', 'required' => false, 'example' => 'testName'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '防火墙模板描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'FirewallTemplateRule',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '轻量应用服务器实例ID。',
+ 'description' => '防火墙规则。',
'type' => 'array',
'items' => [
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
+ 'description' => '防火墙规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'FirewallTemplateRuleId' => ['description' => '防火墙模板规则ID。', 'type' => 'string', 'required' => true, 'example' => 'eeea34d9867b4d55a4ff8d5fcfbd****'],
+ 'RuleProtocol' => ['description' => '传输层协议。可能值：'."\n"
+ ."\n"
+ .'- TCP：TCP协议。'."\n"
+ .'- UDP：UDP协议。'."\n"
+ .'- TCP+UDP：TCP和UDP协议。'."\n"
+ .'- ICMP：ICMP协议。', 'type' => 'string', 'required' => false, 'example' => 'TCP'],
+ 'Port' => ['description' => '端口范围。端口的取值范围为1~65535。使用正斜线（/）隔开起始端口和终止端口，例如：`1024/1055`表示端口范围为1024~1055。'."\n"
+ ."\n"
+ .'> 如果您设置的是ICMP协议，端口只能为-1/-1。', 'type' => 'string', 'required' => false, 'example' => '8080'],
+ 'SourceCidrIp' => ['description' => '需要设置访问权限的源端IPv4 CIDR地址段。支持CIDR格式和IPv4格式的IP地址范围。', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'],
+ 'Remark' => ['description' => '防火墙规则的备注。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
'required' => false,
- 'example' => 'ace0706b2ac4454d984295a94213****',
],
- 'required' => true,
- 'maxItems' => 50,
+ 'required' => false,
+ 'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
+ 'description' => '',
],
],
],
- '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' => '安装云助手',
- 'description' => '执行命令必须要安装云助手，您可以通过调用[DescribeCloudAssistantStatus](~~439512~~)查看轻量应用服务器是否已安装云助手。如果没有安装，您可以调用InstallCloudAssistant接口安装云助手，并调用[RebootInstance](~~190443~~)接口重启实例，云助手客户端即可生效。',
- ],
- 'DescribeCloudAssistantStatus' => [
- 'summary' => '查询轻量云服务器是否安装云助手。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '修改防火墙模板',
+ 'description' => '修改防火墙模板不会影响已应用当前模板的实例规则。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => '为指定的自定义镜像共享或取消共享到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' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。'."\n"
- ."\n"
- .'起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。'."\n"
- ."\n"
- .'最大值：50。'."\n"
- ."\n"
- .'默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => true, 'example' => 'm-saacssasc****'],
],
[
- 'name' => 'InstanceIds',
+ 'name' => 'Operation',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- 'required' => false,
- 'maxItems' => 50,
- ],
+ 'schema' => ['description' => '取值范围如下：'."\n"
+ ."\n\n"
+ .'- Share：共享到ECS'."\n"
+ .'- UnShare：取消共享到ECS'."\n", 'type' => 'string', 'required' => true, 'example' => 'Share'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'CloudAssistantStatus' => [
- 'description' => '云助手状态信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '云助手状态信息。',
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'description' => '指定的轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- 'Status' => [
- 'description' => '云助手状态。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '命令总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。'."\n"
- ."\n"
- .'最大值：50。'."\n"
- ."\n"
- .'默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '当前页码。'."\n"
- ."\n"
- .'起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****'],
],
+ 'description' => '',
],
],
],
- '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' => '查询云助手安装状态',
- 'description' => '轻量服务器默认已安装云助手，如果您已手动卸载，需重新安装云助手，否则无法使用执行命令的功能。',
- ],
- 'DescribeInvocationResult' => [
- 'summary' => '查询单个命令的执行结果。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParam.OperationIllegal', 'errorMessage' => 'The specified parameter operation is illegal.', 'description' => '指定的operation不合法。'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => '指定的镜像不存在，请您检查镜像ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '共享、解除共享自定义镜像',
+ 'description' => '自定义镜像支持共享到ECS。当轻量应用服务器的配置不能再满足您的业务需要、或者您期望使用云服务器ECS部署业务时，您可以通过共享镜像将业务从轻量应用服务器转移至云服务器ECS。'."\n"
+ ."\n"
+ .'> 共享镜像在云服务器ECS中所属的地域，与自定义镜像所属的地域保持一致。'."\n"
+ ."\n"
+ .'当您不再需要共享自定义镜像或者需要删除自定义镜像时，您可以取消共享自定义镜像。'."\n"
+ .'当您取消共享镜像后，请注意：'."\n"
+ .'- 无法通过云服务器ECS管理控制台或ECS API查询到该自定义镜像，也无法再使用该自定义镜像。'."\n"
+ .'- 已使用该共享镜像创建的实例无法重新初始化云盘。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImageShareStatus'],
+ ],
],
+ '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' => '[{"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":""}]',
+ ],
+ 'ModifyInstanceVncPassword' => [
+ 'summary' => '修改实例的VNC密码。',
+ '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' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
- 'name' => 'InvokeId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '命令执行ID。您可以通过接口[DescribeInvocations](~~439368~~)查询InvokeId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 't-bj02prjhw1n****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'VncPassword',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[DescribeRegions](~~25609~~)查看最新的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'VNC密码。', 'type' => 'string', 'required' => false, 'example' => '***'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****',
- ],
- 'InvocationResult' => [
- 'description' => '命令执行结果信息。',
- 'type' => 'object',
- 'properties' => [
- 'StartTime' => [
- 'description' => '命令在实例中开始执行的时间。',
- 'type' => 'string',
- 'example' => '2022-07-11T06:37:16Z',
- ],
- 'FinishedTime' => [
- 'description' => '命令在实例中执行完成时间。',
- 'type' => 'string',
- 'example' => '2022-07-11T06:37:17Z',
- ],
- 'InvocationStatus' => [
- 'description' => '实例的命令进度状态，可能值：'."\n"
- ."\n"
- .'- Pending：系统正在校验或发送命令。'."\n"
- .'- Invalid：指定命令类型或参数有误。'."\n"
- .'- Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成。'."\n"
- .'- Running：命令正在实例上执行。'."\n"
- .'- Success：命令执行完成，且退出码为0。'."\n"
- .'- Failed：命令执行完成，且退出码非0。'."\n"
- .'- Error：命令执行时发生异常无法继续。'."\n"
- .'- Timeout：命令执行超时。'."\n"
- .'- Cancelled：命令的执行动作已经取消，命令未曾启动。'."\n"
- .'- Stopping：正在停止执行的命令。'."\n"
- .'- Terminated：命令执行时被终止。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'ExitCode' => [
- 'description' => '命令的退出码。'."\n"
- ."\n"
- .'- Linux实例为Shell命令的退出码。'."\n"
- .'- Windows实例为Bat或者PowerShell命令的退出码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'ErrorInfo' => [
- 'description' => '命令的下发失败或执行失败原因的详情，可能值：'."\n"
- ."\n"
- .'- 空：命令执行正常。'."\n"
- .'- the specified instance does not exists：指定的实例不存在或已释放。'."\n"
- .'- the instance has released when create task：执行命令期间，该实例被释放。'."\n"
- .'- the instance is not running when create task：命令执行时，该实例不在运行中。'."\n"
- .'- the command is not applicable：命令不适用于指定的实例。'."\n"
- .'- the specified account does not exists：指定的账号不存在。'."\n"
- .'- the specified directory does not exists：指定的目录不存在。'."\n"
- .'- the cron job expression is invalid：指定的周期表达式不合法。'."\n"
- .'- the aliyun service is not running on the instance：云助手客户端未运行。'."\n"
- .'- the aliyun service in the instance does not response：云助手客户端无响应。'."\n"
- .'- the aliyun service in the instance is upgrading now：云助手客户端正在升级中。'."\n"
- .'- the aliyun service in the instance need upgrade：云助手客户端需要升级。'."\n"
- .'- the command delivery has been timeout：发送命令超时。'."\n"
- .'- the command execution has been timeout：命令执行超时。'."\n"
- .'- the command execution got an exception：命令执行发生异常。'."\n"
- .'- the command execution has been interrupted：命令执行被中断。'."\n"
- .'- the command execution exit code is not zero：命令执行结束，退出码非0。',
- 'type' => 'string',
- 'example' => 'the specified instance does not exists',
- ],
- 'ErrorCode' => [
- 'description' => '命令的下发失败或执行失败原因的代码，可能值：'."\n"
- ."\n"
- .'- 空：命令执行正常。'."\n"
- .'- InstanceNotExists：指定的实例不存在或已释放。'."\n"
- .'- InstanceReleased：执行命令期间，该实例被释放。'."\n"
- .'- InstanceNotRunning：命令执行时，该实例不在运行中。'."\n"
- .'- CommandNotApplicable：命令不适用于指定的实例。'."\n"
- .'- AccountNotExists：指定的账号不存在。'."\n"
- .'- DirectoryNotExists：指定的目录不存在。'."\n"
- .'- BadCronExpression：指定的周期表达式不合法。'."\n"
- .'- ClientNotRunning：云助手客户端未运行。'."\n"
- .'- ClientNotResponse：云助手客户端无响应。'."\n"
- .'- ClientIsUpgrading：云助手客户端正在升级中。'."\n"
- .'- ClientNeedUpgrade：云助手客户端需要升级。'."\n"
- .'- DeliveryTimeout：发送命令超时。'."\n"
- .'- ExecutionTimeout：命令执行超时。'."\n"
- .'- ExecutionException：命令执行发生异常。'."\n"
- .'- ExecutionInterrupted：命令执行被中断。'."\n"
- .'- ExitCodeNonzero：命令执行结束，退出码非0。',
- 'type' => 'string',
- 'example' => 'InstanceNotExists',
- ],
- 'InvokeId' => [
- 'description' => '命令执行ID。',
- 'type' => 'string',
- 'example' => 't-bj02prjje65****',
- ],
- 'InvokeRecordStatus' => [
- 'description' => '命令执行状态。可能值：'."\n"
- ."\n"
- .'- Running：运行中。'."\n"
- .'- Finished：已完成。'."\n"
- .'- Failed：失败。'."\n"
- .'- Stopped：已停止。',
- 'type' => 'string',
- 'example' => 'Finished',
- ],
- 'InvokeUser' => [
- 'description' => '在轻量应用服务器实例中执行命令的用户名称。',
- 'type' => 'string',
- 'example' => 'root',
- ],
- 'Output' => [
- 'description' => '命令执行后的输出信息。',
- 'type' => 'string',
- 'example' => 'YWRtaW4K',
- ],
- 'InstanceId' => [
- 'description' => '轻量应用服务器实例ID。',
- 'type' => 'string',
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
],
+ 'description' => '',
],
],
],
- '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' => '查询单个命令的执行结果',
- 'description' => '- 当您执行命令后，不代表命令一定成功执行，并且一定有预期的命令效果。您需要通过本接口查看实际的具体执行结果，以实际输出结果为准。'."\n"
- .'- 您可以查询最近2周的执行信息，执行信息的保留上限为10万条。',
- ],
- 'RunCommand' => [
- 'summary' => '在轻量应用服务器上执行命令。',
- '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' => '传入的regionId和请求的地址不匹配。'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '修改实例VNC密码',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceVncPassword'],
+ ],
+ ],
+ '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' => '重启一台轻量应用服务器。',
+ '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' => '命令内容。您需要注意：'."\n"
- ."\n"
- .'- 指定参数`EnableParameter=true`可在命令内容中启用自定义参数功能：'."\n"
- .'- 用{{}}包含的方式定义自定义参数，在`{{}}`内参数名前后的空格以及换行符会被忽略。'."\n"
- .'- 自定义参数个数不能超过20个。'."\n"
- .'- 自定义参数名允许a-zA-Z0-9-_的组合，不支持其余字符，参数名不区分大小写。'."\n"
- .'- 单个自定义参数名不能超过64字节。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ifconfig -s',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
- 'name' => 'WorkingDir',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '您可自定义命令的执行路径。默认路径如下：'."\n"
- ."\n"
- .'- Linux实例：执行路径默认在管理员root用户的/root目录下。'."\n"
- .'- Windows实例：执行路径默认在C:\\Windows\\system32目录下。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/root',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ClientToken',
'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查看最新的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The state of the current instance does not support this operation.', 'description' => '当前实例的状态不支持此操作。'],
+ ],
[
- 'name' => 'Timeout',
- 'in' => 'query',
- 'schema' => [
- 'description' => '设置命令在服务器实例中的超时时间，单位为秒。'."\n"
- ."\n"
- .'当执行命令的任务超时后，命令助手将强制终止任务进程。可设定超时时间取值范围为10～86400秒（24小时）。'."\n"
- ."\n"
- .'默认值：60。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '60',
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '重启实例',
+ 'description' => '- 您只能重启状态为运行中（Running）的轻量应用服务器实例。'."\n"
+ ."\n"
+ .'- 重启轻量应用服务器实例后进入启动中（Starting）状态。',
+ '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' => '[{"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":""}]',
+ ],
+ 'RebootInstances' => [
+ 'summary' => '重启一台或多台轻量应用服务器。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Type',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '命令的语言类型。取值范围：'."\n"
- ."\n"
- .'- RunBatScript：适用于Windows实例的Bat命令。'."\n"
- .'- RunPowerShellScript：适用于Windows实例的PowerShell命令。'."\n"
- .'- RunShellScript：适用于Linux实例Shell命令。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RunShellScript',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'EnableParameter',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '命令中是否包含自定义参数。'."\n"
- ."\n"
- .'默认值：false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'Parameters',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]'],
+ ],
+ [
+ 'name' => 'ForceReboot',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否强制重启。取值范围：'."\n"
+ ."\n"
+ .'- true：强制重启。相当于典型的断电操作，所有未写入存储设备的缓存数据会丢失。'."\n"
+ ."\n"
+ .'- false：正常重启。'."\n"
+ ."\n"
+ .'默认值：false', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '命令中包含自定义参数时，执行命令时传入的自定义参数的键值对。例如，命令内容为`echo {{name}}`，则可以通过`Parameters`参数传入键值对`{"name":"Jack"}`。自定义参数将自动替换变量值`name`，得到一条新的命令，实际执行的是`echo Jack`。'."\n"
- ."\n"
- .'自定义参数的个数范围为0~20，且您需要注意：'."\n"
- ."\n"
- .'- 键不允许为空字符串，最多支持64个字符。'."\n"
- .'- 值允许为空字符串。'."\n"
- .'- 自定义参数与原始命令内容在Base64编码后，综合长度不能超过16 KB。'."\n"
- .'- 设置的自定义参数名集合必须为创建命令时定义的参数集的子集。对于未传入的参数，您可以使用空字符串代替。'."\n"
- ."\n"
- .'默认值为空，表示取消设置该参数从而禁用自定义参数。',
'type' => 'object',
- 'required' => false,
- 'example' => '{"name":"Jack", "accessKey":"LTAI****************"}',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The state of the current instance does not support this operation.', 'description' => '当前实例的状态不支持此操作。'],
+ ],
[
- 'name' => 'WorkingUser',
- 'in' => 'query',
- 'schema' => [
- 'description' => '您可以指定以某个轻量应用服务器实例中存在的用户执行命令，建议使用普通用户执行命令可降低安全风险。'."\n"
- .'默认值：'."\n"
- ."\n"
- .'- root：Linux实例中默认以root用户执行命令。'."\n"
- ."\n"
- .'- system：Windows实例中默认以system用户执行命令。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'root',
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '批量重启实例',
+ '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' => 'Windows实例中执行命令的用户的密码名称。'."\n"
- ."\n"
- .'当您希望以非默认用户（System）在Windows实例中执行命令时，需要同时传入WorkingUser和该参数。为降低密码泄露的风险，需要将密码明文托管在运维编排服务的参数仓库中，此处仅传入密码的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'axtSecretPassword',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用云服务器实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ace0706b2ac4454d984295a94213****',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
[
- 'name' => 'Name',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '执行命令名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testName',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
@@ -11927,112 +8820,76 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****',
- ],
- 'InvokeId' => [
- 'description' => '命令执行ID。',
- 'type' => 'string',
- 'example' => 't-hz02p9545t6****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
],
],
],
- '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' => '执行命令',
- 'description' => '命令助手是专为轻量应用服务器打造的自动化运维工具。您无需登录，即可在控制台上通过命令（Shell、Powershell和Bat）对轻量应用服务器实例进行运维管理操作。'."\n"
- ."\n"
- .'使用命令助手时，需满足以下条件：'."\n"
- ."\n"
- .'- 轻量应用服务器实例的状态必须为运行中。'."\n"
- .'- 已安装云助手客户端。轻量应用服务器实例默认已安装云助手客户端，如果您手动卸载，需重新安装。具体操作，请参见[安装云助手客户端](~~64921~~)。',
- ],
- 'DescribeInvocations' => [
- 'summary' => '查看命令详细信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '释放外网访问地址',
+ 'summary' => '如果您不再需要使用外网地址访问轻量数据库实例，可以释放外网访问地址。',
+ 'changeSet' => [],
+ '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' => '[{"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":""}]',
+ ],
+ 'RemoveCustomImageShareAccount' => [
+ 'summary' => '为了安全考虑，跨账号共享自定义镜像后，您可以调用RemoveCustomImageShareAccount接口取消跨账号共享自定义镜像。',
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查看最新的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量应用服务器的实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3a658ca270df4df39f22e289b338****',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。'."\n"
- ."\n"
- .'起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。'."\n"
- ."\n"
- .'最大值：50。'."\n"
- ."\n"
- .' 默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '被共享的自定义镜像ID。', 'type' => 'string', 'required' => true, 'example' => 'm-2zehv38jjmwva1ee****'],
],
[
- 'name' => 'InvokeStatus',
+ 'name' => 'Account',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '命令运行状态。可能值：'."\n"
- .'- Running：命令运行中。'."\n"
- .'- Finished：命令执行完成'."\n"
- .'- Failed：命令运行失败。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Finished',
+ 'description' => '授权取消共享镜像的阿里云主账号ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '授权取消共享镜像的阿里云主账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '125111425233****'],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
],
@@ -12040,229 +8897,124 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'Invocations' => [
- 'description' => '命令执行记录。',
- 'type' => 'array',
- 'items' => [
- 'description' => '命令执行记录。',
- 'type' => 'object',
- 'properties' => [
- 'CreationTime' => [
- 'description' => '命令创建时间。',
- 'type' => 'string',
- 'example' => '2022-07-11T06:37:16Z',
- ],
- 'InvocationStatus' => [
- 'description' => '命令执行的状态。可能值：'."\n"
- ."\n"
- .'- Pending：系统正在校验或发送命令。'."\n"
- .'- Invalid：指定命令类型或参数有误。'."\n"
- .'- Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成。'."\n"
- .'- Running：命令正在实例上执行。'."\n"
- .'- Success：命令执行完成，且退出码为0。'."\n"
- .'- Failed：命令执行完成，且退出码非0。'."\n"
- .'- Error：命令执行时发生异常无法继续。'."\n"
- .'- Timeout：命令执行超时。'."\n"
- .'- Cancelled：命令的执行动作已经取消，命令未曾启动。'."\n"
- .'- Stopping：正在停止执行的命令。'."\n"
- .'- Terminated：命令执行时被终止。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'CommandType' => [
- 'description' => '命令类型。可能值：'."\n"
- ."\n"
- .'- RunBatScript：适用于Windows实例的Bat命令。'."\n"
- .'- RunPowerShellScript：适用于Windows实例的PowerShell命令。'."\n"
- .'- RunShellScript：适用于Linux实例Shell命令。',
- 'type' => 'string',
- 'example' => 'RunShellScript',
- ],
- 'CommandContent' => [
- 'description' => '命令内容,，以Base64编码后传输。',
- 'type' => 'string',
- 'example' => 'bHM=',
- ],
- 'Parameters' => [
- 'description' => '命令中包含自定义参数。如果没有参数，默认为{}.',
- 'type' => 'object',
- 'example' => '{}',
- ],
- 'InvokeStatus' => [
- 'description' => '命令状态。可能值：'."\n"
- ."\n"
- .'- Running：命令运行中。'."\n"
- .'- Finished：命令执行完成。'."\n"
- .'- Failed：命令执行失败。'."\n"
- .'- Stopped：停止命令。',
- 'type' => 'string',
- 'example' => 'Finished',
- ],
- 'InvokeId' => [
- 'description' => '命令执行ID。',
- 'type' => 'string',
- 'example' => 't-hz02p9545t6****',
- ],
- 'CommandName' => [
- 'description' => '命令名称。',
- 'type' => 'string',
- 'example' => 'testname',
- ],
- ],
- ],
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '命令总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
],
],
],
- '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' => '查看命令详细信息',
- 'description' => '- 当您执行命令后，不代表命令一定成功运行，并且一定有预期的命令效果。您需要通过接口返回值查看实际执行结果，以实际输出结果为准。'."\n"
- .'- 您可以查询最近2周的执行信息，执行信息的保留上限为10万条。',
- ],
- 'ModifyDatabaseInstanceParameter' => [
- 'summary' => '轻量数据库服务创建后，您可以查看数据库的参数信息，或者根据业务需求，修改数据库参数。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '取消跨账号共享镜像',
+ '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}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\"\\n}","type":"json"}]',
+ ],
+ 'RenewInstance' => [
+ 'summary' => '续费一台轻量应用服务器。',
+ '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',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
- 'name' => 'Parameters',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '数据库参数及其值的JSON串，参数的值为字符串类型。格式：{"参数名称1":"参数值1","参数名称2":"参数值2"...}。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ForceRestart',
+ 'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '修改参数是否重启数据库，取值范围：'."\n"
- ."\n"
- .'- true：强制重启（若修改的参数当中，有需要重启的参数，则必须传入true，否则修改将不生效）。'."\n"
- .'- false：不强制重启。'."\n"
- ."\n"
- .'默认值：false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '续费时长。单位：月。取值范围：{"1", "3", "6","12", "24", "36"}', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '36', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
],
+ 'description' => '',
],
],
],
- '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' => '修改数据库参数',
- ],
- 'StopDatabaseInstance' => [
- 'summary' => '停止轻量数据库实例。',
- 'methods' => [
- 'post',
- 'get',
+ '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' => '售卖系统出现错误。'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '续费实例',
+ 'description' => '- 在调用接口前，请您了解轻量应用服务器的计费信息。更多信息，请参见[计费项](~~58623~~)。'."\n"
+ .'- 调用该接口续费服务器时，您需要确保您的阿里云账户余额充足，否则会续费失败。',
+ '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' => '[{"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":""}]',
+ ],
+ 'ResetDatabaseAccountPassword' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -12274,9 +9026,7 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
+ 'abilityTreeNodes' => ['FEATUREswas8GRVRI'],
'autoTest' => false,
'notSupportAutoTestReason' => '轻量数据库，走下线流程',
'tenantRelevance' => 'publicInformation',
@@ -12285,33 +9035,23 @@
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
+ ],
+ [
+ 'name' => 'AccountPassword',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据库administrator账号的密码。', 'type' => 'string', 'required' => true, 'example' => 'Password****'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
@@ -12321,217 +9061,284 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
],
],
],
- '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' => '停止轻量数据库实例',
- 'description' => '如果轻量数据库实例处于运行状态，您可以通过此接口停止轻量数据库实例。停止后，轻量数据库实例不支持登录和访问。',
- ],
- 'StartDatabaseInstance' => [
- 'summary' => '启动轻量数据库实例。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '重置数据库账号的密码',
+ 'summary' => '如果数据库的密码安全性较差，您也可以通过调用此接口可以修改数据库administrator账号的密码。为了数据库的安全，建议您定期更改数据库密码。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetDatabaseAccountPassword'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => '[{"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":""}]',
+ ],
+ 'ResetDisk' => [
+ 'summary' => '根据快照回滚磁盘。',
+ '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' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '快照对应的轻量应用服务器所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'DiskId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '待回滚的磁盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp14wq0149cpp2xy****'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => '快照ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-bp16oazlsold4dks****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['description' => '请求ID。'."\n"
+ ."\n", 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
],
+ 'description' => '',
],
],
],
- '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' => '启动轻量数据库实例',
- 'description' => '如果轻量数据库实例处于停止状态，您可以通过此接口启动轻量数据库实例。',
- ],
- 'ModifyDatabaseInstanceDescription' => [
- 'summary' => '修改轻量数据库实例的描述信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus.ResetDisk', 'errorMessage' => 'Rolling back the disk requires the instance to operate in a stopped state.', 'description' => '回滚磁盘需要实例在停止的状态下进行操作。'."\n"],
+ ],
+ [
+ ['errorCode' => 'InvalidDiskId.NotFound', 'errorMessage' => 'The specified DiskId does not exist.', 'description' => '指定的磁盘不存在，请您检查磁盘ID是否正确。'],
+ ['errorCode' => 'InvalidSnapshotId.NotFound', 'errorMessage' => 'The specified SnapshotId does not exist.', 'description' => '指定的快照不存在，请您检查快照ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '回滚磁盘',
+ 'description' => '- 使用快照回滚磁盘时，对应的轻量应用服务器必须为已停止状态。'."\n"
+ .'- 回滚快照会丢失该快照创建之后的增量数据，如有需要请您提前做好数据备份。'."\n"
+ .'### 注意事项'."\n"
+ .'重置系统或更换镜像会清除服务器上的磁盘数据，重置系统或更换镜像前创建的快照会保留但无法支持回滚操作。',
+ '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' => '[{"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":""}]',
+ ],
+ 'ResetSystem' => [
+ 'summary' => '为指定的轻量应用服务器重置系统。',
+ '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' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '目标镜像ID。如果不输入目标镜像ID，默认为重置当前镜像。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '794c230fd3e64ea19f83f4d7a0ad****'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
],
[
- 'name' => 'DatabaseInstanceDescription',
+ 'name' => 'LoginCredentials',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '轻量数据库实例描述信息。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '这是轻量数据库实例',
+ 'description' => '登录凭证信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Password' => ['description' => '输入轻量应用服务器管理员账号对应的密码。'."\n"
+ ."\n"
+ .'- Windows服务器：管理员账号默认为Administrator。'."\n"
+ ."\n"
+ .'- Linux服务器：管理员账号默认为root。', 'type' => 'string', 'required' => false, 'example' => '***'],
+ 'KeyPairName' => ['description' => '密钥对名称。仅Linux服务器支持设置密钥对。', 'type' => 'string', 'required' => false, 'example' => 'aliyunkey'],
+ ],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
],
+ 'description' => '',
],
],
],
- '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' => '修改轻量数据库实例的描述信息',
- ],
- 'DescribeDatabaseSlowLogRecords' => [
- 'summary' => '查询轻量数据库慢日志明细信息。',
- 'methods' => [
- 'post',
- 'get',
+ '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' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => '指定的镜像不存在，请您检查镜像ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '重置系统',
+ 'description' => '重置系统可以重新安装服务器的应用或者操作系统，达到重新初始化服务器的目的。重置系统有两种选择，重置当前系统和重置为其他镜像。'."\n"
+ ."\n"
+ .'重置系统包括以下两种方式：'."\n"
+ ."\n"
+ .'- 重置当前系统：不改变当前镜像，重新安装操作系统。'."\n"
+ ."\n"
+ .'- 重置为其他镜像：选择阿里云提供的其他镜像或者您创建的自定义镜像，重新安装操作系统。'."\n"
+ ."\n"
+ .'### 注意事项'."\n"
+ ."\n"
+ .'- 重置系统或更换镜像会清除轻量应用服务器上的磁盘数据，请您根据需要做好数据备份。'."\n"
+ ."\n"
+ .'- 重置系统或更换镜像后，可能会导致监控失效。如果监控出现问题，您可以手动安装云监控插件。'."\n"
+ ."\n"
+ .' - 远程连接服务器安装：具体操作，请参见[为阿里云主机手动安装插件](~~183482~~)。'."\n"
+ ."\n"
+ .' - 使用命令助手安装：具体操作，请参见[使用命令助手](~~438681~~)，安装云监控的命令，您可以从[使用命令助手](~~438681~~)文档的常用命令中获取。 '."\n"
+ ."\n"
+ .'### 使用限制'."\n"
+ ."\n"
+ .'- 重置系统或更换镜像前创建的快照会保留，但无法通过重置前创建的快照回滚磁盘。'."\n"
+ ."\n"
+ .'- 含有数据盘数据的自定义镜像创建的轻量应用服务器，不支持重置系统。'."\n"
+ ."\n"
+ .'- 选择自定义镜像重置系统时：'."\n"
+ ."\n"
+ .' - 仅支持选择与当前服务器同一地域下的自定义镜像。'."\n"
+ ."\n"
+ .' - 不支持选择当前服务器对应的自定义镜像。如果您有恢复服务器数据的需求，可以使用当前服务器对应的快照回滚磁盘数据。'."\n"
+ ."\n"
+ .' - 非中国内地地域不支持Windows Server系统和Linux系统互相切换，即Windows系统的自定义镜像无法重置Linux服务器；Linux系统的自定义镜像无法重置Windows服务器。仅支持Windows Server不同版本之间或Linux不同发行版本之间的更换。'."\n"
+ ."\n"
+ .' - 云盘存在以下限制：'."\n"
+ ."\n"
+ .' - 当自定义镜像中包含系统盘与数据盘，但待重置服务器中只挂载了系统盘，没有挂载数据盘时，您无法使用该自定义镜像重置系统。'."\n"
+ ."\n"
+ .' - 当自定义镜像中包含的系统盘容量比待重置系统的服务器中系统盘容量大时，您无法直接使用该自定义镜像重置系统。'."\n"
+ ."\n"
+ .' - 当服务器中系统盘容量大于等于自定义镜像中系统盘容量时，即可使用该自定义镜像重置系统。您可以为待重置系统的服务器升级配置，将服务器中系统盘容量升级。具体操作，请参见升级配置。'."\n"
+ ."\n"
+ .' - 当自定义镜像中包含的数据盘容量比待重置系统的服务器中数据盘容量大时，您无法使用该自定义镜像重置系统。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ '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' => '[{"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":""}]',
+ ],
+ 'RestartDatabaseInstance' => [
+ 'summary' => '如果轻量数据库实例处于运行状态，您可以通过此接口重启轻量数据库实例。',
+ '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',
@@ -12540,84 +9347,18 @@
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例慢日志列表的页码。'."\n"
- ."\n"
- .'起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。取值范围：30~100。'."\n"
- ."\n"
- .'最大值：100。'."\n"
- ."\n"
- .'默认值：30。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '30',
- 'example' => '30',
- 'default' => '30',
- ],
- ],
- [
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '查询慢日志起始时间。'."\n"
- ."\n"
- .'按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的到期时间。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-07T04:04:44Z',
- ],
- ],
- [
- 'name' => 'EndTime',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '查询轻量数据库实例慢日志的截止时间。截止时间需要大于查询起始时间，且与查询开始时间间隔小于7天。'."\n"
- ."\n"
- .'按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的到期时间。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-08T04:04:44Z',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
@@ -12627,220 +9368,140 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'PageNumber' => [
- 'description' => '轻量数据库实例慢日志列表的页码。'."\n"
- ."\n"
- .'起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。可能值：30~100。'."\n"
- ."\n"
- .'最大值：100。'."\n"
- ."\n"
- .'默认值：30。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'TotalCount' => [
- 'description' => '轻量数据库服务实例慢日志的总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'PhysicalIORead' => [
- 'description' => '逻辑读次数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Engine' => [
- 'description' => '数据库类型。',
- 'type' => 'string',
- 'example' => 'MySQL',
- ],
- 'SlowLogs' => [
- 'description' => '慢日志信息集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '慢日志信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'HostAddress' => [
- 'description' => '连接数据库的客户端名称及地址。',
- 'type' => 'string',
- 'example' => 'xxx[xxx] @ [1xx.xxx.xxx.xx]',
- ],
- 'QueryTimes' => [
- 'description' => '执行时长，单位：秒（s）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'SQLText' => [
- 'description' => 'SQL命令详情。',
- 'type' => 'string',
- 'example' => 'select sleep(2)',
- ],
- 'QueryTimeMS' => [
- 'description' => '执行时长。单位：毫秒（ms）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2001',
- ],
- 'LockTimes' => [
- 'description' => '锁定时长，单位：秒（s）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'ExecutionStartTime' => [
- 'description' => '执行开始时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的到期时间。',
- 'type' => 'string',
- 'example' => '2022-09-08T01:40:44Z',
- ],
- 'ReturnRowCounts' => [
- 'description' => '返回行数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'ParseRowCounts' => [
- 'description' => '解析行数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'DBName' => [
- 'description' => '数据库名称。',
- 'type' => 'string',
- 'example' => 'testDB',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
],
],
],
- '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' => '查询轻量数据库慢日志明细信息',
- 'description' => '您可以查询轻量数据库服务实例的慢日志明细，帮助您定位故障。'."\n"
- ."\n"
- .'> 慢日志明细保留天数为7天。',
- ],
- 'DescribeDatabaseErrorLogs' => [
- 'summary' => '查询错误日志。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '重启轻量数据库实例',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestartDatabaseInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => '[{"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":""}]',
+ ],
+ 'RunCommand' => [
+ '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' => '命令内容。您需要注意：'."\n"
+ ."\n"
+ .'- 指定参数`EnableParameter=true`可在命令内容中启用自定义参数功能：'."\n"
+ .'- 用{{}}包含的方式定义自定义参数，在`{{}}`内参数名前后的空格以及换行符会被忽略。'."\n"
+ .'- 自定义参数个数不能超过20个。'."\n"
+ .'- 自定义参数名允许a-zA-Z0-9-_的组合，不支持其余字符，参数名不区分大小写。'."\n"
+ .'- 单个自定义参数名不能超过64字节。', 'type' => 'string', 'required' => true, 'example' => 'ifconfig -s'],
+ ],
+ [
+ 'name' => 'WorkingDir',
+ 'in' => 'query',
+ 'schema' => ['description' => '您可自定义命令的执行路径。默认路径如下：'."\n"
+ ."\n"
+ .'- Linux实例：执行路径默认在管理员root用户的/root目录下。'."\n"
+ .'- Windows实例：执行路径默认在C:\\Windows\\system32目录下。', 'type' => 'string', 'required' => false, 'example' => '/root'],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量数据库实例所属的地域ID。'."\n"
- ."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'Timeout',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '设置命令在服务器实例中的超时时间，单位为秒。'."\n"
+ ."\n"
+ .'当执行命令的任务超时后，命令助手将强制终止任务进程。可设定超时时间取值范围为10～86400秒（24小时）。'."\n"
+ ."\n"
+ .'默认值：60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '命令的语言类型。取值范围：'."\n"
+ ."\n"
+ .'- RunBatScript：适用于Windows实例的Bat命令。'."\n"
+ .'- RunPowerShellScript：适用于Windows实例的PowerShell命令。'."\n"
+ .'- RunShellScript：适用于Linux实例Shell命令。', 'type' => 'string', 'required' => true, 'example' => 'RunShellScript'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'EnableParameter',
'in' => 'query',
- 'schema' => [
- 'description' => '每页错误日志行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '30',
- 'example' => '30',
- 'default' => '30',
- ],
+ 'schema' => ['description' => '命令中是否包含自定义参数。'."\n"
+ ."\n"
+ .'默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'Parameters',
'in' => 'query',
- 'schema' => [
- 'description' => '查询错误日志起始时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mmZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的到期时间。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-07T04:04Z',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => '命令中包含自定义参数时，执行命令时传入的自定义参数的键值对。例如，命令内容为`echo {{name}}`，则可以通过`Parameters`参数传入键值对`{"name":"Jack"}`。自定义参数将自动替换变量值`name`，得到一条新的命令，实际执行的是`echo Jack`。'."\n"
+ ."\n"
+ .'自定义参数的个数范围为0~20，且您需要注意：'."\n"
+ ."\n"
+ .'- 键不允许为空字符串，最多支持64个字符。'."\n"
+ .'- 值允许为空字符串。'."\n"
+ .'- 自定义参数与原始命令内容在Base64编码后，综合长度不能超过16 KB。'."\n"
+ .'- 设置的自定义参数名集合必须为创建命令时定义的参数集的子集。对于未传入的参数，您可以使用空字符串代替。'."\n"
+ ."\n"
+ .'默认值为空，表示取消设置该参数从而禁用自定义参数。', 'type' => 'object', 'required' => false, 'example' => '{"name":"Jack", "accessKey":"LTAI****************"}'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'WorkingUser',
'in' => 'query',
- 'schema' => [
- 'description' => '查询错误日志截止时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mmZ。截止时间需大于起始时间。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的到期时间。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-08T04:04Z',
- ],
+ 'schema' => ['description' => '您可以指定以某个轻量应用服务器实例中存在的用户执行命令，建议使用普通用户执行命令可降低安全风险。'."\n"
+ .'默认值：'."\n"
+ ."\n"
+ .'- root：Linux实例中默认以root用户执行命令。'."\n"
+ ."\n"
+ .'- system：Windows实例中默认以system用户执行命令。', 'type' => 'string', 'required' => false, 'example' => 'root'],
+ ],
+ [
+ 'name' => 'WindowsPasswordName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Windows实例中执行命令的用户的密码名称。'."\n"
+ ."\n"
+ .'当您希望以非默认用户（System）在Windows实例中执行命令时，需要同时传入WorkingUser和该参数。为降低密码泄露的风险，需要将密码明文托管在运维编排服务的参数仓库中，此处仅传入密码的名称。', 'type' => 'string', 'required' => false, 'example' => 'axtSecretPassword'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '轻量应用云服务器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '执行命令名称。', 'type' => 'string', 'required' => true, 'example' => 'testName'],
],
],
'responses' => [
@@ -12850,84 +9511,57 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'PageNumber' => [
- 'description' => '错误信息当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '错误信息每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'TotalCount' => [
- 'description' => '错误信息总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'ErrorLogs' => [
- 'description' => '错误日志信息集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '错误日志信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'ErrorInfo' => [
- 'description' => '错误日志信息。',
- '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' => '错误日志生成时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的到期时间。',
- 'type' => 'string',
- 'example' => '2022-09-08T12:11:04Z',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'],
+ 'InvokeId' => ['description' => '命令执行ID。', 'type' => 'string', 'example' => 't-hz02p9545t6****'],
],
],
],
],
- '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' => '查询错误日志',
- 'description' => '您可以调用此接口，查询数据库的错误日志，帮助您定位问题。',
- ],
- 'DescribeDatabaseInstanceMetricData' => [
- 'summary' => '查询数据库实例监控信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '执行命令',
+ 'summary' => '在轻量应用服务器上执行命令。',
+ 'description' => '命令助手是专为轻量应用服务器打造的自动化运维工具。您无需登录，即可在控制台上通过命令（Shell、Powershell和Bat）对轻量应用服务器实例进行运维管理操作。'."\n"
+ ."\n"
+ .'使用命令助手时，需满足以下条件：'."\n"
+ ."\n"
+ .'- 轻量应用服务器实例的状态必须为运行中。'."\n"
+ .'- 已安装云助手客户端。轻量应用服务器实例默认已安装云助手客户端，如果您手动卸载，需重新安装。具体操作，请参见[安装云助手客户端](~~64921~~)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RunCommand'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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}'],
+ ],
+ ],
+ ],
],
+ '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":""}]',
+ ],
+ 'StartDatabaseInstance' => [
+ 'summary' => '启动轻量数据库实例。',
+ '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',
@@ -12936,62 +9570,18 @@
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
- ],
- [
- 'name' => 'MetricName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指标名称。取值范围：'."\n"
- ."\n"
- .'- MySQL_MemCpuUsage：实例CPU使用率（占操作系统总数）和MySQL实例内存使用率（占操作系统总数）。'."\n"
- .'- MySQL_DetailedSpaceUsage：实例总空间使用量、数据空间、日志空间、临时空间和系统空间。'."\n"
- .'- MySQL_Sessions ：当前活跃连接数，当前总连接数。'."\n"
- .'- MySQL_IOPS ：实例的IOPS（每秒IO请求次数）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MySQL_MemCpuUsage',
- ],
- ],
- [
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '监控结束时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mmZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的时间。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-06T04:04Z',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '监控开始时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mmZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的时间。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-09-07T04:04Z',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
@@ -13001,490 +9591,188 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'MetricName' => [
- 'description' => '监控指标名称。可能值：'."\n"
- ."\n"
- .'- MySQL_MemCpuUsage：实例CPU使用率（占操作系统总数）和MySQL实例内存使用率（占操作系统总数）。'."\n"
- .'- MySQL_DetailedSpaceUsage：实例总空间使用量、数据空间、日志空间、临时空间和系统空间。'."\n"
- .'- MySQL_Sessions ：当前活跃连接数，当前总连接数。'."\n"
- .'- MySQL_IOPS ：实例的IOPS（每秒IO请求次数）。',
- 'type' => 'string',
- 'example' => 'MySQL_MemCpuUsage',
- ],
- 'Unit' => [
- 'description' => '监控数据单位。'."\n"
- ."\n"
- .'- %'."\n"
- .'- int'."\n"
- .'- MB'."\n",
- 'type' => 'string',
- 'example' => '%',
- ],
- 'DataFormat' => [
- 'description' => '数据格式。可能值：'."\n"
- ."\n"
- .'- cpuusage&memusage'."\n"
- .'- active_session&total_session'."\n"
- .'- ins_size&data_size&log_size&tmp_size&other_size'."\n"
- ."\n"
- .'- io',
- 'type' => 'string',
- 'example' => 'cpuusage&memusage',
- ],
- 'MetricData' => [
- 'description' => '监控数据信息。',
- 'type' => 'string',
- 'example' => '[ { \\"date"\\: " 2022-09-06T04:04:00Z",\\"value\\":\\"0.77&3.69\\" } ]',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
],
],
],
- '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' => '查询数据库实例监控信息',
- 'description' => '创建数据库服务后，您可以查看数据库服务的CPU、内存、磁盘空间和存储IOPS（Input/Output Operations Per Second）和当前总连接数的详细信息。',
- ],
- 'DescribeDatabaseInstanceParameters' => [
- 'summary' => '查看轻量数据库实例的参数信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '启动轻量数据库实例',
+ 'description' => '如果轻量数据库实例处于停止状态，您可以通过此接口启动轻量数据库实例。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartDatabaseInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => '[{"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":""}]',
+ ],
+ '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' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'Engine' => [
- 'description' => '数据库类型。目前仅支持数据库的类型为MySQL。',
- 'type' => 'string',
- 'example' => 'MySQL',
- ],
- 'EngineVersion' => [
- 'description' => '数据库版本。可能值：'."\n"
- ."\n"
- .'- 5.7：MySQL 5.7。'."\n"
- .'- 8.0：MySQL 8.0。',
- 'type' => 'string',
- 'example' => '5.5',
- ],
- 'ConfigParameters' => [
- 'description' => '正在同步的参数列表。修改并提交参数后，需要等待实例同步参数，同步结束后从此列表删除。',
- 'type' => 'array',
- 'items' => [
- 'description' => '正在同步的参数列表。修改并提交参数后，需要等待实例同步参数，同步结束后从此列表删除。',
- 'type' => 'object',
- 'properties' => [
- 'ParameterDescription' => [
- 'description' => '参数描述信息。',
- 'type' => 'string',
- 'example' => 'Auto-increment columns are incremented by this',
- ],
- 'ParameterName' => [
- 'description' => '参数名称。',
- 'type' => 'string',
- 'example' => 'auto_increment_increment',
- ],
- 'ParameterValue' => [
- 'description' => '参数值。'."\n"
- ."\n"
- .'> 不同参数的参数值不同。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'ForceModify' => [
- 'description' => '是否支持修改参数值。可能值：'."\n"
- ."\n"
- .'- true ：支持修改参数值。'."\n"
- .'- false：不支持修改参数值。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'ForceRestart' => [
- 'description' => '修改参数是否重启数据库。可能值：'."\n"
- ."\n"
- .'- true：强制重启（若修改的参数当中，有需要重启的参数，则必须传入true，否则修改将不生效）。'."\n"
- .'- false：不强制重启。'."\n"
- ."\n"
- .'默认值：false。',
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'CheckingCode' => [
- 'description' => '参数值范围。'."\n"
- .'> 不同参数的参数值范围不同。',
- 'type' => 'string',
- 'example' => '[1-65535]',
- ],
- ],
- ],
- ],
- 'RunningParameters' => [
- 'description' => '运行参数信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '运行参数信息。',
- 'type' => 'object',
- 'properties' => [
- 'ParameterDescription' => [
- 'description' => '运行参数描述信息。',
- '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' => '参数名称。',
- 'type' => 'string',
- 'example' => 'autocommit',
- ],
- 'ParameterValue' => [
- 'description' => '运行参数值。',
- 'type' => 'string',
- 'example' => 'ON',
- ],
- 'ForceModify' => [
- 'description' => '是否支持修改参数值。可能值：'."\n"
- ."\n"
- .'- true ：支持修改参数值。'."\n"
- .'- false：不支持修改参数值。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'ForceRestart' => [
- 'description' => '修改参数是否重启数据库。可能值：'."\n"
- ."\n"
- .'- true：强制重启（若修改的参数当中，有需要重启的参数，则必须传入true，否则修改将不生效）。'."\n"
- .'- false：不强制重启。'."\n"
- ."\n"
- .'默认值：false。',
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'CheckingCode' => [
- 'description' => '参数值范围。'."\n"
- .'> 不同参数的参数值范围不同。',
- 'type' => 'string',
- 'example' => '[ON|OFF]',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
],
+ 'description' => '',
],
],
],
- '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' => '查看轻量数据库实例的参数信息',
- 'description' => '如果您需要查看轻量数据库实例的参数的具体信息，可通过此接口查询。',
- ],
- 'DescribeDatabaseInstances' => [
- 'summary' => '查看轻量数据库实例信息。',
- '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' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '启动实例',
+ 'summary' => '启动一台轻量应用服务器。',
+ 'description' => '如果轻量应服务器的实例状态为停止状态，您可以使用此接口将已停止的轻量应用服务器实例启动。',
+ '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' => '启动一台或多台轻量应用服务器。',
+ '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' => '指定的轻量数据库实例所属的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'DatabaseInstanceIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。'."\n"
- .'取值可以由多个轻量数据库实例ID组成一个JSON数组，最多支持100个实例ID，ID之间用英文半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["swasdb-xxx******","swasdb-yyy******"]',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例列表的页码。'."\n"
- ."\n"
- .'起始值：1'."\n"
- ."\n"
- .'默认值：1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。'."\n"
- ."\n"
- .'最大值：100。'."\n"
- ."\n"
- .'默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4****',
- ],
- 'DatabaseInstances' => [
- 'description' => '轻量数据库实例集合信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '轻量数据库实例集合信息。',
- 'type' => 'object',
- 'properties' => [
- 'RegionId' => [
- 'description' => '轻量数据库实例所属的地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'DatabaseInstanceId' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
- 'DatabaseInstanceName' => [
- 'description' => '轻量数据库实例名称。',
- 'type' => 'string',
- 'example' => '我的数据库',
- ],
- 'DatabaseInstanceEdition' => [
- 'description' => '轻量数据库实例套餐版本ID。可能值：'."\n"
- ."\n"
- .'- swas.db.c1m1s25：35元/月。'."\n"
- ."\n"
- .'- swas.db.c1m2s80：100元/月。'."\n"
- ."\n"
- .'- swas.db.c2m4s120：200元/月。'."\n"
- .'- swas.db.c2m8s240：300元/月。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'swas.db.c1m1s25',
- ],
- 'DatabaseVersion' => [
- 'description' => '数据库版本。可能值：'."\n"
- ."\n"
- .'- 5.7：MySQL 5.7。'."\n"
- .'- 8.0：MySQL 8.0。',
- 'type' => 'string',
- 'example' => '5.7',
- ],
- 'Cpu' => [
- 'description' => 'vCPU核数。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Memory' => [
- 'description' => '内存大小，单位为GB。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Storage' => [
- 'description' => 'ESSD云盘容量，单位为GB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '25',
- ],
- 'PrivateConnection' => [
- 'description' => '私网链接地址。',
- 'type' => 'string',
- 'example' => 'rm-bp1d39opj7906****.mysql.rds.aliyuncs.com',
- ],
- 'PublicConnection' => [
- 'description' => '公网链接地址。'."\n"
- ."\n"
- .'> 只有申请开通公网访问地址才显示此参数。您可以调用[AllocatePublicConnection](~~451413~~)申请外网地址。',
- 'type' => 'string',
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com',
- ],
- 'DatabaseInstanceStatus' => [
- 'description' => '轻量数据库服务实例状态：可能值'."\n"
- ."\n"
- .'- Pending: 创建中。'."\n"
- .'- Restarting：重启中。'."\n"
- .'- Running：运行中。'."\n"
- .'- Stopping：停止中。'."\n"
- .'- Stopped：已停止。'."\n"
- .'- UPGRADING：升级中。'."\n"
- .'- DISABLED：已禁用。',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'BusinessStatus' => [
- 'description' => '业务状态。可能值：'."\n"
- ."\n"
- .'- normal: 正常。'."\n"
- .'- expired: 到期。'."\n"
- .'- overdue: 欠费。',
- 'type' => 'string',
- 'example' => 'normal',
- ],
- 'CreationTime' => [
- 'description' => '实例创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-09-01T02:39:46Z',
- ],
- 'ExpiredTime' => [
- 'description' => '实例到期时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的到期时间。',
- 'type' => 'string',
- 'example' => '2022-10-01T16:00:00Z',
- ],
- 'ChargeType' => [
- 'description' => '轻量数据库例的计费方式。目前只支持包年包月的计费方式，取值为PrePaid。'."\n"
- ."\n"
- .'默认值：PrePaid。',
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'SuperAccountName' => [
- 'description' => '轻量数据库实例超级账号名称。',
- 'type' => 'string',
- 'example' => 'administrator',
- ],
- ],
- ],
- ],
- 'PageSize' => [
- 'description' => '轻量数据库实例列表的当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F '],
],
+ 'description' => '',
],
],
],
- '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' => '查看轻量数据库实例信息',
- 'description' => '通过此接口可查看指定地域下一个或多个轻量数据库实例的详细信息，包括轻量数据库实例ID、名称、套餐、数据库版本、公网访问地址、内网访问地址、创建时间、到期时间等信息。',
- ],
- 'AllocatePublicConnection' => [
- 'summary' => '申请公网访问地址。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '批量启动实例',
+ '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' => [],
@@ -13493,47 +9781,27 @@
'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' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~2361076~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou '],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'CommandLine',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '发起会话后，指定执行的命令内容。长度不能超过 512 个字符。', 'type' => 'string', 'required' => false, 'example' => 'ssh root@192.168.0.***'],
],
],
'responses' => [
@@ -13543,35 +9811,44 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
- 'PublicConnection' => [
- 'description' => '外网访问地址。',
- 'type' => 'string',
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
+ 'SessionId' => ['description' => '会话ID。', 'type' => 'string', 'example' => 'ffb90b6e-b18a-4a33-88cf-86fb88****'],
+ 'SecurityToken' => ['description' => '附加在WebSocket的请求头部，用于系统校验本次请求。', 'type' => 'string', 'example' => 'token-xxxaaz'],
+ 'WebSocketUrl' => ['description' => '远程连接轻量应用服务器实例的WebSocket会话对应的URL。包含了会话ID（`SessionId`）以及用于系统校验的`SecurityToken`。', 'type' => 'string', 'example' => 'wss://xxxx'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30637AD6-D977-4833-A54C-CC89483E****\\",\\n \\"PublicConnection\\": \\"db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com\\"\\n}","type":"json"}]',
- 'title' => '申请公网访问地址',
- 'description' => '轻量数据库实例默认不提供外网地址，如果您需要通过轻量容器服务或DMS公网访问数据库，您需要申请开启外网访问地址。',
- ],
- 'RestartDatabaseInstance' => [
- 'summary' => '如果轻量数据库实例处于运行状态，您可以通过此接口重启轻量数据库实例。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'UserBehaviour.SessionManagerDisabled', 'errorMessage' => 'The API is disabled by user behaviour.', 'description' => '用户通过会话管理远程连接功能已关闭。'],
+ ],
+ ],
+ 'title' => '开启免密登录会话',
+ 'summary' => '为轻量应用服务器提供会话登录能力。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:StartTerminalSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', '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' => '停止轻量数据库实例。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13583,9 +9860,7 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswas80NK1I',
- ],
+ 'abilityTreeNodes' => ['FEATUREswas80NK1I'],
'autoTest' => false,
'notSupportAutoTestReason' => '轻量数据库，走下线流程',
'tenantRelevance' => 'publicInformation',
@@ -13594,33 +9869,18 @@
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量数据库实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DatabaseInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '轻量数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'db-38263fa955774501a2ae1bdaed6f****'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
@@ -13630,201 +9890,208 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '30637AD6-D977-4833-A54C-CC89483E****'],
],
],
],
],
- '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' => '重启轻量数据库实例',
- ],
- 'ResetDatabaseAccountPassword' => [
- 'summary' => '如果数据库的密码安全性较差，您也可以通过调用此接口可以修改数据库administrator账号的密码。为了数据库的安全，建议您定期更改数据库密码。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '停止轻量数据库实例',
+ 'description' => '如果轻量数据库实例处于运行状态，您可以通过此接口停止轻量数据库实例。停止后，轻量数据库实例不支持登录和访问。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopDatabaseInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => '[{"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":""}]',
+ ],
+ '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' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
],
[
- 'name' => 'AccountPassword',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '数据库administrator账号的密码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Password****',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
],
+ 'description' => '',
],
],
],
- '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' => '重置数据库账号的密码',
- ],
- 'ReleasePublicConnection' => [
- 'summary' => '如果您不再需要使用外网地址访问轻量数据库实例，可以释放外网访问地址。',
- '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' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '停止实例',
+ 'summary' => '停止一台轻量应用服务器。',
+ 'description' => '如果轻量应用服务器暂时不需要，您可以将轻量应用服务器停止。'."\n"
+ ."\n"
+ .'> 停止轻量应用服务器实例后，可能导致业务中断，建议您在业务低峰期执行该操作。',
+ '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' => '[{"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":""}]',
+ ],
+ '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' => '指定的轻量数据库实例所属的地域ID。'."\n"
- .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'DatabaseInstanceId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '轻量数据库实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'db-38263fa955774501a2ae1bdaed6f****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'InstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '轻量应用服务器的实例ID。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => '["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]'],
+ ],
+ [
+ 'name' => 'ForceStop',
+ 'in' => 'query',
+ 'schema' => ['description' => '停止实例时是否强制关机策略。'."\n"
+ ."\n"
+ .'- **true**：强制关机。'."\n"
+ ."\n"
+ .'- **false**（默认）：正常关机流程。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '30637AD6-D977-4833-A54C-CC89483E****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C2DE174B-7196-5778-A00D-6EA2601B****'],
],
+ 'description' => '',
],
],
],
- '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' => '释放外网访问地址',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '批量停止实例',
+ 'summary' => '停止一台或多台轻量应用服务器。',
+ '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' => '对轻量应用服务器、快照、自定义镜像、命令、防火墙规则和磁盘绑定标签，便于查看和管理轻量资源。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13836,49 +10103,30 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREswasVU1KX6',
- ],
+ 'abilityTreeNodes' => ['FEATUREswasVU1KX6'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'ResourceType',
'in' => 'query',
- 'schema' => [
- 'title' => '资源类型',
- 'description' => '资源类型，取值范围：'."\n"
- ."\n"
- .'- instance：实例。'."\n"
- .'- snapshot：快照。'."\n"
- .'- customimage：自定义镜像。'."\n"
- .'- command：命令。'."\n"
- .'- firewallrule：防火墙规则。'."\n"
- .'- disk：磁盘。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
+ 'schema' => ['title' => '资源类型', 'description' => '资源类型，取值范围：'."\n"
+ ."\n"
+ .'- instance：实例。'."\n"
+ .'- snapshot：快照。'."\n"
+ .'- customimage：自定义镜像。'."\n"
+ .'- command：命令。'."\n"
+ .'- firewallrule：防火墙规则。'."\n"
+ .'- disk：磁盘。', 'type' => 'string', 'required' => true, 'example' => 'instance'],
],
[
'name' => 'ResourceId',
@@ -13888,12 +10136,7 @@
'title' => '资源ID,最多 50个子项',
'description' => '资源ID，最多 50个子项。',
'type' => 'array',
- 'items' => [
- 'description' => '资源ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bp1e2fsl57knvuug****',
- ],
+ 'items' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 's-bp1e2fsl57knvuug****'],
'required' => true,
'maxItems' => 51,
],
@@ -13910,24 +10153,12 @@
'description' => '标签信息。一个轻量资源最多可以打20个标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签键',
- 'description' => '为轻量资源指定的标签键。'."\n"
- ."\n"
- .'一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'title' => '标签值',
- 'description' => '为轻量资源指定的标签值。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['title' => '标签键', 'description' => '为轻量资源指定的标签键。'."\n"
+ ."\n"
+ .'一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['title' => '标签值', 'description' => '为轻量资源指定的标签值。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -13942,140 +10173,101 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
'title' => '绑定标签',
- ],
- 'ListTagResources' => [
- 'summary' => '调用ListTagResources查询一个或多个轻量资源（实例、快照、磁盘、镜像、命令、防火墙规则）已经绑定的标签信息。',
- '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
+ ],
+ 'UntagResources' => [
+ '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' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000 ',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ResourceType',
'in' => 'query',
- 'schema' => [
- 'title' => '下一个查询开始Token',
- 'description' => '下一个查询开始Token。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***',
- ],
+ 'schema' => ['title' => '资源类型', 'description' => '资源类型，取值范围： '."\n"
+ ."\n"
+ .'- instance：实例。'."\n"
+ .'- snapshot：快照。'."\n"
+ .'- customimage：自定义镜像。'."\n"
+ .'- command：命令。'."\n"
+ .'- firewallrule：防火墙规则。'."\n"
+ .'- disk：磁盘。', 'type' => 'string', 'required' => true, 'example' => 'instance'],
],
[
- 'name' => 'ResourceType',
+ 'name' => 'All',
'in' => 'query',
- 'schema' => [
- 'title' => '资源类型',
- 'description' => '资源类型，取值范围：'."\n"
- ."\n"
- .'- instance：实例。'."\n"
- .'- snapshot：快照。'."\n"
- .'- customimage：镜像。'."\n"
- .'- command：命令。'."\n"
- .'- firewallrule：防火墙规则。'."\n"
- .'- disk：磁盘。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
+ 'schema' => ['title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false ,默认是 false', 'description' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围：'."\n"
+ ."\n"
+ .'- true：删除指定轻量资源绑定的全部标签。若指定的轻量资源未绑定任何标签，则不做处理。'."\n"
+ .'- false：不删除指定轻量资源绑定的任何标签。'."\n"
+ ."\n"
+ .'默认是 false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '资源ID,最多 50个子项',
- 'description' => '资源ID，最多50个资源ID。',
+ 'title' => '资源ID，最多50个子项',
+ 'description' => '资源ID，最多50个子项。',
'type' => 'array',
- 'items' => [
- 'description' => '轻量资源ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bw526m1vi6x20c6g****',
- ],
- 'required' => false,
+ 'items' => ['description' => '轻量资源 ID。', 'type' => 'string', 'required' => false, 'example' => 's-bw526m1vi6x20c6g****'],
+ 'required' => true,
'maxItems' => 51,
],
],
[
- 'name' => 'Tag',
+ 'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '标签列表，最多包含20个子项',
- 'description' => '标签列表，最多包含20个标签。',
+ 'title' => '标签键，最多20个子项',
+ 'description' => '标签键，最多20个子项。',
'type' => 'array',
- 'items' => [
- 'description' => '资源所绑定的标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签键',
- 'description' => '轻量资源的标签键。标签键长度的取值范围：1~64。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'title' => '标签值',
- 'description' => '轻量资源的标签值。标签值长度的取值范围：1~64。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
+ 'items' => ['description' => '轻量资源的标签键。标签键大小写敏感。N 的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
'required' => false,
'maxItems' => 21,
],
@@ -14087,366 +10279,408 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'title' => '下一个查询开始Token，NextToken为空说明没有下一个',
- 'description' => '下一个查询开始Token，NextToken为空说明没有下一个。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F ',
- ],
- 'TagResources' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'TagResource' => [
- 'title' => '资源列表',
- 'description' => '由轻量资源及其标签组成的集合，包含了资源 ID、资源类型和标签键值等信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '轻量资源及其标签。',
- 'type' => 'object',
- 'properties' => [
- 'ResourceType' => [
- 'title' => '资源类型',
- 'description' => '资源类型。可能值：'."\n"
- ."\n"
- .'- instance：实例。'."\n"
- .'- snapshot：快照。'."\n"
- .'- customimage：自定义镜像。'."\n"
- .'- command：命令。'."\n"
- .'- firewallrule：防火墙规则。'."\n"
- .'- disk：磁盘。',
- 'type' => 'string',
- 'example' => 'instance',
- ],
- 'TagValue' => [
- 'title' => '标签值',
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- 'ResourceId' => [
- 'title' => '资源ID',
- 'description' => '资源ID。',
- 'type' => 'string',
- 'example' => 's-bw526m1vi6x20c6g****'."\n",
- ],
- 'TagKey' => [
- 'title' => '标签键',
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
],
],
],
],
- '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' => '查询标签列表',
- ],
- 'UntagResources' => [
+ 'title' => '解绑并删除标签',
'summary' => '为指定的轻量资源（实例、快照、磁盘、镜像、命令、防火墙规则）统一解绑并删除标签。',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:UntagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateCommandAttribute' => [
+ 'summary' => '修改一条命令相关参数。',
+ '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' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询可用地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'CommandId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '命令ID。您可以通过接口[DescribeCommands](~~64843~~)查询所有可用的CommandId。 ', 'type' => 'string', 'required' => true, 'example' => 'c-sh02yh0932w****'],
],
[
- 'name' => 'ResourceType',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'title' => '资源类型',
- 'description' => '资源类型，取值范围： '."\n"
- ."\n"
- .'- instance：实例。'."\n"
- .'- snapshot：快照。'."\n"
- .'- customimage：自定义镜像。'."\n"
- .'- command：命令。'."\n"
- .'- firewallrule：防火墙规则。'."\n"
- .'- disk：磁盘。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
+ 'schema' => ['description' => '命令名称，支持全字符集。长度不得超过128个字符。', 'type' => 'string', 'required' => false, 'example' => 'testName'],
],
[
- 'name' => 'All',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false ,默认是 false',
- 'description' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围：'."\n"
- ."\n"
- .'- true：删除指定轻量资源绑定的全部标签。若指定的轻量资源未绑定任何标签，则不做处理。'."\n"
- .'- false：不删除指定轻量资源绑定的任何标签。'."\n"
- ."\n"
- .'默认是 false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '命令描述，支持全字符集。长度不得超过512个字符。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'WorkingDir',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['description' => '执行路径。长度不得超过200个字符。', 'type' => 'string', 'required' => false, 'example' => '/home/'],
+ ],
+ [
+ 'name' => 'Timeout',
+ 'in' => 'query',
+ 'schema' => ['description' => '您创建的命令在ECS实例中执行时最大的超时时间，单位为秒。当因为某种原因无法运行您创建的命令时，会出现超时现象。超时后，会强制终止命令进程，即取消命令的PID。默认值：60。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '资源ID，最多50个子项',
- 'description' => '资源ID，最多50个子项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '轻量资源 ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bw526m1vi6x20c6g****',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'],
],
- 'required' => true,
- 'maxItems' => 51,
],
],
+ ],
+ 'title' => '修改命令',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TagKey',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '标签键，最多20个子项',
- 'description' => '标签键，最多20个子项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '轻量资源的标签键。标签键大小写敏感。N 的取值范围：1~20。',
- '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,
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateDiskAttribute' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'DiskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '指定的磁盘ID。您可以通过调用ListDisks接口获取数据磁盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp18kjxg9ebrhsgi****'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => true, 'example' => 'test'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28D****534F '],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F534F\\"\\n}","type":"json"}]',
- 'title' => '解绑并删除标签',
- ],
- 'ListRegions' => [
- 'summary' => '查询轻量服务器所有可用地域列表。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IncorrectInstanceStatus.ResetDisk', 'errorMessage' => 'Rolling back the disk requires the instance to operate in a stopped state.', 'description' => '回滚磁盘需要实例在停止的状态下进行操作。'."\n"],
+ ],
+ [
+ ['errorCode' => 'InvalidDiskId.NotFound', 'errorMessage' => 'The specified DiskId does not exist.', 'description' => '指定的磁盘不存在，请您检查磁盘ID是否正确。'],
+ ['errorCode' => 'InvalidSnapshotId.NotFound', 'errorMessage' => 'The specified SnapshotId does not exist.', 'description' => '指定的快照不存在，请您检查快照ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '修改数据盘备注信息',
+ 'summary' => '修改轻量应用服务器指定数据盘的备注信息。',
+ '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' => '修改实例的部分信息，包括实例名称，密码。',
+ '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' => '返回值语言，取值：'."\n"
- ."\n"
- .'- **zh-CN**（默认值）：中文。'."\n"
- ."\n"
- .'- **en-US**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '指定的轻量应用服务器所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou '],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => ['description' => '新的服务器密码。长度为8至30个字符，必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是：'."\n"
+ ."\n"
+ .'```'."\n"
+ .'()`~!@#$%^&*-_+=|{}[]:;\'<>,.?/'."\n"
+ .'```'."\n"
+ ."\n"
+ .'其中，Windows实例不能以正斜线（/）为密码首字符。'."\n"
+ ."\n"
+ .'> 如果传入`Password`参数，建议您使用HTTPS协议发送请求，避免密码泄露。', 'type' => 'string', 'required' => false, 'example' => 'Test123!'],
+ ],
+ [
+ 'name' => 'InstanceName',
+ 'in' => 'query',
+ 'schema' => ['description' => '服务器名称。长度为2-50个字符，以大小写字母数字或中文开头，可包含数字，下划线（_）或者短划线（-），同时支持域名。', 'type' => 'string', 'required' => false, 'example' => 'test-InstanceName'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '支持的地域信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'Regions' => [
- 'description' => '地域信息组成的数组。',
- 'type' => 'array',
- 'items' => [
- 'description' => '地域信息。',
- 'type' => 'object',
- 'properties' => [
- 'LocalName' => [
- 'description' => '地域名称。',
- 'type' => 'string',
- 'example' => '华东1（杭州）',
- ],
- 'RegionEndpoint' => [
- 'description' => '地域对应的接入地址（Endpoint）。',
- 'type' => 'string',
- 'example' => 'swas.cn-hangzhou.aliyuncs.com',
- ],
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F'],
],
+ 'description' => '',
],
],
],
'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' => '传入的regionId和请求的地址不匹配。'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ],
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' => '查询可用地域列表',
- 'description' => '查询结果包含了轻量应用服务器中国站与国际站的全部可用地域。',
+ 'title' => '修改实例部分信息',
+ 'description' => '## 接口说明'."\n"
+ ."\n"
+ .'修改密码后，您需要重新启动（[RebootInstance](~~190443~~)）服务器才能生效。',
'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' => '[{"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":""}]',
],
- 'ListImages' => [
- 'summary' => '查询指定地域下一个或多个镜像信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'UpdateSnapshotAttribute' => [
+ 'summary' => '修改轻量应用服务器指定快照的备注信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => ['description' => '快照ID。您可以调用ListSnapshots接口查看快照ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-bp16oazlsold4dks****'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000 '],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C****'],
+ ],
+ 'description' => '',
+ ],
+ ],
],
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidSnapshotId.NotFound', 'errorMessage' => 'The specified SnapshotId does not exist.', 'description' => '指定的快照不存在，请您检查快照ID是否正确。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '修改快照备注信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateSnapshotAttribute'],
+ ],
+ ],
+ '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' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ace0706b2ac4454d984295a94213****'],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ImageIds',
+ 'name' => 'PlanId',
'in' => 'query',
- 'schema' => [
- 'description' => '镜像ID。取值可以由一个或多个镜像ID组成一个JSON数组。格式为`["xxx", "yyy", … "zzz"]`。支持最多50个ID，用半角逗号字符隔开。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]',
- ],
+ 'schema' => ['description' => '升级后的套餐ID。您可以调用[ListPlans](~~189314~~)查询套餐信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'swas.s2.c2m2s50b4t08'],
],
[
- 'name' => 'ImageType',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '镜像类型。取值范围：'."\n"
- ."\n"
- .'- system：系统镜像'."\n"
- .'- app：应用镜像'."\n"
- .'- custom：自定义镜像',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'system',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
@@ -14454,123 +10688,93 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
- 'Images' => [
- 'description' => '镜像信息组成的数组。',
- 'type' => 'array',
- 'items' => [
- 'description' => '镜像信息。',
- 'type' => 'object',
- 'properties' => [
- 'ImageType' => [
- 'description' => '镜像类型。可能值：'."\n"
- ."\n"
- .'- system：系统镜像'."\n"
- .'- app：应用镜像'."\n"
- .'- custom：自定义镜像',
- 'type' => 'string',
- 'example' => 'app',
- ],
- 'Description' => [
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'WordPress是目前非常流行、强大的博客和内容管理网站的工具平台，借助第三方开发的模板、插件，用户可实现多样化的个性化功能。该镜像基于CentOS 7.9，PHP 7.4，MySQL 5.7，Apache 2.4。',
- ],
- 'ImageName' => [
- 'description' => '镜像名称。',
- 'type' => 'string',
- 'example' => 'WordPress-4.8.1',
- ],
- 'ImageId' => [
- 'description' => '镜像ID。',
- 'type' => 'string',
- 'example' => '794c230fd3e64ea19f83f4d7a0ad****',
- ],
- 'Platform' => [
- 'description' => '镜像所使用的操作系统类型。可能值：'."\n"
- ."\n"
- .'- Linux：Linux系统'."\n"
- ."\n"
- .'- Windows：Windows系统',
- 'type' => 'string',
- 'example' => 'Linux',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
],
+ 'description' => '',
],
],
],
'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' => '指定的套餐不存在，请您检查套餐ID是否正确。'],
+ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
],
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' => '获取镜像列表',
- 'description' => '您可以查询指定地域下一个或多个镜像信息，包括镜像的ID、镜像名称、镜像类型等。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListPlans' => [
- 'summary' => '查询指定地域下，轻量应用服务器所有的套餐信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '升级实例',
+ 'summary' => '为指定的轻量应用服务器升级套餐配置。',
+ 'description' => '- 仅支持升级为更高配置的套餐。关于套餐的更多信息，请参见[计费项](~~58623~~)。'."\n"
+ ."\n"
+ .'- 调用该接口升级服务器时，您需要确保您的阿里云账户余额充足，否则会升级失败。',
+ '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' => '[{"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":""}]',
+ ],
+ 'UploadInstanceKeyPair' => [
+ 'summary' => '为一台轻量应用服务器导入密钥对。',
+ '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' => '地域ID。您可以调用[ListRegions](~~189315~~)查询轻量应用服务器的可用地域。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '指定的轻量应用服务器实例所属的地域ID。'."\n"
+ .'您可以调用[ListRegions](~~189315~~)查看支持的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '指定的轻量应用服务器的实例ID。', 'type' => 'string', 'required' => true, 'example' => '2ad1ae67295445f598017499dc****'],
+ ],
+ [
+ 'name' => 'KeyPairName',
+ 'in' => 'query',
+ 'schema' => ['description' => '密钥对名称。', 'type' => 'string', 'required' => false, 'example' => 'test_gin'],
+ ],
+ [
+ 'name' => 'PublicKey',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户公钥。', 'type' => 'string', 'required' => false, 'example' => 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID5aQ5bM0Am3mWe+upjSXqisUT4DLR6ExwvA0***** **@**.com'],
],
],
'responses' => [
@@ -14578,245 +10782,1770 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Plans' => [
- 'description' => '套餐信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '套餐信息。',
- 'type' => 'object',
- 'properties' => [
- 'Core' => [
- 'description' => 'vCPU核数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Bandwidth' => [
- 'description' => '峰值带宽。单位：Mbps。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'DiskSize' => [
- 'description' => '磁盘容量。单位：GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
- 'Flow' => [
- 'description' => '每月流量。单位：GB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'PlanId' => [
- 'description' => '套餐ID。',
- 'type' => 'string',
- 'example' => 'swas.s2.c2m1s40b3t04',
- ],
- 'DiskType' => [
- 'description' => '磁盘类型，可能值：'."\n"
- ."\n"
- .'- ESSD：ESSD云盘，性能级别 PL0。'."\n"
- .'- SSD：SSD云盘。'."\n"
- .'- CLOUD_EFFICIENCY：高效云盘。',
- 'type' => 'string',
- 'example' => 'ESSD',
- ],
- 'Currency' => [
- 'description' => '价格单位。可能值：'."\n"
- ."\n"
- .'- CNY：元'."\n"
- ."\n"
- .'- USD：美元'."\n"
- ."\n"
- .'> 中国站价格单位为CNY，国际站价格单位为USD。',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'SupportPlatform' => [
- 'description' => '套餐支持的操作系统类型。',
- 'type' => 'string',
- 'example' => '["Linux","Windows"]',
- ],
- 'PlanType' => [
- 'description' => '套餐类型，可能值：'."\n"
- ."\n"
- .'- NORMAL：通用型。'."\n"
- .'- CAPACITY：容量型。'."\n"
- .'- PREVIOUS：上一代。'."\n"
- .'- MULTI_IP：多公网IP型。'."\n"
- .'- INTERNATIONAL：国际型。'."\n"
- ."\n"
- .'> 更多信息，请参见[实例规格族](~~2861773~~)。',
- 'type' => 'string',
- 'example' => 'NORMAL',
- ],
- 'PublicIpNum' => [
- 'description' => '公网IP数量。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'IspType' => [
- 'description' => '公网线路类型。'."\n"
- .'- **BGP**（默认值）：BGP线路。'."\n"
- .'- **BGP_NCO**：BGP（非中国优化）线路。',
- 'type' => 'string',
- 'example' => 'BGP',
- ],
- 'Memory' => [
- 'description' => '内存。单位：GiB。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '1',
- ],
- 'OriginPrice' => [
- 'description' => '轻量应用服务器套餐的包月价格。',
- 'type' => 'string',
- 'example' => '60',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '20758A-585D-4A41-A9B2-28DA8F4F534F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20758A-585D-4A41-A9B2-28DA8F4F****'],
],
+ 'description' => '',
],
],
],
'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' => '导入密钥对',
+ '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' => '获取套餐信息',
- 'description' => '您可以查询指定地域下轻量应用服务器所有的套餐信息，包括套餐ID、磁盘容量、磁盘类型、套餐价格等。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20758A-585D-4A41-A9B2-28DA8F4F****\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.ap-northeast-2.aliyuncs.com', 'endpoint' => 'swas.ap-northeast-2.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '菲律宾（马尼拉）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.ap-southeast-6.aliyuncs.com', 'endpoint' => 'swas.ap-southeast-6.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-7', 'regionName' => '泰国（曼谷）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.ap-southeast-7.aliyuncs.com', 'endpoint' => 'swas.ap-southeast-7.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-beijing.aliyuncs.com', 'endpoint' => 'swas.cn-beijing.aliyuncs.com', 'vpc' => 'swas-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-chengdu.aliyuncs.com', 'endpoint' => 'swas.cn-chengdu.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-fuzhou', 'regionName' => '华东6（福州-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-fuzhou.aliyuncs.com', 'endpoint' => 'swas.cn-fuzhou.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-guangzhou.aliyuncs.com', 'endpoint' => 'swas.cn-guangzhou.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-hangzhou.aliyuncs.com', 'endpoint' => 'swas.cn-hangzhou.aliyuncs.com', 'vpc' => 'swas-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-heyuan', 'regionName' => '华南2（河源）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-heyuan.aliyuncs.com', 'endpoint' => 'swas.cn-heyuan.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-hongkong.aliyuncs.com', 'endpoint' => 'swas.cn-hongkong.aliyuncs.com', 'vpc' => 'swas-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-huhehaote.aliyuncs.com', 'endpoint' => 'swas.cn-huhehaote.aliyuncs.com', 'vpc' => 'swas-vpc.cn-huhehaote.aliyuncs.com'],
+ ['regionId' => 'cn-nanjing', 'regionName' => '华东5（南京-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-nanjing.aliyuncs.com', 'endpoint' => 'swas.cn-nanjing.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-qingdao.aliyuncs.com', 'endpoint' => 'swas.cn-qingdao.aliyuncs.com', 'vpc' => 'swas-vpc.cn-qingdao.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-shanghai.aliyuncs.com', 'endpoint' => 'swas.cn-shanghai.aliyuncs.com', 'vpc' => 'swas-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-shenzhen.aliyuncs.com', 'endpoint' => 'swas.cn-shenzhen.aliyuncs.com', 'vpc' => 'swas-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-wuhan-lr', 'regionName' => '华中1（武汉-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'swas.cn-wuhan-lr.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'swas.cn-wulanchabu.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'swas.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'swas.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'swas-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', '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' => '当前自定义镜像共享中，请先解除共享然后删除。'],
+ ['code' => 'CustomImageInShare', 'message' => 'The custom image is in sharing,please unshare first then to retry.', 'http_code' => 400, 'description' => '自定义镜像正在共享，请解除共享。'],
+ ['code' => 'CustomImageQuotaLimit', 'message' => 'The maximum number of custom image in this region is exceeded.', 'http_code' => 400, 'description' => '您的自定义镜像在该地域下已达上限。'],
+ ['code' => 'DomainQuotaExceed', 'message' => 'Too many domains adding.', 'http_code' => 400, 'description' => '添加的域名数量超过限额。'],
+ ['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' => '镜像名称已存在。'],
+ ['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' => '回滚磁盘需要实例在停止的状态下进行操作。'."\n"],
+ ['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' => '指定的参数命令内容不合法。'],
+ ['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' => '指定的磁盘不存在，请您检查磁盘ID是否正确。'],
+ ['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' => '指定的镜像不存在，请您检查镜像ID是否正确。'],
+ ['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' => '指定的实例Id不存在'],
+ ['code' => 'InvalidInstanceId.NotFound', 'message' => 'The specified InstanceId does not exist.', 'http_code' => 404, 'description' => '指定的实例不存在，请您检查实例ID是否正确。'],
+ ['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' => '指定的镜像名称不合法。'],
+ ['code' => 'InvalidParam.OperationIllegal', 'message' => 'The specified parameter operation is illegal.', 'http_code' => 400, 'description' => '指定的operation不合法。'],
+ ['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' => '指定的套餐不存在，请您检查套餐ID是否正确。'],
+ ['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' => '指定的公网IP不合法。'],
+ ['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' => '指定的快照不存在，请您检查快照ID是否正确。'],
+ ['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' => '无法根据您指定的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' => '传入的regionId和请求的地址不匹配。'],
+ ['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' => '指定的快照已经被用于创建自定义镜像，请先删除该快照下的自定义镜像再操作。'],
+ ['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' => '当前VPC已配置内网互通，请重新选择。'],
+ ['code' => 'VPC_PEER_ALREADY_EXISTS', 'message' => 'The specified vpc peer already exists. Please change Vpc.', 'http_code' => 400, 'description' => '当前VPC已配置内网互通，请重新选择。'],
+ ['code' => 'NotFoundfirewallRuleId', 'message' => 'The incoming firewallRuleId does not exist.', 'http_code' => 404, 'description' => '传入的firewallRuleId不存在'],
+ ['code' => 'NotFound%s', 'message' => 'Cannot find resource according to your specified %s.', 'http_code' => 404, 'description' => '根据您指定的数据找不到资源。'],
+ ['code' => 'InvalidFormatResourceIds', 'message' => 'The specified resource ID format is incorrect.', 'http_code' => 400, 'description' => '指定的资源ID格式不正确'."\n"],
+ ['code' => 'InvalidSnapshotName.Malformed', 'message' => 'The specified SnapshotName is wrongly formed.', 'http_code' => 400, 'description' => '指定的SnapshotName格式错误。'],
+ ['code' => 'IncorrectDiskStatus', 'message' => 'The specified disk status is incorrect.', 'http_code' => 400, 'description' => '指定的磁盘状态不正确'],
+ ['code' => 'InvalidInstanceIds', 'message' => 'The specified instance ID is invalid.', 'http_code' => 400, 'description' => '指定的实例ID是无效的'."\n"],
+ ['code' => 'SALES_LIMIT_REACHED', 'message' => 'Sales limit reached.', 'http_code' => 400, 'description' => '已达到销售限额'],
+ ['code' => 'PAY.INSUFFICIENT_BALANCE', 'message' => 'Insufficient available funds.', 'http_code' => 400, 'description' => '可用金不够'],
+ ['code' => 'UserBehaviour.SessionManagerDisabled', 'message' => 'The API is disabled by user behaviour.', 'http_code' => 400, 'description' => '用户通过会话管理远程连接功能已关闭。'],
+ ['code' => 'INSTANCE_LOGIN_FAILURE', 'message' => 'Instance login failure.', 'http_code' => 500, 'description' => '实例登录失败。'],
+ ['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' => '参数Permissions.1.IpProtocol必须指定为不区分大小写的TCP、UDP、ICMP、GRE或All。'],
+ ['code' => 'InvalidPublicIpAddresses', 'message' => 'The specified parameter PublicIpAddresses value is not valid.', 'http_code' => 400, 'description' => '指定的参数PublicIpAddresses值无效。'],
+ ['code' => 'InvalidSnapshotIds', 'message' => 'The specified SnapshotIds is not valid.', 'http_code' => 400, 'description' => '指定的快照ID无效。'],
+ ['code' => 'CSS_SYSTEM_ERROR', 'message' => 'The sales system encountered an error.', 'http_code' => 400, 'description' => '售卖系统出现错误。'],
+ ['code' => 'UserBehavior.SessionManagerDisabled', 'message' => 'The API is disabled by user behaviour.', 'http_code' => 400, 'description' => '用户通过会话管理远程连接功能已关闭。'],
+ ['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' => '您选择的配置在当前地域已售罄，请尝试选择其他配置或者地域。'],
+ ],
+ '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' => '轻量应用服务器',
+ 'ramCodes' => ['swas', 'swas-open'],
+ 'ramLevel' => '资源级',
+ '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' => '全部资源', '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' => '全部资源', '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' => '全部资源', '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' => '全部资源', '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' => '获取实例VNC连接地址',
+ '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' => '全部资源', '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeSecurityAgentStatus',
+ 'description' => '查询安全中心Agent插件状态',
+ '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' => '全部资源', '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DetachKeyPair',
+ 'description' => '解绑密钥对',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'swas-open:DetachKeyPair',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', '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' => '全部资源', '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' => '全部资源', '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' => '修改实例VNC密码',
+ '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' => '全部资源', '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' => '全部资源', '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateKeyPair',
+ 'description' => '创建密钥对',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateKeyPair',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeFirewallTemplateApplyResults',
+ 'description' => '查询防火墙模板应用结果',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'swas-open:DescribeFirewallTemplateApplyResults',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartTerminalSession',
+ 'description' => '开启免密登录会话',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:StartTerminalSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UntagResources',
+ 'description' => '解绑并删除标签',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'swas-open:UntagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateFirewallTemplate',
+ 'description' => '创建防火墙模板',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'swas-open:CreateFirewallTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SimpleApplicationServer', 'resourceType' => '全部资源', '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' => '全部资源', '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 18:44:22 +0000