summaryrefslogtreecommitdiff
path: root/data/en_us/sgw/2018-05-11/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/sgw/2018-05-11/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/sgw/2018-05-11/api-docs.php')
-rw-r--r--data/en_us/sgw/2018-05-11/api-docs.php15798
1 files changed, 7468 insertions, 8330 deletions
diff --git a/data/en_us/sgw/2018-05-11/api-docs.php b/data/en_us/sgw/2018-05-11/api-docs.php
index 2f73f4b..98167c8 100644
--- a/data/en_us/sgw/2018-05-11/api-docs.php
+++ b/data/en_us/sgw/2018-05-11/api-docs.php
@@ -1,212 +1,84 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'sgw',
- 'version' => '2018-05-11',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'sgw', 'version' => '2018-05-11'],
'directories' => [
[
- 'id' => 282066,
- 'title' => null,
+ 'children' => ['CreateStorageBundle', 'ModifyStorageBundle', 'DescribeStorageBundle', 'DeleteStorageBundle', 'DescribeStorageBundles'],
'type' => 'directory',
- 'children' => [
- 'CreateStorageBundle',
- 'ModifyStorageBundle',
- 'DescribeStorageBundle',
- 'DeleteStorageBundle',
- 'DescribeStorageBundles',
- ],
+ 'title' => 'Gateway cluster',
],
[
- 'id' => 282072,
- 'title' => null,
+ 'children' => ['OpenSgwService', 'ModifyGateway', 'DeployGateway', 'DescribeGateways', 'DescribeGatewayCategories', 'DescribeGatewayTypes', 'DescribeAccountConfig', 'DescribeGatewayImages', 'TriggerGatewayRemoteSync', 'DescribeGatewayClasses', 'ExpandGatewayNetworkBandwidth'],
'type' => 'directory',
- 'children' => [
- 'OpenSgwService',
- 'CreateGateway',
- 'UpgradeGateway',
- 'DeleteGateway',
- 'DescribeGateway',
- 'ModifyGateway',
- 'DeployGateway',
- 'DescribeTasks',
- 'DescribeGateways',
- 'DescribeGatewayCategories',
- 'DescribeGatewayTypes',
- 'DescribeAccountConfig',
- 'DescribeGatewayImages',
- 'TriggerGatewayRemoteSync',
- 'DescribeRegions',
- 'DescribeGatewayClasses',
- 'ExpandGatewayNetworkBandwidth',
- ],
+ 'title' => 'Gateway',
],
[
- 'id' => 282090,
- 'title' => null,
+ 'children' => ['CreateGatewayBlockVolume', 'DescribeGatewayBlockVolumes', 'UpdateGatewayBlockVolume', 'DeleteGatewayBlockVolumes'],
'type' => 'directory',
- 'children' => [
- 'CreateGatewayBlockVolume',
- 'DescribeGatewayBlockVolumes',
- 'UpdateGatewayBlockVolume',
- 'DeleteGatewayBlockVolumes',
- ],
+ 'title' => 'Block volume',
],
[
- 'id' => 282095,
- 'title' => null,
+ 'children' => ['CreateGatewayFileShare', 'DescribeGatewayFileStatus', 'DescribeGatewayFileShares', 'UpdateGatewayFileShare', 'DeleteGatewayFileShares', 'DescribeGatewayNFSClients', 'ModifyGatewayFileShareWatermark', 'ExpandGatewayFileShare', 'CreateGatewaySMBUser', 'DeleteGatewaySMBUser', 'DescribeGatewaySMBUsers', 'SetGatewayDNS', 'DescribeGatewayDNS', 'SetGatewayADInfo', 'DescribeGatewayADInfo'],
'type' => 'directory',
- 'children' => [
- 'CreateGatewayFileShare',
- 'DescribeGatewayFileStatus',
- 'DescribeGatewayFileShares',
- 'UpdateGatewayFileShare',
- 'DeleteGatewayFileShares',
- 'DescribeGatewayNFSClients',
- 'ModifyGatewayFileShareWatermark',
- 'ExpandGatewayFileShare',
- 'CreateGatewaySMBUser',
- 'DeleteGatewaySMBUser',
- 'DescribeGatewaySMBUsers',
- 'SetGatewayDNS',
- 'DescribeGatewayDNS',
- 'SetGatewayADInfo',
- 'DescribeGatewayADInfo',
- ],
+ 'title' => 'File share',
],
[
- 'id' => 282111,
- 'title' => null,
+ 'children' => ['CreateGatewayCacheDisk', 'DescribeGatewayCaches', 'ExpandCacheDisk', 'DeleteGatewayCacheDisk'],
'type' => 'directory',
- 'children' => [
- 'CreateGatewayCacheDisk',
- 'DescribeGatewayCaches',
- 'ExpandCacheDisk',
- 'DeleteGatewayCacheDisk',
- ],
+ 'title' => 'Cache disk',
],
[
- 'id' => 282116,
- 'title' => null,
+ 'children' => ['CreateGatewayLogging', 'DescribeGatewayLogging', 'EnableGatewayLogging', 'DisableGatewayLogging', 'DeleteGatewayLogging'],
'type' => 'directory',
- 'children' => [
- 'TagResources',
- 'ListTagResources',
- 'UntagResources',
- ],
+ 'title' => 'Log monitoring',
],
[
- 'id' => 282120,
- 'title' => null,
+ 'children' => ['CreateExpressSync', 'AddSharesToExpressSync', 'DescribeExpressSyncs', 'DescribeExpressSyncShares', 'DeleteExpressSync', 'RemoveSharesFromExpressSync'],
'type' => 'directory',
- 'children' => [
- 'CreateGatewayLogging',
- 'DescribeGatewayLogging',
- 'EnableGatewayLogging',
- 'DisableGatewayLogging',
- 'DeleteGatewayLogging',
- ],
+ 'title' => 'Express synchronization group',
],
[
- 'id' => 282126,
- 'title' => null,
+ 'children' => ['DescribeGatewayLocations', 'DescribeGatewaySMBClients', 'DescribeGatewaySMBSecurityStrategy', 'SetGatewaySMBSecurityStrategy'],
'type' => 'directory',
- 'children' => [
- 'CreateExpressSync',
- 'AddSharesToExpressSync',
- 'DescribeExpressSyncs',
- 'DescribeExpressSyncShares',
- 'DeleteExpressSync',
- 'RemoveSharesFromExpressSync',
- ],
+ 'title' => 'Other',
],
[
- 'id' => 282133,
- 'title' => null,
+ 'children' => ['CreateGateway', 'DeleteGateway', 'DescribeGateway', 'DescribeGatewayModificationClasses', 'DescribeRegions', 'DescribeTasks', 'ListAlertEvents', 'ListTagResources', 'ModifyGatewayClass', 'RestartFileShares', 'TagResources', 'UntagResources', 'UpgradeGateway', 'UploadGatewayLog'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'DescribeGatewayLocations',
- 'DescribeGatewaySMBClients',
- 'DescribeGatewaySMBSecurityStrategy',
- 'ListAlertEvents',
- 'SetGatewaySMBSecurityStrategy',
- ],
- ],
- [
- 'id' => 0,
- 'title' => '其它',
- 'type' => 'directory',
- 'children' => [
- 'DescribeGatewayModificationClasses',
- 'ModifyGatewayClass',
- 'RestartFileShares',
- 'UploadGatewayLog',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateStorageBundle' => [
- 'summary' => 'Creates a gateway cluster.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddSharesToExpressSync' => [
+ 'summary' => 'Adds one or more shares to an express synchronization group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwNGMQUV'],
],
'parameters' => [
[
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'alex-123***',
- ],
- ],
- [
- 'name' => 'Description',
+ 'name' => 'ExpressSyncId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The ID of the express synchronization group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sync-0001xv7je357xn8tr***', 'title' => ''],
],
[
- 'name' => 'BackendBucketRegionId',
+ 'name' => 'GatewayShares',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['description' => 'The names of gateway shares. You can add multiple shares. The value must be a JSON string that is in the following format: {"Gateway ID1":"Share 1,Share 2","Gateway ID2":"Share 1,Share 2"}', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"gw-000gwgp0j3jp8cb3t***":"share1,share2","gw-0001b2otnkdzte62j***":"weekly"}', 'title' => ''],
],
],
'responses' => [
@@ -214,79 +86,61 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2AD80BDC-E05C-4A77-BBAD-5EDAEDE6D333',
- ],
- 'StorageBundleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sb-000ibk4xrlr03qrjr***',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-0001xv7je357xr6ql***', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA3887', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'MnsTopic' => ['type' => 'string', 'description' => 'The Simple Message Queue (formerly MNS) topic that is used by the express synchronization group.', 'example' => 'sgw-express-sync-topic-sync-0009e51kabuou08***', 'title' => ''],
+ 'MnsQueues' => ['type' => 'string', 'description' => 'The Simple Message Queue (formerly MNS) queue that is used by the express synchronization group.', 'example' => 'sgw-express-sync-queue-gw-0009e51kabuoty9***-341604', 'title' => ''],
+ 'MnsFullSyncDelay' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The latency of the first full synchronization. Unit: seconds.', 'example' => '719', 'title' => ''],
+ 'MnsPublicEndpoint' => ['type' => 'string', 'description' => 'The public endpoint of Simple Message Queue (formerly MNS) that is used by the express synchronization group.', 'example' => 'http://123.mns.cn-hangzhou.aliyuncs.com/', 'title' => ''],
+ 'MnsInnerEndpoint' => ['type' => 'string', 'description' => 'The internal endpoint of Simple Message Queue (formerly MNS) that is used by the express synchronization group.', 'example' => 'http://123.mns.cn-hangzhou-internal.aliyuncs.com/', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyStorageBundleName',
- 'errorMessage' => 'You must enter a valid name for the gateway cluster.',
- ],
- [
- 'errorCode' => 'InvalidRegionId',
- 'errorMessage' => 'The specified RegionId does not exist. You must specify a valid RegionId.',
- ],
- [
- 'errorCode' => 'StorageBundleDescriptionOverLimit',
- 'errorMessage' => 'The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
- ],
- [
- 'errorCode' => 'DuplicateStorageBundleName',
- 'errorMessage' => 'The name you specified for the gateway cluster already exists. You must specify a valid name.',
- ],
- [
- 'errorCode' => 'InvalidStorageBundleName',
- 'errorMessage' => 'The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.',
+ ['errorCode' => 'EmptyExpressSyncId', 'errorMessage' => 'You must specify a valid ID for the sync group.', 'description' => 'You must specify a valid ID for the sync group.'],
+ ['errorCode' => 'ExpressSyncNotExist', 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.', 'description' => 'The specified sync group does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'ExpressSyncInOperation', 'errorMessage' => 'The sync group is busy. Try again later.', 'description' => 'The sync group is busy. Try again later.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xr6ql***\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA3887\\",\\n \\"Message\\": \\"successful\\",\\n \\"MnsTopic\\": \\"sgw-express-sync-topic-sync-0009e51kabuou08***\\",\\n \\"MnsQueues\\": \\"sgw-express-sync-queue-gw-0009e51kabuoty9***-341604\\",\\n \\"MnsFullSyncDelay\\": 719,\\n \\"MnsPublicEndpoint\\": \\"http://123.mns.cn-hangzhou.aliyuncs.com/\\",\\n \\"MnsInnerEndpoint\\": \\"http://123.mns.cn-hangzhou-internal.aliyuncs.com/\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AddSharesToExpressSync',
+ 'description' => 'When you call this operation, note the following:'."\n"
+ ."\n"
+ .'- Ensure that an express synchronization group is created. If not, you can call the CreateExpressSync operation to create one. The bucket for the express synchronization group must be the same as the bucket for the share.'."\n"
+ .'- If the share name that you specify is empty, the request is ignored.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddSharesToExpressSync'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:AddSharesToExpressSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"2AD80BDC-E05C-4A77-BBAD-5EDAEDE6D333\\",\\n \\"StorageBundleId\\": \\"sb-000ibk4xrlr03qrjr***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateStorageBundleResponse>\\n <Message>successful</Message>\\n <RequestId>2AD80BDC-E05C-4A77-BBAD-5EDAEDE6333</RequestId>\\n <StorageBundleId>sb-000ibk4xrlr03qrjr***</StorageBundleId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateStorageBundleResponse>","errorExample":""}]',
- 'title' => 'CreateStorageBundle',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
- 'ModifyStorageBundle' => [
- 'summary' => 'Modifies the information about a gateway cluster, including the name and description of the gateway cluster.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateExpressSync' => [
+ 'summary' => 'Creates an express synchronization group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -295,45 +149,39 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwNGMQUV'],
],
'parameters' => [
[
- 'name' => 'StorageBundleId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sb-000ibk4xrlr03qrjr***',
- ],
+ 'schema' => ['description' => 'The name of the express synchronization group. The name must be 1 to 128 characters in length and can contain letters, Chinese characters, digits, periods (.), underscores (\\_), and hyphens (-). The name must start with a letter or a Chinese character.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex-tb***', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'alex-123***',
- ],
+ 'schema' => ['description' => 'The description of the express synchronization group. The description can be up to 255 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'Synchronization group test', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'BucketRegion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The region where the OSS bucket is located.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'BucketName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the bucket. Note:'."\n"
+ ."\n"
+ .'- You can specify only one OSS bucket for a synchronization group. All data changes in the bucket are synchronized to your on-premises environment.'."\n"
+ .'- If you have not created a share for the OSS bucket, you must first create a share between the file gateway and the OSS bucket.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sgw-test***', 'title' => ''],
+ ],
+ [
+ 'name' => 'BucketPrefix',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The prefix of the subdirectory in the bucket. If you want to synchronize data changes in a specific subdirectory of the bucket, you can specify the subdirectory.', 'type' => 'string', 'required' => false, 'example' => 'test***', 'title' => ''],
],
],
'responses' => [
@@ -341,216 +189,441 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '70EACC9C-D07A-4A34-ADA4-77506C42777',
- ],
- 'StorageBundleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sb-000ibk4xrlr03qr***',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEFC9927-B097-446D-8FDA-F848C8B2C9E0', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ExpressSyncId' => ['description' => 'The ID of the express synchronization group.', 'type' => 'string', 'example' => 'sync-0001xv7je357xn8tr***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyStorageBundleId',
- 'errorMessage' => 'You must enter a valid ID for the gateway cluster.',
- ],
- [
- 'errorCode' => 'EmptyStorageBundleName',
- 'errorMessage' => 'You must enter a valid name for the gateway cluster.',
- ],
- [
- 'errorCode' => 'StorageBundleDescriptionOverLimit',
- 'errorMessage' => 'The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.',
- ],
- [
- 'errorCode' => 'InvalidStorageBundleName',
- 'errorMessage' => 'The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.',
- ],
+ ['errorCode' => 'EmptyExpressSyncName', 'errorMessage' => 'You must enter a valid name for the sync group.', 'description' => 'You must enter a valid name for the sync group.'],
+ ['errorCode' => 'EmptyBucketName', 'errorMessage' => 'You must enter a valid name for the bucket.', 'description' => 'You must enter a valid name for the bucket.'],
+ ['errorCode' => 'EmptyBucketRegion', 'errorMessage' => 'You must specify a valid region for the bucket.', 'description' => 'You must specify a valid region for the bucket.'],
+ ['errorCode' => 'InvalidExpressSyncName', 'errorMessage' => 'The specified name for the sync group is invalid. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.', 'description' => 'The specified name for the sync group is invalid. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.'],
+ ['errorCode' => 'DescriptionOverLimit', 'errorMessage' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.', 'description' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.'],
+ ['errorCode' => 'DuplicateExpressSyncName', 'errorMessage' => 'The specified name of the sync group already exists. Try again later after you specify a valid parameter.', 'description' => 'The specified name of the sync group already exists. Try again later after you specify a valid parameter.'],
+ ['errorCode' => 'ConflictExpressSyncConfig', 'errorMessage' => 'The parameter you specified for the sync group is invalid. Try again later after you specify a valid parameter.', 'description' => 'The parameter you specified for the sync group is invalid. Try again later after you specify a valid parameter.'],
+ ['errorCode' => 'ExpressSyncNotificationEventLimitExceed', 'errorMessage' => 'The number of sync groups exceeds the maximum limit. If you want to add more sync groups, we recommend that you submit a ticket to apply for the whitelist permission.', 'description' => 'The number of sync groups exceeds the maximum limit. If you want to add more sync groups, we recommend that you submit a ticket to apply for the whitelist permission.'],
+ ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'The specified RegionId does not exist. You must specify a valid RegionId.', 'description' => 'The specified RegionId does not exist. You must specify a valid RegionId.'],
+ ['errorCode' => 'InvalidBucketName', 'errorMessage' => 'The specified bucket name is invalid. You must enter a valid bucket name.', 'description' => 'The specified bucket name is invalid. You must enter a valid bucket name.'],
+ ['errorCode' => 'ExpressSyncNotificationEventConflict', 'errorMessage' => 'The express sync configuration of bucket and prefix conflicts with existing notification events in MNS.', 'description' => 'The bucket and prefix configurations of the synchronization group conflict with the existing event rule configurations in the MNS.'],
],
- 404 => [
- [
- 'errorCode' => 'StorageBundleNotExist',
- 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.',
- ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.', 'description' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.'],
+ ['errorCode' => 'AssumeRoleFail', 'errorMessage' => 'Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'description' => 'Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
+ ],
+ [
+ ['errorCode' => 'RoleNotExist', 'errorMessage' => 'The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.', 'description' => 'The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'description' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"70EACC9C-D07A-4A34-ADA4-77506C42777\\",\\n \\"StorageBundleId\\": \\"sb-000ibk4xrlr03qr***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyStorageBundleResponse>\\n <Message>successful</Message>\\n <RequestId>70EACC9C-D07A-4A34-ADA4-77506C42777</RequestId>\\n <StorageBundleId>sb-000ibk4xrlr03qr***</StorageBundleId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyStorageBundleResponse>","errorExample":""}]',
- 'title' => 'ModifyStorageBundle',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EEFC9927-B097-446D-8FDA-F848C8B2C9E0\\",\\n \\"Code\\": \\"200\\",\\n \\"ExpressSyncId\\": \\"sync-0001xv7je357xn8tr***\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateExpressSync',
+ 'description' => '### Description'."\n"
+ ."\n"
+ .'Note the following when you call this operation:'."\n"
+ ."\n"
+ .'<props="china">'."\n"
+ ."\n"
+ .'- Make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/help/en/message-service/latest/billing-overview) of Simple Message Queue (formerly MNS). You are charged daily for MNS topics and queues. Each express synchronization group is billed as a topic, and each share that is added to an express synchronization group is billed as a queue.'."\n"
+ ."\n"
+ .'</props><props="intl">Make sure that you understand the billing methods and pricing of Simple Message Queue (formerly MNS). You are charged daily for MNS topics and queues. Each express synchronization group is billed as a topic, and each share that is added to an express synchronization group is billed as a queue.</props>'."\n"
+ .'- The express synchronization feature is built on Simple Message Queue (formerly MNS). Therefore, you are charged for using this feature.'."\n"
+ .'- The express synchronization feature lets you add one or more shares that are connected to the same OSS bucket to a synchronization group. Data changes in the bucket are then synchronized to the local clients of all shares in the group. This eliminates the need to perform a remote sync for each share, which improves the efficiency and accuracy of data synchronization.'."\n"
+ .'- Only Medium, Enhanced, and Performance Cloud Storage Gateway instances support the express synchronization feature.'."\n"
+ .'- Make sure that you have created a file gateway and added a cache.'."\n"
+ .'- Make sure that you have created an OSS bucket and configured an NFS or SMB share between the file gateway and the OSS bucket.'."\n"
+ .'- You can call the DescribeSharesBucketInfoForExpressSync operation to query the buckets that can be added to an express synchronization group.'."\n"
+ .'- Make sure that you have activated Simple Message Queue (formerly MNS) and granted the required permissions.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeStorageBundle' => [
- 'summary' => 'Queries the information about a gateway cluster, such as the region, name, and description of the gateway cluster.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateExpressSync'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateExpressSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'CreateGateway' => [
+ 'summary' => 'Creates a subscription or pay-as-you-go gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '17166',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
'name' => 'StorageBundleId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'sb-0007y2889yyxkuqov***',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the gateway cluster. You must specify this parameter if you do not specify ResourceRegionId.', 'docRequired' => false, 'required' => false, 'type' => 'string', 'example' => 'sb-0001b2otnkdxrigeq***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the gateway. The name must be 60 characters in length. The name must start with a letter or a Chinese character. The name can contain letters, Chinese characters, digits, underscores (\\_), hyphens (-), and periods (.).', 'docRequired' => true, 'required' => true, 'type' => 'string', 'example' => 'alex***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the gateway. The description can be 0 to 255 characters in length.', 'example' => 'For testing', 'required' => false, 'type' => 'string', 'title' => ''],
+ ],
+ [
+ 'name' => 'Category',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'description' => 'The category of the gateway. The default value is `Aliyun`.', 'example' => 'Aliyun', 'title' => ''],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The type of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- File: file gateway.'."\n"
+ .'- Iscsi: iSCSI gateway.', 'docRequired' => true, 'required' => true, 'type' => 'string', 'example' => 'File', 'title' => ''],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The location of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- Cloud: cloud gateway.'."\n"
+ .'- On\\_Premise: on-premises gateway.', 'docRequired' => true, 'required' => true, 'type' => 'string', 'example' => 'Cloud', 'title' => ''],
+ ],
+ [
+ 'name' => 'GatewayClass',
+ 'in' => 'query',
+ 'schema' => ['description' => '<props="china">The gateway class. **This parameter is related to fees**. **For more information, see** [Billable items and billing methods](https://help.aliyun.com/document_detail/126872.html?spm=a2c4g.11186623.2.18.2d7376e8ZmSIJp#concept-126872-zh).</props> <props="intl">The gateway class. **This parameter is related to fees**. **For more information, see** [Billable items and billing methods](https://www.alibabacloud.com/help/zh/csg/billable-items-and-billing-methods).</props>'."\n"
+ ."\n"
+ .'If your gateway is deployed in a data center, which is an on-premises gateway, you can ignore this parameter.'."\n"
+ ."\n"
+ .'If your gateway is deployed on Alibaba Cloud, which is a cloud gateway, valid values are:'."\n"
+ ."\n"
+ .'- Basic: Basic'."\n"
+ .'- Standard: Medium'."\n"
+ .'- Enhanced: Enhanced'."\n"
+ .'- Advanced: Performance', 'required' => false, 'type' => 'string', 'example' => 'Basic', 'title' => ''],
+ ],
+ [
+ 'name' => 'VSwitchId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the virtual switch. If your gateway is deployed in a data center, you can ignore this parameter.'."\n"
+ ."\n"
+ .'- The vSwitch must be in the same VPC as the ECS instance that you want to attach.'."\n"
+ .'- If no gateway resources can be allocated in the zone where the vSwitch resides, create a vSwitch in another zone.', 'docRequired' => false, 'required' => false, 'type' => 'string', 'example' => 'vsw-bp1krhkglx3nahkb9s***', 'title' => ''],
+ ],
+ [
+ 'name' => 'PostPaid',
+ 'in' => 'query',
+ 'schema' => ['description' => '<props="china">The billing method of the gateway. **This parameter is related to fees**. **For more information, see** [Billable items and billing methods](https://help.aliyun.com/document_detail/126872.html?spm=a2c4g.11186623.2.18.2d7376e8ZmSIJp#concept-126872-zh).</props> <props="intl">The billing method of the gateway. **This parameter is related to fees**. **For more information, see** [Billable items and billing methods](https://www.alibabacloud.com/help/zh/csg/billable-items-and-billing-methods).</props> Valid values:'."\n"
+ ."\n"
+ .'- true: pay-as-you-go.'."\n"
+ .'- false: subscription.'."\n"
+ ."\n"
+ .'Default value: false (subscription).', 'required' => false, 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'ReleaseAfterExpiration',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to release the gateway when the subscription expires. Valid values:'."\n"
+ ."\n"
+ .'true: The gateway is automatically released.'."\n"
+ ."\n"
+ .'false: The billing method of the gateway is automatically changed to pay-as-you-go after the subscription expires.', 'required' => false, 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'PublicNetworkBandwidth',
+ 'in' => 'query',
+ 'schema' => ['description' => '<props="china">The public bandwidth for data transmission. Unit: Mbit/s. Valid values: 5 to 200. **This parameter is related to fees**. **For more information, see** [Billable items and billing methods](https://help.aliyun.com/document_detail/126872.html?spm=a2c4g.11186623.2.18.2d7376e8ZmSIJp#concept-126872-zh).</props> <props="intl">The public bandwidth for data transmission. Unit: Mbit/s. Valid values: 5 to 200. **This parameter is related to fees**. **For more information, see** [Billable items and billing methods](https://www.alibabacloud.com/help/zh/csg/billable-items-and-billing-methods).</props>'."\n"
+ ."\n"
+ .'> - This parameter is supported only for cloud gateways. You can ignore this parameter for on-premises gateways.'."\n"
+ .'> - Configure this parameter only when you need to mount an OSS bucket across regions.'."\n"
+ .'> - If you specify 0 or do not specify this parameter, the default value is 5.', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'example' => '5', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceRegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the resource region.', 'required' => false, 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'UntrustedEnvInstanceType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '<props="china">'."\n"
+ ."\n"
+ .'The actual gateway class in an untrusted environment ([CloudBox](https://help.aliyun.com/zh/csg/user-guide/whatis-csg-on-cloud-box?spm=a2c4g.11186623.help-menu-53923.d_2_0.55606ae8YwKRow)).'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\n"
+ ."\n"
+ .'The actual gateway class in an untrusted environment ([CloudBox](https://www.alibabacloud.com/help/zh/csg/product-overview/whatis-csg-on-cloud-box)).'."\n"
+ ."\n"
+ .'</props>', 'required' => false, 'example' => 'ecs.g6.large', 'title' => ''],
+ ],
+ [
+ 'name' => 'UntrustedEnvId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '<props="china">'."\n"
+ ."\n"
+ .'The ID of the instance in an untrusted environment ([CloudBox](https://help.aliyun.com/zh/csg/user-guide/whatis-csg-on-cloud-box?spm=a2c4g.11186623.help-menu-53923.d_2_0.55606ae8YwKRow)).'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\n"
+ ."\n"
+ .'The ID of the instance in an untrusted environment ([CloudBox](https://www.alibabacloud.com/help/zh/csg/product-overview/whatis-csg-on-cloud-box)).'."\n"
+ ."\n"
+ .'</props>', 'required' => false, 'example' => 'cb-2vcdsa32432***', 'title' => ''],
+ ],
+ [
+ 'name' => 'SecondaryVSwitchId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => 'The ID of the vSwitch for the secondary node of the high-availability (HA) gateway.', 'required' => false, 'example' => 'vsw-bp1krhkglx3nahcx9s***', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
- 'Description' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'example' => '1657706998',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => '736C7733-FCED-4AFB-8407-C325F210CE03',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'successful',
- 'type' => 'string',
- ],
- 'StorageBundleId' => [
- 'description' => '',
- 'example' => 'sb-000dt67z4ijqfocpy***',
- 'type' => 'string',
- ],
- 'BackendBucketRegionId' => [
- 'description' => '',
- 'example' => 'cn-shanghai',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'Name' => [
- 'description' => '',
- 'example' => 'sdfa***',
- 'type' => 'string',
- ],
+ 'BuyURL' => ['description' => 'The purchase URL.', 'type' => 'string', 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***","directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8E69E1A1-9076-4C8C-8ADF-ACD253886E22', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'string', 'example' => 'gw-0001xv7je357zm9u6***', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyStorageBundleId',
- 'errorMessage' => 'You must enter a valid ID for the gateway cluster.',
- ],
+ ['errorCode' => 'EmptyGatewayName', 'errorMessage' => 'You must enter a valid name for the gateway.', 'description' => 'You must enter a valid name for the gateway.'],
+ ['errorCode' => 'InvalidGatewayName', 'errorMessage' => 'The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.', 'description' => 'The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.'],
+ ['errorCode' => 'DescriptionOverLimit', 'errorMessage' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.', 'description' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.'],
+ ['errorCode' => 'EmptyStorageBundleId', 'errorMessage' => 'You must enter a valid ID for the gateway cluster.', 'description' => 'You must enter a valid ID for the gateway cluster.'],
+ ['errorCode' => 'InvalidGatewayClass', 'errorMessage' => 'The specified specification of the gateway is invalid.', 'description' => 'The specified specification of the gateway is invalid.'],
+ ['errorCode' => 'InvalidGatewayType', 'errorMessage' => 'The specified type of the gateway is invalid.', 'description' => 'The specified type of the gateway is invalid.'],
+ ['errorCode' => 'InvalidVSwitchId', 'errorMessage' => 'The specified VSwitch ID does not exist.', 'description' => 'The specified VSwitch ID does not exist.'],
+ ['errorCode' => 'NoAvailableOnlineResource', 'errorMessage' => 'There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.', 'description' => 'There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.'],
+ ['errorCode' => 'DuplicateGatewayName', 'errorMessage' => 'The specified name of the gateway already exists. You must specify a valid name.', 'description' => 'The specified name of the gateway already exists. You must specify a valid name.'],
+ ['errorCode' => 'InvalidGatewayBandwidth', 'errorMessage' => 'The specified public network bandwidth for the gateway is invalid. The bandwidth ranges from 6 to 200 Mbit/s.', 'description' => 'The specified public network bandwidth for the gateway is invalid. The bandwidth ranges from 6 to 200 Mbit/s.'],
+ ['errorCode' => 'GatewayBandwidthNotSupported', 'errorMessage' => 'You cannot decrease the public network bandwidth of a On Premise Gateway.', 'description' => 'You cannot decrease the public network bandwidth of a On Premise Gateway.'],
+ ['errorCode' => 'InvalidGatewayLocation', 'errorMessage' => 'The specified location of the gateway is invalid.', 'description' => 'The specified location of the gateway is invalid.'],
+ ['errorCode' => 'ServiceReleased', 'errorMessage' => 'Service is released, please open service again.', 'description' => 'Service is released, please open service again.'],
],
404 => [
- [
- 'errorCode' => 'StorageBundleNotExist',
- 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.',
- ],
+ ['errorCode' => 'StorageBundleNotExist', 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', 'description' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"测试集群\\",\\n \\"CreatedTime\\": 1657706998,\\n \\"RequestId\\": \\"736C7733-FCED-4AFB-8407-C325F210CE03\\",\\n \\"Message\\": \\"successful\\",\\n \\"StorageBundleId\\": \\"sb-000dt67z4ijqfocpy***\\",\\n \\"BackendBucketRegionId\\": \\"cn-shanghai\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Name\\": \\"sdfa***\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeStorageBundleResponse>\\n <Description>测试集群</Description>\\n <CreatedTime>1657706998</CreatedTime>\\n <RequestId>736C7733-FCED-4AFB-8407-C325F210CE03</RequestId>\\n <Message>successful</Message>\\n <StorageBundleId>sb-000dt67z4ijqfocpy***</StorageBundleId>\\n <BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Name>sdfa***</Name>\\n</DescribeStorageBundleResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***\\\\\\",\\\\\\"directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}&regionId=cn-hangzhou#/buy\\",\\n \\"RequestId\\": \\"8E69E1A1-9076-4C8C-8ADF-ACD253886E22\\",\\n \\"Message\\": \\"successful\\",\\n \\"GatewayId\\": \\"gw-0001xv7je357zm9u6***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateGateway',
+ 'description' => '### Description'."\n"
+ ."\n"
+ .'Before you call this operation, make sure that the following requirements are met:'."\n"
+ ."\n"
+ .'<props="china">'."\n"
+ ."\n"
+ .'- You understand the billing methods and [pricing](https://www.aliyun.com/price/product?spm=5176.144914.752642.btn2.1fea7d70I6QIr5\\&aly_as=C81M1m5N#/hcs_sgw/detail) of Cloud Storage Gateway.'."\n"
+ ."\n"
+ .'</props> <props="intl">You understand the billing methods and pricing of Cloud Storage Gateway.</props>'."\n"
+ .'- You have registered an Alibaba Cloud account and completed real-name verification.'."\n"
+ .'- You have activated the Cloud Storage Gateway service.'."\n"
+ .'- A virtual private cloud (VPC) and a vSwitch are available in the region where you want to create the cloud gateway.'."\n"
+ .'- An Elastic Compute Service (ECS) instance is available in the region where you want to create the cloud gateway. The ECS instance is assigned to the VPC.'."\n"
+ .'- A gateway cluster is available. If a gateway cluster is not available, you can call the [CreateStorageBundle](~~170260~~) operation to create one.'."\n"
+ .'- If the gateway uses the subscription billing method, you must use the purchase URL returned by this operation to complete the purchase after the gateway is created.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- 'title' => 'DescribeStorageBundle',
- ],
- 'DeleteStorageBundle' => [
- 'summary' => 'Deletes a gateway cluster. You must delete all gateways in a gateway cluster before you can delete the gateway cluster.',
- 'methods' => [
- 'post',
- 'get',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGateway'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'CreateGatewayBlockVolume' => [
+ 'summary' => 'Creates a block volume (iSCSI) for an iSCSI gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwJLV9QR'],
],
'parameters' => [
[
- 'name' => 'StorageBundleId',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sb-0001b2otnkdxrigeq***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000dt67z4ijngqvh1***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the block volume. The name must be 1 to 32 characters in length, start with a lowercase letter, and can contain lowercase letters and digits.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'name', 'title' => ''],
+ ],
+ [
+ 'name' => 'Recovery',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable recovery for the block volume. If you enable recovery and the specified OSS bucket was previously used as the cloud storage of a block volume, the gateway attempts to recover the block volume using the metadata dataset in the bucket.'."\n"
+ ."\n"
+ .'The default value is false. This value indicates that a new block volume is created using the OSS bucket.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'VolumeProtocol',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The protocol of the block volume. The only valid value is iSCSI.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'iSCSI', 'title' => ''],
+ ],
+ [
+ 'name' => 'Size',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The size of the block volume. Unit: GB. Valid values:'."\n"
+ ."\n"
+ .'1 to 262144.'."\n"
+ ."\n"
+ .'Default value: 100.'."\n"
+ ."\n"
+ .'> This parameter is invalid when recovery is enabled.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChunkSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The storage allocation unit of the block volume. This parameter specifies the minimum allocation unit of the block volume. To achieve optimal storage efficiency, we recommend that you set this parameter to the same value as the storage allocation unit of the application. Unit: bytes. Valid values:'."\n"
+ ."\n"
+ .'- 8192\\.'."\n"
+ .'- 16384\\.'."\n"
+ .'- 32768\\.'."\n"
+ .'- 65536\\.'."\n"
+ .'- 131072\\.'."\n"
+ ."\n"
+ .'Default value: 32768.'."\n"
+ ."\n"
+ .'> This parameter is invalid when recovery is enabled.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32768', 'title' => ''],
+ ],
+ [
+ 'name' => 'CacheMode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cache mode of the block volume. Default value: Cache. Valid values:'."\n"
+ ."\n"
+ .'- Cache: cache mode.'."\n"
+ .'- WriteThrough: write-through mode.'."\n"
+ ."\n"
+ .'> * You must specify this parameter.'."\n"
+ .'> * In cache mode, read and write operations preferentially access the local cache of the gateway. In write-through mode, read and write operations directly access the OSS bucket in the cloud. In most cases, the cache mode provides better read and write performance.', 'type' => 'string', 'required' => false, 'example' => 'Cache', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChapEnabled',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable Challenge-Handshake Authentication Protocol (CHAP) for iSCSI access. Inbound CHAP is supported.'."\n"
+ ."\n"
+ .'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChapInUser',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The username for inbound CHAP when CHAP is enabled for the block volume. The username must be 1 to 32 characters in length and can contain letters and digits.'."\n"
+ ."\n"
+ .'> This parameter is invalid when CHAP is disabled.', 'type' => 'string', 'required' => false, 'example' => 'chapInUser', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChapInPassword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The password for inbound CHAP when CHAP is enabled for the block volume. The password must be 12 to 16 characters in length and can contain letters, digits, or the following special characters: !, @, #, $, %, ^, &, and \\*.'."\n"
+ ."\n"
+ .'> This parameter is invalid when CHAP is disabled.', 'type' => 'string', 'required' => false, 'example' => 'chapInPassword', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssBucketName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the Object Storage Service (OSS) bucket that corresponds to the block volume.'."\n"
+ ."\n"
+ .'> Block volumes do not support OSS buckets for which the back-to-origin feature is enabled.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bucketName', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssEndpoint',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The endpoint of the region where the OSS bucket that corresponds to the block volume is located.'."\n"
+ ."\n"
+ .'> Differentiate between internal and public endpoints. If the OSS bucket and the gateway are in the same region, we recommend that you use an internal endpoint, such as oss-cn-shanghai-internal.aliyuncs.com.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'oss-cn-shanghai-internal.aliyuncs.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssBucketSsl',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable SSL to access the OSS bucket.'."\n"
+ ."\n"
+ .'Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'LocalFilePath',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The internal device name of the cache disk used by the block volume. You can call the DescribeGatewayCaches operation to obtain the name.'."\n"
+ ."\n"
+ .'> - If CacheMode is set to Cache, you must specify LocalFilePath.'."\n"
+ .'> - If CacheMode is set to WriteThrough, this parameter is invalid.', 'type' => 'string', 'required' => false, 'example' => '/dev/vdb', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssBucketRegionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => 'The region where the OSS bucket that corresponds to the block volume is located.', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
@@ -558,110 +631,107 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '28708A34-83AF-42B8-928B-40E7B3E1D719',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-000c6hshwukkbtxrb***', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9083F167-95B1-4B40-B2CD-70DE068EC3**', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'StorageBundleNotEmpty',
- 'errorMessage' => 'Failed to delete the gateway cluster because a cloud gateway or an on-premises gateway exists. We recommend that you delete all attached gateways before you delete the gateway cluster.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'StorageBundleNotExist',
- 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.',
- ],
+ ['errorCode' => 'InvalidParameter.BlockVolume.%s', 'errorMessage' => 'The specified field %s for block volume is invalid. Please check it again.', 'description' => 'The specified block volume parameter is invalid. You must specify a valid parameter.'],
+ ['errorCode' => 'VersionNotSupported.BlockVolume.%s', 'errorMessage' => 'The specified field %s for block volume is not supported by current gateway version. Please check it again.', 'description' => 'The specified block volume parameter for the gateway is not compatible with the gateway version. You must specify a valid parameter.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"28708A34-83AF-42B8-928B-40E7B3E1D719\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteStorageBundleResponse>\\n <Message>successful</Message>\\n <RequestId>28708A34-83AF-42B8-928B-40E7B3E1D719</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteStorageBundleResponse>","errorExample":""}]',
- 'title' => 'DeleteStorageBundle',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkbtxrb***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9083F167-95B1-4B40-B2CD-70DE068EC3**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateGatewayBlockVolume',
+ 'description' => 'Before you call this operation, make sure that the following requirements are met:'."\n"
+ ."\n"
+ .'- You have created and deployed an iSCSI gateway. If the cache mode is used, the gateway must have an unused cache disk. If the write-through mode is used, no cache disk is required.'."\n"
+ .'- You have an Object Storage Service (OSS) bucket.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeStorageBundles' => [
- 'summary' => 'Queries the information about gateway clusters in the specified region. The information of a gateway cluster includes the name, description, and the time at which the gateway cluster was created.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGatewayBlockVolume'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewayBlockVolume',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateGatewayCacheDisk' => [
+ 'summary' => 'Creates a cache disk for a gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '17168',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwLTSLKH'],
],
'parameters' => [
[
- 'name' => 'BackendBucketRegionId',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'gw-000eg44nmxbsfwbvq***'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'CacheDiskCategory',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The type of the cache disk. Only Enhanced SSDs (ESSDs) are supported. Set the value to cloud\\_essd.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cloud_essd'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'CacheDiskSizeInGB',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'The capacity of the cache disk in GB. The capacity must meet the following requirements:'."\n"
+ ."\n"
+ .'- For a basic gateway, the capacity must be in the range of 40 GB to 4,096 GB.'."\n"
+ ."\n"
+ .'- For a standard gateway, the capacity must be in the range of 40 GB to 8,192 GB.'."\n"
+ ."\n"
+ .'- For an enhanced or performance-optimized gateway, the capacity must be in the range of 40 GB to 32,768 GB.'."\n"
+ ."\n"
+ .'- If CacheDiskCategory is set to cloud\\_essd and PerformanceLevel is set to PL2, the minimum capacity is 461 GB.'."\n"
+ ."\n"
+ .'- If CacheDiskCategory is set to cloud\\_essd and PerformanceLevel is set to PL3, the minimum capacity is 1,261 GB.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '100'],
+ ],
+ [
+ 'name' => 'PerformanceLevel',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => 'The performance level of the ESSD. This parameter is required if CacheDiskCategory is set to cloud\\_essd. Valid values:'."\n"
+ ."\n"
+ .'- PL1'."\n"
+ ."\n"
+ .'- PL2'."\n"
+ ."\n"
+ .'- PL3', 'required' => false, 'title' => '', 'example' => 'PL1'],
],
],
'responses' => [
@@ -669,201 +739,466 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1EB4639B-0812-4F2D-AB78-194E67645E357',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'StorageBundles' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'StorageBundle' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'BackendBucketRegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'StorageBundleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sb-000ibk4xrlr03qrjr***',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'zy-test***',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1565750633',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'BuyURL' => ['description' => 'The purchase URL. This parameter is returned for subscription gateways.', 'type' => 'string', 'title' => '', 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***","directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy'],
+ 'TaskId' => ['description' => 'The ID of the task that is used to create the cache disk. This parameter is returned for pay-as-you-go gateways.', 'type' => 'string', 'title' => '', 'example' => 't-0001xv7je357xv4st***'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8E69E1A1-9076-4C8C-8ADF-ACD253886E22'],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'BadPageSize',
- 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.',
- ],
- [
- 'errorCode' => 'BadPageNumber',
- 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.',
- ],
- [
- 'errorCode' => 'InvalidRegionId',
- 'errorMessage' => 'The specified RegionId does not exist. You must specify a valid RegionId.',
+ ['errorCode' => 'LocationCloudRequired', 'errorMessage' => 'You must specify a cloud gateway. Try again later.', 'description' => 'You must specify a cloud gateway. Try again later.'],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
+ ['errorCode' => 'GatewayOperationNotAllowed', 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', 'description' => 'You cannot perform the operation when the gateway is in the current state.'],
+ ['errorCode' => 'InvalidCacheDiskCategory', 'errorMessage' => 'The category that you specified for the cache disk is invalid. You must specify a valid category.', 'description' => 'The category that you specified for the cache disk is invalid. You must specify a valid category.'],
+ ['errorCode' => 'CacheSizeLimitForBasic', 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Basic gateway is 4 TB.', 'description' => 'The expansion capacity exceeds the maximum cache disk limit. The maximum cache disk limit for Basic Gateway is 4 TB.'],
+ ['errorCode' => 'CacheSizeLimitForStandard', 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Standard gateway is 8 TB.', 'description' => 'The expansion capacity exceeds the maximum cache disk limit. The standard gateway cache disk limit is 8 TB.'],
+ ['errorCode' => 'CacheSizeLimit', 'errorMessage' => 'The maximum size of cache disks for the gateway is 32 TB.', 'description' => 'The maximum cache disk size of the gateway is 32 TB.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***\\\\\\",\\\\\\"directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}&regionId=cn-hangzhou#/buy\\",\\n \\"TaskId\\": \\"t-0001xv7je357xv4st***\\",\\n \\"RequestId\\": \\"8E69E1A1-9076-4C8C-8ADF-ACD253886E22\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateGatewayCacheDisk',
+ 'description' => '- This operation applies only to online gateways.'."\n"
+ ."\n"
+ .'- If the gateway uses the subscription billing method, this operation returns a BuyURL. After you complete the payment, the cache disk is automatically created.'."\n"
+ ."\n"
+ .'- If the gateway uses the pay-as-you-go billing method, this operation returns the ID of the task that creates the cache disk.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGatewayCacheDisk'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewayCacheDisk',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"1EB4639B-0812-4F2D-AB78-194E67645E357\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"StorageBundles\\": {\\n \\"StorageBundle\\": [\\n {\\n \\"Description\\": \\"测试使用\\",\\n \\"BackendBucketRegionId\\": \\"cn-hangzhou\\",\\n \\"StorageBundleId\\": \\"sb-000ibk4xrlr03qrjr***\\",\\n \\"Name\\": \\"zy-test***\\",\\n \\"CreatedTime\\": 1565750633\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeStorageBundlesResponse>\\n <TotalCount>3</TotalCount>\\n <Message>successful</Message>\\n <PageSize>5</PageSize>\\n <RequestId>0F96A15D-BA06-4A34-9587-AA8C9C230E80</RequestId>\\n <PageNumber>1</PageNumber>\\n <Code>200</Code>\\n <StorageBundles>\\n <StorageBundle>\\n <CreatedTime>1568795768</CreatedTime>\\n <StorageBundleId>sb-0007y2889yyxkuqov***</StorageBundleId>\\n <BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>\\n <Description>测试使用</Description>\\n <Name>sgw1-test***</Name>\\n </StorageBundle>\\n <StorageBundle>\\n <CreatedTime>1533283347</CreatedTime>\\n <StorageBundleId>sb-000dai44c82bp6i32***</StorageBundleId>\\n <BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>\\n <Description>测试使用</Description>\\n <Name>sgw2-test***</Name>\\n </StorageBundle>\\n <StorageBundle>\\n <CreatedTime>1532663546</CreatedTime>\\n <StorageBundleId>sb-000e9qyjn694q148r***</StorageBundleId>\\n <BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>\\n <Description>测试使用</Description>\\n <Name>sgw3-test***</Name>\\n </StorageBundle>\\n </StorageBundles>\\n <Success>true</Success>\\n</DescribeStorageBundlesResponse>","errorExample":""}]',
- 'title' => 'DescribeStorageBundles',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
- 'OpenSgwService' => [
- 'summary' => 'Activates the Cloud Storage Gateway (CSG) service. To use the CSG service, you must first activate the service.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateGatewayFileShare' => [
+ 'summary' => 'Creates a file share for a file gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
- [
- 'APP' => [],
- ],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
+ 'abilityTreeCode' => '17169',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'GatewayId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the file share. The name must be 1 to 255 characters in length. It can contain uppercase and lowercase letters, digits, periods (.), underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex***', 'title' => ''],
+ ],
+ [
+ 'name' => 'ShareProtocol',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The file sharing protocol. Valid values:'."\n"
+ ."\n"
+ .'- NFS: Network File System (NFS)'."\n"
+ ."\n"
+ .'- SMB: Server Message Block (SMB)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NFS', 'title' => ''],
+ ],
+ [
+ 'name' => 'RemoteSync',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Indicates whether to enable remote sync for the file share. Valid values:'."\n"
+ ."\n"
+ .'- false (default): disables remote sync.'."\n"
+ ."\n"
+ .'- true: enables remote sync.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'PollingInterval',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The remote sync interval, in seconds. The value must be an integer from 15 to 36,000.'."\n"
+ ."\n"
+ .'> If you use replication mode and enable both remote sync and file data download, the value must be an integer from 3,600 to 36,000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4500', 'title' => ''],
+ ],
+ [
+ 'name' => 'IgnoreDelete',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Indicates whether to ignore deletions. If this feature is enabled, deleting a file on the gateway does not delete the corresponding file in the OSS bucket.'."\n"
+ ."\n"
+ .'- false (default): does not ignore deletions.'."\n"
+ ."\n"
+ .'- true: ignores deletions.'."\n"
+ ."\n"
+ .'> This feature is supported by gateway versions 1.0.40 and later.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'FrontendLimit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum write speed of the file share, in MB/s. Valid values are 0 to 1,280. A value of 0 indicates no limit. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1234', 'title' => ''],
+ ],
+ [
+ 'name' => 'BackendLimit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum upload speed of the file share, in MB/s. Valid values are 0 to 1,280. A value of 0 indicates no limit. The default value is 0.'."\n"
+ ."\n"
+ .'> If you set a maximum write speed, the maximum upload speed cannot be less than the maximum write speed.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1234', 'title' => ''],
+ ],
+ [
+ 'name' => 'InPlace',
+ 'in' => 'query',
+ 'schema' => ['description' => 'This parameter is deprecated. Do not set this parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'CacheMode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cache mode of the file share. Valid values:'."\n"
+ ."\n"
+ .'- Cache: cache mode'."\n"
+ ."\n"
+ .'- Sync: replication mode', 'type' => 'string', 'required' => false, 'example' => 'Cache', 'title' => ''],
+ ],
+ [
+ 'name' => 'Browsable',
+ 'in' => 'query',
+ 'schema' => ['description' => 'For a file share that uses the SMB protocol, this parameter indicates whether the share is discoverable in Network Neighborhood. Valid values:'."\n"
+ ."\n"
+ .'- true (default): The file share is discoverable.'."\n"
+ ."\n"
+ .'- false: The file share is not discoverable.'."\n"
+ ."\n"
+ .'> * This parameter is not valid for the NFS protocol.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'Squash',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The user mapping for the file share that uses the NFS protocol. Valid values:'."\n"
+ ."\n"
+ .'- none (default)'."\n"
+ ."\n"
+ .'- root\\_squash'."\n"
+ ."\n"
+ .'- all\\_squash'."\n"
+ ."\n"
+ .'- all\\_anonymous', 'type' => 'string', 'required' => false, 'example' => 'none', 'title' => ''],
+ ],
+ [
+ 'name' => 'ReadWriteUserList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A list of users with read and write permissions for the SMB file share. Separate multiple users with a comma (,).'."\n"
+ ."\n"
+ .'> - This parameter is not valid for the NFS protocol.', 'type' => 'string', 'required' => false, 'example' => 'user1,user2', 'title' => ''],
+ ],
+ [
+ 'name' => 'ReadOnlyUserList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A list of users with read-only permissions for the SMB file share. Separate multiple users with a comma (,).'."\n"
+ ."\n"
+ .'> - This parameter is not valid for the NFS protocol.', 'type' => 'string', 'required' => false, 'example' => 'userA,userB', 'title' => ''],
+ ],
+ [
+ 'name' => 'ReadWriteClientList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A list of clients with read and write permissions for the NFS file share. The list can contain IP addresses or IP address ranges. Separate multiple clients with a comma (,).', 'type' => 'string', 'required' => false, 'example' => '12.12.12.12', 'title' => ''],
+ ],
+ [
+ 'name' => 'ReadOnlyClientList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A list of clients with read-only permissions for the NFS file share. The list can contain IP addresses or IP address ranges. Separate multiple clients with a comma (,).', 'type' => 'string', 'required' => false, 'example' => '12.12.12.12', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssBucketName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the OSS bucket that the file share uses.'."\n"
+ ."\n"
+ .'> - File shares do not support OSS buckets of the Cold Archive storage class or buckets that have the origin fetch feature enabled.'."\n"
+ .'>'."\n"
+ .'> - If you enable multi-bucket aggregation, separate multiple OSS bucket names with a comma (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testbucket', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssEndpoint',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The endpoint of the region where the OSS bucket is located.'."\n"
+ ."\n"
+ .'> Use an internal endpoint if the OSS bucket and the gateway are in the same region. For example, \\`oss-cn-hangzhou-internal.aliyuncs.com\\`. Otherwise, use a public endpoint.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssBucketSsl',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Indicates whether to use Secure Sockets Layer (SSL) to access the OSS bucket. Valid values:'."\n"
+ ."\n"
+ .'- true (default): enables SSL.'."\n"
+ ."\n"
+ .'- false: disables SSL.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'LagPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The synchronization latency in seconds. This is the delay when synchronizing the local cache of the gateway to the OSS bucket. Valid values are 5 to 120. The default value is 5.'."\n"
+ ."\n"
+ .'> This feature is supported by gateway versions 1.0.40 and later.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''],
+ ],
+ [
+ 'name' => 'DirectIO',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'LocalFilePath',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The internal device name of the cache disk that the file share uses. To get this name, call the \\`DescribeGatewayCaches\\` operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/dev/vdb', 'title' => ''],
+ ],
+ [
+ 'name' => 'ServerSideEncryption',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'ServerSideCmk',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientSideEncryption',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientSideCmk',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'KmsRotatePeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
+ ],
+ [
+ 'name' => 'PathPrefix',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The path of the subdirectory in the OSS bucket that the file share uses. If you leave this parameter empty, the file share uses the root directory of the bucket.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''],
+ ],
+ [
+ 'name' => 'FastReclaim',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Indicates whether to enable upload optimization for the file share. This is suitable for scenarios where you only back up data to the cloud. Valid values:'."\n"
+ ."\n"
+ .'- false (default): disables upload optimization.'."\n"
+ ."\n"
+ .'- true: enables upload optimization.'."\n"
+ ."\n"
+ .'> This feature is supported by gateway versions 1.0.39 and later.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'SupportArchive',
+ 'in' => 'query',
+ 'schema' => ['description' => 'This parameter is deprecated. Do not set this parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'WindowsAcl',
+ 'in' => 'query',
+ 'schema' => ['description' => 'For the SMB protocol, indicates whether to enable access control with Windows Access Control Lists (ACLs). This requires an Active Directory (AD) domain. Valid values:'."\n"
+ ."\n"
+ .'- false (default): disables Windows ACLs.'."\n"
+ ."\n"
+ .'- true: enables Windows ACLs.'."\n"
+ ."\n"
+ .'> This feature is supported by gateway versions 1.0.45 and later.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'AccessBasedEnumeration',
+ 'in' => 'query',
+ 'schema' => ['description' => 'For the SMB protocol, indicates whether to enable Windows access-based enumeration (ABE). This parameter takes effect only if \\`WindowsAcl\\` is set to \\`true\\`. Valid values:'."\n"
+ ."\n"
+ .'- false (default): disables Windows ABE.'."\n"
+ ."\n"
+ .'- true: enables Windows ABE.'."\n"
+ ."\n"
+ .'> This feature is supported by gateway versions 1.0.45 and later.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'NfsV4Optimization',
+ 'in' => 'query',
+ 'schema' => ['description' => 'For the NFS protocol, indicates whether to enable NFSv4 optimization to improve mount and upload efficiency. Valid values:'."\n"
+ ."\n"
+ .'- false (default): disables NFSv4 optimization.'."\n"
+ ."\n"
+ .'- true: enables NFSv4 optimization.'."\n"
+ ."\n"
+ .'> If you enable this feature, you cannot mount the share with NFSv3. This feature is supported by gateway versions 1.2.0 and later.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'TransferAcceleration',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Indicates whether to enable transfer acceleration for the file share. The corresponding OSS bucket must also have transfer acceleration enabled.'."\n"
+ ."\n"
+ .'> This feature is supported by gateway versions 1.3.0 and later.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'RemoteSyncDownload',
+ 'in' => 'query',
+ 'schema' => ['description' => 'In replication mode, indicates whether to download file data. Valid values:'."\n"
+ ."\n"
+ .'- false (default): does not download file data.'."\n"
+ ."\n"
+ .'- true: downloads file data.'."\n"
+ ."\n"
+ .'> This parameter takes effect only if remote sync is enabled for the share or the share is added to an express synchronization group.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'DownloadLimit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum download speed for the file share in MB/s. Valid values range from 0 to 1280. A value of 0 indicates an unlimited speed.'."\n"
+ ."\n"
+ .'> - This parameter can be set only when the file share is in replication mode and file data download is enabled. It takes effect only if remote sync is enabled for the share or the share is added to an express synchronization group. This parameter is supported in gateway versions 1.3.0 and later.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
+ ],
+ [
+ 'name' => 'PartialSyncPaths',
+ 'in' => 'query',
+ 'schema' => ['description' => 'In replication mode, lets you specify a collection of directory paths. Only these directories use replication mode.'."\n"
+ ."\n"
+ .'> Before you can configure this setting, contact us to add your account to the whitelist.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ServerSideAlgorithm',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'example' => 'AES256', 'title' => ''],
+ ],
+ [
+ 'name' => 'BypassCacheRead',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Indicates whether to read directly from OSS. Valid values:'."\n"
+ ."\n"
+ .'- true: reads directly from OSS.'."\n"
+ ."\n"
+ .'- false (default): does not read directly from OSS.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'BindIPAddr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The virtual mount IP address to attach to the share. This parameter is used only for high availability (HA) gateways.', 'type' => 'string', 'required' => false, 'example' => '192.168.0.10', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssBucketRegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region where the OSS bucket is located.'."\n"
+ ."\n"
+ .'> - If the gateway version is 2.0.0 or later and you pass this parameter correctly, the gateway uses the OSS v4 signature algorithm to access data in the OSS bucket.'."\n"
+ .'>'."\n"
+ .'> - If the gateway version is earlier than 2.0.0 or you do not pass this parameter correctly, the gateway uses the OSS v1 signature algorithm to access data in the OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'BucketInfos',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Deprecated.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'example' => 'test-aliyun', 'title' => ''],
+ 'Endpoint' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-hangzhou.aliyuncs.com', 'title' => ''],
+ 'PathPrefix' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'BucketStub',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '开通接口,无法反复调用并返回200',
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ECCBBC17-0C21-5272-9754-9C1AAF83****',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2410000000****',
- ],
+ 'Code' => ['description' => 'The status code. A value of \\`200\\` indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F8B59F29-453D-49BF-8673-EEB8F9F2D5C6', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-000eg44nmxbsh3qk***', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'OrderOpend',
- 'errorMessage' => 'You have already activated the service. Please go to the console to start using it.',
- ],
- [
- 'errorCode' => 'OrderNoRealNameAuthentication',
- 'errorMessage' => 'You have not completed real name authentication yet. Please complete the real-name authentication.',
- ],
- [
- 'errorCode' => 'NoAvailabePaymentMetthod',
- 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.',
- ],
+ ['errorCode' => 'InvalidParameter.FileShare.%s', 'errorMessage' => 'The specified field %s for file share is invalid. Please check it again.', 'description' => 'The specified file sharing parameter for the gateway is invalid. You must specify a valid parameter.'],
+ ['errorCode' => 'VersionNotSupported.FileShare.%s', 'errorMessage' => 'The specified field %s for file share is not supported by current gateway version. Please check it again.', 'description' => 'The specified file sharing parameter for the gateway does not match the gateway version. You must specify a valid parameter.'],
+ ['errorCode' => 'FileShareArchiveSupportConflict', 'errorMessage' => 'You can configure the ArchiveSupport parameter only with NFS protocol and when the user mapping value is "none".', 'description' => ''],
],
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.',
- ],
- [
- 'errorCode' => 'InDebt',
- 'errorMessage' => 'The specified account has overdue payments. We recommend that you add funds to the account now.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F8B59F29-453D-49BF-8673-EEB8F9F2D5C6\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"t-000eg44nmxbsh3qk***\\"\\n}","type":"json"}]',
+ 'title' => 'CreateGatewayFileShare',
+ 'description' => 'Before you call this operation, ensure that the following requirements are met:'."\n"
+ ."\n"
+ .'- You have created and deployed a file gateway that has an unused cache disk.'."\n"
+ ."\n"
+ .'- You have an Object Storage Service (OSS) bucket.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGatewayFileShare'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewayFileShare',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ECCBBC17-0C21-5272-9754-9C1AAF83****\\",\\n \\"OrderId\\": \\"2410000000****\\"\\n}","type":"json"}]',
- 'title' => 'OpenSgwService',
],
- 'CreateGateway' => [
- 'summary' => 'Creates a subscription or pay-as-you-go gateway in a gateway cluster.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateGatewayLogging' => [
+ 'summary' => 'Enables log monitoring for a gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -874,394 +1209,351 @@
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '17166',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwR40N8S'],
],
'parameters' => [
[
- 'name' => 'StorageBundleId',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => false,
- 'example' => 'sb-0001b2otnkdxrigeq***',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfw****', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'SlsProject',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'alex***',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The SLS project.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex****', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'SlsLogstore',
'in' => 'query',
+ 'schema' => ['description' => 'The SLS Logstore.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'logs****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '76109369-5729-467D-D4A3-1131A8DA****', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The call was successful.'."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
+ 'title' => '',
'example' => '',
- 'required' => false,
- 'type' => 'string',
],
],
- [
- 'name' => 'Category',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'EmptySlsProject', 'errorMessage' => 'You must specify a valid project of Log Service.', 'description' => 'You must specify a valid project of Log Service.'],
+ ['errorCode' => 'EmptySlsLogstore', 'errorMessage' => 'You must specify a valid Logstore of Log Service.', 'description' => 'You must specify a valid Logstore of Log Service.'],
+ ['errorCode' => 'GatewayVersionNotAllowed', 'errorMessage' => 'The specified version for the gateway is invalid. You must specify a valid version.', 'description' => 'The specified version for the gateway is invalid. You must specify a valid version.'],
+ ['errorCode' => 'GatewayLoggingStatusNotAllowed', 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.', 'description' => 'Failed to perform the operation because log monitoring is not enabled.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'InvalidLogstore', 'errorMessage' => 'You must specify a valid project and Logstore of Log Service. The project and Logstore must reside in the same region as the gateway. You can use the project and Logstore to monitor logs.', 'description' => 'You must specify a valid project and Logstore of Log Service. The project and Logstore must reside in the same region as the gateway. You can use the project and Logstore to monitor logs.'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.', 'description' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.'],
+ ['errorCode' => 'AssumeRoleFail', 'errorMessage' => 'Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'description' => 'Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
],
[
- 'name' => 'Type',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'File',
- 'required' => true,
- 'type' => 'string',
- ],
+ ['errorCode' => 'StorageBundleNotExist', 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', 'description' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'RoleNotExist', 'errorMessage' => 'The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.', 'description' => 'The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"76109369-5729-467D-D4A3-1131A8DA****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateGatewayLogging',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGatewayLogging'],
],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Location',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'Cloud',
- 'required' => true,
- 'type' => 'string',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewayLogging',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'extraInfo' => ' ',
+ ],
+ 'CreateGatewaySMBUser' => [
+ 'summary' => 'Adds an SMB user to a file gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'GatewayClass',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'Basic',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
+ ],
+ 'parameters' => [
[
- 'name' => 'VSwitchId',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => false,
- 'example' => 'vsw-bp1krhkglx3nahkb9s***',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq2**', 'title' => ''],
],
[
- 'name' => 'PostPaid',
+ 'name' => 'Username',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'type' => 'boolean',
- ],
+ 'schema' => ['description' => 'The username of the SMB user. The username must be 1 to 32 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex', 'title' => ''],
],
[
- 'name' => 'ReleaseAfterExpiration',
+ 'name' => 'Password',
'in' => 'query',
+ 'schema' => ['description' => 'The password of the SMB user. The password cannot be empty. The password can contain letters, digits, and the following special characters: !, @, #, $, %, ^, &, and \\*.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123***', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-000c6hshwukkbtxrb***', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9083F167-95B1-4B40-B2CD-70DE068EC3**', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'type' => 'boolean',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidSMBUserName', 'errorMessage' => 'You must enter a valid SMB username.', 'description' => 'You must enter a valid SMB username.'],
+ ['errorCode' => 'EmptySMBPassword', 'errorMessage' => 'You must enter a valid SMB password.', 'description' => 'You must enter a valid SMB password.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ['errorCode' => 'EmptySMBUserName', 'errorMessage' => 'You must enter a valid SMB username.', 'description' => 'You must enter a valid SMB username.'],
+ ['errorCode' => 'InvalidSMBPassword', 'errorMessage' => 'The specified SMB password is invalid. You must enter a valid password.', 'description' => 'The specified SMB password is invalid. You must enter a valid password.'],
+ ['errorCode' => 'CouldNotCreateSMBUser', 'errorMessage' => 'The gateway has linked an AD or LDAP service. You cannot create an SMB user on the gateway. We recommend that you create an SMB user in the AD or LDAP service.', 'description' => 'The gateway has been configured with an AD service and does not support creating an SMB user from the gateway. Please perform user operations on the AD server.'],
+ ],
+ 404 => [
+ ['errorCode' => 'StorageBundleNotExist', 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', 'description' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'description' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkbtxrb***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9083F167-95B1-4B40-B2CD-70DE068EC3**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateGatewaySMBUser',
+ 'description' => 'Note the following before you call this operation:'."\n"
+ ."\n"
+ .'- This operation fails if your Cloud Storage Gateway is connected to an Active Directory (AD) server. In this case, create the SMB user on the AD server.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGatewaySMBUser'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PublicNetworkBandwidth',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '50',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewaySMBUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'CreateStorageBundle' => [
+ 'summary' => 'Creates a gateway cluster.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ResourceRegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'cn-hangzhou',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'UntrustedEnvInstanceType',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The name of the gateway cluster. The name must be 1 to 60 characters in length and can contain uppercase letters, lowercase letters, Chinese characters, digits, periods (.), underscores (\\_), or hyphens (-). The name must start with an uppercase letter, a lowercase letter, or a Chinese character.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex-123***', 'title' => ''],
],
[
- 'name' => 'UntrustedEnvId',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The description of the gateway cluster. The description can be 0 to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'For testing', 'title' => ''],
],
[
- 'name' => 'SecondaryVSwitchId',
+ 'name' => 'BackendBucketRegionId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The region where the gateway cluster is located. You can call the DescribeRegions operation to obtain a valid region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'BuyURL' => [
- 'description' => '',
- 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***","directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => '8E69E1A1-9076-4C8C-8ADF-ACD253886E22',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'successful',
- 'type' => 'string',
- ],
- 'GatewayId' => [
- 'description' => '',
- 'example' => 'gw-0001xv7je357zm9u6***',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2AD80BDC-E05C-4A77-BBAD-5EDAEDE6D333', 'title' => ''],
+ 'StorageBundleId' => ['description' => 'The ID of the gateway cluster.', 'type' => 'string', 'example' => 'sb-000ibk4xrlr03qrjr***', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayName',
- 'errorMessage' => 'You must enter a valid name for the gateway.',
- ],
- [
- 'errorCode' => 'InvalidGatewayName',
- 'errorMessage' => 'The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.',
- ],
- [
- 'errorCode' => 'DescriptionOverLimit',
- 'errorMessage' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.',
- ],
- [
- 'errorCode' => 'EmptyStorageBundleId',
- 'errorMessage' => 'You must enter a valid ID for the gateway cluster.',
- ],
- [
- 'errorCode' => 'InvalidGatewayClass',
- 'errorMessage' => 'The specified specification of the gateway is invalid.',
- ],
- [
- 'errorCode' => 'InvalidGatewayType',
- 'errorMessage' => 'The specified type of the gateway is invalid.',
- ],
- [
- 'errorCode' => 'InvalidVSwitchId',
- 'errorMessage' => 'The specified VSwitch ID does not exist.',
- ],
- [
- 'errorCode' => 'NoAvailableOnlineResource',
- 'errorMessage' => 'There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.',
- ],
- [
- 'errorCode' => 'DuplicateGatewayName',
- 'errorMessage' => 'The specified name of the gateway already exists. You must specify a valid name.',
- ],
- [
- 'errorCode' => 'InvalidGatewayBandwidth',
- 'errorMessage' => 'The specified public network bandwidth for the gateway is invalid. The bandwidth ranges from 6 to 200 Mbit/s.',
- ],
- [
- 'errorCode' => 'GatewayBandwidthNotSupported',
- 'errorMessage' => 'You cannot decrease the public network bandwidth of a On Premise Gateway.',
- ],
- [
- 'errorCode' => 'InvalidGatewayLocation',
- 'errorMessage' => 'The specified location of the gateway is invalid.',
- ],
- [
- 'errorCode' => 'ServiceReleased',
- 'errorMessage' => 'Service is released, please open service again.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'StorageBundleNotExist',
- 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.',
- ],
+ ['errorCode' => 'EmptyStorageBundleName', 'errorMessage' => 'You must enter a valid name for the gateway cluster.', 'description' => 'You must enter a valid name for the gateway cluster.'],
+ ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'The specified RegionId does not exist. You must specify a valid RegionId.', 'description' => 'The specified RegionId does not exist. You must specify a valid RegionId.'],
+ ['errorCode' => 'StorageBundleDescriptionOverLimit', 'errorMessage' => 'The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.', 'description' => 'The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.'],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
+ ['errorCode' => 'DuplicateStorageBundleName', 'errorMessage' => 'The name you specified for the gateway cluster already exists. You must specify a valid name.', 'description' => 'The name you specified for the gateway cluster already exists. You must specify a valid name.'],
+ ['errorCode' => 'InvalidStorageBundleName', 'errorMessage' => 'The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.', 'description' => 'The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***\\\\\\",\\\\\\"directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}&regionId=cn-hangzhou#/buy\\",\\n \\"RequestId\\": \\"8E69E1A1-9076-4C8C-8ADF-ACD253886E22\\",\\n \\"Message\\": \\"successful\\",\\n \\"GatewayId\\": \\"gw-0001xv7je357zm9u6***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateGatewayResponse>\\n <Message>successful</Message>\\n <RequestId>8E69E1A1-9076-4C8C-8ADF-ACD253886E22</RequestId>\\n <GatewayId>gw-0001xv7je357zm9u6m0u</GatewayId>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&amp;request=%7B%22gateway_id%22:%22gw-0007va9bnidei3s8a09e%22,%22directBuy%22:%22false%22,%22gateway_class%22:%22standard%22,%22cache_cloud_efficiency_size%22:0%7D®ionId=cn-hangzhou#/buy</BuyURL>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateGatewayResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"2AD80BDC-E05C-4A77-BBAD-5EDAEDE6D333\\",\\n \\"StorageBundleId\\": \\"sb-000ibk4xrlr03qrjr***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateStorageBundle',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- 'title' => 'CreateGateway',
- ],
- 'UpgradeGateway' => [
- 'summary' => 'Updates a gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateStorageBundle'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateStorageBundle',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'DeleteExpressSync' => [
+ 'summary' => 'Deletes a specified express synchronization group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwDLQA4J',
- ],
+ 'abilityTreeCode' => '17175',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwNGMQUV'],
],
'parameters' => [
[
- 'name' => 'GatewayId',
+ 'name' => 'ExpressSyncId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The gateway ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-0001xv7je3580031y***',
- ],
+ 'schema' => ['description' => 'The ID of the express synchronization group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sync-0001xv7je357xn8tr***', 'title' => ''],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'string',
- 'example' => 't-0001xv7je3580412***',
- ],
- 'Message' => [
- 'description' => 'The returned message.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'CB300009-3850-4107-B291-59BDB4EDA183',
- ],
- 'Code' => [
- 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-0001xv7je357xv4st***', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A870C702-C3AC-4FC9-91E4-053D3E599A24', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayOperationNotAllowed',
- 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
- ],
+ ['errorCode' => 'EmptyExpressSyncId', 'errorMessage' => 'You must specify a valid ID for the sync group.', 'description' => 'You must specify a valid ID for the sync group.'],
+ ['errorCode' => 'ExpressSyncNotExist', 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.', 'description' => 'The specified sync group does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'ExpressSyncInOperation', 'errorMessage' => 'The sync group is busy. Try again later.', 'description' => 'The sync group is busy. Try again later.'],
+ ['errorCode' => 'ExpressSyncNotEmpty', 'errorMessage' => 'Failed to delete the express sync because a file share or a CSD mount point is attached. We recommend that you remove all attached before you delete the express sync.', 'description' => 'There are file shares in the extreme synchronization group or the mount point of the software version is bound. Please remove all bound file shares and mount points of the software version before deleting the extreme synchronization group.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je3580412***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CB300009-3850-4107-B291-59BDB4EDA183\\",\\n \\"Code\\": \\"Code\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpgradeGatewayResponse>\\n <TaskId>t-0001xv7je3580412***</TaskId>\\n <Message>successful</Message>\\n <RequestId>CB300009-3850-4107-B291-59BDB4EDA183</RequestId>\\n <Code>Code</Code>\\n <Success>true</Success>\\n</UpgradeGatewayResponse>","errorExample":""}]',
- 'title' => 'UpgradeGateway',
- 'description' => '### [](#)Usage notes'."\n"
- ."\n"
- .'When you call this operation, take note of the following items:'."\n"
- ."\n"
- .'* You can update a gateway that is only in the Running or Activated state.'."\n"
- .'* During the update process, the gateway cannot respond to other requests.'."\n"
- ."\n"
- .'**'."\n"
- ."\n"
- .'**Warning** Updating gateways will cause temporary business interruptions. Exercise caution when performing this operation.'."\n",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xv4st***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A870C702-C3AC-4FC9-91E4-053D3E599A24\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteExpressSync',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteExpressSync'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteExpressSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DeleteGateway' => [
'summary' => 'Deletes a pay-as-you-go gateway from its cluster.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1273,46 +1565,28 @@
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The gateway ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-0001xv7je3580031y***',
- ],
+ 'schema' => ['description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031****', 'title' => ''],
],
[
'name' => 'ReasonType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the reason why you want to delete the gateway. Valid values:'."\n"
- ."\n"
- .'* REASON1: The gateway fee is too high.'."\n"
- .'* REASON2: The gateway is used for testing only and is no longer needed now.'."\n"
- .'* REASON3: The gateway feature or performance does not meet the business requirements.'."\n"
- .'* REASON4: The new features are highly anticipated.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'REASON2',
- ],
+ 'schema' => ['description' => 'The type of the reason why you want to delete the gateway. Valid values:'."\n"
+ ."\n"
+ .'* REASON1: The gateway fee is too high.'."\n"
+ .'* REASON2: The gateway is used for testing only and is no longer needed now.'."\n"
+ .'* REASON3: The gateway feature or performance does not meet the business requirements.'."\n"
+ .'* REASON4: The new features are highly anticipated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'REASON2', 'title' => ''],
],
[
'name' => 'ReasonDetail',
'in' => 'query',
- 'schema' => [
- 'description' => 'The detailed reason why you want to delete the gateway.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
+ 'schema' => ['description' => 'The detailed reason why you want to delete the gateway.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Gateway testing completed, no longer needed', 'title' => ''],
],
],
'responses' => [
@@ -1320,68 +1594,32 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'string',
- 'example' => 't-0000iwdggbhaordhk***',
- ],
- 'Message' => [
- 'description' => 'The returned message.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '151BB31D-571D-4BB9-9A02-D4210E5BF5DB',
- ],
- 'Code' => [
- 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 't-0000iwdggbhaordh****', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '151BB31D-571D-4BB9-9A02-D4210E5B****', 'title' => ''],
+ 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayOperationNotAllowed',
- 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
- ],
- [
- 'errorCode' => 'GatewayNotEmpty',
- 'errorMessage' => 'There are file shares or block volumes still under the gateway, please delete them first and then delete the gateway.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayOperationNotAllowed', 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', 'description' => 'You cannot perform the operation when the gateway is in the current state.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
+ ['errorCode' => 'GatewayNotEmpty', 'errorMessage' => 'There are file shares or block volumes still under the gateway, please delete them first and then delete the gateway.', 'description' => 'There are file shares or block volumes still under the gateway, please delete them first and then delete the gateway.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0000iwdggbhaordh****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"151BB31D-571D-4BB9-9A02-D4210E5B****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGatewayResponse>\\n <TaskId>t-0000iwdggbhaordhk***</TaskId>\\n <Message>successful</Message>\\n <RequestId>151BB31D-571D-4BB9-9A02-D4210E5BF5DB</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteGatewayResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0000iwdggbhaordh****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"151BB31D-571D-4BB9-9A02-D4210E5B****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<TaskId>t-0000iwdggbhaordhk***</TaskId>\\n<RequestId>151BB31D-571D-4BB9-9A02-D4210E5BF5DB</RequestId>\\n<Message>successful</Message>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]',
'title' => 'DeleteGateway',
'description' => '### [](#)Usage notes'."\n"
."\n"
@@ -1395,310 +1633,117 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeGateway' => [
- 'summary' => 'Queries the information about a gateway, such as the status and type.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGateway'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteGatewayBlockVolumes' => [
+ 'summary' => 'Deletes the specified iSCSI gateway block volumes.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwJLV9QR'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwb***', 'title' => ''],
+ ],
+ [
+ 'name' => 'IndexId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the index. You can call the DescribeGatewayBlockVolumes operation to query the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NFSalex-gx***', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsSourceDeletion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to delete the source data. Valid values:'."\n"
+ ."\n"
+ .'- true: When the iSCSI gateway volume is deleted, the data in the OSS bucket is also deleted. Proceed with caution.'."\n"
+ .'- false: When the iSCSI gateway volume is deleted, the data in the OSS bucket is not deleted. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'Description' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'example' => '1532099461',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'PublicNetworkBandwidth' => [
- 'description' => '',
- 'example' => '50',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'DataLoadType' => [
- 'description' => '',
- 'example' => 'once',
- 'type' => 'string',
- ],
- 'Category' => [
- 'description' => '',
- 'example' => 'Aliyun',
- 'type' => 'string',
- ],
- 'TaskId' => [
- 'description' => '',
- 'example' => 't-0000iwdggbharrw6r***',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'successful',
- 'type' => 'string',
- ],
- 'ExpireStatus' => [
- 'description' => '',
- 'example' => '0',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'Ip' => [
- 'description' => '',
- 'example' => '47.101.160.44',
- 'type' => 'string',
- ],
- 'GatewayType' => [
- 'description' => '',
- 'example' => 'File',
- 'type' => 'string',
- ],
- 'StorageBundleId' => [
- 'description' => '',
- 'example' => 'sb-000dt67z4ijqfocpy***',
- 'type' => 'string',
- ],
- 'GatewayClass' => [
- 'description' => '',
- 'example' => 'Basic',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'Name' => [
- 'description' => '',
- 'example' => 'alex***',
- 'type' => 'string',
- ],
- 'IsPostPaid' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'Capacity' => [
- 'description' => '',
- 'example' => '500',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'ExpiredTime' => [
- 'description' => '',
- 'example' => '1532530021',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'GatewayVersion' => [
- 'description' => '',
- 'example' => '1.0.39',
- 'type' => 'string',
- ],
- 'IsReleaseAfterExpiration' => [
- 'description' => '',
- 'example' => 'false',
- 'type' => 'boolean',
- ],
- 'Status' => [
- 'description' => '',
- 'example' => 'Initialized',
- 'type' => 'string',
- ],
- 'BuyURL' => [
- 'description' => '',
- 'example' => 'https://expense.console.aliyun.com/?returnExpense=true#/order/list/',
- 'type' => 'string',
- ],
- 'MaxThroughput' => [
- 'description' => '',
- 'example' => '30',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'DataLoadInterval' => [
- 'description' => '',
- 'example' => '120',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'InnerIp' => [
- 'description' => '',
- 'example' => '172.19.55.65',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => '736C7733-FCED-4AFB-8407-C325F210CE03',
- 'type' => 'string',
- ],
- 'VSwitchId' => [
- 'description' => '',
- 'example' => 'vsw-bp1b3mvml55ziekq7e***',
- 'type' => 'string',
- ],
- 'ElasticNodes' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ElasticNode' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'example' => '172.16.0.23',
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'GatewayId' => [
- 'description' => '',
- 'example' => 'gw-0000ewknguw5o96vn***',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'EcsInstanceId' => [
- 'description' => '',
- 'example' => 'i-uf62406gy5vyao4y8***',
- 'type' => 'string',
- ],
- 'Type' => [
- 'description' => '',
- 'example' => 'File',
- 'type' => 'string',
- ],
- 'RenewURL' => [
- 'description' => '',
- 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew',
- 'type' => 'string',
- ],
- 'VpcId' => [
- 'description' => '',
- 'example' => 'vpc-uf6j237kxmsw08auey***',
- 'type' => 'string',
- ],
- 'ActivatedTime' => [
- 'description' => '',
- 'example' => '1578986214',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'ElasticGateway' => [
- 'description' => '',
- 'example' => 'false',
- 'type' => 'boolean',
- ],
- 'CommonBuyInstanceId' => [
- 'description' => '',
- 'example' => 'i-uf6gjr3lnwhyrd6hu***',
- 'type' => 'string',
- ],
- 'InnerIpv6Ip' => [
- 'description' => '',
- 'example' => '2408:4004:110:6000:4656:f88e:1c14:e578',
- 'type' => 'string',
- ],
- 'LastErrorKey' => [
- 'description' => '',
- 'example' => 'InternalError',
- 'type' => 'string',
- ],
- 'Location' => [
- 'description' => '',
- 'example' => 'Cloud',
- 'type' => 'string',
- ],
- 'GatewayRegionId' => [
- 'type' => 'string',
- ],
- 'UntrustedEnvInstanceType' => [
- 'type' => 'string',
- ],
- 'UntrustedEnvOssEndpoint' => [
- 'type' => 'string',
- ],
- 'HighAvailability' => [
- 'type' => 'boolean',
- ],
- 'SecondaryVSwitchId' => [
- 'type' => 'string',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-0000iwdggbhaordhk***', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successsful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '151BB31D-571D-4BB9-9A02-D4210E5BF5DB', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ['errorCode' => 'EmptyVolumeIndexId', 'errorMessage' => 'You must enter an index ID for the block volume.', 'description' => 'You must enter an index ID for the block volume.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"测试使用\\",\\n \\"CreatedTime\\": 1532099461,\\n \\"PublicNetworkBandwidth\\": 5,\\n \\"DataLoadType\\": \\" 废弃\\",\\n \\"Category\\": \\"Aliyun\\",\\n \\"TaskId\\": \\"t-0000iwdggbharrw6r***\\",\\n \\"Message\\": \\"successful\\",\\n \\"ExpireStatus\\": 0,\\n \\"Ip\\": \\"47.101.**.**\\",\\n \\"GatewayType\\": \\"File\\",\\n \\"StorageBundleId\\": \\"sb-000dt67z4ijqfocpy***\\",\\n \\"GatewayClass\\": \\"Basic\\",\\n \\"Success\\": true,\\n \\"Name\\": \\"alex***\\",\\n \\"IsPostPaid\\": true,\\n \\"Capacity\\": 500,\\n \\"ExpiredTime\\": 1532530021,\\n \\"GatewayVersion\\": \\"1.0.39\\",\\n \\"IsReleaseAfterExpiration\\": false,\\n \\"Status\\": \\"Initialized\\",\\n \\"BuyURL\\": \\"https://expense.console.aliyun.com/?returnExpense=true#/order/list/\\",\\n \\"MaxThroughput\\": 30,\\n \\"DataLoadInterval\\": 120,\\n \\"InnerIp\\": \\"172.19.55.65\\",\\n \\"RequestId\\": \\"736C7733-FCED-4AFB-8407-C325F210CE03\\",\\n \\"VSwitchId\\": \\"vsw-bp1b3mvml55ziekq7e***\\",\\n \\"ElasticNodes\\": {\\n \\"ElasticNode\\": [\\n \\"172.16.0.23\\"\\n ]\\n },\\n \\"GatewayId\\": \\"gw-0000ewknguw5o96vn***\\",\\n \\"Code\\": \\"200\\",\\n \\"EcsInstanceId\\": \\"i-uf62406gy5vyao4y8***\\",\\n \\"Type\\": \\"File\\",\\n \\"RenewURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew\\",\\n \\"VpcId\\": \\"vpc-uf6j237kxmsw08auey***\\",\\n \\"ActivatedTime\\": 1578986214,\\n \\"ElasticGateway\\": false,\\n \\"CommonBuyInstanceId\\": \\"gw-000fhosecoziy6ri****\\",\\n \\"InnerIpv6Ip\\": \\"2408:4004::ffff:ffff:ffff:ffff:ffff:ffff\\",\\n \\"LastErrorKey\\": \\"InternalError\\",\\n \\"Location\\": \\"Cloud\\",\\n \\"GatewayRegionId\\": \\"cn-hangzhou\\",\\n \\"UntrustedEnvInstanceType\\": \\"ecs.g6.large\\",\\n \\"UntrustedEnvOssEndpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"HighAvailability\\": false,\\n \\"SecondaryVSwitchId\\": \\"vsw-bp1xw499jo5****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayResponse>\\n <Description>测试使用</Description>\\n <CreatedTime>1532099461</CreatedTime>\\n <PublicNetworkBandwidth>50</PublicNetworkBandwidth>\\n <DataLoadType>once</DataLoadType>\\n <Category>Aliyun</Category>\\n <TaskId>t-0000iwdggbharrw6r***</TaskId>\\n <Message>successful</Message>\\n <ExpireStatus>0</ExpireStatus>\\n <Ip>47.101.**.**</Ip>\\n <GatewayType>File</GatewayType>\\n <StorageBundleId>sb-000dt67z4ijqfocpy***</StorageBundleId>\\n <GatewayClass>Basic</GatewayClass>\\n <Success>true</Success>\\n <Name>alex***</Name>\\n <IsPostPaid>true</IsPostPaid>\\n <Capacity>500</Capacity>\\n <ExpiredTime>1532530021</ExpiredTime>\\n <GatewayVersion>1.0.39</GatewayVersion>\\n <IsReleaseAfterExpiration>false</IsReleaseAfterExpiration>\\n <Status>Initialized</Status>\\n <BuyURL>https://expense.console.aliyun.com/?returnExpense=true#/order/list/</BuyURL>\\n <MaxThroughput>30</MaxThroughput>\\n <DataLoadInterval>120</DataLoadInterval>\\n <InnerIp>172.19.55.65</InnerIp>\\n <RequestId>736C7733-FCED-4AFB-8407-C325F210CE03</RequestId>\\n <VSwitchId>vsw-bp1b3mvml55ziekq7e***</VSwitchId>\\n <ElasticNodes>172.16.0.23</ElasticNodes>\\n <GatewayId>gw-0000ewknguw5o96vn***</GatewayId>\\n <Code>200</Code>\\n <EcsInstanceId>i-uf62406gy5vyao4y8***</EcsInstanceId>\\n <Type>File</Type>\\n <RenewURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&amp;orderType=RENEW&amp;instanceId=ca-0007va9bnideidndn***#/renew</RenewURL>\\n <VpcId>vpc-uf6j237kxmsw08auey***</VpcId>\\n <ActivatedTime>1578986214</ActivatedTime>\\n <ElasticGateway>false</ElasticGateway>\\n <CommonBuyInstanceId>i-uf6gjr3lnwhyrd6hu***</CommonBuyInstanceId>\\n <InnerIpv6Ip>2408:4004::ffff:ffff:ffff:ffff:ffff:ffff</InnerIpv6Ip>\\n <LastErrorKey>InternalError</LastErrorKey>\\n <Location>Cloud</Location>\\n <GatewayRegionId>cn-hangzhou</GatewayRegionId>\\n <UntrustedEnvInstanceType>ecs.g6.large</UntrustedEnvInstanceType>\\n <UntrustedEnvOssEndpoint>oss-cn-hangzhou.aliyuncs.com</UntrustedEnvOssEndpoint>\\n <HighAvailability>false</HighAvailability>\\n</DescribeGatewayResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-0000iwdggbhaordhk***\\",\\n \\"Message\\": \\"successsful\\",\\n \\"RequestId\\": \\"151BB31D-571D-4BB9-9A02-D4210E5BF5DB\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteGatewayBlockVolumes',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- 'title' => 'DescribeGateway',
- ],
- 'ModifyGateway' => [
- 'summary' => 'Modifies the basic information of a gateway, including the name and description.',
- 'methods' => [
- 'post',
- 'get',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGatewayBlockVolumes'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewayBlockVolumes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteGatewayCacheDisk' => [
+ 'summary' => 'Deletes a cache disk from a file gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1707,45 +1752,26 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwLTSLKH'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-0001xv7je3580031y***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031y***', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'CacheId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'alex***',
- ],
+ 'schema' => ['description' => 'The ID of the cache disk. You can call the DescribeGatewayCaches operation to query the ID of the cache disk.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp1dcnq8zldree6ok***', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'LocalFilePath',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The name of the device that corresponds to the cache disk. You can call the DescribeGatewayCaches operation to query the name of the device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/dev/vdb', 'title' => ''],
],
],
'responses' => [
@@ -1753,79 +1779,59 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '220E7407-DF77-428D-8955-B02CF8F82D07',
- ],
- 'GatewayId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gw-0001xv7je3580031y***',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-0001xv7je357xv4s***', 'title' => ''],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EEFC9927-B097-446D-8FDA-F848C8B2C9E3', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'EmptyGatewayName',
- 'errorMessage' => 'You must enter a valid name for the gateway.',
- ],
- [
- 'errorCode' => 'InvalidGatewayName',
- 'errorMessage' => 'The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.',
- ],
- [
- 'errorCode' => 'DescriptionOverLimit',
- 'errorMessage' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'DuplicateGatewayName',
- 'errorMessage' => 'The specified name of the gateway already exists. You must specify a valid name.',
- ],
+ ['errorCode' => 'LocationCloudRequired', 'errorMessage' => 'You must specify a cloud gateway. Try again later.', 'description' => 'You must specify a cloud gateway. Try again later.'],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
+ ['errorCode' => 'GatewayOperationNotAllowed', 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', 'description' => 'You cannot perform the operation when the gateway is in the current state.'],
+ ['errorCode' => 'CacheInUse', 'errorMessage' => 'The cache disk is in use.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"220E7407-DF77-428D-8955-B02CF8F82D07\\",\\n \\"GatewayId\\": \\"gw-0001xv7je3580031y***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyGatewayResponse>\\n <Message>successful</Message>\\n <RequestId>220E7407-DF77-428D-8955-B02CF8F82D07</RequestId>\\n <GatewayId>gw-0001xv7je3580031***</GatewayId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyGatewayResponse>","errorExample":""}]',
- 'title' => 'ModifyGateway',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xv4s***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EEFC9927-B097-446D-8FDA-F848C8B2C9E3\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteGatewayCacheDisk',
+ 'description' => 'Before you call this operation, note the following:'."\n"
+ ."\n"
+ .'- This operation is valid only for online gateways.'."\n"
+ .'- You can delete only pay-as-you-go cache disks.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeployGateway' => [
- 'summary' => 'Deploys a pay-as-you-go gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGatewayCacheDisk'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewayCacheDisk',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteGatewayFileShares' => [
+ 'summary' => 'Deletes one or more file shares from a file gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1834,379 +1840,206 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-0001xv7je3580031y***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'gw-000eg44nmxbsfwbv****'],
],
[
- 'name' => 'GatewayClass',
+ 'name' => 'IndexId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'Basic',
- ],
+ 'schema' => ['description' => 'The ID of the file share. You can call the DescribeGatewayFileShares operation to query the IDs of file shares.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'NFSalex***'],
+ ],
+ [
+ 'name' => 'Force',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to force delete the file share. Valid values:'."\n"
+ ."\n"
+ .'- true: Force deletes the file share even if data synchronization is incomplete. Use this option with caution.'."\n"
+ ."\n"
+ .'- false (default): Does not delete the file share if data synchronization is incomplete.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0001xv7je35800307***',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '8FEAFE9D-66C2-46AB-833B-35269EC7524C',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'title' => '', 'example' => 't-000c6hshwukkcfn****'],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'title' => '', 'example' => 'successful'],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 't-000czaedx5koz578vk**'],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
- ],
- [
- 'errorCode' => 'InvalidGatewayLocation',
- 'errorMessage' => 'The specified location of the gateway is invalid.',
- ],
- [
- 'errorCode' => 'InvalidGatewayClass',
- 'errorMessage' => 'The specified specification of the gateway is invalid.',
- ],
+ ['errorCode' => 'EmptyShareIndexId', 'errorMessage' => 'You must enter a valid file sharing ID.', 'description' => 'You must enter a valid file sharing ID.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'description' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je35800307***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"8FEAFE9D-66C2-46AB-833B-35269EC7524C\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeployGatewayResponse>\\n <TaskId>t-0001xv7je35800307***</TaskId>\\n <Message>successful</Message>\\n <RequestId>8FEAFE9D-66C2-46AB-833B-35269EC7524C</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeployGatewayResponse>","errorExample":""}]',
- 'title' => 'DeployGateway',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkcfn****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"t-000czaedx5koz578vk**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteGatewayFileShares',
+ 'description' => '### Description'."\n"
+ ."\n"
+ .'><warning>'."\n"
+ ."\n"
+ .'- Deleting a file share interrupts services and data synchronization. Use this operation with caution.'."\n"
+ ."\n"
+ .'- Before you delete a Network File System (NFS) share, unmount it from the client. If you delete the share or the gateway before you unmount it, the mount target cannot be unmounted. Subsequent operations on the mount directory will freeze or become unresponsive.'."\n"
+ ."\n"
+ .'- Deleting a file share does not stop billing for the gateway. If you no longer need the gateway, call the [DeleteGateway](https://help.aliyun.com/zh/csg/developer-reference/api-sgw-2018-05-11-deletegateway?spm=a2c4g.11186623.help-menu-53923.d_5_1_3_1_3.15947491Vl7Ja9\\&scm=20140722.H_2874297._.OR_help-T_cn~zh-V_1) operation to delete the gateway and avoid further charges.'."\n"
+ ."\n"
+ .'></warning>',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeTasks' => [
- 'summary' => 'Queries task information, including task progress and name.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGatewayFileShares'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewayFileShares',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteGatewayLogging' => [
+ 'summary' => 'Deletes the log monitoring feature for a gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwR40N8S'],
],
'parameters' => [
[
- 'name' => 'TargetId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the gateway or express synchronization group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sync-0001xv757xl9sn548***',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n"
- ."\n"
- .'* Page starts from page 1.'."\n"
- .'* Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n"
- ."\n"
- .'* Maximum value: 50.'."\n"
- .'* Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
- ],
- [
- 'name' => 'TaskId',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The task ID. If you leave the parameter empty, all tasks are queried.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 't-0001xv7je357xl9n***',
- ],
+ 'schema' => ['description' => 'The gateway ID.', 'docRequired' => true, 'required' => true, 'type' => 'string', 'example' => 'gw-0001xv7je3580031***', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => 'The total number of tasks.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Tasks' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SimpleTask' => [
- 'description' => 'The task information.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'StateCode' => [
- 'description' => 'The status code of the task. Valid values:'."\n"
- ."\n"
- .'* task.state.Initialized'."\n"
- .'* task.state.Running'."\n"
- .'* task.state.completed'."\n"
- .'* task.state.Failed'."\n",
- 'type' => 'string',
- 'example' => 'task.state.completed',
- ],
- 'Progress' => [
- 'description' => 'The task progress in percentage.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'UpdatedTime' => [
- 'description' => 'The timestamp when the task was last modified. Unit: seconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1578367230',
- ],
- 'MessageKey' => [
- 'description' => 'The error message returned.'."\n",
- 'type' => 'string',
- 'example' => 'xxxxxxxxxx',
- ],
- 'Name' => [
- 'description' => 'The task name.'."\n",
- 'type' => 'string',
- 'example' => 'task.name.operate_fast_sync.delete',
- ],
- 'CreatedTime' => [
- 'description' => 'The timestamp when the task was created. Unit: seconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1578367229',
- ],
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'string',
- 'example' => 't-0001xv7je357xl9n***',
- ],
- 'RelatedResourceId' => [
- 'description' => 'The ID of the associated resource.'."\n",
- 'type' => 'string',
- 'example' => 'NFSnfstest',
- ],
- ],
- 'description' => '',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '8E9C6D43-4603-4F05-BE76-677A05EDFB7A',
- ],
- 'Message' => [
- 'description' => 'The returned message.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Code' => [
- 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E66BF56E-068D-4308-A2D8-7FBBCE22E812', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'type' => 'object',
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyTargetId',
- 'errorMessage' => 'You must enter a valid ID for the target gateway.',
- ],
- [
- 'errorCode' => 'BadPageSize',
- 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.',
- ],
- [
- 'errorCode' => 'BadPageNumber',
- 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayLoggingStatusNotAllowed', 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.', 'description' => 'Failed to perform the operation because log monitoring is not enabled.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"Tasks\\": {\\n \\"SimpleTask\\": [\\n {\\n \\"StateCode\\": \\"task.state.completed\\",\\n \\"Progress\\": 100,\\n \\"UpdatedTime\\": 1578367230,\\n \\"MessageKey\\": \\"xxx\\",\\n \\"Name\\": \\"task.name.operate_fast_sync.delete\\",\\n \\"CreatedTime\\": 1578367229,\\n \\"TaskId\\": \\"t-0001xv7je357xl9n***\\",\\n \\"RelatedResourceId\\": \\"NFSnfstest\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"8E9C6D43-4603-4F05-BE76-677A05EDFB7A\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeTasksResponse>\\n <TotalCount>1</TotalCount>\\n <Tasks>\\n <StateCode>task.state.completed</StateCode>\\n <Progress>100</Progress>\\n <UpdatedTime>1578367230</UpdatedTime>\\n <MessageKey>xxx</MessageKey>\\n <Name>task.name.operate_fast_sync.delete</Name>\\n <CreatedTime>1578367229</CreatedTime>\\n <TaskId>t-0001xv7je357xl9n***</TaskId>\\n <RelatedResourceId>NFSnfstest</RelatedResourceId>\\n </Tasks>\\n <RequestId>8E9C6D43-4603-4F05-BE76-677A05EDFB7A</RequestId>\\n <Message>successful</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeTasksResponse>","errorExample":""}]',
- 'title' => 'DescribeTasks',
- ],
- 'DescribeGateways' => [
- 'summary' => 'Queries a list of gateways. The returned information includes gateway IDs and names.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"E66BF56E-068D-4308-A2D8-7FBBCE22E812\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteGatewayLogging',
+ 'description' => '### Description'."\n"
+ ."\n"
+ .'When you call this operation, note the following:'."\n"
+ ."\n"
+ .'- If you no longer require the log monitoring feature, you can call this operation to delete the specified log monitoring configuration.'."\n"
+ .'- Make sure that you have created a Cloud Storage Gateway (CSG) instance and enabled the log monitoring feature for the gateway.'."\n"
+ .'- You can delete the log monitoring configuration only when the log monitoring feature has a status of Enabled or Disabled.'."\n"
+ .'<props="china">'."\n"
+ ."\n"
+ .'- You can call the [DescribeGatewayLogging](https://help.aliyun.com/zh/csg/developer-reference/api-describegatewaylogging) operation to query the status of the log monitoring feature for a gateway.'."\n"
+ ."\n"
+ .'</props> <props="intl">You can call the [DescribeGatewayLogging](https://www.alibabacloud.com/help/zh/csg/developer-reference/api-describegatewaylogging?spm=a2c63.p38356.0.0.19107582L1BU5t) operation to query the status of the log monitoring feature for a gateway.</props>',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGatewayLogging'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewayLogging',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteGatewaySMBUser' => [
+ 'summary' => 'Deletes a specified Server Message Block (SMB) user from a file gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '17215',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
],
'parameters' => [
[
- 'name' => 'StorageBundleId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'sb-0001b2otnkdxrigeq***',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000c6hshwukkbrypj***', 'title' => ''],
],
[
- 'name' => 'ResourceRegionId',
+ 'name' => 'Username',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The SMB username. The username must be 1 to 32 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username', 'title' => ''],
],
],
'responses' => [
@@ -2214,314 +2047,83 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2C4A8287-66F4-45F9-84E3-866E4232C763',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Gateways' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Gateway' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc-bp1p0usrgr5z9e7lwr***',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'File',
- ],
- 'Capacity' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'GatewayId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gw-0001b2odzvl3b1mhi***',
- ],
- 'IsReleaseAfterExpiration' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'GatewayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'File',
- ],
- 'BuyURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***”,”directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy',
- ],
- 'EcsInstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gw-0001b2onkdzvl3b***',
- ],
- 'MaxThroughput' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'GatewayClass' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Advanced',
- ],
- 'InnerIp' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '172.16.0.21',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'fio-weekly***',
- ],
- 'InnerIpv6Ip' => [
- 'type' => 'string',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1577179604',
- ],
- 'ExpireStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'DataLoadInterval' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'RenewURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew',
- ],
- 'IsPostPaid' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'PublicNetworkBandwidth' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '55',
- ],
- 'StorageBundleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sb-0001b2otrigeqkso***',
- ],
- 'Ip' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '47.111.145.66',
- ],
- 'LastErrorKey' => [
- 'type' => 'string',
- ],
- 'ElasticNodes' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ElasticNode' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'VSwitchId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-bp1krhkgnahkb9stp0***',
- ],
- 'CommonBuyInstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gw-0001b2onkdzvl3b***',
- ],
- 'ExpiredTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1532426471',
- ],
- 'GatewayVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.2.6',
- ],
- 'DataLoadType' => [
- 'type' => 'string',
- ],
- 'ElasticGateway' => [
- 'type' => 'boolean',
- ],
- 'Category' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Aliyun',
- ],
- 'ActivatedTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1577179769',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-000978oflgrd8ah6p***',
- ],
- 'Location' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Cloud',
- ],
- 'GatewayRegionId' => [
- 'type' => 'string',
- ],
- 'UntrustedEnvInstanceType' => [
- 'type' => 'string',
- ],
- 'HighAvailability' => [
- 'type' => 'boolean',
- ],
- 'SecondaryVSwitchId' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-000c6hshwukkcfn3k**', 'title' => ''],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyStorageBundleId',
- 'errorMessage' => 'You must enter a valid ID for the gateway cluster.',
- ],
- [
- 'errorCode' => 'BadPageSize',
- 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.',
- ],
- [
- 'errorCode' => 'BadPageNumber',
- 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.',
- ],
+ ['errorCode' => 'EmptySMBUserName', 'errorMessage' => 'You must enter a valid SMB username.', 'description' => 'You must enter a valid SMB username.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInUpgrading', 'errorMessage' => 'The gateway is upgrading. Try again later.', 'description' => 'The gateway is upgrading. Try again later.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ['errorCode' => 'GatewayStatusRunningRequired', 'errorMessage' => 'The gateway is not in the Running state. Try again later.', 'description' => 'The gateway is not in the Running state. Try again later.'],
+ ['errorCode' => 'InvalidSMBUserName', 'errorMessage' => 'You must enter a valid SMB username.', 'description' => 'You must enter a valid SMB username.'],
+ ['errorCode' => 'CouldNotDeleteSMBUser', 'errorMessage' => 'The gateway is already linked with an AD or LDAP service. You cannot delete an SMB user on the gateway. We recommend that you delete an SMB user in the AD or LDAP service.', 'description' => 'The gateway has been configured with an AD service and does not support deleting an SMB user from the gateway. Please perform user operations on the AD server.'],
],
- 404 => [
- [
- 'errorCode' => 'StorageBundleNotExist',
- 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'description' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"2C4A8287-66F4-45F9-84E3-866E4232C763\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Gateways\\": {\\n \\"Gateway\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1p0usrgr5z9e7lwr***\\",\\n \\"Status\\": \\"Running\\",\\n \\"Type\\": \\"File\\",\\n \\"Capacity\\": 500,\\n \\"GatewayId\\": \\"gw-0001b2odzvl3b1mhi***\\",\\n \\"IsReleaseAfterExpiration\\": false,\\n \\"GatewayType\\": \\"File\\",\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***”,”directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}&regionId=cn-hangzhou#/buy\\",\\n \\"EcsInstanceId\\": \\"gw-0001b2onkdzvl3b***\\",\\n \\"MaxThroughput\\": 0,\\n \\"GatewayClass\\": \\"Advanced\\",\\n \\"InnerIp\\": \\"172.16.0.21\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"Name\\": \\"fio-weekly***\\",\\n \\"InnerIpv6Ip\\": \\"2408:4004:110:6000:4656:f88e:1c14:e578\\",\\n \\"CreatedTime\\": 1577179604,\\n \\"ExpireStatus\\": 0,\\n \\"DataLoadInterval\\": 120,\\n \\"RenewURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew\\",\\n \\"IsPostPaid\\": true,\\n \\"PublicNetworkBandwidth\\": 55,\\n \\"StorageBundleId\\": \\"sb-0001b2otrigeqkso***\\",\\n \\"Ip\\": \\"47.111.145.66\\",\\n \\"LastErrorKey\\": \\"InternalError\\",\\n \\"ElasticNodes\\": {\\n \\"ElasticNode\\": [\\n \\"172.16.0.23\\"\\n ]\\n },\\n \\"VSwitchId\\": \\"vsw-bp1krhkgnahkb9stp0***\\",\\n \\"CommonBuyInstanceId\\": \\"gw-0001b2onkdzvl3b***\\",\\n \\"ExpiredTime\\": 1532426471,\\n \\"GatewayVersion\\": \\"1.2.6\\",\\n \\"DataLoadType\\": \\"once\\",\\n \\"ElasticGateway\\": false,\\n \\"Category\\": \\"Aliyun\\",\\n \\"ActivatedTime\\": 1577179769,\\n \\"TaskId\\": \\"t-000978oflgrd8ah6p***\\",\\n \\"Location\\": \\"Cloud\\",\\n \\"GatewayRegionId\\": \\"cn-hangzhou\\",\\n \\"UntrustedEnvInstanceType\\": \\"ecs.g6.large\\",\\n \\"HighAvailability\\": false,\\n \\"SecondaryVSwitchId\\": \\"vsw-bp1krhkgnahkb8stp0***\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewaysResponse>\\n <TotalCount>2</TotalCount>\\n <RequestId>2C4A8287-66F4-45F9-84E3-866E4232C763</RequestId>\\n <Message>successful</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Gateways>\\n <VpcId>vpc-bp1p0usrgr5z9e7lwr***</VpcId>\\n <Status>Running</Status>\\n <Type>File</Type>\\n <Capacity>500</Capacity>\\n <GatewayId>gw-0001b2odzvl3b1mhi***</GatewayId>\\n <IsReleaseAfterExpiration>false</IsReleaseAfterExpiration>\\n <GatewayType>File</GatewayType>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&amp;request={\\"gateway_id\\":\\"gw-0007va9bnidei3s8a***”,”directBuy\\":\\"false\\",\\"gateway_class\\":\\"standard\\",\\"cache_cloud_efficiency_size\\":0}&amp;regionId=cn-hangzhou#/buy</BuyURL>\\n <EcsInstanceId>gw-0001b2onkdzvl3b***</EcsInstanceId>\\n <MaxThroughput>30</MaxThroughput>\\n <GatewayClass>Advanced</GatewayClass>\\n <InnerIp>172.16.0.21</InnerIp>\\n <Description>测试使用</Description>\\n <Name>fio-weekly***</Name>\\n <InnerIpv6Ip>2408:4004:110:6000:4656:f88e:1c14:e578</InnerIpv6Ip>\\n <CreatedTime>1577179604</CreatedTime>\\n <ExpireStatus>0</ExpireStatus>\\n <DataLoadInterval>120</DataLoadInterval>\\n <RenewURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&amp;orderType=RENEW&amp;instanceId=ca-0007va9bnideidndnu72#/renew</RenewURL>\\n <IsPostPaid>true</IsPostPaid>\\n <PublicNetworkBandwidth>55</PublicNetworkBandwidth>\\n <StorageBundleId>sb-0001b2otrigeqkso***</StorageBundleId>\\n <Ip>47.111.145.66</Ip>\\n <LastErrorKey>InternalError</LastErrorKey>\\n <ElasticNodes>172.16.0.23</ElasticNodes>\\n <VSwitchId>vsw-bp1krhkgnahkb9stp0***</VSwitchId>\\n <CommonBuyInstanceId>gw-0001b2onkdzvl3b***</CommonBuyInstanceId>\\n <ExpiredTime>1532426471</ExpiredTime>\\n <GatewayVersion>1.2.6</GatewayVersion>\\n <DataLoadType>once</DataLoadType>\\n <ElasticGateway>false</ElasticGateway>\\n <Category>Aliyun</Category>\\n <ActivatedTime>1577179769</ActivatedTime>\\n <TaskId>t-000978oflgrd8ah6p***</TaskId>\\n <Location>Cloud</Location>\\n <GatewayRegionId>cn-hangzhou</GatewayRegionId>\\n <UntrustedEnvInstanceType>ecs.g6.large</UntrustedEnvInstanceType>\\n <HighAvailability>false</HighAvailability>\\n <SecondaryVSwitchId>vsw-bp1krhkgnahkb8stp0***</SecondaryVSwitchId>\\n </Gateways>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewaysResponse>","errorExample":""}]',
- 'title' => 'DescribeGateways',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkcfn3k**\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteGatewaySMBUser',
+ 'description' => 'When you call this operation, note the following:'."\n"
+ ."\n"
+ .'- Make sure that you have created a Cloud Storage Gateway. If not, you can call the CreateGateway operation to create one.'."\n"
+ .'- If your Cloud Storage Gateway is connected to an Active Directory (AD) server, this operation fails. In this case, you can delete the SMB user on the AD server.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeGatewayCategories' => [
- 'summary' => 'Queries available gateway categories.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGatewaySMBUser'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewaySMBUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteStorageBundle' => [
+ 'summary' => 'If the gateway cluster contains online or on-premises Cloud Storage Gateways, you must delete all gateways before you can delete the cluster.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '17200',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
- 'name' => 'GatewayLocation',
+ 'name' => 'StorageBundleId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'On_Premise',
- ],
+ 'schema' => ['description' => 'The ID of the gateway cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sb-0001b2otnkdxrige****', 'title' => ''],
],
],
'responses' => [
@@ -2529,139 +2131,148 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4DA9D8E2-2C27-5FD8-83D7-F0AA00C1****',
- ],
- 'Categories' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Aliyun,Apsara',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '28708A34-83AF-42B8-928B-40E7B3E1D719', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ .'- false: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4DA9D8E2-2C27-5FD8-83D7-F0AA00C1****\\",\\n \\"Categories\\": \\"Aliyun,Apsara\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'DescribeGatewayCategories',
- ],
- 'DescribeGatewayTypes' => [
- 'summary' => 'Queries available gateway types.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'StorageBundleNotEmpty', 'errorMessage' => 'Failed to delete the gateway cluster because a cloud gateway or an on-premises gateway exists. We recommend that you delete all attached gateways before you delete the gateway cluster.', 'description' => 'Failed to delete the gateway cluster because a cloud gateway or an on-premises gateway exists. We recommend that you delete all attached gateways before you delete the gateway cluster.'],
+ ],
+ 404 => [
+ ['errorCode' => 'StorageBundleNotExist', 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', 'description' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"28708A34-83AF-42B8-928B-40E7B3E1D719\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteStorageBundle',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteStorageBundle'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteStorageBundle',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeployGateway' => [
+ 'summary' => 'You can call the DeployGateway operation to deploy a pay-as-you-go gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '17222',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
- 'name' => 'GatewayLocation',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Cloud',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031y***', 'title' => ''],
+ ],
+ [
+ 'name' => 'GatewayClass',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The gateway class. Valid values:'."\n"
+ ."\n"
+ .'- Basic'."\n"
+ .'- Standard'."\n"
+ .'- Enhanced'."\n"
+ .'- Advanced', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Basic', 'title' => ''],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
- 'Types' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'File,Iscsi',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '787ECFD0-5F30-44C0-BB8F-56A964F66D01',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-0001xv7je35800307***', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '8FEAFE9D-66C2-46AB-833B-35269EC7524C', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
- ],
- [
- 'errorCode' => 'InvalidGatewayLocation',
- 'errorMessage' => 'The specified location of the gateway is invalid.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
+ ['errorCode' => 'InvalidGatewayLocation', 'errorMessage' => 'The specified location of the gateway is invalid.', 'description' => 'The specified location of the gateway is invalid.'],
+ ['errorCode' => 'InvalidGatewayClass', 'errorMessage' => 'The specified specification of the gateway is invalid.', 'description' => 'The specified specification of the gateway is invalid.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Types\\": \\"File,Iscsi\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"787ECFD0-5F30-44C0-BB8F-56A964F66D01\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayTypesResponse>\\n <code>200</code>\\n <message>successful</message>\\n <requestId>787ECFD0-5F30-44C0-BB8F-56A964F66D01</requestId>\\n <success>true</success>\\n <types>File,Iscsi</types>\\n</DescribeGatewayTypesResponse>","errorExample":""}]',
- 'title' => 'DescribeGatewayTypes',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-0001xv7je35800307***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"8FEAFE9D-66C2-46AB-833B-35269EC7524C\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeployGateway',
+ 'description' => 'When you call this operation, note the following:'."\n"
+ ."\n"
+ .'- This operation supports only pay-as-you-go cloud-based file gateways.'."\n"
+ .'- You can deploy only cloud-based file gateways that are in the Initialized status.'."\n"
+ .'- After the gateway is deployed, you can call the DescribeGateway operation to query the status of the gateway. The gateway is successfully deployed if its status is Running.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeAccountConfig' => [
- 'summary' => 'Queries account configurations.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeployGateway'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeployGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeAccountConfig' => [
+ 'summary' => 'Retrieves the configuration of an account.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2673,20 +2284,13 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gw-000hy2wefifsxau8****',
- ],
+ 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'gw-000hy2wefifsxau8****'],
],
],
'responses' => [
@@ -2694,62 +2298,55 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ADBBF2E5-3B01-54D3-B2CA-F09EBD48****',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'IsSupportServerSideEncryption' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'IsSupportClientSideEncryption' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'IsSupportGatewayLogging' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'IsSupportElasticGatewayBeta' => [
- 'description' => '',
- 'type' => 'boolean',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'ADBBF2E5-3B01-54D3-B2CA-F09EBD48****'],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'title' => '', 'example' => 'successful'],
+ 'IsSupportServerSideEncryption' => ['description' => 'This parameter is deprecated.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'IsSupportClientSideEncryption' => ['description' => 'This parameter is deprecated.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful. Other values indicate that the request failed.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'IsSupportGatewayLogging' => ['description' => 'Indicates whether the account supports gateway Log Monitoring. Valid values:'."\n"
+ ."\n"
+ .'- true: Supported.'."\n"
+ ."\n"
+ .'- false: Not supported.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ ."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'IsSupportElasticGatewayBeta' => ['description' => 'This parameter is deprecated.', 'type' => 'boolean', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADBBF2E5-3B01-54D3-B2CA-F09EBD48****\\",\\n \\"Message\\": \\"successful\\",\\n \\"IsSupportServerSideEncryption\\": false,\\n \\"IsSupportClientSideEncryption\\": true,\\n \\"Code\\": \\"200\\",\\n \\"IsSupportGatewayLogging\\": true,\\n \\"Success\\": true,\\n \\"IsSupportElasticGatewayBeta\\": true\\n}","type":"json"}]',
'title' => 'DescribeAccountConfig',
- ],
- 'DescribeGatewayImages' => [
- 'summary' => 'Queries the image information about an on-premises gateway, including the name and description.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAccountConfig'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeAccountConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADBBF2E5-3B01-54D3-B2CA-F09EBD48****\\",\\n \\"Message\\": \\"successful\\",\\n \\"IsSupportServerSideEncryption\\": false,\\n \\"IsSupportClientSideEncryption\\": true,\\n \\"Code\\": \\"200\\",\\n \\"IsSupportGatewayLogging\\": true,\\n \\"Success\\": true,\\n \\"IsSupportElasticGatewayBeta\\": false\\n}","type":"json"}]',
+ ],
+ 'DescribeExpressSyncShares' => [
+ 'summary' => 'Queries for shares that are associated with an express synchronization group or can be added to the group. The returned information includes details such as the gateway name, cluster ID, and share name.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2761,190 +2358,148 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '17206',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwNGMQUV'],
],
'parameters' => [
[
- 'name' => 'Type',
+ 'name' => 'ExpressSyncIds',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'File',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'A list of express synchronization group IDs. The IDs are separated by commas.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sync-0002xetjdlxne2sd***,sync-0004agfrbke1l39p***', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsExternal',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to query the shares that have been added to the express synchronization group. Valid values:'."\n"
+ ."\n"
+ .'- true: queries the information about shares that can be added to the express synchronization group.'."\n"
+ .'- false: queries the information about shares that are in the express synchronization group.'."\n"
+ ."\n"
+ .'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'example' => 'successful',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => '30DFF66156-3672-4204-B708-24389F01FC77',
- 'type' => 'string',
- ],
- 'Images' => [
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EA258616-36AD-4609-A0A6-2B17C28CBF88', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Shares' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Image' => [
- 'description' => '',
+ 'Share' => [
+ 'description' => 'The information about the shares in the express synchronization group.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'type' => 'object',
'properties' => [
- 'Type' => [
- 'description' => '',
- 'example' => 'application/octet-stream',
- 'type' => 'string',
- ],
- 'Description' => [
- 'description' => '',
- 'example' => 'sgw.file.kvm.description',
- 'type' => 'string',
- ],
- 'Version' => [
- 'description' => '',
- 'example' => '1.0.40',
- 'type' => 'string',
- ],
- 'Size' => [
- 'description' => '',
- 'example' => '1063744588',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'Url' => [
- 'description' => '',
- 'example' => 'http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAINaSMVqr8***&Signature=%2BoTNVCGWgxis8GMpvpg5NIRkFvE%3D',
- 'type' => 'string',
- ],
- 'Title' => [
- 'description' => '',
- 'example' => 'sgw.file.kvm.title',
- 'type' => 'string',
- ],
- 'MD5' => [
- 'description' => '',
- 'example' => '48f43e6a906b28ed30ec40d8***',
- 'type' => 'string',
- ],
- 'Name' => [
- 'description' => '',
- 'example' => 'aliyun/file/1.0.40/image/sgw-file-1.0.39.v***',
- 'type' => 'string',
- ],
- 'ModifiedDate' => [
- 'description' => '',
- 'example' => '2019-07-24',
- 'type' => 'string',
- ],
+ 'MnsQueue' => ['description' => 'The name of the message queue (Queue) that corresponds to the share in Alibaba Cloud Simple Message Queue (formerly MNS).', 'type' => 'string', 'example' => 'sgw-express-sync-queue-gw-000245alq48e7ytgxq03***', 'title' => ''],
+ 'ExpressSyncId' => ['description' => 'The express synchronization ID.', 'type' => 'string', 'example' => 'sb-0003c7qh5yuc1z6b8***', 'title' => ''],
+ 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'string', 'example' => 'gw-000245alq48e7ytg***', 'title' => ''],
+ 'ExpressSyncState' => ['description' => 'The health status of the express synchronization group. Possible values:'."\n"
+ ."\n"
+ .'- TopicAndQueueFailure: The message topic and message queue are inaccessible.'."\n"
+ .'- TopicFailure: The message topic is inaccessible.'."\n"
+ .'- MNSFullSyncInit: A full synchronization is pending.'."\n"
+ .'- MNSFullSyncing: A full synchronization is in progress.'."\n"
+ .'- QueueFailure: The message queue is inaccessible.'."\n"
+ .'- MNSNotEnabled: Express synchronization is disabled.'."\n"
+ .'- MNSHealthy: The synchronization is normal.', 'type' => 'string', 'example' => 'MNSHealthy', 'title' => ''],
+ 'GatewayName' => ['description' => 'The gateway name.', 'type' => 'string', 'example' => 'File-upgrade***', 'title' => ''],
+ 'StorageBundleId' => ['description' => 'The gateway cluster ID.', 'type' => 'string', 'example' => 'sb-0003c7qh5yuc1z6b8***', 'title' => ''],
+ 'SyncProgress' => ['description' => 'The progress of the full synchronization of the share. This parameter is valid only when the share is added to an express synchronization group. Possible values:'."\n"
+ ."\n"
+ .'- 0 to 100: the progress of the full synchronization of the share in percentage.'."\n"
+ .'- -1: A full synchronization is not performed for the share.'."\n"
+ .'- -2: The gateway version of the share does not support this feature.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'GatewayRegion' => ['description' => 'The region where the gateway is located.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'ShareName' => ['description' => 'The share name.', 'type' => 'string', 'example' => 'ji***', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'Success' => [
'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
+ 'title' => '',
+ 'example' => '',
],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidGatewayType',
- 'errorMessage' => 'The specified type of the gateway is invalid.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'OSSResourceAccountAccessFail',
- 'errorMessage' => 'Failed to access OSS. We recommend that you submit a ticket in the Alibaba Cloud console.',
- ],
+ ['errorCode' => 'EmptyExpressSyncId', 'errorMessage' => 'You must specify a valid ID for the sync group.', 'description' => 'You must specify a valid ID for the sync group.'],
+ ['errorCode' => 'ExpressSyncNotExist', 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.', 'description' => 'The specified sync group does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"30DFF66156-3672-4204-B708-24389F01FC77\\",\\n \\"Images\\": {\\n \\"Image\\": [\\n {\\n \\"Type\\": \\"application/octet-stream\\",\\n \\"Description\\": \\"sgw.file.kvm.description\\",\\n \\"Version\\": \\"1.0.40\\",\\n \\"Size\\": 1063744588,\\n \\"Url\\": \\"http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAI****************&Signature=%2BoTNVCGWgxis8GMpvpg5NIRkFv****\\",\\n \\"Title\\": \\"sgw.file.kvm.title\\",\\n \\"MD5\\": \\"48f43e6a906b28ed30ec40d****\\",\\n \\"Name\\": \\"aliyun/file/1.0.40/image/sgw-file-1.0.39.v***\\",\\n \\"ModifiedDate\\": \\"2019-07-24\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayImagesResponse>\\n <Message>successful</Message>\\n <RequestId>6BF67960-7782-4542-98AF-1E4B3B6E514B</RequestId>\\n <Images>\\n <Image>\\n <Type>application/octet-stre**</Type>\\n <Description>sgw.file.kvm.description</Description>\\n <Version>1.0.40</Version>\\n <Size>1063744512</Size>\\n <Title>sgw.file.kvm.title</Title>\\n <ModifiedDate>2019-07-24</ModifiedDate>\\n <Url>http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&amp;OSSAccessKeyId=LTAISMVqr8***&amp;Signature=%2BoTNVCxis8GMpv5NIRkFvE***%3D</Url>\\n <Name>aliyun/file/1.0.40/image/sgw-file-1.0.40.qc***</Name>\\n <MD5>76069b6a745dd360cd54064b***</MD5>\\n </Image>\\n <Image>\\n <Type>application/x-virtualbox-v***</Type>\\n <Description>sgw.file.vhd.description</Description>\\n <Version>1.0.39</Version>\\n <Size>1819893760</Size>\\n <Title>sgw.file.vhd.title</Title>\\n <ModifiedDate>2019-07-24</ModifiedDate>\\n <Url>http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.39.vhd?Expires=1564045229&amp;OSSAccessKeyId=LTAINaSMVqr8***&amp;Signature=MUfa0layij2ofNWzUAoSxg%3D***</Url>\\n <Name>aliyun/file/1.0.40/image/sgw-file-1.0.39.v***</Name>\\n <MD5>48f3ce6a906b30ec40d84bf***</MD5>\\n </Image>\\n </Images>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayImagesResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EA258616-36AD-4609-A0A6-2B17C28CBF88\\",\\n \\"Code\\": \\"200\\",\\n \\"Shares\\": {\\n \\"Share\\": [\\n {\\n \\"MnsQueue\\": \\"sgw-express-sync-queue-gw-000245alq48e7ytgxq03***\\",\\n \\"ExpressSyncId\\": \\"sb-0003c7qh5yuc1z6b8***\\",\\n \\"GatewayId\\": \\"gw-000245alq48e7ytg***\\",\\n \\"ExpressSyncState\\": \\"MNSHealthy\\",\\n \\"GatewayName\\": \\"File-upgrade***\\",\\n \\"StorageBundleId\\": \\"sb-0003c7qh5yuc1z6b8***\\",\\n \\"SyncProgress\\": 100,\\n \\"GatewayRegion\\": \\"cn-hangzhou\\",\\n \\"ShareName\\": \\"ji***\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeExpressSyncShares',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- 'title' => 'DescribeGatewayImages',
- ],
- 'TriggerGatewayRemoteSync' => [
- 'summary' => 'Actively triggers a file gateway to perform a reverse synchronization on the specified path.',
- 'methods' => [
- 'get',
- 'post',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeExpressSyncShares'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeExpressSyncShares',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'DescribeExpressSyncs' => [
+ 'summary' => 'Queries the details of express synchronization groups, including their names, IDs, and bucket names.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwSTR2C0',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwNGMQUV'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The gateway ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gw-0004wacp5e4ll1542****',
- ],
- ],
- [
- 'name' => 'IndexId',
+ 'name' => 'BucketName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the share.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'NFSshare_12012112****',
- ],
+ 'schema' => ['description' => 'The name of the bucket. If you do not specify this parameter, all express synchronization groups that belong to the current user are queried.', 'type' => 'string', 'required' => false, 'example' => 'sgw****', 'title' => ''],
],
[
- 'name' => 'Path',
+ 'name' => 'BucketPrefix',
'in' => 'query',
- 'schema' => [
- 'description' => 'The path on which you want to trigger reverse synchronization.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/dirchild24120121****',
- ],
+ 'schema' => ['description' => 'The subdirectory of the bucket. If you do not specify this parameter, the express synchronization groups of the bucket are queried. If you specify an empty string, the express synchronization groups in the root directory of the bucket are queried by default.'."\n"
+ ."\n"
+ .'> You cannot leave the bucket name empty and query only the bucket subdirectory.', 'type' => 'string', 'required' => false, 'example' => 'test****', 'title' => ''],
],
],
'responses' => [
@@ -2952,252 +2507,400 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'The returned message.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '29BD52E7-CF30-418F-A240-E15A9351****',
- ],
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'string',
- 'example' => 't-000avsri6tlyddgf****',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'ExpressSyncs' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ExpressSync' => [
+ 'description' => 'The information about the express synchronization groups.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ExpressSyncId' => ['description' => 'The ID of the express synchronization group.', 'type' => 'string', 'example' => 'sync-0002xetjdlxne2sd****', 'title' => ''],
+ 'Description' => ['description' => 'The description of the express synchronization group.', 'type' => 'string', 'example' => 'For testing', 'title' => ''],
+ 'BucketName' => ['description' => 'The name of the bucket.', 'type' => 'string', 'example' => 'sgw-mns****', 'title' => ''],
+ 'Name' => ['description' => 'The name of the express synchronization group.', 'type' => 'string', 'example' => 'wptest****', 'title' => ''],
+ 'BucketPrefix' => ['description' => 'The subdirectory of the bucket.', 'type' => 'string', 'example' => 'test****', 'title' => ''],
+ 'MnsTopic' => ['description' => 'The name of the message topic in Simple Message Queue (formerly MNS) that corresponds to the synchronization group.', 'type' => 'string', 'example' => 'sgw-express-sync-0002xetjdlxne2sd****', 'title' => ''],
+ 'BucketRegion' => ['description' => 'The OSS region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50DE1383-D4A1-433C-98A6-459C1830A888', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"29BD52E7-CF30-418F-A240-E15A9351****\\",\\n \\"TaskId\\": \\"t-000avsri6tlyddgf****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'TriggerGatewayRemoteSync',
- ],
- 'DescribeRegions' => [
- 'summary' => 'Queries available regions.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExpressSyncs\\": {\\n \\"ExpressSync\\": [\\n {\\n \\"ExpressSyncId\\": \\"sync-0002xetjdlxne2sd****\\",\\n \\"Description\\": \\"For testing\\",\\n \\"BucketName\\": \\"sgw-mns****\\",\\n \\"Name\\": \\"wptest****\\",\\n \\"BucketPrefix\\": \\"test****\\",\\n \\"MnsTopic\\": \\"sgw-express-sync-0002xetjdlxne2sd****\\",\\n \\"BucketRegion\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"50DE1383-D4A1-433C-98A6-459C1830A888\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeExpressSyncs',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeExpressSyncs'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeExpressSyncs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'DescribeGateway' => [
+ 'summary' => 'Queries basic information about a gateway, such as its status and type, based on the specified gateway ID.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '17228',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'GatewayId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The gateway ID.', 'docRequired' => true, 'required' => true, 'type' => 'string', 'example' => 'gw-000eg44nmxbsfwbvq***', 'title' => ''],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E09C421A-A175-4D21-8928-ADF5643D15F8',
- ],
- 'Regions' => [
+ 'Description' => ['description' => 'The description of the gateway.', 'example' => 'For testing', 'type' => 'string', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the gateway was created. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'format' => 'int64', 'type' => 'integer', 'example' => '1532099461', 'title' => ''],
+ 'PublicNetworkBandwidth' => ['description' => 'The public bandwidth. Unit: Mbit/s. If the gateway is a cloud gateway, the public bandwidth is returned.', 'format' => 'int32', 'type' => 'integer', 'example' => '5', 'title' => ''],
+ 'DataLoadType' => ['description' => 'This parameter is discontinued.', 'type' => 'string', 'example' => 'Deprecated.', 'title' => ''],
+ 'Category' => ['description' => 'The category of the gateway. The default value is `Aliyun`.', 'type' => 'string', 'example' => 'Aliyun', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-0000iwdggbharrw6r***', 'title' => ''],
+ 'Message' => ['description' => 'The description of the result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'ExpireStatus' => ['description' => 'The expiration status of the subscription gateway. Valid values:'."\n"
+ ."\n"
+ .'- 0: The gateway is normal.'."\n"
+ .'- 1: The gateway is about to expire.'."\n"
+ .'- 2: The gateway has expired.', 'format' => 'int32', 'type' => 'integer', 'example' => '0', 'title' => ''],
+ 'Ip' => ['description' => 'The public IP address.', 'type' => 'string', 'example' => '47.101.**.**', 'title' => ''],
+ 'GatewayType' => ['description' => 'The type of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- File: file gateway'."\n"
+ .'- Iscsi: iSCSI gateway', 'type' => 'string', 'example' => 'File', 'title' => ''],
+ 'StorageBundleId' => ['description' => 'The ID of the gateway cluster.', 'type' => 'string', 'example' => 'sb-000dt67z4ijqfocpy***', 'title' => ''],
+ 'GatewayClass' => ['description' => 'The gateway class. This parameter is returned if the gateway is a cloud gateway. Valid values:'."\n"
+ ."\n"
+ .'- Basic: Basic'."\n"
+ .'- Standard: Standard'."\n"
+ .'- Enhanced: Enhanced'."\n"
+ .'- Advanced: Performance', 'type' => 'string', 'example' => 'Basic', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Name' => ['description' => 'The name of the gateway.', 'type' => 'string', 'example' => 'alex***', 'title' => ''],
+ 'IsPostPaid' => ['description' => 'Indicates whether the gateway is a pay-as-you-go gateway. Valid values:'."\n"
+ ."\n"
+ .'- true: The gateway is a pay-as-you-go gateway.'."\n"
+ .'- false: The gateway is a subscription gateway.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Capacity' => ['description' => 'This parameter is discontinued.', 'format' => 'int32', 'type' => 'integer', 'example' => '500', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'The time when the subscription gateway expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'format' => 'int64', 'type' => 'integer', 'example' => '1532530021', 'title' => ''],
+ 'GatewayVersion' => ['description' => 'The version of the gateway.', 'type' => 'string', 'example' => '1.0.39', 'title' => ''],
+ 'IsReleaseAfterExpiration' => ['description' => 'Indicates whether the subscription gateway is automatically released after it expires. Valid values:'."\n"
+ ."\n"
+ .'- true: The gateway is automatically released after it expires.'."\n"
+ .'- false: The gateway is automatically converted to a pay-as-you-go gateway after it expires.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'Status' => ['description' => 'The status of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- Initialized: The gateway is initialized.'."\n"
+ .'- Deactivated: The gateway is inactive.'."\n"
+ .'- Activated: The gateway is active.'."\n"
+ .'- Deploying: The gateway is being deployed.'."\n"
+ .'- Running: The gateway is running.'."\n"
+ .'- Stopping: The gateway is being stopped.'."\n"
+ .'- Stopped: The gateway is stopped.'."\n"
+ .'- Starting: The gateway is being started.'."\n"
+ .'- Rebooting: The gateway is being restarted.'."\n"
+ .'- Deleting: The gateway is being deleted.'."\n"
+ .'- Failed: The gateway failed.'."\n"
+ .'- Upgrading: The gateway is being upgraded.'."\n"
+ .'- Modifying: The gateway is being modified.'."\n"
+ .'- Unknown: The gateway has no heartbeat for a long time.', 'type' => 'string', 'example' => 'Initialized', 'title' => ''],
+ 'BuyURL' => ['description' => 'The purchase URL of the subscription gateway if the payment is not complete.', 'type' => 'string', 'example' => 'https://expense.console.aliyun.com/?returnExpense=true#/order/list/', 'title' => ''],
+ 'MaxThroughput' => ['description' => 'This parameter is discontinued.', 'format' => 'int32', 'type' => 'integer', 'example' => '30', 'title' => ''],
+ 'DataLoadInterval' => ['description' => 'This parameter is discontinued.', 'format' => 'int32', 'type' => 'integer', 'example' => '120', 'title' => ''],
+ 'InnerIp' => ['description' => 'The IP address used for mounting.', 'type' => 'string', 'example' => '172.19.55.65', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '736C7733-FCED-4AFB-8407-C325F210CE03', 'title' => ''],
+ 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1b3mvml55ziekq7e***', 'title' => ''],
+ 'ElasticNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Region' => [
- 'description' => '',
+ 'ElasticNode' => [
+ 'description' => 'The IP address of the elastic gateway node.',
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- ],
- ],
+ 'items' => ['description' => 'This parameter is discontinued.', 'type' => 'string', 'example' => '172.16.0.23', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'Code' => [
'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
+ 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'string', 'example' => 'gw-0000ewknguw5o96vn***', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'EcsInstanceId' => ['description' => 'The ID of the ECS instance.', 'type' => 'string', 'example' => 'i-uf62406gy5vyao4y8***', 'title' => ''],
+ 'Type' => ['description' => 'See the GatewayType parameter.', 'type' => 'string', 'example' => 'File', 'title' => ''],
+ 'RenewURL' => ['description' => 'The renewal URL of the subscription gateway.', 'type' => 'string', 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew', 'title' => ''],
+ 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-uf6j237kxmsw08auey***', 'title' => ''],
+ 'ActivatedTime' => ['description' => 'The time when the gateway was activated. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'format' => 'int64', 'type' => 'integer', 'example' => '1578986214', 'title' => ''],
+ 'ElasticGateway' => ['description' => 'This parameter is discontinued.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'CommonBuyInstanceId' => ['description' => 'The ID of the subscription gateway instance in the sales system.', 'type' => 'string', 'example' => 'gw-000fhosecoziy6ri****', 'title' => ''],
+ 'InnerIpv6Ip' => ['description' => 'The IPv6 address.', 'type' => 'string', 'example' => '2408:4004::ffff:ffff:ffff:ffff:ffff:ffff', 'title' => ''],
+ 'LastErrorKey' => ['description' => 'The error keyword.', 'type' => 'string', 'example' => 'InternalError', 'title' => ''],
+ 'Location' => ['description' => 'The location of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- Cloud: cloud gateway'."\n"
+ .'- On\\_Premise: on-premises gateway', 'type' => 'string', 'example' => 'Cloud', 'title' => ''],
+ 'GatewayRegionId' => ['type' => 'string', 'description' => 'The region of the gateway.', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'UntrustedEnvInstanceType' => ['type' => 'string', 'description' => '<props="china">'."\n"
+ ."\n"
+ .'The actual gateway class in an untrusted environment ([CloudBox](https://help.aliyun.com/zh/csg/user-guide/whatis-csg-on-cloud-box?spm=a2c4g.11186623.help-menu-53923.d_2_0.55606ae8YwKRow)).'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\n"
+ ."\n"
+ .'The actual gateway class in an untrusted environment ([CloudBox](https://www.alibabacloud.com/help/zh/csg/product-overview/whatis-csg-on-cloud-box)).'."\n"
+ ."\n"
+ .'</props>', 'example' => 'ecs.g6.large', 'title' => ''],
+ 'UntrustedEnvOssEndpoint' => ['type' => 'string', 'description' => '<props="china">'."\n"
+ ."\n"
+ .'The OSS endpoint of the gateway in an untrusted environment ([CloudBox](https://help.aliyun.com/zh/csg/user-guide/whatis-csg-on-cloud-box?spm=a2c4g.11186623.help-menu-53923.d_2_0.55606ae8YwKRow)).'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\n"
+ ."\n"
+ .'The OSS endpoint of the gateway in an untrusted environment ([CloudBox](https://www.alibabacloud.com/help/zh/csg/product-overview/whatis-csg-on-cloud-box)).'."\n"
+ ."\n"
+ .'</props>', 'example' => 'oss-cn-hangzhou.aliyuncs.com', 'title' => ''],
+ 'HighAvailability' => ['type' => 'boolean', 'description' => 'Indicates whether the gateway is a high availability (HA) gateway.', 'example' => 'false', 'title' => ''],
+ 'SecondaryVSwitchId' => ['type' => 'string', 'description' => 'The ID of the vSwitch for the secondary node of the HA gateway.', 'example' => 'vsw-bp1xw499jo5****', 'title' => ''],
],
+ 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"E09C421A-A175-4D21-8928-ADF5643D15F8\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <code>200</code>\\n <message>successful</message>\\n <regions>\\n <regionId>cn-hangzhou</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-shanghai</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-qingdao</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-beijing</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-zhangjiakou</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-huhehaote</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-shenzhen</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-chengdu</regionId>\\n </regions>\\n <regions>\\n <regionId>cn-hongkong</regionId>\\n </regions>\\n <regions>\\n <regionId>ap-southeast-1</regionId>\\n </regions>\\n <regions>\\n <regionId>ap-southeast-2</regionId>\\n </regions>\\n <regions>\\n <regionId>ap-southeast-5</regionId>\\n </regions>\\n <regions>\\n <regionId>eu-central-1</regionId>\\n </regions>\\n <requestId>E09C421A-A175-4D21-8928-ADF5643D15F8</requestId>\\n <success>true</success>\\n</DescribeRegionsResponse>","errorExample":""}]',
- 'title' => 'DescribeRegions',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"For testing\\",\\n \\"CreatedTime\\": 1532099461,\\n \\"PublicNetworkBandwidth\\": 5,\\n \\"DataLoadType\\": \\"Deprecated.\\",\\n \\"Category\\": \\"Aliyun\\",\\n \\"TaskId\\": \\"t-0000iwdggbharrw6r***\\",\\n \\"Message\\": \\"successful\\",\\n \\"ExpireStatus\\": 0,\\n \\"Ip\\": \\"47.101.**.**\\",\\n \\"GatewayType\\": \\"File\\",\\n \\"StorageBundleId\\": \\"sb-000dt67z4ijqfocpy***\\",\\n \\"GatewayClass\\": \\"Basic\\",\\n \\"Success\\": true,\\n \\"Name\\": \\"alex***\\",\\n \\"IsPostPaid\\": true,\\n \\"Capacity\\": 500,\\n \\"ExpiredTime\\": 1532530021,\\n \\"GatewayVersion\\": \\"1.0.39\\",\\n \\"IsReleaseAfterExpiration\\": false,\\n \\"Status\\": \\"Initialized\\",\\n \\"BuyURL\\": \\"https://expense.console.aliyun.com/?returnExpense=true#/order/list/\\",\\n \\"MaxThroughput\\": 30,\\n \\"DataLoadInterval\\": 120,\\n \\"InnerIp\\": \\"172.19.55.65\\",\\n \\"RequestId\\": \\"736C7733-FCED-4AFB-8407-C325F210CE03\\",\\n \\"VSwitchId\\": \\"vsw-bp1b3mvml55ziekq7e***\\",\\n \\"ElasticNodes\\": {\\n \\"ElasticNode\\": [\\n \\"172.16.0.23\\"\\n ]\\n },\\n \\"GatewayId\\": \\"gw-0000ewknguw5o96vn***\\",\\n \\"Code\\": \\"200\\",\\n \\"EcsInstanceId\\": \\"i-uf62406gy5vyao4y8***\\",\\n \\"Type\\": \\"File\\",\\n \\"RenewURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew\\",\\n \\"VpcId\\": \\"vpc-uf6j237kxmsw08auey***\\",\\n \\"ActivatedTime\\": 1578986214,\\n \\"ElasticGateway\\": false,\\n \\"CommonBuyInstanceId\\": \\"gw-000fhosecoziy6ri****\\",\\n \\"InnerIpv6Ip\\": \\"2408:4004::ffff:ffff:ffff:ffff:ffff:ffff\\",\\n \\"LastErrorKey\\": \\"InternalError\\",\\n \\"Location\\": \\"Cloud\\",\\n \\"GatewayRegionId\\": \\"cn-hangzhou\\",\\n \\"UntrustedEnvInstanceType\\": \\"ecs.g6.large\\",\\n \\"UntrustedEnvOssEndpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"HighAvailability\\": false,\\n \\"SecondaryVSwitchId\\": \\"vsw-bp1xw499jo5****\\"\\n}","type":"json"}]',
+ 'title' => 'DescribeGateway',
+ 'description' => '### Description'."\n"
+ ."\n"
+ .'Before you call this operation, note the following:'."\n"
+ ."\n"
+ .'<props="china">'."\n"
+ ."\n"
+ .'- Make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product?spm=5176.144914.752642.btn2.1fea7d70I6QIr5\\&aly_as=C81M1m5N#/hcs_sgw/detail) of Cloud Storage Gateway.'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\n"
+ ."\n"
+ .'- Make sure that you understand the billing methods and pricing of Cloud Storage Gateway.'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'- You can use the purchase URL or renewal URL returned by this operation to purchase or renew the gateway.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeGatewayClasses' => [
- 'summary' => 'Queries available gateway editions.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGateway'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'DescribeGatewayADInfo' => [
+ 'summary' => 'Queries information about the AD server configured for a gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '17201',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwYT4X0O'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'GatewayId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', 'title' => ''],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => 'The description of the request result.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'EC3D33E5-0F6B-4D1B-9B35-59A71EB3FA50',
- ],
- 'Code' => [
- 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Classes' => [
- 'description' => 'The gateway editions. The gateway specifications are separated by commas (,). Valid values:'."\n"
- ."\n"
- .'* Basic: the Basic edition'."\n"
- .'* Standard: the Standard edition'."\n"
- .'* Enhanced: the Enhanced edition'."\n"
- .'* Advanced: the Performance Optimized edition'."\n",
- 'type' => 'string',
- 'example' => 'Basic,Standard,Enhanced,Advanced',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BB2D3121-8271-5DD7-9957-D52433FF****', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'DomainName' => ['description' => 'The domain name used to connect to the AD server.', 'type' => 'string', 'example' => 'ad.aliyundoc.com', 'title' => ''],
+ 'IsEnabled' => ['description' => 'Indicates whether the AD server is enabled. Valid values:'."\n"
+ ."\n"
+ .'- true: The AD server is enabled.'."\n"
+ .'- false: The AD server is not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Username' => ['description' => 'The domain administrator.', 'type' => 'string', 'example' => ' administrator', 'title' => ''],
+ 'ServerIp' => ['description' => 'The IP address of the AD server.', 'type' => 'string', 'example' => '47.101.**.***', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'The result of the call. The return values are as follows:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EC3D33E5-0F6B-4D1B-9B35-59A71EB3FA50\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Classes\\": \\"Basic,Standard,Enhanced,Advanced\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayClassesResponse>\\n <classes>Basic,Standard,Enhanced,Advanced</classes>\\n <code>200</code>\\n <message>successful</message>\\n <requestId>EC3D33E5-0F6B-4D1B-9B35-59A71EB3FA50</requestId>\\n <success>true</success>\\n</DescribeGatewayClassesResponse>","errorExample":""}]',
- 'title' => 'DescribeGatewayClasses',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ExpandGatewayNetworkBandwidth' => [
- 'summary' => 'Increases the public network bandwidth level for a gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInUpgrading', 'errorMessage' => 'The gateway is upgrading. Try again later.', 'description' => 'The gateway is upgrading. Try again later.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ['errorCode' => 'GatewayStatusRunningRequired', 'errorMessage' => 'The gateway is not in the Running state. Try again later.', 'description' => 'The gateway is not in the Running state. Try again later.'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2D3121-8271-5DD7-9957-D52433FF****\\",\\n \\"Message\\": \\"successful\\",\\n \\"DomainName\\": \\"ad.aliyundoc.com\\",\\n \\"IsEnabled\\": true,\\n \\"Username\\": \\" administrator\\",\\n \\"ServerIp\\": \\"47.101.**.***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeGatewayADInfo',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayADInfo'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayADInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'extraInfo' => ' ',
+ ],
+ 'DescribeGatewayBlockVolumes' => [
+ 'summary' => 'Queries details about iSCSI gateway volumes, such as operation status, data transfer, address, capacity, port, CHAP, OSS Bucket SSL, LUN ID, and volume status.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwJLV9QR'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbv****',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000dt67z4ijngqvh***', 'title' => ''],
],
[
- 'name' => 'NewNetworkBandwidth',
+ 'name' => 'IndexId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The index ID. If this parameter is left empty, the configurations of all iSCSI gateway volumes on the gateway are enumerated.', 'type' => 'string', 'required' => false, 'example' => 'alex-or2020010816***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Refresh',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to forcibly refresh the cache. Valid values:'."\n"
+ ."\n"
+ .'- true (default): yes.'."\n"
+ .'- false: no.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
@@ -3205,222 +2908,405 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'BuyURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&i',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0001xv7je357xv4s****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8****',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
+ 'BlockVolumes' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'BlockVolume' => [
+ 'description' => 'The information about the iSCSI gateway volume.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The operation status. Valid values:'."\n"
+ ."\n"
+ .'- 0: The operation is successful.'."\n"
+ .'- 1: The volume failed to be created.'."\n"
+ .'- 2: The volume failed to be deleted.'."\n"
+ .'- 3: The target failed to be enabled.'."\n"
+ .'- 4: The target failed to be disabled.'."\n"
+ .'- 5: A database error occurred.'."\n"
+ .'- 6: The cache failed to be enabled.'."\n"
+ .'- 7: The cache failed to be disabled.'."\n"
+ .'- 8: A system error occurred.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'ChunkSize' => ['description' => 'The storage allocation unit. Unit: bytes. The storage allocation unit can be 8 KB, 16 KB, 32 KB, 64 KB, or 128 KB. The default value is 32 KB.', 'type' => 'integer', 'format' => 'int32', 'example' => '32768', 'title' => ''],
+ 'TotalUpload' => ['description' => 'The total amount of data that is uploaded. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '123214564', 'title' => ''],
+ 'DiskType' => ['description' => 'The type of the cache disk.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'DiskId' => ['description' => 'The ID of the cache disk.', 'type' => 'string', 'example' => 'd-bp1a8athxvwbja18***', 'title' => ''],
+ 'Port' => ['description' => 'The port.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'IndexId' => ['description' => 'The index ID.', 'type' => 'string', 'example' => 'alex-or2020010816***', 'title' => ''],
+ 'TotalDownload' => ['description' => 'The total amount of data that is downloaded. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '56342324', 'title' => ''],
+ 'ChapEnabled' => ['description' => 'Indicates whether CHAP is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Enabled' => ['description' => 'Indicates whether the block volume is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Address' => ['description' => 'The service IP address.', 'type' => 'string', 'example' => '172.16.0.22', 'title' => ''],
+ 'Name' => ['description' => 'The name of the block volume.', 'type' => 'string', 'example' => 'alex', 'title' => ''],
+ 'Target' => ['description' => 'The volume target.', 'type' => 'string', 'example' => 'iqn**************', 'title' => ''],
+ 'OssEndpoint' => ['description' => 'The region of the Object Storage Service (OSS) bucket that corresponds to the block volume.> You must distinguish between internal and public endpoints. If the OSS bucket and the gateway are in the same region, we recommend that you use an internal endpoint, such as oss-cn-hangzhou-internal.aliyuncs.com.', 'type' => 'string', 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com', 'title' => ''],
+ 'OssBucketName' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'example' => 'random***', 'title' => ''],
+ 'CacheMode' => ['description' => 'The cache mode. Valid values:'."\n"
+ ."\n"
+ .'- Cache: cache mode.'."\n"
+ .'- WriteThrough: write-through mode.', 'type' => 'string', 'example' => 'Cache', 'title' => ''],
+ 'State' => ['description' => 'The cache status. Valid values:'."\n"
+ ."\n"
+ .'- clean: The synchronization is complete.'."\n"
+ .'- dirty: The synchronization is incomplete.', 'type' => 'string', 'example' => 'clean', 'title' => ''],
+ 'Protocol' => ['description' => 'The protocol.', 'type' => 'string', 'example' => 'iSCSI', 'title' => ''],
+ 'LunId' => ['description' => 'The LUN ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'OssBucketSsl' => ['description' => 'Indicates whether SSL is used for the OSS bucket.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'VolumeState' => ['description' => 'The volume status. Valid values:'."\n"
+ ."\n"
+ .'- 0: Failed'."\n"
+ .'- 1: Complete'."\n"
+ .'- 2: Creating'."\n"
+ .'- 3: Deleting'."\n"
+ .'- 4: Enabling'."\n"
+ .'- 5: Disabling'."\n"
+ .'- 6: Running', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'LocalPath' => ['description' => 'The local path of the cache disk.', 'type' => 'string', 'example' => '/dev/vdb', 'title' => ''],
+ 'ChapInUser' => ['description' => 'The inbound CHAP user.', 'type' => 'string', 'example' => 'alex***', 'title' => ''],
+ 'Size' => ['description' => 'The capacity. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '107374182400', 'title' => ''],
+ 'OssBucketRegionId' => ['type' => 'string', 'description' => 'The region where the Object Storage Service (OSS) bucket corresponding to the block volume is located.', 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '787D4AD4-5536-4C36-9FB0-D74C0554D344', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&i\\",\\n \\"TaskId\\": \\"t-0001xv7je357xv4s****\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8****\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'ExpandGatewayNetworkBandwidth',
- ],
- 'CreateGatewayBlockVolume' => [
- 'summary' => 'Creates a volume for an Internet Small Computer System Interface (iSCSI) gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInUpgrading', 'errorMessage' => 'The gateway is upgrading. Try again later.', 'description' => 'The gateway is upgrading. Try again later.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BlockVolumes\\": {\\n \\"BlockVolume\\": [\\n {\\n \\"Status\\": 0,\\n \\"ChunkSize\\": 32768,\\n \\"TotalUpload\\": 123214564,\\n \\"DiskType\\": \\"cloud_efficiency\\",\\n \\"DiskId\\": \\"d-bp1a8athxvwbja18***\\",\\n \\"Port\\": 0,\\n \\"IndexId\\": \\"alex-or2020010816***\\",\\n \\"TotalDownload\\": 56342324,\\n \\"ChapEnabled\\": true,\\n \\"Enabled\\": true,\\n \\"Address\\": \\"172.16.0.22\\",\\n \\"Name\\": \\"alex\\",\\n \\"Target\\": \\"iqn**************\\",\\n \\"OssEndpoint\\": \\"oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"OssBucketName\\": \\"random***\\",\\n \\"CacheMode\\": \\"Cache\\",\\n \\"State\\": \\"clean\\",\\n \\"Protocol\\": \\"iSCSI\\",\\n \\"LunId\\": 0,\\n \\"OssBucketSsl\\": true,\\n \\"VolumeState\\": 1,\\n \\"LocalPath\\": \\"/dev/vdb\\",\\n \\"ChapInUser\\": \\"alex***\\",\\n \\"Size\\": 107374182400,\\n \\"OssBucketRegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"787D4AD4-5536-4C36-9FB0-D74C0554D344\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeGatewayBlockVolumes',
+ 'description' => '***',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayBlockVolumes'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayBlockVolumes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeGatewayCaches' => [
+ 'summary' => 'Queries information about cache disks, such as size and type.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwJLV9QR',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwLTSLKH'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000dt67z4ijngqvh1***',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'name',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', 'title' => ''],
],
- [
- 'name' => 'Recovery',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '40797B4D-09D9-482E-B163-CCB568BADE35', 'title' => ''],
+ 'Caches' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Cache' => [
+ 'description' => 'The information about the cache disks.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PerformanceLevel' => ['type' => 'string', 'description' => 'The performance level of the Enhanced SSD (ESSD). Valid values:'."\n"
+ ."\n"
+ .'- PL1'."\n"
+ .'- PL2'."\n"
+ .'- PL3', 'example' => 'PL1', 'title' => ''],
+ 'SizeInGB' => ['description' => 'The size of the cache disk. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'BuyURL' => ['type' => 'string', 'description' => 'The link to purchase the cache disk.', 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy', 'title' => ''],
+ 'Iops' => ['description' => 'The input/output operations per second (IOPS) of the cache disk.', 'type' => 'integer', 'format' => 'int64', 'example' => '2605', 'title' => ''],
+ 'CacheId' => ['description' => 'The ID of the cache disk.', 'type' => 'string', 'example' => 'd-bp1dcnq8zldree6ok***', 'title' => ''],
+ 'CacheType' => ['description' => 'The type of the cache disk. Valid values:'."\n"
+ ."\n"
+ .'- cloud\\_efficiency: ultra disk.'."\n"
+ .'- cloud\\_ssd: standard SSD.'."\n"
+ .'- cloud\\_essd: ESSD.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'IsUsed' => ['description' => 'Indicates whether the cache disk is used.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'The UNIX timestamp when the cache disk expires. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532510649', 'title' => ''],
+ 'LocalFilePath' => ['description' => 'The internal name of the device.', 'type' => 'string', 'example' => '/dev/vdb', 'title' => ''],
+ 'IsNoPartition' => ['type' => 'boolean', 'description' => 'Indicates whether the cache disk has a partition. A value of true indicates that the cache disk does not have a partition.', 'example' => 'true', 'title' => ''],
+ 'SubscriptionInstanceId' => ['type' => 'string', 'description' => 'The ID of the subscription instance.', 'example' => 'ca-000bq2fkzol56575***', 'title' => ''],
+ 'ExpireStatus' => ['description' => 'The expiration status. Valid values:'."\n"
+ ."\n"
+ .'- 0: The cache disk is Normal.'."\n"
+ .'- 1: The cache disk is about to expire.'."\n"
+ .'- 2: The cache disk has expired.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'RenewURL' => ['description' => 'The renewal link.', 'type' => 'string', 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew', 'title' => ''],
+ 'IsDirectExpand' => ['type' => 'string', 'description' => 'Indicates whether online scale-out is supported. A value of true indicates that online scale-out is supported.', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'VolumeProtocol',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'iSCSI',
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInUpgrading', 'errorMessage' => 'The gateway is upgrading. Try again later.', 'description' => 'The gateway is upgrading. Try again later.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
],
- [
- 'name' => 'Size',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'description' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
],
- [
- 'name' => 'ChunkSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '32768',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"40797B4D-09D9-482E-B163-CCB568BADE35\\",\\n \\"Caches\\": {\\n \\"Cache\\": [\\n {\\n \\"PerformanceLevel\\": \\"PL1\\",\\n \\"SizeInGB\\": 100,\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy\\",\\n \\"Iops\\": 2605,\\n \\"CacheId\\": \\"d-bp1dcnq8zldree6ok***\\",\\n \\"CacheType\\": \\"cloud_efficiency\\",\\n \\"IsUsed\\": false,\\n \\"ExpiredTime\\": 1532510649,\\n \\"LocalFilePath\\": \\"/dev/vdb\\",\\n \\"IsNoPartition\\": true,\\n \\"SubscriptionInstanceId\\": \\"ca-000bq2fkzol56575***\\",\\n \\"ExpireStatus\\": 0,\\n \\"RenewURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew\\",\\n \\"IsDirectExpand\\": \\"true\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeGatewayCaches',
+ 'description' => '### Description'."\n"
+ ."\n"
+ .'Before you call this operation, note the following:'."\n"
+ ."\n"
+ .'<props="china">'."\n"
+ ."\n"
+ .'- Make sure that you understand the billing methods and [prices](https://www.aliyun.com/price/product?spm=5176.144914.752642.btn2.1fea7d70I6QIr5\\&aly_as=C81M1m5N#/hcs_sgw/detail) of Cloud Storage Gateway.'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\n"
+ ."\n"
+ .'- Make sure that you understand the billing methods and prices of Cloud Storage Gateway.'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'- You can use the renewal link that is returned by this operation to renew your gateway.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayCaches'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayCaches',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'extraInfo' => ' ',
+ ],
+ 'DescribeGatewayCategories' => [
+ 'summary' => 'Queries the available gateway categories.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CacheMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Cache',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '17200',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ ],
+ 'parameters' => [
[
- 'name' => 'ChapEnabled',
+ 'name' => 'GatewayLocation',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '><notice>'."\n"
+ ."\n"
+ .'- This parameter is required.'."\n"
+ ."\n"
+ .'</notice>'."\n"
+ ."\n"
+ .'The location of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- Cloud: an online gateway.'."\n"
+ .'- On\\_Premise: an on-premises gateway.', 'type' => 'string', 'required' => false, 'example' => 'On_Premise', 'title' => ''],
],
- [
- 'name' => 'ChapInUser',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4DA9D8E2-2C27-5FD8-83D7-F0AA00C1****', 'title' => ''],
+ 'Categories' => ['description' => 'The gateway category. The following values are returned:'."\n"
+ ."\n"
+ .'- Aliyun: Alibaba Cloud Cloud Storage Gateway.'."\n"
+ .'- Apsara: hybrid cloud array gateway.', 'type' => 'string', 'example' => 'Aliyun,Apsara', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful. Other values indicate that the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The following values are returned:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'chapInUser',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'ChapInPassword',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'chapInPassword',
- ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4DA9D8E2-2C27-5FD8-83D7-F0AA00C1****\\",\\n \\"Categories\\": \\"Aliyun,Apsara\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeGatewayCategories',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayCategories'],
],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DescribeGatewayClasses' => [
+ 'summary' => 'Queries available gateway editions.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'OssBucketName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'bucketName',
- ],
+ 'AK' => [],
],
- [
- 'name' => 'OssEndpoint',
- 'in' => 'query',
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '17201',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The description of the request result.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EC3D33E5-0F6B-4D1B-9B35-59A71EB3FA50', 'title' => ''],
+ 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Classes' => ['description' => 'The gateway editions. The gateway specifications are separated by commas (,). Valid values:'."\n"
+ ."\n"
+ .'* Basic: the Basic edition'."\n"
+ .'* Standard: the Standard edition'."\n"
+ .'* Enhanced: the Enhanced edition'."\n"
+ .'* Advanced: the Performance Optimized edition'."\n", 'type' => 'string', 'example' => 'Basic,Standard,Enhanced,Advanced', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'oss-cn-shanghai-internal.aliyuncs.com',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'OssBucketSsl',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EC3D33E5-0F6B-4D1B-9B35-59A71EB3FA50\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Classes\\": \\"Basic,Standard,Enhanced,Advanced\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayClassesResponse>\\n <classes>Basic,Standard,Enhanced,Advanced</classes>\\n <code>200</code>\\n <message>successful</message>\\n <requestId>EC3D33E5-0F6B-4D1B-9B35-59A71EB3FA50</requestId>\\n <success>true</success>\\n</DescribeGatewayClassesResponse>","errorExample":""}]',
+ 'title' => 'DescribeGatewayClasses',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayClasses'],
],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DescribeGatewayDNS' => [
+ 'summary' => 'You can call the DescribeGatewayDNS operation to query the DNS servers that are configured on a gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'LocalFilePath',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/dev/vdb',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwYT4X0O'],
+ ],
+ 'parameters' => [
[
- 'name' => 'OssBucketRegionId',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', 'title' => ''],
],
],
'responses' => [
@@ -3428,63 +3314,55 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-000c6hshwukkbtxrb***',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9083F167-95B1-4B40-B2CD-70DE068EC3**',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'DnsServer' => ['description' => 'The list of the IP addresses of the DNS servers. The IP addresses are separated by commas.', 'type' => 'string', 'example' => '100.100.2.136,100.100.2.188', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter.BlockVolume.%s',
- 'errorMessage' => 'The specified field %s for block volume is invalid. Please check it again.',
- ],
- [
- 'errorCode' => 'VersionNotSupported.BlockVolume.%s',
- 'errorMessage' => 'The specified field %s for block volume is not supported by current gateway version. Please check it again.',
- ],
+ ['errorCode' => 'GatewayInUpgrading', 'errorMessage' => 'The gateway is upgrading. Try again later.', 'description' => 'The gateway is upgrading. Try again later.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ['errorCode' => 'GatewayStatusRunningRequired', 'errorMessage' => 'The gateway is not in the Running state. Try again later.', 'description' => 'The gateway is not in the Running state. Try again later.'],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkbtxrb***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9083F167-95B1-4B40-B2CD-70DE068EC3**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateGatewayBlockVolumeResponse>\\n <TaskId>t-000c6hshwukkbtxrb***</TaskId>\\n <Message>successful</Message>\\n <RequestId>9083F167-95B1-4B40-B2CD-70DE068EC3**</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateGatewayBlockVolumeResponse>","errorExample":""}]',
- 'title' => 'CreateGatewayBlockVolume',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50\\",\\n \\"Code\\": \\"200\\",\\n \\"DnsServer\\": \\"100.100.2.136,100.100.2.188\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeGatewayDNS',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeGatewayBlockVolumes' => [
- 'summary' => 'Queries volume details of an Internet Small Computer System Interface (iSCSI) gateway, such as the status, amount of transferred data, IP address, volume size, port, Challenge Handshake Authentication Protocol (CHAP) usage, bucket SSL security settings, logical unit number (LUN), and volume status.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayDNS'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayDNS',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeGatewayFileShares' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3493,44 +3371,27 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwJLV9QR',
- ],
+ 'abilityTreeCode' => '17204',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000dt67z4ijngqvh***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'gw-000eg44nmxbsfwbvq***'],
],
[
'name' => 'IndexId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alex-or2020010816***',
- ],
+ 'schema' => ['description' => 'The ID of the file share. If you leave this parameter empty, the configurations of all file shares on the gateway are returned.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'NFSd-million'],
],
[
'name' => 'Refresh',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to forcibly refresh the cache. The default value is false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
],
'responses' => [
@@ -3538,402 +3399,462 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'BlockVolumes' => [
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the request is successful.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'FileShares' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'BlockVolume' => [
- 'description' => '',
+ 'FileShare' => [
+ 'description' => 'The configurations of the shares.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ChunkSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32768',
- ],
- 'TotalUpload' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123214564',
- ],
- 'DiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'DiskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd-bp1a8athxvwbja18***',
- ],
- 'Port' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'IndexId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alex-or2020010816***',
- ],
- 'TotalDownload' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '56342324',
- ],
- 'ChapEnabled' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Enabled' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Address' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '172.16.0.22',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alex',
- ],
- 'Target' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'iqn**************',
- ],
- 'OssEndpoint' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com',
- ],
- 'OssBucketName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'random***',
- ],
- 'CacheMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Cache',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'clean',
- ],
- 'Protocol' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'iSCSI',
- ],
- 'LunId' => [
- 'description' => 'LUN ID。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'OssBucketSsl' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'VolumeState' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'LocalPath' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '/dev/vdb',
- ],
- 'ChapInUser' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alex***',
- ],
- 'Size' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '107374182400',
- ],
- 'OssBucketRegionId' => [
- 'type' => 'string',
- ],
+ 'AccessBasedEnumeration' => ['description' => 'Indicates whether access-based enumeration is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'ActiveMessages' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The number of active messages.', 'title' => '', 'example' => '0'],
+ 'Address' => ['description' => 'The internal IP address of the share in the VPC.', 'type' => 'string', 'title' => '', 'example' => '172.16.0.44'],
+ 'BeLimit' => ['description' => 'The maximum upload speed. A value of 0 indicates no limit. Unit: B/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
+ 'BindIPAddr' => ['type' => 'string', 'description' => 'The mount IP address bound to the share.', 'title' => '', 'example' => '192.0.0.0'],
+ 'Browsable' => ['description' => 'Indicates whether the share is browsable.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'BucketInfos' => ['description' => 'The information about multiple buckets.', 'type' => 'string', 'title' => '', 'example' => '[{\\"Endpoint\\":\\"oss-cn-hangzhou.aliyuncs.com\\",\\"Name\\":\\"bucket1\\",\\"PathPrefix\\":\\"\\"},{\\"Endpoint\\":\\"oss-cn-hangzhou.aliyuncs.com\\",\\"Name\\":\\"bucket2\\",\\"PathPrefix\\":\\"\\"}]'],
+ 'BucketsStub' => ['description' => 'Indicates whether multi-bucket aggregation is enabled. A value of false indicates that the feature is disabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'BypassCacheRead' => ['type' => 'boolean', 'description' => 'Indicates whether the feature of directly reading from OSS is enabled. A value of false indicates that the feature is disabled.', 'title' => '', 'example' => 'false'],
+ 'CacheMode' => ['description' => 'The cache mode of the file share. Valid values:'."\n"
+ ."\n"
+ .'- Cache: cache mode.'."\n"
+ ."\n"
+ .'- Sync: replication mode.', 'type' => 'string', 'title' => '', 'example' => 'Cache'],
+ 'ClientSideCmk' => ['description' => 'Deprecated.', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ 'ClientSideEncryption' => ['description' => 'Deprecated.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'DirectIO' => ['description' => 'Deprecated.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'DiskId' => ['description' => 'The ID of the cache disk that corresponds to the file share. This parameter is returned only for online gateways.', 'type' => 'string', 'title' => '', 'example' => 'd-bp1cvy8o2569jij31***'],
+ 'DiskType' => ['description' => 'Deprecated.', 'type' => 'string', 'title' => '', 'example' => 'cloud_efficiency'],
+ 'DownloadLimit' => ['description' => 'The maximum download speed. A value of 0 indicates no limit. Unit: B/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
+ 'DownloadQueue' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The download queue.', 'title' => '', 'example' => '5'],
+ 'DownloadRate' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The download rate. Unit: B/s.', 'title' => '', 'example' => '0'],
+ 'Enabled' => ['description' => 'Indicates whether the share is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ExpressSyncId' => ['description' => 'The ID of the express synchronization group.', 'type' => 'string', 'title' => '', 'example' => 'sync-0001xv7je357xn8tr***'],
+ 'FastReclaim' => ['description' => 'Indicates whether upload optimization is enabled. A value of false indicates that the feature is disabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'FeLimit' => ['description' => 'The maximum write speed. A value of 0 indicates no limit. Unit: B/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
+ 'FileNumLimit' => ['description' => 'The number of files that the file system supports.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10200202'],
+ 'FsSizeLimit' => ['description' => 'The capacity of the file system. Unit: B.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '70368744177664'],
+ 'HighWatermark' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The high watermark.', 'title' => '', 'example' => '80'],
+ 'IgnoreDelete' => ['description' => 'Indicates whether the ignore deletions feature is enabled. A value of false indicates that the feature is disabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'InPlace' => ['description' => 'Deprecated.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'InRate' => ['description' => 'The rate at which data is written to the cache. Unit: B/s.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'],
+ 'IndexId' => ['description' => 'The ID of the file share.', 'type' => 'string', 'title' => '', 'example' => 'NFSale***'],
+ 'KmsRotatePeriod' => ['description' => 'The key rotation period. Unit: seconds.', 'type' => 'string', 'title' => '', 'example' => '0'],
+ 'LagPeriod' => ['description' => 'The upload latency. Unit: s.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '5'],
+ 'LocalPath' => ['description' => 'The internal device name of the cache disk.', 'type' => 'string', 'title' => '', 'example' => '/dev/vdb'],
+ 'LowWatermark' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The low watermark.', 'title' => '', 'example' => '60'],
+ 'MnsHealth' => ['description' => 'The health status of the message queue. Valid values:'."\n"
+ ."\n"
+ .'- TopicAndQueueFailure: The message topic and queue are inaccessible.'."\n"
+ ."\n"
+ .'- TopicFailure: The message topic is inaccessible.'."\n"
+ ."\n"
+ .'- MNSFullSyncInit: A full synchronization is pending.'."\n"
+ ."\n"
+ .'- MNSFullSyncing: A full synchronization is in progress.'."\n"
+ ."\n"
+ .'- QueueFailure: The message queue is inaccessible.'."\n"
+ ."\n"
+ .'- MNSNotEnabled: Express synchronization is disabled.'."\n"
+ ."\n"
+ .'- MNSHealthy: The synchronization is normal.', 'type' => 'string', 'title' => '', 'example' => 'MNSNotEnabled'],
+ 'Name' => ['description' => 'The name of the share.', 'type' => 'string', 'title' => '', 'example' => 'alex***'],
+ 'NfsV4Optimization' => ['description' => 'Indicates whether NFSv4 optimization is enabled. A value of false indicates that the feature is disabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'NoPartition' => ['type' => 'boolean', 'description' => 'Indicates whether a partition exists. A value of true indicates that no partition exists.', 'title' => '', 'example' => 'true'],
+ 'ObsoleteBuckets' => ['description' => 'The buckets that are being removed from the multi-bucket aggregation.', 'type' => 'string', 'title' => '', 'example' => 'bucket1'],
+ 'OssBucketName' => ['description' => 'The name of the bucket.', 'type' => 'string', 'title' => '', 'example' => 'bucketA'],
+ 'OssBucketSsl' => ['description' => 'Indicates whether an SSL connection is used to access the OSS bucket.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'OssEndpoint' => ['description' => 'The endpoint used to access the OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'],
+ 'OssHealth' => ['description' => 'The health status of the OSS bucket. Valid values:'."\n"
+ ."\n"
+ .'- BucketHealthy: The OSS connection is normal.'."\n"
+ ."\n"
+ .'- BucketAccessDenied: The OSS access permissions are abnormal.'."\n"
+ ."\n"
+ .'- BucketMiscFailure: Other OSS access exceptions occurred.'."\n"
+ ."\n"
+ .'- BucketNetworkFailure: An OSS network access exception occurred.'."\n"
+ ."\n"
+ .'- BucketNotExist: The OSS bucket does not exist.'."\n"
+ ."\n"
+ .'- Empty: The status is unknown.', 'type' => 'string', 'title' => '', 'example' => 'BucketHealthy'],
+ 'OssUsed' => ['description' => 'The amount of data in the cloud. Unit: B.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'],
+ 'OutRate' => ['description' => 'The upload speed. Unit: B/s.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'],
+ 'PartialSyncPaths' => ['description' => 'The group of directory paths in partial replication mode. This parameter is in the JSON format.', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ 'PathPrefix' => ['description' => 'The OSS subdirectory.', 'type' => 'string', 'title' => '', 'example' => 'testprefix'],
+ 'PollingInterval' => ['description' => 'The remote sync interval.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '900'],
+ 'Protocol' => ['description' => 'The type of the share. Valid values:'."\n"
+ ."\n"
+ .'- SMB'."\n"
+ ."\n"
+ .'- NFS', 'type' => 'string', 'title' => '', 'example' => 'SMB'],
+ 'RemainingMetaSpace' => ['description' => 'The remaining metadata space. Unit: B.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '21308227584'],
+ 'RemoteSync' => ['description' => 'Indicates whether remote sync is enabled. A value of false indicates that the feature is disabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'RemoteSyncDownload' => ['description' => 'Indicates whether to download file data during a remote sync.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'RoClientList' => ['description' => 'The list of read-only clients. This parameter is returned when Protocol is set to NFS.', 'type' => 'string', 'title' => '', 'example' => '1.1.1.1'],
+ 'RoUserList' => ['description' => 'The list of read-only users. This parameter is returned when Protocol is set to SMB.', 'type' => 'string', 'title' => '', 'example' => 'user1'],
+ 'RwClientList' => ['description' => 'The list of read-write clients. This parameter is returned when Protocol is set to NFS.', 'type' => 'string', 'title' => '', 'example' => '1.1.1.1'],
+ 'RwUserList' => ['description' => 'The list of read-write users. This parameter is returned when Protocol is set to SMB.', 'type' => 'string', 'title' => '', 'example' => 'user2'],
+ 'ServerSideAlgorithm' => ['type' => 'string', 'description' => 'Deprecated.', 'title' => '', 'example' => 'AES256'],
+ 'ServerSideCmk' => ['description' => 'Deprecated.', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ 'ServerSideEncryption' => ['description' => 'Deprecated.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'Size' => ['description' => 'The cache capacity. Unit: B.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '85899345920'],
+ 'Squash' => ['description' => 'The user mapping.', 'type' => 'string', 'title' => '', 'example' => 'root_squash'],
+ 'State' => ['description' => 'The file synchronization status. Valid values:'."\n"
+ ."\n"
+ .'- clean: The synchronization is complete.'."\n"
+ ."\n"
+ .'- dirty: The synchronization is incomplete.', 'type' => 'string', 'title' => '', 'example' => 'clean'],
+ 'Status' => ['type' => 'string', 'description' => 'The status of the share. Valid values:'."\n"
+ ."\n"
+ .'- started'."\n"
+ ."\n"
+ .'- stopped', 'title' => '', 'example' => 'started'],
+ 'SupportArchive' => ['description' => 'Indicates whether transparent reading of archived files is supported.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'SyncProgress' => ['description' => 'The progress of the full synchronization.'."\n"
+ ."\n"
+ .'- This parameter is valid only when the share is added to a synchronization group. It indicates the progress of the full synchronization, from 0 to 100.'."\n"
+ ."\n"
+ .'- -2: indicates that the gateway version does not support this feature.'."\n"
+ ."\n"
+ .'- -1: indicates that no full synchronization has occurred.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '-2'],
+ 'Throttling' => ['type' => 'boolean', 'description' => 'Indicates whether throttling is enabled for the share. A value of false indicates that throttling is disabled.', 'title' => '', 'example' => 'false'],
+ 'TotalDownload' => ['description' => 'The total amount of data downloaded from the OSS bucket to the gateway. Unit: B.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'],
+ 'TotalUpload' => ['description' => 'The total amount of data uploaded from the gateway to the OSS bucket. Unit: B.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'],
+ 'TransferAcceleration' => ['description' => 'Indicates whether transfer acceleration is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'UploadQueue' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The upload queue.', 'title' => '', 'example' => '5'],
+ 'Used' => ['description' => 'The used cache space. Unit: B.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'],
+ 'WindowsAcl' => ['description' => 'Indicates whether support for Windows Access Control Lists (ACLs) is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'OssBucketRegionId' => ['type' => 'string', 'description' => 'The region where the Object Storage Service (OSS) bucket of the file share is located.', 'title' => '', 'example' => 'cn-hangzhou'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
'description' => '',
- 'type' => 'string',
- 'example' => '787D4AD4-5536-4C36-9FB0-D74C0554D344',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'title' => '', 'example' => 'successful'],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '9A3C3C32-3F37-4658-9D38-945D0799CA0E'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ ."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInUpgrading',
- 'errorMessage' => 'The gateway is upgrading. Try again later.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInUpgrading', 'errorMessage' => 'The gateway is upgrading. Try again later.', 'description' => 'The gateway is upgrading. Try again later.'],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ],
+ ],
+ 'title' => 'DescribeGatewayFileShares',
+ 'summary' => 'Describes the configurations of file shares on a file gateway.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayFileShares'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayFileShares',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"BlockVolumes\\": {\\n \\"BlockVolume\\": [\\n {\\n \\"Status\\": 0,\\n \\"ChunkSize\\": 32768,\\n \\"TotalUpload\\": 123214564,\\n \\"DiskType\\": \\"cloud_efficiency\\",\\n \\"DiskId\\": \\"d-bp1a8athxvwbja18***\\",\\n \\"Port\\": 0,\\n \\"IndexId\\": \\"alex-or2020010816***\\",\\n \\"TotalDownload\\": 56342324,\\n \\"ChapEnabled\\": true,\\n \\"Enabled\\": true,\\n \\"Address\\": \\"172.16.0.22\\",\\n \\"Name\\": \\"alex\\",\\n \\"Target\\": \\"iqn**************\\",\\n \\"OssEndpoint\\": \\"oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"OssBucketName\\": \\"random***\\",\\n \\"CacheMode\\": \\"Cache\\",\\n \\"State\\": \\"clean\\",\\n \\"Protocol\\": \\"iSCSI\\",\\n \\"LunId\\": 0,\\n \\"OssBucketSsl\\": true,\\n \\"VolumeState\\": 1,\\n \\"LocalPath\\": \\"/dev/vdb\\",\\n \\"ChapInUser\\": \\"alex***\\",\\n \\"Size\\": 107374182400,\\n \\"OssBucketRegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"787D4AD4-5536-4C36-9FB0-D74C0554D344\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayBlockVolumesResponse>\\n <BlockVolumes>\\n <BlockVolume>\\n <TotalDownload>0</TotalDownload>\\n <Address>172.16.0.40</Address>\\n <TotalUpload>0</TotalUpload>\\n <ChapOutUser/>\\n <LunId>0</LunId>\\n <Size>107374182400</Size>\\n <ChapEnabled>false</ChapEnabled>\\n <Port>0</Port>\\n <CacheMode>Cache</CacheMode>\\n <LocalPath>/dev/vdb</LocalPath>\\n <Name>alex</Name>\\n <DiskType>cloud_efficiency</DiskType>\\n <Target/>\\n <OssEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</OssEndpoint>\\n <Protocol>iSCSI</Protocol>\\n <Status>0</Status>\\n <IndexId>alex-or20200108161***</IndexId>\\n <Enabled>false</Enabled>\\n <VolumeState>1</VolumeState>\\n <OssBucketSsl>true</OssBucketSsl>\\n <ChunkSize>32768</ChunkSize>\\n <State>clean</State>\\n <OssBucketName>random***</OssBucketName>\\n <ChapInUser/>\\n <DiskId>d-bp1a8athxvwbja18h***</DiskId>\\n </BlockVolume>\\n </BlockVolumes>\\n <Message>successful</Message>\\n <RequestId>787D4AD4-5536-4C36-9FB0-D74C0554D185</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayBlockVolumesResponse>","errorExample":""}]',
- 'title' => 'DescribeGatewayBlockVolumes',
- 'description' => '****',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"FileShares\\": {\\n \\"FileShare\\": [\\n {\\n \\"AccessBasedEnumeration\\": false,\\n \\"ActiveMessages\\": 0,\\n \\"Address\\": \\"172.16.0.44\\",\\n \\"BeLimit\\": 0,\\n \\"BindIPAddr\\": \\"192.0.0.0\\",\\n \\"Browsable\\": true,\\n \\"BucketInfos\\": \\"[{\\\\\\\\\\\\\\"Endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bucket1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PathPrefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"Endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bucket2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PathPrefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}]\\",\\n \\"BucketsStub\\": false,\\n \\"BypassCacheRead\\": false,\\n \\"CacheMode\\": \\"Cache\\",\\n \\"ClientSideCmk\\": \\"xxx\\",\\n \\"ClientSideEncryption\\": false,\\n \\"DirectIO\\": false,\\n \\"DiskId\\": \\"d-bp1cvy8o2569jij31***\\",\\n \\"DiskType\\": \\"cloud_efficiency\\",\\n \\"DownloadLimit\\": 0,\\n \\"DownloadQueue\\": 5,\\n \\"DownloadRate\\": 0,\\n \\"Enabled\\": true,\\n \\"ExpressSyncId\\": \\"sync-0001xv7je357xn8tr***\\",\\n \\"FastReclaim\\": false,\\n \\"FeLimit\\": 0,\\n \\"FileNumLimit\\": 10200202,\\n \\"FsSizeLimit\\": 70368744177664,\\n \\"HighWatermark\\": 80,\\n \\"IgnoreDelete\\": false,\\n \\"InPlace\\": false,\\n \\"InRate\\": 0,\\n \\"IndexId\\": \\"NFSale***\\",\\n \\"KmsRotatePeriod\\": \\"0\\",\\n \\"LagPeriod\\": 5,\\n \\"LocalPath\\": \\"/dev/vdb\\",\\n \\"LowWatermark\\": 60,\\n \\"MnsHealth\\": \\"MNSNotEnabled\\",\\n \\"Name\\": \\"alex***\\",\\n \\"NfsV4Optimization\\": false,\\n \\"NoPartition\\": true,\\n \\"ObsoleteBuckets\\": \\"bucket1\\",\\n \\"OssBucketName\\": \\"bucketA\\",\\n \\"OssBucketSsl\\": false,\\n \\"OssEndpoint\\": \\"oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"OssHealth\\": \\"BucketHealthy\\",\\n \\"OssUsed\\": 0,\\n \\"OutRate\\": 0,\\n \\"PartialSyncPaths\\": \\"xxx\\",\\n \\"PathPrefix\\": \\"testprefix\\",\\n \\"PollingInterval\\": 900,\\n \\"Protocol\\": \\"SMB\\",\\n \\"RemainingMetaSpace\\": 21308227584,\\n \\"RemoteSync\\": false,\\n \\"RemoteSyncDownload\\": false,\\n \\"RoClientList\\": \\"1.1.1.1\\",\\n \\"RoUserList\\": \\"user1\\",\\n \\"RwClientList\\": \\"1.1.1.1\\",\\n \\"RwUserList\\": \\"user2\\",\\n \\"ServerSideAlgorithm\\": \\"AES256\\",\\n \\"ServerSideCmk\\": \\"xxx\\",\\n \\"ServerSideEncryption\\": false,\\n \\"Size\\": 85899345920,\\n \\"Squash\\": \\"root_squash\\",\\n \\"State\\": \\"clean\\",\\n \\"Status\\": \\"started\\",\\n \\"SupportArchive\\": false,\\n \\"SyncProgress\\": -2,\\n \\"Throttling\\": false,\\n \\"TotalDownload\\": 0,\\n \\"TotalUpload\\": 0,\\n \\"TransferAcceleration\\": false,\\n \\"UploadQueue\\": 5,\\n \\"Used\\": 0,\\n \\"WindowsAcl\\": false,\\n \\"OssBucketRegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9A3C3C32-3F37-4658-9D38-945D0799CA0E\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'extraInfo' => ' ',
],
- 'UpdateGatewayBlockVolume' => [
- 'summary' => 'Updates the configuration of a volume for an Internet Small Computer System Interface (iSCSI) gateway.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeGatewayFileStatus' => [
+ 'summary' => 'Queries the status of a single file in a file gateway\'s file share.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwJLV9QR',
- ],
+ 'abilityTreeCode' => '17205',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0004wacp5e4ll1542****', 'title' => ''],
],
[
'name' => 'IndexId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'NFSalex***',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the file share. You can call the DescribeGatewayFileShares operation to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NFSalex-gx-nfs-1201****', 'title' => ''],
],
[
- 'name' => 'Size',
+ 'name' => 'FilePath',
'in' => 'query',
+ 'schema' => ['description' => 'The path of the file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sub/cptestfile****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status of the file in the file share of the file gateway. The following values are returned:'."\n"
+ ."\n"
+ .'- Not found: The file path does not exist.'."\n"
+ .'- Clean: The file is synchronized.'."\n"
+ .'- Waiting to upload: The file is waiting to be uploaded.'."\n"
+ .'- Uploading: The file is being uploaded.'."\n"
+ .'- Waiting to download: The file is waiting to be downloaded.'."\n"
+ .'- Downloading: The file is being downloaded.'."\n"
+ .'- Unknown status: The file status is unknown. We recommend that you retry the request.', 'type' => 'string', 'example' => 'Clean', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA****', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'The result of the request. The following values are returned:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Clean\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeGatewayFileStatus',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayFileStatus'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ChapEnabled',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'type' => 'boolean',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayFileStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'DescribeGatewayImages' => [
+ 'summary' => 'Queries details of on-premises gateway images, including their names and descriptions.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ChapInUser',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'user',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '17206',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ ],
+ 'parameters' => [
[
- 'name' => 'ChapInPassword',
+ 'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'ChapInPassword',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The type of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- File: file gateway.'."\n"
+ .'- Iscsi: iSCSI gateway.', 'docRequired' => true, 'required' => true, 'type' => 'string', 'example' => 'File', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'example' => 't-000avsri6tlyddgfe***',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'successful',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'EBAF769F-2E88-4D81-AF1E-A34FAACF9***',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'Success' => [
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '30DFF66156-3672-4204-B708-24389F01FC77', 'title' => ''],
+ 'Images' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Image' => [
+ 'description' => 'The information about the on-premises gateway images.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the on-premises gateway image.',
+ 'properties' => [
+ 'Type' => ['description' => 'The type of the image.', 'type' => 'string', 'example' => 'application/octet-stream', 'title' => ''],
+ 'Description' => ['description' => 'The description of the image. Possible values:'."\n"
+ ."\n"
+ .'- sgw\\.file.ova.description: Use this OVA image to install the cloud storage file gateway service on VMware vSphere 6.0 or later.'."\n"
+ .'- sgw\\.file.vhd.description: Use this VHD image to install the cloud storage file gateway service on Microsoft Hyper-V.'."\n"
+ .'- sgw\\.file.kvm.description: Use this qcow2 image to install the cloud storage file gateway service on KVM.', 'type' => 'string', 'example' => 'sgw.file.kvm.description', 'title' => ''],
+ 'Version' => ['description' => 'The version of the image.', 'type' => 'string', 'example' => '1.0.40', 'title' => ''],
+ 'Size' => ['description' => 'The size of the image. Unit: bytes.', 'format' => 'int64', 'type' => 'integer', 'example' => '1063744588', 'title' => ''],
+ 'Url' => ['description' => 'The download URL of the on-premises gateway. The URL is valid for one hour.', 'type' => 'string', 'example' => 'http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAI****************&Signature=%2BoTNVCGWgxis8GMpvpg5NIRkFv****', 'title' => ''],
+ 'Title' => ['description' => 'The i18n key for the name of the on-premises gateway image. Possible values:'."\n"
+ ."\n"
+ .'- sgw\\.file.ova.title: Performance-optimized cloud storage file gateway image for VMware vSphere 6.0 or later.'."\n"
+ .'- sgw\\.file.vhd.title: Performance-optimized cloud storage file gateway image for Microsoft Hyper-V.'."\n"
+ .'- sgw\\.file.kvm.title: Performance-optimized cloud storage file gateway image for KVM.', 'type' => 'string', 'example' => 'sgw.file.kvm.title', 'title' => ''],
+ 'MD5' => ['description' => 'The MD5 hash of the on-premises gateway image file.', 'type' => 'string', 'example' => '48f43e6a906b28ed30ec40d****', 'title' => ''],
+ 'Name' => ['description' => 'The name of the image.', 'type' => 'string', 'example' => 'aliyun/file/1.0.40/image/sgw-file-1.0.39.v***', 'title' => ''],
+ 'ModifiedDate' => ['description' => 'The date when the image was last modified.', 'type' => 'string', 'example' => '2019-07-24', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter.BlockVolume.%s',
- 'errorMessage' => 'The specified field %s for block volume is invalid. Please check it again.',
- ],
- [
- 'errorCode' => 'VersionNotSupported.BlockVolume.%s',
- 'errorMessage' => 'The specified field %s for block volume is not supported by current gateway version. Please check it again.',
- ],
+ ['errorCode' => 'InvalidGatewayType', 'errorMessage' => 'The specified type of the gateway is invalid.', 'description' => 'The specified type of the gateway is invalid.'],
+ ],
+ 500 => [
+ ['errorCode' => 'OSSResourceAccountAccessFail', 'errorMessage' => 'Failed to access OSS. We recommend that you submit a ticket in the Alibaba Cloud console.', 'description' => 'Failed to access OSS. We recommend that you submit a ticket in the Alibaba Cloud console.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000avsri6tlyddgfe***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EBAF769F-2E88-4D81-AF1E-A34FAACF9***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateGatewayBlockVolumeResponse>\\n <TaskId>t-000avsri6tlyddgfe***</TaskId>\\n <Message>successful</Message>\\n <RequestId>EBAF769F-2E88-4D81-AF1E-A34FAACF9***</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateGatewayBlockVolumeResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"30DFF66156-3672-4204-B708-24389F01FC77\\",\\n \\"Images\\": {\\n \\"Image\\": [\\n {\\n \\"Type\\": \\"application/octet-stream\\",\\n \\"Description\\": \\"sgw.file.kvm.description\\",\\n \\"Version\\": \\"1.0.40\\",\\n \\"Size\\": 1063744588,\\n \\"Url\\": \\"http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAI****************&Signature=%2BoTNVCGWgxis8GMpvpg5NIRkFv****\\",\\n \\"Title\\": \\"sgw.file.kvm.title\\",\\n \\"MD5\\": \\"48f43e6a906b28ed30ec40d****\\",\\n \\"Name\\": \\"aliyun/file/1.0.40/image/sgw-file-1.0.39.v***\\",\\n \\"ModifiedDate\\": \\"2019-07-24\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeGatewayImages',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- 'title' => 'UpdateGatewayBlockVolume',
- ],
- 'DeleteGatewayBlockVolumes' => [
- 'summary' => 'Deletes a volume from an Internet Small Computer System Interface (iSCSI) gateway.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayImages'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'DescribeGatewayLocations' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwJLV9QR',
- ],
+ 'abilityTreeCode' => '17209',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C85521C5-AB12-52E0-8541-76E582C1DA2C', 'title' => ''],
+ 'Locations' => ['description' => 'The list of gateway locations.', 'type' => 'string', 'example' => 'Cloud,On_Premise', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ ."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwb***',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'DescribeGatewayLocations',
+ 'summary' => 'Returns a list of gateway locations.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C85521C5-AB12-52E0-8541-76E582C1DA2C\\",\\n \\"Locations\\": \\"Cloud,On_Premise\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'DescribeGatewayLogging' => [
+ 'summary' => 'Queries the logging configurations of a gateway, including the logging status, Simple Log Service (SLS) project name, and Logstore name.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'IndexId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'NFSalex-gx***',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwR40N8S'],
+ ],
+ 'parameters' => [
[
- 'name' => 'IsSourceDeletion',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwb***', 'title' => ''],
],
],
'responses' => [
@@ -3941,651 +3862,504 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0000iwdggbhaordhk***',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successsful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '151BB31D-571D-4BB9-9A02-D4210E5BF5DB',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'SlsProject' => ['description' => 'The project name.'."\n", 'type' => 'string', 'example' => '123***', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '17D08346-BD08-4107-BFBC-01A6AAD5F5FB', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'GatewayLoggingStatus' => ['description' => 'The logging status of the gateway. Valid values:'."\n"
+ ."\n"
+ .'* None: Logging is not configured for the gateway.'."\n"
+ .'* Enabled: Logging is enabled.'."\n"
+ .'* Disabled: Logging is disabled.'."\n", 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
+ 'SlsLogstore' => ['description' => 'The Logstore name.'."\n", 'type' => 'string', 'example' => 'alex***', 'title' => ''],
+ 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
- [
- 'errorCode' => 'EmptyVolumeIndexId',
- 'errorMessage' => 'You must enter an index ID for the block volume.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0000iwdggbhaordhk***\\",\\n \\"Message\\": \\"successsful\\",\\n \\"RequestId\\": \\"151BB31D-571D-4BB9-9A02-D4210E5BF5DB\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<TaskId>t-0000iwdggbhaordhk***</TaskId>\\n<RequestId>151BB31D-571D-4BB9-9A02-D4210E5BF5DB</RequestId>\\n<Message>successsful</Message>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]',
- 'title' => 'DeleteGatewayBlockVolumes',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"SlsProject\\": \\"123***\\",\\n \\"RequestId\\": \\"17D08346-BD08-4107-BFBC-01A6AAD5F5FB\\",\\n \\"Message\\": \\"successful\\",\\n \\"GatewayLoggingStatus\\": \\"Enabled\\",\\n \\"SlsLogstore\\": \\"alex***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayLoggingResponse>\\n <SlsProject>alex***</SlsProject>\\n <Message>successful</Message>\\n <RequestId>17D08346-BD08-4107-BFBC-01A6AAD5F5FB</RequestId>\\n <GatewayLoggingStatus>Enabled</GatewayLoggingStatus>\\n <SlsLogstore>123***</SlsLogstore>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayLoggingResponse>","errorExample":""}]',
+ 'title' => 'DescribeGatewayLogging',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateGatewayFileShare' => [
- 'summary' => 'Creates a share for a file gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayLogging'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayLogging',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeGatewayModificationClasses' => [
+ 'summary' => 'Queries the instance types to which a gateway can be upgraded.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '17169',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwQHP82G'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The gateway ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031***', 'title' => ''],
],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the share. The name must be 1 to 255 characters in length and can contain lowercase letters, digits, periods (.), underscores (\\_), and hyphens (-). It must start with a lowercase letter.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'alex***',
- ],
- ],
- [
- 'name' => 'ShareProtocol',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The protocol of the share. Valid values:'."\n"
- ."\n"
- .'* NFS'."\n"
- .'* SMB'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'NFS',
- ],
- ],
- [
- 'name' => 'RemoteSync',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable reverse synchronization for the share. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'PollingInterval',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The time interval between two consecutive reverse synchronization tasks. Valid values: 15 to 36000'."\n"
- ."\n"
- .'> In replication mode, if both reverse synchronization and data download are enabled, a valid value for this parameter ranges from 3600 to 36000.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '4500',
- ],
- ],
- [
- 'name' => 'IgnoreDelete',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable the ignore deletions feature for the share. After you enable the feature, data stored in the OSS bucket is retained if you delete data from the gateway. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n"
- ."\n"
- .'> This parameter is supported for gateway version 1.0.40 and later.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'FrontendLimit',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The upper limit on the write speed of the share. Unit: MB/s. Valid values: 0 to 1280. The default value 0 specifies that the write speed is not limited.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1234',
- ],
- ],
- [
- 'name' => 'BackendLimit',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The upper limit on the upload speed of the share. Unit: MB/s. Valid values: 0 to 1280. The default value 0 specifies that the upload speed is not limited.'."\n"
- ."\n"
- .'> If an upper limit is applied to the write speed, the upper limit on the upload speed must be greater than or equal to the upper speed on the write speed.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1234',
- ],
- ],
- [
- 'name' => 'InPlace',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable the fragmentation optimization feature for the share. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'CacheMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The data synchronization mode of the share. Valid values:'."\n"
- ."\n"
- .'* Cache: the cache mode'."\n"
- .'* Sync: the replication mode'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Cache',
- ],
- ],
- [
- 'name' => 'Browsable',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether the share is browsable over the SMB protocol (that is, whether the share is discoverable in the network neighbor). This parameter takes effect only when the ShareProtocol parameter is set to SMB. Valid values:'."\n"
- ."\n"
- .'* true (default)'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'Squash',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The user mapping for an NFS share. Valid values:'."\n"
- ."\n"
- .'* none (default)'."\n"
- .'* root_squash'."\n"
- .'* all_squash'."\n"
- .'* all_anonymous'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'none',
- ],
- ],
- [
- 'name' => 'ReadWriteUserList',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The list of users who have read and write access to the SMB share. Separate multiple users with commas (,). This parameter takes effect only when the ShareProtocol parameter is set to SMB.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user1,user2',
- ],
- ],
- [
- 'name' => 'ReadOnlyUserList',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The list of users who have read-only access to the SMB share. Separate multiple users with commas (,). This parameter takes effect only when the ShareProtocol parameter is set to SMB.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'userA,userB',
- ],
- ],
- [
- 'name' => 'ReadWriteClientList',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The IP addresses or CIDR blocks allowed to read and write the NFS share. Separate multiple IP addresses or CIDR blocks with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '12.12.12.12',
- ],
- ],
- [
- 'name' => 'ReadOnlyClientList',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The IP addresses or CIDR blocks allowed to only read the NFS share. Separate multiple IP addresses or CIDR blocks with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '12.12.12.12',
- ],
- ],
- [
- 'name' => 'OssBucketName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the OSS bucket.'."\n"
- ."\n"
- .'> An OSS bucket for which you configure back-to-origin routing is not supported.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'testbucket',
- ],
- ],
- [
- 'name' => 'OssEndpoint',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The endpoint for the region in which the OSS bucket associated with the share is located.'."\n"
- ."\n"
- .'> You can specify the internal or public endpoint for a region. If the OSS bucket and the gateway reside in the same region, we recommend that you specify the internal endpoint. Example: oss-cn-shanghai-internal.aliyuncs.com.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com',
- ],
- ],
- [
- 'name' => 'OssBucketSsl',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'Specifies whether to enable Secure Sockets Layer (SSL) connection to the OSS bucket. Valid values:'."\n"
- ."\n"
- .'* true (default)'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'FA8951CC-A534-425D-8705-F9A5CF9FD555', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'TargetGatewayClasses' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'TargetGatewayClass' => [
+ 'description' => 'The instance types to which you can upgrade the gateway.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'GatewayClass' => ['description' => 'The gateway instance type to which you can upgrade. Valid values:'."\n"
+ ."\n"
+ .'- Basic'."\n"
+ ."\n"
+ .'- Standard'."\n"
+ ."\n"
+ .'- Enhanced'."\n"
+ ."\n"
+ .'- Advanced', 'type' => 'string', 'example' => 'Enhanced', 'title' => ''],
+ 'IsAvailable' => ['description' => 'Indicates whether the instance type is available.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'LagPeriod',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The delay in uploading files from the gateway to the OSS bucket. Unit: seconds. Valid values: 5 to 120. Default value: 5.'."\n"
- ."\n"
- .'> This parameter is supported for gateway version 1.0.40 and later.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '5',
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'LocationCloudRequired', 'errorMessage' => 'You must specify a cloud gateway. Try again later.', 'description' => 'You must specify a cloud gateway. Try again later.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
],
- [
- 'name' => 'DirectIO',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether data is directly read from and written to the cache disk. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ ],
+ 'title' => 'DescribeGatewayModificationClasses',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayModificationClasses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"FA8951CC-A534-425D-8705-F9A5CF9FD555\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"TargetGatewayClasses\\": {\\n \\"TargetGatewayClass\\": [\\n {\\n \\"GatewayClass\\": \\"Enhanced\\",\\n \\"IsAvailable\\": true\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeGatewayNFSClients' => [
+ 'summary' => 'Queries the NFS clients for a file gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'LocalFilePath',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The internal device name of the cache disk for the share. You can call the DescribeGatewayCaches operation to query the internal device name of the cache disk.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '/dev/vdb',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
+ ],
+ 'parameters' => [
[
- 'name' => 'ServerSideEncryption',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable server-side encryption for the share. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n"
- ."\n"
- .'> - The feature is available only to users on the whitelist. To enable the feature, contact the technical support. Server-side encryption and client-side encryption cannot be configured at the same time.',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000gchoknplv4f27****', 'title' => ''],
],
[
- 'name' => 'ServerSideCmk',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The Key Management Service (KMS) key used for server-side encryption.'."\n"
- ."\n"
- .'> The key must be in the same region as the gateway.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxxx',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ClientSideEncryption',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable client-side encryption for the share. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n"
- ."\n"
- .'> The feature is available only to users on the whitelist. To enable the feature, contact the technical support. Only Enhanced and Performance Optimized gateways support the feature. Server-side encryption and client-side encryption cannot be configured at the same time.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '10', 'example' => '10', 'title' => ''],
],
- [
- 'name' => 'ClientSideCmk',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The KMS key used in client-side encryption for the share.'."\n"
- ."\n"
- .'> The key must be in the same region as the gateway.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxxx',
+ 'type' => 'object',
+ 'properties' => [
+ 'Version40Enabled' => ['description' => 'Indicates whether the gateway supports NFS v4.0 mounts. Valid values:'."\n"
+ ."\n"
+ .'- true: The gateway supports NFS v4.0 mounts.'."\n"
+ .'- false: The gateway does not support NFS v4.0 mounts.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Version41Enabled' => ['description' => 'Indicates whether the gateway supports NFS v4.1 mounts. Valid values:'."\n"
+ ."\n"
+ .'- true: The gateway supports NFS v4.1 mounts.'."\n"
+ .'- false: The gateway does not support NFS v4.1 mounts.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of clients.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F694EBF3-59AB-1DDD-B5B4-87CB7D6A****', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Version3Enabled' => ['description' => 'Indicates whether the gateway supports NFS v3 mounts. Valid values:'."\n"
+ ."\n"
+ .'- true: The gateway supports NFS v3 mounts.'."\n"
+ .'- false: The gateway does not support NFS v3 mounts.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ClientInfoList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ClientInfo' => [
+ 'description' => 'The client information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HasNFSv40' => ['description' => 'Indicates whether the client uses an NFS v4.0 mount. Valid values:'."\n"
+ ."\n"
+ .'- true: The client uses an NFS v4.0 mount.'."\n"
+ .'- false: The client does not use an NFS v4.0 mount.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'HasNFSv41' => ['description' => 'Indicates whether the client uses an NFS v4.1 mount. Valid values:'."\n"
+ ."\n"
+ .'- true: The client uses an NFS v4.1 mount.'."\n"
+ .'- false: The client does not use an NFS v4.1 mount.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'HasNFSv3' => ['description' => 'Indicates whether the client uses an NFS v3 mount. Valid values:'."\n"
+ ."\n"
+ .'- true: The client uses an NFS v3 mount.'."\n"
+ .'- false: The client does not use an NFS v3 mount.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ClientIpAddr' => ['description' => 'The IP address of the NFS client.', 'type' => 'string', 'example' => '172.16.XX.XX', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'KmsRotatePeriod',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The key rotation cycle for client-side encryption. The parameter takes effect only when client-side encryption is enabled for the share. Unit: seconds. Valid values: -3600 to 360 × 86400. The default value 0 indicates that the key is not rotated.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'BadPageSize', 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', 'description' => 'The specified number of pages is invalid. The number ranges from 1 to 50.'],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
+ ['errorCode' => 'BadPageNumber', 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.', 'description' => 'The specified page number is invalid. The page number must be greater than 0.'],
],
- [
- 'name' => 'PathPrefix',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The subdirectory of the OSS bucket. If you leave the parameter empty, the root directory of the OSS bucket is specified.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test1',
- ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Version40Enabled\\": true,\\n \\"Version41Enabled\\": false,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"F694EBF3-59AB-1DDD-B5B4-87CB7D6A****\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Version3Enabled\\": true,\\n \\"ClientInfoList\\": {\\n \\"ClientInfo\\": [\\n {\\n \\"HasNFSv40\\": true,\\n \\"HasNFSv41\\": false,\\n \\"HasNFSv3\\": true,\\n \\"ClientIpAddr\\": \\"172.16.XX.XX\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeGatewayNFSClients',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayNFSClients'],
],
+ ],
+ 'ramActions' => [
[
- 'name' => 'FastReclaim',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable the upload optimization feature for the share. The feature is suitable for the scenarios where you synchronize backups to the cloud. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n"
- ."\n"
- .'> This parameter is supported for gateway version 1.0.39 and later.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayNFSClients',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'DescribeGatewaySMBClients' => [
+ 'summary' => 'Queries the Server Message Block (SMB) clients of a file gateway.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'SupportArchive',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to allow archiving for the share. This parameter takes effect only when the ShareProtocol parameter is set to NFS.'."\n"
- ."\n"
- .'> If you enable the feature and access an archived file, a request is initiated to restore the archived file. The request does not trigger error messages. However, the restoration process takes some time to complete. If you do not enable the feature, accessing an archived file throws an error.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219649',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ ],
+ 'parameters' => [
[
- 'name' => 'WindowsAcl',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to configure a Windows access control list (ACL) for the SMB share. Active Directory is required to configure this setting. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n"
- ."\n"
- .'> This parameter is supported for gateway version 1.0.45 and later.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', 'title' => ''],
],
[
- 'name' => 'AccessBasedEnumeration',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable Windows access-based enumeration (ABE) for the SMB share. This parameter takes effect only when the WindowsAcl parameter is set to true. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n"
- ."\n"
- .'> This parameter is supported for gateway version 1.0.45 and later.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'NfsV4Optimization',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to enable fragment optimization based on the Network File System version 4 (NFSv4) protocol to improve the upload efficiency. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n"
- ."\n"
- .'> After you enable the feature, you cannot mount the share on on-premises clients over NFSv3. This parameter is supported for gateway version 1.2.0 and later.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '10', 'example' => '10', 'title' => ''],
],
- [
- 'name' => 'TransferAcceleration',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'Specifies whether to enable the transfer acceleration feature for the share. To enable transfer acceleration for the share, you must also enable transfer acceleration for the OSS bucket.'."\n"
- ."\n"
- .'> This parameter is supported for gateway version 1.3.0 and later.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213A***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ ."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of SMB clients.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'ClientInfoList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ClientInfo' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Signing' => ['description' => 'The SMB signing status.', 'type' => 'string', 'example' => 'required', 'title' => ''],
+ 'ProtocolVersion' => ['description' => 'The protocol version.', 'type' => 'string', 'example' => '2.1', 'title' => ''],
+ 'Group' => ['description' => 'The user group.', 'type' => 'string', 'example' => 'guest', 'title' => ''],
+ 'Username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'guest', 'title' => ''],
+ 'ClientIpAddr' => ['description' => 'The IP address of the SMB client.', 'type' => 'string', 'example' => '192.168.xx.xx', 'title' => ''],
+ ],
+ 'description' => 'The information about an SMB client.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of SMB clients.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'DescribeGatewaySMBClients',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'RemoteSyncDownload',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to download data if the replication mode is enabled. Valid values:'."\n"
- ."\n"
- .'* false (default)'."\n"
- .'* true'."\n"
- ."\n"
- .'> This parameter takes effect only if the share allows reverse synchronization or is added to an express synchronization group.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewaySMBClients',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213A***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"ClientInfoList\\": {\\n \\"ClientInfo\\": [\\n {\\n \\"Signing\\": \\"required\\",\\n \\"ProtocolVersion\\": \\"2.1\\",\\n \\"Group\\": \\"guest\\",\\n \\"Username\\": \\"guest\\",\\n \\"ClientIpAddr\\": \\"192.168.xx.xx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeGatewaySMBSecurityStrategy' => [
+ 'summary' => 'Queries the Server Message Block (SMB) security level configuration of a gateway.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DownloadLimit',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The upper limit on the download speed of the share. Unit: MB/s. Valid values: 0 to 1280. The default value 0 specifies that the download speed is not limited.'."\n"
- ."\n"
- .'> '."\n"
- ."\n"
- .'* This parameter takes effect only when the replication mode and data download feature are enabled. This parameter takes effect only if the share allows reverse synchronization or is added to an express synchronization group. This parameter is supported for gateway version 1.3.0 and later.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
+ ],
+ 'parameters' => [
[
- 'name' => 'PartialSyncPaths',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The directories from which you want to synchronize data if the replication mode is enabled.'."\n"
- ."\n"
- .'> The feature is available only to users on the whitelist. To enable the feature, contact the technical support.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test1',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'example' => 'gw-000c6hshwukkbryp****', 'title' => ''],
],
- [
- 'name' => 'ServerSideAlgorithm',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The encryption algorithm. Valid values:'."\n"
- ."\n"
- .'* AES256 (default)'."\n"
- .'* SM4'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AES256',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '395B1136-982E-4F95-BDCE-7323FFEF499E', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Possible values:'."\n"
+ ."\n"
+ .'- true: Successful.'."\n"
+ ."\n"
+ .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SecurityStrategy' => ['description' => 'The security level. Possible values:'."\n"
+ ."\n"
+ .'- ClientNegotiated: Client negotiation.'."\n"
+ ."\n"
+ .'- EnforceSigning: Enforced signing.', 'type' => 'string', 'example' => 'ClientNegotiated', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'DescribeGatewaySMBSecurityStrategy',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'BypassCacheRead',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to directly read data from OSS. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false (default)'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewaySMBSecurityStrategy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"395B1136-982E-4F95-BDCE-7323FFEF499E\\",\\n \\"Success\\": true,\\n \\"SecurityStrategy\\": \\"ClientNegotiated\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeGatewaySMBUsers' => [
+ 'summary' => 'Queries the list of SMB usernames on a file gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'BindIPAddr',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The virtual IP address used to mount the share. This parameter applies only to a high-availability gateway.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.0.10',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
+ ],
+ 'parameters' => [
[
- 'name' => 'OssBucketRegionId',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region in which the OSS bucket associated with the share is located.'."\n"
- ."\n"
- .'> If the gateway version is greater than or equal to 2.0.0 and this parameter is correctly specified, the gateway uses the OSS Signature V4 to access data in the bucket. If the gateway version is earlier than 2.0.0 or this parameter is not correctly specified, the gateway uses the OSS Signature V1 to access data in the OSS bucket.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'gw-000eg44nmxbsfwbv***'],
],
[
- 'name' => 'BucketInfos',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-aliyun',
- ],
- 'Endpoint' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss-cn-hangzhou.aliyuncs.com',
- ],
- 'PathPrefix' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The page number to return for a paged query.'."\n"
+ ."\n"
+ .'- Start value: 1.'."\n"
+ ."\n"
+ .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'title' => '', 'example' => '1'],
],
[
- 'name' => 'BucketStub',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page for a paged query.'."\n"
+ ."\n"
+ .'- Maximum value: 50.'."\n"
+ ."\n"
+ .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '10', 'title' => '', 'example' => '10'],
],
],
'responses' => [
@@ -4593,72 +4367,89 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'The returned message.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F8B59F29-453D-49BF-8673-EEB8F9F2D5C6',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'string',
- 'example' => 't-000eg44nmxbsh3qk***',
+ 'TotalCount' => ['description' => 'The total number of SMB usernames.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4C02F482-FC2E-45BF-88C5-8D40134D11**'],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'title' => '', 'example' => 'successful'],
+ 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'Users' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'User' => [
+ 'description' => 'The list of SMB usernames.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Username' => ['description' => 'The SMB username.', 'type' => 'string', 'title' => '', 'example' => 'alex***'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ActiveDirectory' => ['type' => 'boolean', 'description' => 'Indicates whether the gateway is added to a Windows Active Directory (AD) domain.'."\n"
+ ."\n"
+ .'- false (default): The gateway is not added.'."\n"
+ ."\n"
+ .'- true: The gateway is added.', 'title' => '', 'example' => 'false'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter.FileShare.%s',
- 'errorMessage' => 'The specified field %s for file share is invalid. Please check it again.',
- ],
- [
- 'errorCode' => 'VersionNotSupported.FileShare.%s',
- 'errorMessage' => 'The specified field %s for file share is not supported by current gateway version. Please check it again.',
- ],
- [
- 'errorCode' => 'FileShareArchiveSupportConflict',
- 'errorMessage' => 'You can configure the ArchiveSupport parameter only with NFS protocol and when the user mapping value is "none".',
- ],
+ ['errorCode' => 'BadPageSize', 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', 'description' => 'The specified number of pages is invalid. The number ranges from 1 to 50.'],
+ ['errorCode' => 'BadPageNumber', 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.', 'description' => 'The specified page number is invalid. The page number must be greater than 0.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F8B59F29-453D-49BF-8673-EEB8F9F2D5C6\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"t-000eg44nmxbsh3qk***\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateGatewayFileShareResponse>\\n <TaskId>t-000eg44nmxbsh3qk***</TaskId>\\n <Message>successful</Message>\\n <RequestId>F8B59F29-453D-49BF-8673-EEB8F9F2D5C6</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateGatewayFileShareResponse>","errorExample":""}]',
- 'title' => 'CreateGatewayFileShare',
- 'description' => 'Before you call the operation, take note of the following items:'."\n"
+ 'title' => 'DescribeGatewaySMBUsers',
+ 'description' => 'When you call this operation, note the following:'."\n"
."\n"
- .'* Make sure that you have created and deployed a file gateway that has an unused cache disk.'."\n"
- .'* Make sure that you have created an Object Storage Service (OSS) bucket.'."\n",
+ .'- If you have added an Active Directory (AD) server to your Cloud Storage Gateway, this operation returns the list of SMB users on the server.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeGatewayFileStatus' => [
- 'summary' => 'Queries the status of a file in a share of a file gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewaySMBUsers'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewaySMBUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"4C02F482-FC2E-45BF-88C5-8D40134D11**\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Users\\": {\\n \\"User\\": [\\n {\\n \\"Username\\": \\"alex***\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"ActiveDirectory\\": false\\n}","type":"json"}]',
+ ],
+ 'DescribeGatewayTypes' => [
+ 'summary' => 'Queries the available gateway types for a specified location.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4670,46 +4461,17 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '17205',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '17222',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-0004wacp5e4ll1542****',
- ],
- ],
- [
- 'name' => 'IndexId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'NFSalex-gx-nfs-1201****',
- ],
- ],
- [
- 'name' => 'FilePath',
+ 'name' => 'GatewayLocation',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sub/cptestfile****',
- ],
+ 'schema' => ['description' => 'The location of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- Cloud: a cloud gateway.'."\n"
+ .'- On\\_Premise: an on-premises gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Cloud', 'title' => ''],
],
],
'responses' => [
@@ -4717,103 +4479,86 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Clean',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Types' => ['description' => 'The available types of the gateway. The gateway types are separated by commas. Possible values:'."\n"
+ ."\n"
+ .'- File: file gateway.'."\n"
+ .'- Iscsi: iSCSI gateway.', 'type' => 'string', 'example' => 'File,Iscsi', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '787ECFD0-5F30-44C0-BB8F-56A964F66D01', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
- ],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
+ ['errorCode' => 'InvalidGatewayLocation', 'errorMessage' => 'The specified location of the gateway is invalid.', 'description' => 'The specified location of the gateway is invalid.'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Clean\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'DescribeGatewayFileStatus',
- ],
- 'DescribeGatewayFileShares' => [
- 'summary' => 'Queries shares for a file gateway.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Types\\": \\"File,Iscsi\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"787ECFD0-5F30-44C0-BB8F-56A964F66D01\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeGatewayTypes',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayTypes'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'DescribeGateways' => [
+ 'summary' => 'Queries a list of gateways and returns their IDs and names.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '17204',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
- ],
+ 'abilityTreeCode' => '17215',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
- 'name' => 'GatewayId',
+ 'name' => 'StorageBundleId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway cluster.'."\n"
+ ."\n"
+ .'> - If you do not specify ResourceRegionId, you must specify this parameter.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'sb-0001b2otnkdxrigeq***', 'title' => ''],
],
[
- 'name' => 'IndexId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NFSd-million',
- ],
+ 'schema' => ['description' => 'The page number of the gateway list.'."\n"
+ ."\n"
+ .'- Start value: 1.'."\n"
+ .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Refresh',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page for a paged query.'."\n"
+ ."\n"
+ .'- Maximum value: 50.'."\n"
+ .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '10', 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceRegionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => 'The ID of the region where the resource resides.', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
@@ -4821,774 +4566,500 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'FileShares' => [
+ 'TotalCount' => ['description' => 'The total number of gateways in the specified gateway cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2C4A8287-66F4-45F9-84E3-866E4232C763', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries returned per page in the gateway list.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the gateway list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Gateways' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'FileShare' => [
- 'description' => '',
+ 'Gateway' => [
+ 'description' => 'The information about the gateways.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'AccessBasedEnumeration' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ActiveMessages' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Address' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '172.16.0.44',
- ],
- 'BeLimit' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'BindIPAddr' => [
- 'type' => 'string',
- ],
- 'Browsable' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'BucketInfos' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'BucketsStub' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'BypassCacheRead' => [
- 'type' => 'boolean',
- ],
- 'CacheMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Cache',
- ],
- 'ClientSideCmk' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'ClientSideEncryption' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'DirectIO' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'DiskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd-bp1cvy8o2569jij31***',
- ],
- 'DiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'DownloadLimit' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'DownloadQueue' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'DownloadRate' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Enabled' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ExpressSyncId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sync-0001xv7je357xn8tr***',
- ],
- 'FastReclaim' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'FeLimit' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'FileNumLimit' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10200202',
- ],
- 'FsSizeLimit' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '70368744177664',
- ],
- 'HighWatermark' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'IgnoreDelete' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'InPlace' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'InRate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'IndexId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NFSale***',
- ],
- 'KmsRotatePeriod' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'LagPeriod' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'LocalPath' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '/dev/vdb',
- ],
- 'LowWatermark' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'MnsHealth' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MNSNotEnabled',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alex***',
- ],
- 'NfsV4Optimization' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'NoPartition' => [
- 'type' => 'boolean',
- ],
- 'ObsoleteBuckets' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'bucket1',
- ],
- 'OssBucketName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'bucketA',
- ],
- 'OssBucketSsl' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'OssEndpoint' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com',
- ],
- 'OssHealth' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BucketHealthy',
- ],
- 'OssUsed' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'OutRate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'PartialSyncPaths' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'PathPrefix' => [
- 'description' => 'OSS Prefix。',
- 'type' => 'string',
- 'example' => 'testprefix',
- ],
- 'PollingInterval' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Protocol' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SMB',
- ],
- 'RemainingMetaSpace' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21308227584',
- ],
- 'RemoteSync' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'RemoteSyncDownload' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'RoClientList' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'user1',
- ],
- 'RoUserList' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'user2',
- ],
- 'RwClientList' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'user3',
- ],
- 'RwUserList' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'user4',
- ],
- 'ServerSideAlgorithm' => [
- 'type' => 'string',
- ],
- 'ServerSideCmk' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'ServerSideEncryption' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Size' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '85899345920',
- ],
- 'Squash' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'root_squash',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'clean',
- ],
- 'Status' => [
- 'type' => 'string',
- ],
- 'SupportArchive' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'SyncProgress' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '-2',
- ],
- 'Throttling' => [
- 'type' => 'boolean',
- ],
- 'TotalDownload' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'TotalUpload' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'TransferAcceleration' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'UploadQueue' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Used' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'WindowsAcl' => [
+ 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'example' => 'vpc-bp1p0usrgr5z9e7lwr***', 'title' => ''],
+ 'Status' => ['description' => 'The status of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- Initialized: The gateway is initialized.'."\n"
+ .'- Deactivated: The gateway is not activated.'."\n"
+ .'- Activated: The gateway is activated.'."\n"
+ .'- Deploying: The gateway is being deployed.'."\n"
+ .'- Running: The gateway is running.'."\n"
+ .'- Stopping: The gateway is being stopped.'."\n"
+ .'- Stopped: The gateway is stopped.'."\n"
+ .'- Starting: The gateway is being started.'."\n"
+ .'- Rebooting: The gateway is being restarted.'."\n"
+ .'- Deleting: The gateway is being deleted.'."\n"
+ .'- Failed: The gateway failed to run.'."\n"
+ .'- Upgrading: The gateway is being upgraded.'."\n"
+ .'- Modifying: The gateway is being modified.'."\n"
+ .'- Unknown: No heartbeat is detected for a long time.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'Type' => ['description' => 'See the GatewayType parameter', 'type' => 'string', 'example' => 'File', 'title' => ''],
+ 'Capacity' => ['type' => 'integer', 'format' => 'int32', 'description' => 'This parameter is deprecated.', 'example' => '500', 'title' => ''],
+ 'GatewayId' => ['description' => 'The gateway ID.', 'type' => 'string', 'example' => 'gw-0001b2odzvl3b1mhi***', 'title' => ''],
+ 'IsReleaseAfterExpiration' => ['description' => 'Indicates whether the subscription gateway is released after it expires. Valid values:'."\n"
+ ."\n"
+ .'- true: The gateway is released after it expires. The service of the Cloud Storage Gateway is stopped seven days after the gateway expires.'."\n"
+ .'- false: The gateway is converted to a pay-as-you-go gateway after it expires.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'GatewayType' => ['description' => 'The type of the gateway'."\n"
+ ."\n"
+ .'- File: file gateway'."\n"
+ .'- Iscsi: iSCSI gateway', 'type' => 'string', 'example' => 'File', 'title' => ''],
+ 'BuyURL' => ['description' => 'The purchase URL. This parameter is returned only for subscription gateways.', 'type' => 'string', 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***”,”directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy', 'title' => ''],
+ 'EcsInstanceId' => ['description' => 'The ID of the ECS instance.', 'type' => 'string', 'example' => 'gw-0001b2onkdzvl3b***', 'title' => ''],
+ 'MaxThroughput' => ['type' => 'integer', 'format' => 'int32', 'description' => 'This parameter is deprecated.', 'example' => '30。', 'title' => ''],
+ 'GatewayClass' => ['description' => 'The gateway class. Valid values:'."\n"
+ ."\n"
+ .'- Basic: Basic.'."\n"
+ .'- Standard: Medium.'."\n"
+ .'- Enhanced: Enhanced.'."\n"
+ .'- Advanced: Performance.', 'type' => 'string', 'example' => 'Advanced', 'title' => ''],
+ 'InnerIp' => ['description' => 'The mount IP address.', 'type' => 'string', 'example' => '172.16.0.21', 'title' => ''],
+ 'Description' => ['description' => 'The description of the gateway.', 'type' => 'string', 'example' => 'For testing', 'title' => ''],
+ 'Name' => ['description' => 'The name of the gateway.', 'type' => 'string', 'example' => 'fio-weekly***', 'title' => ''],
+ 'InnerIpv6Ip' => ['type' => 'string', 'description' => 'The IPv6 address.', 'example' => '2408:4004:110:6000:4656:f88e:1c14:e578', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the gateway was created. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1577179604', 'title' => ''],
+ 'ExpireStatus' => ['description' => 'The expiration status of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- 0: Normal.'."\n"
+ .'- 1: The gateway is about to expire.'."\n"
+ .'- 2: The gateway has expired.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'DataLoadInterval' => ['type' => 'integer', 'format' => 'int32', 'description' => 'This parameter is deprecated.', 'example' => '120', 'title' => ''],
+ 'RenewURL' => ['description' => 'The renewal URL.', 'type' => 'string', 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew', 'title' => ''],
+ 'IsPostPaid' => ['description' => 'The billing method. Valid values:'."\n"
+ ."\n"
+ .'- true: pay-as-you-go.'."\n"
+ .'- false: subscription.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'PublicNetworkBandwidth' => ['description' => 'The public bandwidth for data transmission. Unit: Mbit/s. This parameter is supported only by gateways deployed on Alibaba Cloud.', 'type' => 'integer', 'format' => 'int32', 'example' => '55', 'title' => ''],
+ 'StorageBundleId' => ['description' => 'The ID of the gateway cluster.', 'type' => 'string', 'example' => 'sb-0001b2otrigeqkso***', 'title' => ''],
+ 'Ip' => ['description' => 'The public IP address.', 'type' => 'string', 'example' => '47.111.145.66', 'title' => ''],
+ 'LastErrorKey' => ['type' => 'string', 'description' => 'The error keyword.', 'example' => 'InternalError', 'title' => ''],
+ 'ElasticNodes' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ElasticNode' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => 'This parameter is deprecated.', 'example' => '172.16.0.23', 'title' => ''],
+ 'description' => 'This parameter is deprecated.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'OssBucketRegionId' => [
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
+ 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-bp1krhkgnahkb9stp0***', 'title' => ''],
+ 'CommonBuyInstanceId' => ['description' => 'The ID of the instance in the sales system. This parameter is returned only for subscription gateways.', 'type' => 'string', 'example' => 'gw-0001b2onkdzvl3b***', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'The expiration time. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532426471', 'title' => ''],
+ 'GatewayVersion' => ['description' => 'The gateway version.', 'type' => 'string', 'example' => '1.2.6', 'title' => ''],
+ 'DataLoadType' => ['type' => 'string', 'description' => 'This parameter is deprecated.', 'example' => 'once', 'title' => ''],
+ 'ElasticGateway' => ['type' => 'boolean', 'description' => 'This parameter is deprecated.', 'example' => 'false', 'title' => ''],
+ 'Category' => ['description' => 'The gateway category.'."\n"
+ ."\n"
+ .'- Default: Aliyun.', 'type' => 'string', 'example' => 'Aliyun', 'title' => ''],
+ 'ActivatedTime' => ['description' => 'The activation time. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1577179769', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-000978oflgrd8ah6p***', 'title' => ''],
+ 'Location' => ['description' => 'The location of the gateway. Valid values:'."\n"
+ ."\n"
+ .'- Cloud: a gateway deployed on Alibaba Cloud.'."\n"
+ .'- On\\_Premise: a gateway deployed in a data center.', 'type' => 'string', 'example' => 'Cloud', 'title' => ''],
+ 'GatewayRegionId' => ['type' => 'string', 'description' => 'The region of the gateway.', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'UntrustedEnvInstanceType' => ['type' => 'string', 'description' => '<props="china">'."\n"
+ ."\n"
+ .'The actual gateway class in an untrusted environment ([CloudBox](https://www.alibabacloud.com/help/en/csg/user-guide/whatis-csg-on-cloud-box)).'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\n"
+ ."\n"
+ .'The actual gateway class in an untrusted environment ([CloudBox](https://www.alibabacloud.com/help/en/csg/product-overview/whatis-csg-on-cloud-box)).'."\n"
+ ."\n"
+ .'</props>', 'example' => 'ecs.g6.large', 'title' => ''],
+ 'HighAvailability' => ['type' => 'boolean', 'description' => 'Indicates whether the gateway is a cross-zone high availability (HA) gateway. The return values are as follows:'."\n"
+ ."\n"
+ .'- true: The gateway is a cross-zone HA gateway.'."\n"
+ .'- false: The gateway is not a cross-zone HA gateway.', 'example' => 'false', 'title' => ''],
+ 'SecondaryVSwitchId' => ['type' => 'string', 'description' => 'The ID of the vSwitch. This parameter is supported only by HA gateways.', 'example' => 'vsw-bp1krhkgnahkb8stp0***', 'title' => ''],
],
+ 'description' => 'The information about the gateway.',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'Message' => [
'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9A3C3C32-3F37-4658-9D38-945D0799CA0E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInUpgrading',
- 'errorMessage' => 'The gateway is upgrading. Try again later.',
- ],
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
+ ['errorCode' => 'EmptyStorageBundleId', 'errorMessage' => 'You must enter a valid ID for the gateway cluster.', 'description' => 'You must enter a valid ID for the gateway cluster.'],
+ ['errorCode' => 'BadPageSize', 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', 'description' => 'The specified number of pages is invalid. The number ranges from 1 to 50.'],
+ ['errorCode' => 'BadPageNumber', 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.', 'description' => 'The specified page number is invalid. The page number must be greater than 0.'],
+ ],
+ 404 => [
+ ['errorCode' => 'StorageBundleNotExist', 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', 'description' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"FileShares\\": {\\n \\"FileShare\\": [\\n {\\n \\"AccessBasedEnumeration\\": false,\\n \\"ActiveMessages\\": 0,\\n \\"Address\\": \\"172.16.0.44\\",\\n \\"BeLimit\\": 0,\\n \\"BindIPAddr\\": \\"192.0.0.0\\",\\n \\"Browsable\\": true,\\n \\"BucketInfos\\": \\"[{\\\\\\\\\\\\\\"Endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bucket1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PathPrefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"Endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bucket2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PathPrefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}]\\",\\n \\"BucketsStub\\": false,\\n \\"BypassCacheRead\\": false,\\n \\"CacheMode\\": \\"Cache\\",\\n \\"ClientSideCmk\\": \\"xxx\\",\\n \\"ClientSideEncryption\\": false,\\n \\"DirectIO\\": false,\\n \\"DiskId\\": \\"d-bp1cvy8o2569jij31***\\",\\n \\"DiskType\\": \\"cloud_efficiency\\",\\n \\"DownloadLimit\\": 0,\\n \\"DownloadQueue\\": 5,\\n \\"DownloadRate\\": 0,\\n \\"Enabled\\": true,\\n \\"ExpressSyncId\\": \\"sync-0001xv7je357xn8tr***\\",\\n \\"FastReclaim\\": false,\\n \\"FeLimit\\": 0,\\n \\"FileNumLimit\\": 10200202,\\n \\"FsSizeLimit\\": 70368744177664,\\n \\"HighWatermark\\": 80,\\n \\"IgnoreDelete\\": false,\\n \\"InPlace\\": false,\\n \\"InRate\\": 0,\\n \\"IndexId\\": \\"NFSale***\\",\\n \\"KmsRotatePeriod\\": \\"0\\",\\n \\"LagPeriod\\": 5,\\n \\"LocalPath\\": \\"/dev/vdb\\",\\n \\"LowWatermark\\": 60,\\n \\"MnsHealth\\": \\"MNSNotEnabled\\",\\n \\"Name\\": \\"alex***\\",\\n \\"NfsV4Optimization\\": false,\\n \\"NoPartition\\": true,\\n \\"ObsoleteBuckets\\": \\"bucket1\\",\\n \\"OssBucketName\\": \\"bucketA\\",\\n \\"OssBucketSsl\\": false,\\n \\"OssEndpoint\\": \\"oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"OssHealth\\": \\"BucketHealthy\\",\\n \\"OssUsed\\": 0,\\n \\"OutRate\\": 0,\\n \\"PartialSyncPaths\\": \\"xxx\\",\\n \\"PathPrefix\\": \\"testprefix\\",\\n \\"PollingInterval\\": 900,\\n \\"Protocol\\": \\"SMB\\",\\n \\"RemainingMetaSpace\\": 21308227584,\\n \\"RemoteSync\\": false,\\n \\"RemoteSyncDownload\\": false,\\n \\"RoClientList\\": \\"1.1.1.1\\",\\n \\"RoUserList\\": \\"user1\\",\\n \\"RwClientList\\": \\"1.1.1.1\\",\\n \\"RwUserList\\": \\"user2\\",\\n \\"ServerSideAlgorithm\\": \\"AES256\\",\\n \\"ServerSideCmk\\": \\"xxx\\",\\n \\"ServerSideEncryption\\": false,\\n \\"Size\\": 85899345920,\\n \\"Squash\\": \\"root_squash\\",\\n \\"State\\": \\"clean\\",\\n \\"Status\\": \\"started\\",\\n \\"SupportArchive\\": false,\\n \\"SyncProgress\\": -2,\\n \\"Throttling\\": false,\\n \\"TotalDownload\\": 0,\\n \\"TotalUpload\\": 0,\\n \\"TransferAcceleration\\": false,\\n \\"UploadQueue\\": 5,\\n \\"Used\\": 0,\\n \\"WindowsAcl\\": false,\\n \\"OssBucketRegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9A3C3C32-3F37-4658-9D38-945D0799CA0E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayFileSharesResponse>\\n <Message>successful</Message>\\n <RequestId>9A3C3C32-3F37-4658-9D38-945D0799CA0E</RequestId>\\n <FileShares>\\n <ClientSideCmk>xxx</ClientSideCmk>\\n <PartialSyncPaths>xxx</PartialSyncPaths>\\n <PathPrefix>testprefix</PathPrefix>\\n <BucketsStub>false</BucketsStub>\\n <UploadQueue>5</UploadQueue>\\n <DiskId>d-bp1cvy8o2569jij31***</DiskId>\\n <OssUsed>0</OssUsed>\\n <DownloadQueue>5</DownloadQueue>\\n <ActiveMessages>0</ActiveMessages>\\n <IndexId>NFSale***</IndexId>\\n <MnsHealth>MNSNotEnabled</MnsHealth>\\n <AccessBasedEnumeration>false</AccessBasedEnumeration>\\n <DownloadRate>0</DownloadRate>\\n <FeLimit>0</FeLimit>\\n <SupportArchive>false</SupportArchive>\\n <OssEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</OssEndpoint>\\n <OssHealth>BucketHealthy</OssHealth>\\n <OutRate>0</OutRate>\\n <ServerSideCmk>xxx</ServerSideCmk>\\n <RwClientList>1.1.1.1</RwClientList>\\n <State>clean</State>\\n <Protocol>SMB</Protocol>\\n <OssBucketSsl>false</OssBucketSsl>\\n <DownloadLimit>0</DownloadLimit>\\n <InPlace>false</InPlace>\\n <RemoteSync>false</RemoteSync>\\n <FileNumLimit>10200202</FileNumLimit>\\n <Squash>root_squash</Squash>\\n <RemainingMetaSpace>21308227584</RemainingMetaSpace>\\n <TransferAcceleration>false</TransferAcceleration>\\n <Size>85899345920</Size>\\n <ServerSideEncryption>false</ServerSideEncryption>\\n <WindowsAcl>false</WindowsAcl>\\n <RemoteSyncDownload>false</RemoteSyncDownload>\\n <ClientSideEncryption>false</ClientSideEncryption>\\n <BucketInfos>[{\\\\\\"Endpoint\\\\\\":\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"bucket1\\\\\\",\\\\\\"PathPrefix\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"Endpoint\\\\\\":\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"bucket2\\\\\\",\\\\\\"PathPrefix\\\\\\":\\\\\\"\\\\\\"}]</BucketInfos>\\n <NfsV4Optimization>false</NfsV4Optimization>\\n <TotalUpload>0</TotalUpload>\\n <DiskType>cloud_efficiency</DiskType>\\n <Used>0</Used>\\n <IgnoreDelete>false</IgnoreDelete>\\n <RoUserList>user1</RoUserList>\\n <FsSizeLimit>70368744177664</FsSizeLimit>\\n <TotalDownload>0</TotalDownload>\\n <Enabled>true</Enabled>\\n <HighWatermark>80</HighWatermark>\\n <KmsRotatePeriod>0</KmsRotatePeriod>\\n <Address>172.16.0.44</Address>\\n <PollingInterval>900</PollingInterval>\\n <Name>alex***</Name>\\n <OssBucketName>bucketA</OssBucketName>\\n <ExpressSyncId>sync-0001xv7je357xn8tr***</ExpressSyncId>\\n <LagPeriod>5</LagPeriod>\\n <DirectIO>false</DirectIO>\\n <CacheMode>Cache</CacheMode>\\n <InRate>0</InRate>\\n <LowWatermark>60</LowWatermark>\\n <SyncProgress>-2</SyncProgress>\\n <ServerSideAlgorithm>AES256</ServerSideAlgorithm>\\n <ObsoleteBuckets>bucket1</ObsoleteBuckets>\\n <BeLimit>0</BeLimit>\\n <LocalPath>/dev/vdb</LocalPath>\\n <RoClientList>1.1.1.1</RoClientList>\\n <RwUserList>user2</RwUserList>\\n <FastReclaim>false</FastReclaim>\\n <Browsable>true</Browsable>\\n <Throttling>false</Throttling>\\n <BypassCacheRead>false</BypassCacheRead>\\n <NoPartition>true</NoPartition>\\n <Status>started</Status>\\n <BindIPAddr>192.0.0.0</BindIPAddr>\\n </FileShares>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayFileSharesResponse>","errorExample":""}]',
- 'title' => 'DescribeGatewayFileShares',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"2C4A8287-66F4-45F9-84E3-866E4232C763\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Gateways\\": {\\n \\"Gateway\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1p0usrgr5z9e7lwr***\\",\\n \\"Status\\": \\"Running\\",\\n \\"Type\\": \\"File\\",\\n \\"Capacity\\": 500,\\n \\"GatewayId\\": \\"gw-0001b2odzvl3b1mhi***\\",\\n \\"IsReleaseAfterExpiration\\": false,\\n \\"GatewayType\\": \\"File\\",\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***”,”directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}&regionId=cn-hangzhou#/buy\\",\\n \\"EcsInstanceId\\": \\"gw-0001b2onkdzvl3b***\\",\\n \\"MaxThroughput\\": 0,\\n \\"GatewayClass\\": \\"Advanced\\",\\n \\"InnerIp\\": \\"172.16.0.21\\",\\n \\"Description\\": \\"For testing\\",\\n \\"Name\\": \\"fio-weekly***\\",\\n \\"InnerIpv6Ip\\": \\"2408:4004:110:6000:4656:f88e:1c14:e578\\",\\n \\"CreatedTime\\": 1577179604,\\n \\"ExpireStatus\\": 0,\\n \\"DataLoadInterval\\": 120,\\n \\"RenewURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew\\",\\n \\"IsPostPaid\\": true,\\n \\"PublicNetworkBandwidth\\": 55,\\n \\"StorageBundleId\\": \\"sb-0001b2otrigeqkso***\\",\\n \\"Ip\\": \\"47.111.145.66\\",\\n \\"LastErrorKey\\": \\"InternalError\\",\\n \\"ElasticNodes\\": {\\n \\"ElasticNode\\": [\\n \\"172.16.0.23\\"\\n ]\\n },\\n \\"VSwitchId\\": \\"vsw-bp1krhkgnahkb9stp0***\\",\\n \\"CommonBuyInstanceId\\": \\"gw-0001b2onkdzvl3b***\\",\\n \\"ExpiredTime\\": 1532426471,\\n \\"GatewayVersion\\": \\"1.2.6\\",\\n \\"DataLoadType\\": \\"once\\",\\n \\"ElasticGateway\\": false,\\n \\"Category\\": \\"Aliyun\\",\\n \\"ActivatedTime\\": 1577179769,\\n \\"TaskId\\": \\"t-000978oflgrd8ah6p***\\",\\n \\"Location\\": \\"Cloud\\",\\n \\"GatewayRegionId\\": \\"cn-hangzhou\\",\\n \\"UntrustedEnvInstanceType\\": \\"ecs.g6.large\\",\\n \\"HighAvailability\\": false,\\n \\"SecondaryVSwitchId\\": \\"vsw-bp1krhkgnahkb8stp0***\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeGateways',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UpdateGatewayFileShare' => [
- 'summary' => 'Updates the configuration of a share for a file gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGateways'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGateways',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'DescribeRegions' => [
+ 'summary' => 'You can call the DescribeRegions operation to query the valid regions for gateways.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeCode' => '17228',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000c6hshwukkbryp****',
- ],
- ],
- [
- 'name' => 'IndexId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'NFStest',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'name',
- ],
- ],
- [
- 'name' => 'RemoteSync',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'RemoteSyncDownload',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'PollingInterval',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '36000',
- ],
- ],
- [
- 'name' => 'IgnoreDelete',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'FrontendLimit',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'BackendLimit',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'DownloadLimit',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'InPlace',
- 'in' => 'query',
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E09C421A-A175-4D21-8928-ADF5643D15F8', 'title' => ''],
+ 'Regions' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Region' => [
+ 'description' => 'The list of regions.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'CacheMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Cache',
- ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"E09C421A-A175-4D21-8928-ADF5643D15F8\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DescribeRegions',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'],
],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DescribeStorageBundle' => [
+ 'summary' => 'Queries information about a gateway cluster, including its region, timestamp, name, and description.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Browsable',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ ],
+ 'parameters' => [
[
- 'name' => 'Squash',
+ 'name' => 'StorageBundleId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'none',
- ],
+ 'schema' => ['description' => 'The ID of the gateway cluster.', 'docRequired' => true, 'required' => true, 'type' => 'string', 'example' => 'sb-0007y2889yyxkuqov***', 'title' => ''],
],
- [
- 'name' => 'ReadWriteUserList',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'properties' => [
+ 'Description' => ['description' => 'The description of the gateway cluster.', 'example' => 'Test cluster', 'type' => 'string', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The UNIX timestamp when the gateway cluster was created. Unit: seconds.', 'format' => 'int64', 'type' => 'integer', 'example' => '1657706998', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '736C7733-FCED-4AFB-8407-C325F210CE03', 'title' => ''],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'StorageBundleId' => ['description' => 'The ID of the gateway cluster.', 'type' => 'string', 'example' => 'sb-000dt67z4ijqfocpy***', 'title' => ''],
+ 'BackendBucketRegionId' => ['description' => 'The region where the gateway cluster is located.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Name' => ['description' => 'The name of the gateway cluster.', 'type' => 'string', 'example' => 'sdfa***', 'title' => ''],
+ ],
+ 'type' => 'object',
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user1,user2',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'ReadOnlyUserList',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user1,user2',
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'EmptyStorageBundleId', 'errorMessage' => 'You must enter a valid ID for the gateway cluster.', 'description' => 'You must enter a valid ID for the gateway cluster.'],
],
- [
- 'name' => 'ReadWriteClientList',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '172.16.146.100',
- ],
+ 404 => [
+ ['errorCode' => 'StorageBundleNotExist', 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', 'description' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.'],
],
- [
- 'name' => 'ReadOnlyClientList',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '172.16.146.100',
- ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"Test cluster\\",\\n \\"CreatedTime\\": 1657706998,\\n \\"RequestId\\": \\"736C7733-FCED-4AFB-8407-C325F210CE03\\",\\n \\"Message\\": \\"successful\\",\\n \\"StorageBundleId\\": \\"sb-000dt67z4ijqfocpy***\\",\\n \\"BackendBucketRegionId\\": \\"cn-shanghai\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Name\\": \\"sdfa***\\"\\n}","type":"json"}]',
+ 'title' => 'DescribeStorageBundle',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeStorageBundle'],
],
+ ],
+ 'ramActions' => [
[
- 'name' => 'LagPeriod',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '5',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeStorageBundle',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'translator' => 'machine',
+ ],
+ 'DescribeStorageBundles' => [
+ 'summary' => 'Queries information about storage bundles, including their names, descriptions, and creation time.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DirectIO',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ ],
+ 'parameters' => [
[
- 'name' => 'ServerSideEncryption',
+ 'name' => 'BackendBucketRegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The region where the gateway cluster resides. You can call the DescribeRegions operation to obtain a valid region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ServerSideCmk',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'b1e08822-1e9c-4f8e-9dd1-a740cb200***',
- ],
+ 'schema' => ['description' => 'The page number of the gateway cluster list.'."\n"
+ ."\n"
+ .'Start value: 1.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ClientSideEncryption',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page for a paged query.'."\n"
+ ."\n"
+ .'Maximum value: 50.'."\n"
+ ."\n"
+ .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '10', 'example' => '10', 'title' => ''],
],
- [
- 'name' => 'ClientSideCmk',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => 'The total number of gateway clusters.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1EB4639B-0812-4F2D-AB78-194E67645E357', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the gateway cluster list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'StorageBundles' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'StorageBundle' => [
+ 'description' => 'The information about the gateway clusters.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => 'The description of the gateway cluster.', 'type' => 'string', 'example' => 'For testing', 'title' => ''],
+ 'BackendBucketRegionId' => ['description' => 'The region where the gateway cluster resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'StorageBundleId' => ['description' => 'The ID of the gateway cluster.', 'type' => 'string', 'example' => 'sb-000ibk4xrlr03qrjr***', 'title' => ''],
+ 'Name' => ['description' => 'The name of the gateway cluster.', 'type' => 'string', 'example' => 'zy-test***', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the gateway cluster was created. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1565750633', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'b1e08822-1e9c-4f8e-9dd1-a740cb200***',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'KmsRotatePeriod',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'BadPageSize', 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', 'description' => 'The specified number of pages is invalid. The number ranges from 1 to 50.'],
+ ['errorCode' => 'BadPageNumber', 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.', 'description' => 'The specified page number is invalid. The page number must be greater than 0.'],
+ ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'The specified RegionId does not exist. You must specify a valid RegionId.', 'description' => 'The specified RegionId does not exist. You must specify a valid RegionId.'],
],
- [
- 'name' => 'FastReclaim',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"1EB4639B-0812-4F2D-AB78-194E67645E357\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"StorageBundles\\": {\\n \\"StorageBundle\\": [\\n {\\n \\"Description\\": \\"For testing\\",\\n \\"BackendBucketRegionId\\": \\"cn-hangzhou\\",\\n \\"StorageBundleId\\": \\"sb-000ibk4xrlr03qrjr***\\",\\n \\"Name\\": \\"zy-test***\\",\\n \\"CreatedTime\\": 1565750633\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'DescribeStorageBundles',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeStorageBundles'],
],
+ ],
+ 'ramActions' => [
[
- 'name' => 'WindowsAcl',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeStorageBundles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'translator' => 'machine',
+ ],
+ 'DescribeTasks' => [
+ 'summary' => 'Queries task information, including task progress and name.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'AccessBasedEnumeration',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ ],
+ 'parameters' => [
[
- 'name' => 'NfsV4Optimization',
+ 'name' => 'TargetId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The ID of the gateway or express synchronization group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sync-0001xv757xl9sn548***', 'title' => ''],
],
[
- 'name' => 'TransferAcceleration',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The page number.'."\n"
+ ."\n"
+ .'* Page starts from page 1.'."\n"
+ .'* Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''],
],
[
- 'name' => 'BypassCacheRead',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'* Maximum value: 50.'."\n"
+ .'* Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10', 'title' => ''],
],
[
- 'name' => 'ServerSideAlgorithm',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The task ID. If you leave the parameter empty, all tasks are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 't-0001xv7je357xl9n***', 'title' => ''],
],
],
'responses' => [
@@ -5596,113 +5067,107 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-000avsri6tlyddgf****',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EBAF769F-2E88-4D81-AF1E-A34FAACF9***',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
+ 'TotalCount' => ['description' => 'The total number of tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Tasks' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SimpleTask' => [
+ 'description' => 'The task information.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'StateCode' => ['description' => 'The status code of the task. Valid values:'."\n"
+ ."\n"
+ .'* task.state.Initialized'."\n"
+ .'* task.state.Running'."\n"
+ .'* task.state.completed'."\n"
+ .'* task.state.Failed'."\n", 'type' => 'string', 'example' => 'task.state.completed', 'title' => ''],
+ 'Progress' => ['description' => 'The task progress in percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'UpdatedTime' => ['description' => 'The timestamp when the task was last modified. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1578367230', 'title' => ''],
+ 'MessageKey' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Name' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'task.name.operate_fast_sync.delete', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The timestamp when the task was created. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1578367229', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 't-0001xv7je357xl9n***', 'title' => ''],
+ 'RelatedResourceId' => ['description' => 'The ID of the associated resource.'."\n", 'type' => 'string', 'example' => 'NFSnfstest', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8E9C6D43-4603-4F05-BE76-677A05EDFB7A', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter.FileShare.%s',
- 'errorMessage' => 'The specified field %s for file share is invalid. Please check it again.',
- ],
- [
- 'errorCode' => 'VersionNotSupported.FileShare.%s',
- 'errorMessage' => 'The specified field %s for file share is not supported by current gateway version. Please check it again.',
- ],
+ ['errorCode' => 'EmptyTargetId', 'errorMessage' => 'You must enter a valid ID for the target gateway.', 'description' => 'You must enter a valid ID for the target gateway.'],
+ ['errorCode' => 'BadPageSize', 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', 'description' => 'The specified number of pages is invalid. The number ranges from 1 to 50.'],
+ ['errorCode' => 'BadPageNumber', 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.', 'description' => 'The specified page number is invalid. The page number must be greater than 0.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000avsri6tlyddgf****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EBAF769F-2E88-4D81-AF1E-A34FAACF9***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateGatewayFileShareResponse>\\n <TaskId>t-000avsri6tlyddgf****</TaskId>\\n <Message>successful</Message>\\n <RequestId>EBAF769F-2E88-4D81-AF1E-A34FAACF9***</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateGatewayFileShareResponse>","errorExample":""}]',
- 'title' => 'UpdateGatewayFileShare',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteGatewayFileShares' => [
- 'summary' => 'Deletes a share from a gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"Tasks\\": {\\n \\"SimpleTask\\": [\\n {\\n \\"StateCode\\": \\"task.state.completed\\",\\n \\"Progress\\": 100,\\n \\"UpdatedTime\\": 1578367230,\\n \\"MessageKey\\": \\"xxx\\",\\n \\"Name\\": \\"task.name.operate_fast_sync.delete\\",\\n \\"CreatedTime\\": 1578367229,\\n \\"TaskId\\": \\"t-0001xv7je357xl9n***\\",\\n \\"RelatedResourceId\\": \\"NFSnfstest\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"8E9C6D43-4603-4F05-BE76-677A05EDFB7A\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeTasksResponse>\\n <TotalCount>1</TotalCount>\\n <Tasks>\\n <SimpleTask>\\n <Progress>100</Progress>\\n <CreatedTime>1578367229</CreatedTime>\\n <TaskId>t-0001xv7je357xl9n9***</TaskId>\\n <StateCode>task.state.completed</StateCode>\\n <UpdatedTime>1578367230</UpdatedTime>\\n <StageCode>completed</StageCode>\\n <Name>task.name.operate_fast_sync.delete</Name>\\n </SimpleTask>\\n </Tasks>\\n <Message>successful</Message>\\n <PageSize>10</PageSize>\\n <RequestId>8E9C6D43-4603-4F05-BE76-677A05EDFB7A</RequestId>\\n <PageNumber>1</PageNumber>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeTasksResponse>","errorExample":""}]',
+ 'title' => 'DescribeTasks',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 30, 'regionId' => '*', 'api' => 'DescribeTasks'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DisableGatewayLogging' => [
+ 'summary' => 'Disables the log monitoring feature for a gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwR40N8S'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The gateway ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbv****',
- ],
- ],
- [
- 'name' => 'IndexId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the share. You can call the DescribeGatewayFileShares operation to query the share ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'NFSalex***',
- ],
- ],
- [
- 'name' => 'Force',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to forcibly delete the share if data synchronization is not complete for the share. Valid values:'."\n"
- ."\n"
- .'* true: forcibly deletes the share. Proceed with caution.'."\n"
- .'* false: does not forcibly delete the share. This is the default value.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwb***', 'title' => ''],
],
],
'responses' => [
@@ -5710,129 +5175,78 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => 'The ID of the task.'."\n",
- 'type' => 'string',
- 'example' => 't-000c6hshwukkcfn****',
- ],
- 'Message' => [
- 'description' => 'The returned message.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 't-000czaedx5koz578vk**',
- ],
- 'Code' => [
- 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25288205-A591-4AA9-ACF8-427E8727A9D3', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyShareIndexId',
- 'errorMessage' => 'You must enter a valid file sharing ID.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayLoggingStatusNotAllowed', 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.', 'description' => 'Failed to perform the operation because log monitoring is not enabled.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkcfn****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"t-000czaedx5koz578vk**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGatewayFileSharesResponse>\\n <TaskId>t-000c6hshwukkcfn****</TaskId>\\n <Message>successful</Message>\\n <RequestId>D3205DCC-D32B-497D-BB49-E212C608AD**</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteGatewayFileSharesResponse>","errorExample":""}]',
- 'title' => 'DeleteGatewayFileShares',
- 'description' => '### [](#)Usage notes'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"25288205-A591-4AA9-ACF8-427E8727A9D3\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DisableGatewayLogging',
+ 'description' => '### Description'."\n"
."\n"
- .'**'."\n"
+ .'Before you call this operation, note the following:'."\n"
."\n"
- .'**Warning** Deleting shares will interrupt your business continuity and data synchronization tasks. Exercise caution when performing this action.'."\n",
+ .'- You can call this operation to temporarily disable the log monitoring feature for a gateway.'."\n"
+ .'- Make sure that you have created a Cloud Storage Gateway and enabled the log monitoring feature for it. The status of the log monitoring feature must be Enabled.'."\n"
+ .'- You can call the DescribeGatewayLogging operation to query the status of the log monitoring feature for a gateway.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeGatewayNFSClients' => [
- 'summary' => 'Queries the NFS clients of a file gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 30, 'regionId' => '*', 'api' => 'DisableGatewayLogging'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DisableGatewayLogging',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'EnableGatewayLogging' => [
+ 'summary' => 'Enables log monitoring for a gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwR40N8S'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000gchoknplv4f27****',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbv***', 'title' => ''],
],
],
'responses' => [
@@ -5840,178 +5254,93 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Version40Enabled' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Version41Enabled' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F694EBF3-59AB-1DDD-B5B4-87CB7D6A****',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Version3Enabled' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ClientInfoList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ClientInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'HasNFSv40' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'HasNFSv41' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'HasNFSv3' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ClientIpAddr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '172.16.XX.XX',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CAE39768-CE96-4E16-A9F7-1FF9AE8E3FBF', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'BadPageSize',
- 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
- ],
- [
- 'errorCode' => 'BadPageNumber',
- 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayLoggingStatusNotAllowed', 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.', 'description' => 'Failed to perform the operation because log monitoring is not enabled.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Version40Enabled\\": true,\\n \\"Version41Enabled\\": false,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"F694EBF3-59AB-1DDD-B5B4-87CB7D6A****\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Version3Enabled\\": true,\\n \\"ClientInfoList\\": {\\n \\"ClientInfo\\": [\\n {\\n \\"HasNFSv40\\": true,\\n \\"HasNFSv41\\": false,\\n \\"HasNFSv3\\": true,\\n \\"ClientIpAddr\\": \\"172.16.XX.XX\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'DescribeGatewayNFSClients',
- ],
- 'ModifyGatewayFileShareWatermark' => [
- 'summary' => 'Modifies the threshold for cache data drop.',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CAE39768-CE96-4E16-A9F7-1FF9AE8E3FBF\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'EnableGatewayLogging',
+ 'description' => '### Description'."\n"
+ ."\n"
+ .'Before you call this operation, note the following:'."\n"
+ ."\n"
+ .'- You can call this operation to enable the log monitoring feature for a specified gateway.'."\n"
+ .'- Make sure that a Cloud Storage Gateway is created and that the log monitoring feature for the gateway is in the Disabled state.'."\n"
+ .'- You can call the DescribeGatewayLogging operation to query the status of gateway log monitoring.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 30, 'regionId' => '*', 'api' => 'EnableGatewayLogging'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:EnableGatewayLogging',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExpandCacheDisk' => [
+ 'summary' => 'Expands the cache disk of a Cloud Storage Gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '17242',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwLTSLKH'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-0001xv7je3580031****',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', 'title' => ''],
],
[
- 'name' => 'IndexId',
+ 'name' => 'NewSizeInGB',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'NFSalex****',
- ],
+ 'schema' => ['description' => 'The capacity of the cache disk after it is scaled out. Unit: GB. The following requirements must be met:'."\n"
+ ."\n"
+ .'- The capacity of the cache disk after it is scaled out cannot be smaller than the original capacity. You cannot scale in a cache disk.'."\n"
+ .'- The maximum capacity of a cache disk for a Basic gateway is 4 TB. The maximum capacity of a cache disk for a Medium gateway is 8 TB. The maximum capacity of a cache disk for an Enhanced or Performance gateway is 32 TB.'."\n"
+ .'- The minimum capacity of a cache disk for a file gateway is 40 GB. The minimum capacity of a cache disk for an iSCSI gateway is 20 GB.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '101', 'title' => ''],
],
[
- 'name' => 'Watermark',
+ 'name' => 'LocalFilePath',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '90',
- 'minimum' => '40',
- 'example' => '40'."\n",
- ],
+ 'schema' => ['description' => 'The internal device name of the cache disk. You can call the DescribeGatewayCaches operation to query the internal device name of the cache disk.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/dev/vdb', 'title' => ''],
],
],
'responses' => [
@@ -6019,59 +5348,73 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0001xv7je357xr6q****',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA****',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'BuyURL' => ['description' => 'The URL that is used to pay for the subscription cache disk.', 'type' => 'string', 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***”,”directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy', 'title' => ''],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-000eg44nmxbsh3qk3***', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F8B59F29-453D-49BF-8673-EEB8F9F2D5C6', 'title' => ''],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ .'- false: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CacheNotExist',
- 'errorMessage' => 'The specified cache disk does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayOperationNotAllowed', 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', 'description' => 'You cannot perform the operation when the gateway is in the current state.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
+ ['errorCode' => 'CacheNotExist', 'errorMessage' => 'The specified cache disk does not exist. You must specify a valid parameter.', 'description' => 'The specified cache disk does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'EmptyLocalFilePath', 'errorMessage' => 'You must enter an local file path for the cache disk.', 'description' => 'You must enter an internal device name for the cache disk.'],
+ ['errorCode' => 'InvalidNewSizeInGB', 'errorMessage' => 'The scale-up size that you specified for the cache disk is invalid. You must specify a valid size.', 'description' => 'The scale-up size that you specified for the cache disk is invalid. You must specify a valid size.'],
+ ['errorCode' => 'CacheSizeLimit', 'errorMessage' => 'The maximum size of cache disks for the gateway is 32 TB.', 'description' => 'The maximum cache disk size of the gateway is 32 TB.'],
+ ['errorCode' => 'CacheSizeLimitForBasic', 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Basic gateway is 4 TB.', 'description' => 'The expansion capacity exceeds the maximum cache disk limit. The maximum cache disk limit for Basic Gateway is 4 TB.'],
+ ['errorCode' => 'CacheSizeLimitForStandard', 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Standard gateway is 8 TB.', 'description' => 'The expansion capacity exceeds the maximum cache disk limit. The standard gateway cache disk limit is 8 TB.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***”,”directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}&regionId=cn-hangzhou#/buy\\",\\n \\"TaskId\\": \\"t-000eg44nmxbsh3qk3***\\",\\n \\"RequestId\\": \\"F8B59F29-453D-49BF-8673-EEB8F9F2D5C6\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ExpandCacheDisk',
+ 'description' => 'Before you call this operation, note the following:'."\n"
+ ."\n"
+ .'<props="china">Before you call this operation, make sure that you are familiar with the billing and [pricing](https://www.aliyun.com/price/product?spm=5176.144914.752642.btn2.1fea7d70I6QIr5\\&aly_as=C81M1m5N#/hcs_sgw/detail) of Cloud Storage Gateway.</props> <props="intl">Before you call this operation, make sure that you are familiar with the billing and pricing of Cloud Storage Gateway.</props>'."\n"
+ ."\n"
+ .'- Make sure that a cache disk is created. You can use the purchase URL returned by this operation to complete the payment and expand the cache disk.'."\n"
+ .'- The maximum cache disk capacity is 4 TB for a Basic gateway, 8 TB for a Medium gateway, and 32 TB for an Enhanced or Performance gateway.'."\n"
+ .'- Cloud Storage Gateway lets you scale out cache disks, but you cannot scale them in.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 30, 'regionId' => '*', 'api' => 'ExpandCacheDisk'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ExpandCacheDisk',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xr6q****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'ModifyGatewayFileShareWatermark',
],
'ExpandGatewayFileShare' => [
'summary' => 'Increases the capacity of a share for an on-premises gateway.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6084,9 +5427,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '22312',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
'autoTest' => false,
'notSupportAutoTestReason' => '仅线下网关(用户idc环境)支持该操作',
],
@@ -6094,22 +5435,12 @@
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The gateway ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gw-000eg44nmxbsfwbv****',
- ],
+ 'schema' => ['description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gw-000eg44nmxbsfwbv****', 'title' => ''],
],
[
'name' => 'IndexId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the share. You can call the DescribeGatewayFileShares operation to query the share ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SMBpapcn',
- ],
+ 'schema' => ['description' => 'The ID of the share. You can call the DescribeGatewayFileShares operation to query the share ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SMBpapcn', 'title' => ''],
],
],
'responses' => [
@@ -6117,36 +5448,18 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8****',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'The returned message.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'string',
- 'example' => 't-0001xv7je357xv4s***',
- ],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8****', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 't-0001xv7je357xv4s***', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -6155,17 +5468,30 @@
'description' => 'Before you call this operation, take note of the following information:'."\n"
."\n"
.'In the virtual environment where the on-premises gateway is installed, you must first increase the capacity of the cache disk that corresponds to the share.'."\n",
- ],
- 'CreateGatewaySMBUser' => [
- 'summary' => 'Adds an SMB user and password to a gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExpandGatewayFileShare'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ExpandGatewayFileShare',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExpandGatewayNetworkBandwidth' => [
+ 'summary' => 'Expands the public bandwidth of a gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6174,46 +5500,24 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq2**',
- ],
- ],
- [
- 'name' => 'Username',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'alex',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbv****', 'title' => ''],
],
[
- 'name' => 'Password',
+ 'name' => 'NewNetworkBandwidth',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123***',
- ],
+ 'schema' => ['description' => 'The new network bandwidth. Unit: Mbit/s. Valid values: a value that is greater than the current bandwidth up to 200.'."\n"
+ ."\n"
+ .'> - This parameter is required.'."\n"
+ .'> - The peak bandwidth is for reference only and does not indicate a service level agreement (SLA). It specifies the upper limit of the bandwidth.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -6221,132 +5525,109 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-000c6hshwukkbtxrb***',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9083F167-95B1-4B40-B2CD-70DE068EC3**',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'BuyURL' => ['description' => 'The payment URL for the subscription gateway.', 'type' => 'string', 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&i', 'title' => ''],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-0001xv7je357xv4s****', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8****', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the request is successful. Other values indicate that the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'The result of the request. Valid values:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidSMBUserName',
- 'errorMessage' => 'You must enter a valid SMB username.',
- ],
- [
- 'errorCode' => 'EmptySMBPassword',
- 'errorMessage' => 'You must enter a valid SMB password.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
- [
- 'errorCode' => 'EmptySMBUserName',
- 'errorMessage' => 'You must enter a valid SMB username.',
- ],
- [
- 'errorCode' => 'InvalidSMBPassword',
- 'errorMessage' => 'The specified SMB password is invalid. You must enter a valid password.',
- ],
- [
- 'errorCode' => 'CouldNotCreateSMBUser',
- 'errorMessage' => 'The gateway has linked an AD or LDAP service. You cannot create an SMB user on the gateway. We recommend that you create an SMB user in the AD or LDAP service.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'StorageBundleNotExist',
- 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&i\\",\\n \\"TaskId\\": \\"t-0001xv7je357xv4s****\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8****\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ExpandGatewayNetworkBandwidth',
+ 'description' => 'When you call this operation, note the following:'."\n"
+ ."\n"
+ .'If the gateway and the target OSS bucket are in different regions, you must call this operation to expand the public bandwidth for cross-region mounting.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExpandGatewayNetworkBandwidth'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ExpandGatewayNetworkBandwidth',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkbtxrb***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9083F167-95B1-4B40-B2CD-70DE068EC3**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateGatewaySMBUserResponse>\\n <TaskId>t-000c6hshwukkbtxrb***</TaskId>\\n <Message>successful</Message>\\n <RequestId>9083F167-95B1-4B40-B2CD-70DE068EC3**</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateGatewaySMBUserResponse>","errorExample":""}]',
- 'title' => 'CreateGatewaySMBUser',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'DeleteGatewaySMBUser' => [
- 'summary' => 'Deletes a Server Message Block (SMB) user from a gateway.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListAlertEvents' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
- ],
+ 'abilityTreeCode' => '191531',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000c6hshwukkbrypj***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => false, 'example' => 'gw-000eg44nmxbsfwbvq***', 'title' => ''],
],
[
- 'name' => 'Username',
+ 'name' => 'ShareIndexId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username',
- ],
+ 'schema' => ['description' => 'The share name.', 'type' => 'string', 'required' => false, 'example' => 'nfs_share', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '10', 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'FirstTriggerTimestampStartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1761559501337', 'title' => ''],
+ ],
+ [
+ 'name' => 'FirstTriggerTimestampEndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1761570323090', 'title' => ''],
+ ],
+ [
+ 'name' => 'GatewayRegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the region where the gateway is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The status of the alert events.'."\n"
+ ."\n"
+ .'- If you set this parameter to **alerting**, only the events that are being triggered are listed.'."\n"
+ ."\n"
+ .'- If you do not specify this parameter, all alert events are listed.', 'type' => 'string', 'required' => false, 'example' => 'alerting', 'title' => ''],
],
],
'responses' => [
@@ -6354,89 +5635,90 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-000c6hshwukkcfn3k**',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '395B1136-982E-4F95-BDCE-7323FFEF499E', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ ."\n"
+ .'- true: The call was successful.'."\n"
+ ."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of alert events.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'AlertEvents' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The alert type. Valid values:'."\n"
+ ."\n"
+ .'- throttling: Throttling.'."\n"
+ ."\n"
+ .'- uploadQueueFull: The upload queue is full.'."\n"
+ ."\n"
+ .'- lowMetaSpace: The metadata space is insufficient.', 'type' => 'string', 'example' => 'uploadQueueFull', 'title' => ''],
+ 'FirstTriggerTimestamp' => ['description' => 'The time when the alert was first triggered. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1761559501337', 'title' => ''],
+ 'GatewayId' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'example' => 'gw-000dx594q3j5o663s8nx', 'title' => ''],
+ 'LastTriggerTimestamp' => ['description' => 'The time when the alert was last triggered. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1761570323090', 'title' => ''],
+ 'StorageBundleId' => ['description' => 'The ID of the gateway cluster.', 'type' => 'string', 'example' => 'sb-000iymnht76bdwsho0lm', 'title' => ''],
+ 'ShareIndexId' => ['description' => 'The index ID of the share.', 'type' => 'string', 'example' => 'NFSnfs_share', 'title' => ''],
+ 'Level' => ['description' => 'The severity level of the alert. The value is warn.', 'type' => 'string', 'example' => 'warn', 'title' => ''],
+ 'AccountId' => ['description' => 'This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '”“', 'title' => ''],
+ 'Status' => ['description' => 'The status of the alert event. Valid values:'."\n"
+ ."\n"
+ .'- alerting: The alert is being triggered.'."\n"
+ ."\n"
+ .'- restored: The service has returned to normal.'."\n"
+ ."\n"
+ .'- gatewayDeleted: The gateway is deleted.'."\n"
+ ."\n"
+ .'- shareDeleted: The share is deleted.', 'type' => 'string', 'example' => 'alerting', 'title' => ''],
+ 'RegionId' => ['description' => 'The ID of the region where the gateway is located.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''],
+ 'Display' => ['description' => 'This parameter is deprecated.', 'type' => 'boolean', 'example' => '”“', 'title' => ''],
+ 'ShareStatus' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '”“', 'title' => ''],
+ 'GatewayStatus' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '”“', 'title' => ''],
+ ],
+ 'description' => 'The information about the alert event.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The information about the alert events.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EmptySMBUserName',
- 'errorMessage' => 'You must enter a valid SMB username.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInUpgrading',
- 'errorMessage' => 'The gateway is upgrading. Try again later.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
- [
- 'errorCode' => 'GatewayStatusRunningRequired',
- 'errorMessage' => 'The gateway is not in the Running state. Try again later.',
- ],
- [
- 'errorCode' => 'InvalidSMBUserName',
- 'errorMessage' => 'You must enter a valid SMB username.',
- ],
- [
- 'errorCode' => 'CouldNotDeleteSMBUser',
- 'errorMessage' => 'The gateway is already linked with an AD or LDAP service. You cannot delete an SMB user on the gateway. We recommend that you delete an SMB user in the AD or LDAP service.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.',
+ 'title' => 'ListAlertEvents',
+ 'summary' => 'Lists alert events for a gateway.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ListAlertEvents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkcfn3k**\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGatewaySMBUserResponse>\\n <TaskId>t-000c6hshwukkcfn3k**</TaskId>\\n <Message>successful</Message>\\n <RequestId>89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteGatewaySMBUserResponse>","errorExample":""}]',
- 'title' => 'DeleteGatewaySMBUser',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"395B1136-982E-4F95-BDCE-7323FFEF499E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 20,\\n \\"AlertEvents\\": [\\n {\\n \\"Type\\": \\"uploadQueueFull\\",\\n \\"FirstTriggerTimestamp\\": 1761559501337,\\n \\"GatewayId\\": \\"gw-000dx594q3j5o663s8nx\\",\\n \\"LastTriggerTimestamp\\": 1761570323090,\\n \\"StorageBundleId\\": \\"sb-000iymnht76bdwsho0lm\\",\\n \\"ShareIndexId\\": \\"NFSnfs_share\\",\\n \\"Level\\": \\"warn\\",\\n \\"AccountId\\": 0,\\n \\"Status\\": \\"alerting\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Display\\": true,\\n \\"ShareStatus\\": \\"”“\\",\\n \\"GatewayStatus\\": \\"”“\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DescribeGatewaySMBUsers' => [
- 'summary' => 'Queries the SMB users of a gateway.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListTagResources' => [
+ 'summary' => 'Lists the tags attached to one or more gateways.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6445,47 +5727,77 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
- ],
+ 'abilityTreeCode' => '17247',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw7Q12RI'],
],
'parameters' => [
[
- 'name' => 'GatewayId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbv***',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ResourceRegionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => 'The ID of the resource region.', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The resource type. The value must be GATEWAY.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'GATEWAY'],
+ ],
+ [
+ 'name' => 'NextToken',
'in' => 'query',
+ 'schema' => ['description' => 'The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request. If the number of results exceeds the page size, you can use the token that is returned for the previous request to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '212db86sca4384811e0b5e8707ec21345'],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The IDs of gateways. You can query the tags of N gateways at a time.'."\n"
+ ."\n"
+ .'> - You must specify at least one of ResourceId and Tag.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => 'The IDs of gateways. You can query the tags of N gateways at a time. N can be an integer from 1 to 50.'."\n"
+ ."\n"
+ .'> You must specify at least one of ResourceId.N and Tag.N.Key.', 'required' => false, 'title' => '', 'example' => 'gw-uf6wjk5xxxxxxx'],
'required' => false,
- 'example' => '1',
- 'default' => '1',
+ 'example' => 'gw-uf6wjk5xxxxxxx',
+ 'maxItems' => 51,
+ 'title' => '',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key. You can query N tag keys at a time. N can be an integer from 1 to 20. The tag key cannot be an empty string.'."\n"
+ ."\n"
+ .'> You must specify at least one of ResourceId.N and Tag.N.Key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'testkey1'],
+ 'Value' => ['description' => 'The tag value of the tag key. You can query N tag values at a time. N can be an integer from 1 to 20. The tag value can be an empty string.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'testvalue1'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '10',
- 'default' => '10',
+ 'maxItems' => 21,
+ 'description' => 'The tags.'."\n"
+ ."\n"
+ .'> - You must specify at least one of ResourceId and Tag.',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -6494,106 +5806,99 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4C02F482-FC2E-45BF-88C5-8D40134D11**',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Users' => [
+ 'NextToken' => ['description' => 'If not all results are returned in a query, you can use the token that is returned for the previous query to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'example' => '212db86sca4384811e0b5e8707ec21345'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '47A514A1-4B77-4E30-B4C5-2A880650B3FD'],
+ 'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'User' => [
- 'description' => '',
+ 'TagResource' => [
+ 'description' => 'The information about the queried gateways and tags.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Username' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alex***',
- ],
+ 'ResourceType' => ['description' => 'The resource type. ALIYUN::HCS\\_SGW::GATEWAY indicates a Cloud Storage Gateway.', 'type' => 'string', 'title' => '', 'example' => 'ALIYUN::HCS_SGW::GATEWAY'],
+ 'TagValue' => ['description' => 'The tag value of the tag key.', 'type' => 'string', 'title' => '', 'example' => 'testvalue1'],
+ 'ResourceId' => ['description' => 'The gateway ID.', 'type' => 'string', 'title' => '', 'example' => '47A514A1-4B77-4E30-B4C5-2A880650B3FD '],
+ 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'testkey1 '],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ActiveDirectory' => [
- 'type' => 'boolean',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'BadPageSize',
- 'errorMessage' => 'The specified number of pages is invalid. The number ranges from 1 to 50.',
- ],
- [
- 'errorCode' => 'BadPageNumber',
- 'errorMessage' => 'The specified page number is invalid. The page number must be greater than 0.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
+ ['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'The parameter - ResourceIds.N should not be null.', 'description' => ''],
+ ['errorCode' => 'MissingParameter.Tags', 'errorMessage' => 'The parameter - Tags should not be null.', 'description' => ''],
+ ['errorCode' => 'Missing.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is blank.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contain duplicate key.', 'description' => ''],
+ ['errorCode' => 'MissingParameter.TagOrResourceId', 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.', 'description' => ''],
+ ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50', 'description' => ''],
+ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter\'s number is exceed , Valid : 20', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'PermissionDenied.Scope', 'errorMessage' => 'The specified operator not have permission to set Scope value.', 'description' => ''],
+ ['errorCode' => 'PermissionDenied.TagOwnerUid', 'errorMessage' => 'The specified operator not have permission to set TagOwnerUid value.', 'description' => ''],
+ ['errorCode' => 'PermissionDenied.TagOwnerBid', 'errorMessage' => 'The specified operator not have permission to set TagOwnerBid value.', 'description' => ''],
+ ['errorCode' => 'NoPermissionKey.Operator', 'errorMessage' => 'These keys are not permission for this operator.', 'description' => ''],
+ ['errorCode' => 'NoPermissionKey.Scope', 'errorMessage' => 'These keys are not permission for this scope.', 'description' => ''],
+ ['errorCode' => 'NoPermissionKey.Category', 'errorMessage' => 'These keys are not permission for this category.', 'description' => ''],
+ ['errorCode' => 'NoPermission.SystemTag', 'errorMessage' => 'The operator is not permission for the system tag.', 'description' => ''],
+ ['errorCode' => 'NoPermission.Operator', 'errorMessage' => 'The operator is not permission for this operate.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidResourceType.NotFound', 'errorMessage' => 'The ResourceType provided does not exist in our records.', 'description' => ''],
+ ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceId is not found in our records.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"4C02F482-FC2E-45BF-88C5-8D40134D11**\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Users\\": {\\n \\"User\\": [\\n {\\n \\"Username\\": \\"alex***\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"ActiveDirectory\\": false\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewaySMBUsersResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>4C02F482-FC2E-45BF-88C5-8D40134D11**</RequestId>\\n <Message>successful</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Users>\\n <Username>alex***</Username>\\n </Users>\\n <Code>200</Code>\\n <Success>true</Success>\\n <ActiveDirectory>false</ActiveDirectory>\\n</DescribeGatewaySMBUsersResponse>","errorExample":""}]',
- 'title' => 'DescribeGatewaySMBUsers',
+ 'title' => 'ListTagResources',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SetGatewayDNS' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ListTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707ec21345\\",\\n \\"RequestId\\": \\"47A514A1-4B77-4E30-B4C5-2A880650B3FD\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::HCS_SGW::GATEWAY\\",\\n \\"TagValue\\": \\"testvalue1\\",\\n \\"ResourceId\\": \\"47A514A1-4B77-4E30-B4C5-2A880650B3FD\\\\t\\",\\n \\"TagKey\\": \\"testkey1\\\\t\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ModifyGateway' => [
+ 'summary' => 'Modifies a specified gateway\'s basic information, including its name and description.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6601,29 +5906,27 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ ],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000c6hshwukkbryp****',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031y***', 'title' => ''],
],
[
- 'name' => 'DnsServer',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '100.100.XX.XX,100.100.XX.XX',
- ],
+ 'schema' => ['description' => 'The new name of the gateway. The name must be 1 to 60 characters in length. It can contain uppercase letters, lowercase letters, Chinese characters, digits, periods (.), underscores (\\_), or hyphens (-). The name must start with an uppercase letter, a lowercase letter, or a Chinese character.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The new description of the gateway. The description can be 0 to 255 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'For testing', 'title' => ''],
],
],
'responses' => [
@@ -6631,104 +5934,88 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-000czaedx5koz578****',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '220E7407-DF77-428D-8955-B02CF8F82D07', 'title' => ''],
+ 'GatewayId' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'example' => 'gw-0001xv7je3580031y***', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidDNS',
- 'errorMessage' => 'The specified parameter includes one or more invalid IP addresses. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'EmptyGatewayName', 'errorMessage' => 'You must enter a valid name for the gateway.', 'description' => 'You must enter a valid name for the gateway.'],
+ ['errorCode' => 'InvalidGatewayName', 'errorMessage' => 'The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.', 'description' => 'The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.'],
+ ['errorCode' => 'DescriptionOverLimit', 'errorMessage' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.', 'description' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'DuplicateGatewayName', 'errorMessage' => 'The specified name of the gateway already exists. You must specify a valid name.', 'description' => 'The specified name of the gateway already exists. You must specify a valid name.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000czaedx5koz578****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetGatewayDNSResponse>\\n <TaskId>t-000czaedx5koz578****</TaskId>\\n <RequestId>C5A78764-05A4-4E57-87E6-70C6657698**</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SetGatewayDNSResponse>","errorExample":""}]',
- 'title' => 'SetGatewayDNS',
- 'summary' => 'Configures a DNS server for a gateway.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"220E7407-DF77-428D-8955-B02CF8F82D07\\",\\n \\"GatewayId\\": \\"gw-0001xv7je3580031y***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ModifyGateway',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeGatewayDNS' => [
- 'summary' => 'Queries DNS servers configured for a gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGateway'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'ModifyGatewayClass' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwYT4X0O',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7580031yzun***', 'title' => ''],
+ ],
+ [
+ 'name' => 'GatewayClass',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The gateway class to which you want to upgrade. You can call the DescribeGatewayModificationClasses operation to query the available gateway classes. Valid values:'."\n"
+ ."\n"
+ .'- Basic'."\n"
+ ."\n"
+ .'- Standard'."\n"
+ ."\n"
+ .'- Enhanced'."\n"
+ ."\n"
+ .'- Advanced', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Enhanced', 'title' => ''],
],
],
'responses' => [
@@ -6736,75 +6023,80 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'DnsServer' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100.100.2.136,100.100.2.188',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'BuyURL' => ['description' => 'The URL used to complete the upgrade. This parameter is returned only for subscription gateways.', 'type' => 'string', 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&instanceId=gw-000c6hshwukjwc7e1***#/upgrade', 'title' => ''],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-0001xv7je3580bx6v***', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '395B1136-982E-4F95-BDCE-7323FFEF499E', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the call was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'GatewayInUpgrading',
- 'errorMessage' => 'The gateway is upgrading. Try again later.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
- [
- 'errorCode' => 'GatewayStatusRunningRequired',
- 'errorMessage' => 'The gateway is not in the Running state. Try again later.',
- ],
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'InvalidGatewayClass', 'errorMessage' => 'The specified specification of the gateway is invalid.', 'description' => 'The specified specification of the gateway is invalid.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'LocationCloudRequired', 'errorMessage' => 'You must specify a cloud gateway. Try again later.', 'description' => 'You must specify a cloud gateway. Try again later.'],
+ ['errorCode' => 'GatewayStatusRunningRequired', 'errorMessage' => 'The gateway is not in the Running state. Try again later.', 'description' => 'The gateway is not in the Running state. Try again later.'],
+ ['errorCode' => 'GatewayClassUpgradeOnly', 'errorMessage' => 'You can upgrade only the specification of the gateway.', 'description' => 'You can upgrade only the specification of the gateway.'],
+ ['errorCode' => 'NoAvailableOnlineResource', 'errorMessage' => 'There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.', 'description' => 'There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50\\",\\n \\"Code\\": \\"200\\",\\n \\"DnsServer\\": \\"100.100.2.136,100.100.2.188\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayDNSResponse>\\n <RequestId>ACB4BBBB-9046-4D46-BA93-0737DE78B735</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <DnsServer>100.100.2.136,100.100.2.188</DnsServer>\\n</DescribeGatewayDNSResponse>","errorExample":""}]',
- 'title' => 'DescribeGatewayDNS',
+ 'title' => 'ModifyGatewayClass',
+ 'summary' => 'Upgrades the gateway class of an online gateway.',
+ 'description' => '### Description'."\n"
+ ."\n"
+ .'Note the following when you call this operation:'."\n"
+ ."\n"
+ .'<props="china">'."\n"
+ ."\n"
+ .'- Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product?spm=5176.144914.752642.btn2.1fea7d70I6QIr5\\&aly_as=C81M1m5N#/hcs_sgw/detail) of Cloud Storage Gateway.'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n\n"
+ .'<props="intl">'."\n"
+ ."\n"
+ .'- Before you call this operation, make sure that you understand the pricing of Cloud Storage Gateway.'."\n"
+ ."\n"
+ .'</props>'."\n"
+ ."\n\n"
+ .'- If your gateway is a subscription instance, you must use the purchase URL returned in the response to complete the upgrade.'."\n"
+ ."\n"
+ .'- You can call the DescribeGatewayModificationClasses operation to query the gateway classes to which you can upgrade a specified online gateway.'."\n"
+ ."\n"
+ .'- You can only upgrade an online gateway. You cannot downgrade a gateway.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SetGatewayADInfo' => [
- 'summary' => 'Enables or disables an Active Directory (AD) domain for a gateway.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyGatewayClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&instanceId=gw-000c6hshwukjwc7e1***#/upgrade\\",\\n \\"TaskId\\": \\"t-0001xv7je3580bx6v***\\",\\n \\"RequestId\\": \\"395B1136-982E-4F95-BDCE-7323FFEF499E\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ModifyGatewayFileShareWatermark' => [
+ 'summary' => 'Modifies the watermark for a gateway file share.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6813,64 +6105,29 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwYT4X0O',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbv****',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031****', 'title' => ''],
],
[
- 'name' => 'Username',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ale****',
- ],
- ],
- [
- 'name' => 'Password',
+ 'name' => 'IndexId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The ID of the file share. You can obtain the ID by calling the DescribeGatewayFileShares operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NFSalex****', 'title' => ''],
],
[
- 'name' => 'ServerIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12.12.x.x',
- ],
- ],
- [
- 'name' => 'IsEnabled',
+ 'name' => 'Watermark',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The watermark. The value must be within the following range:'."\n"
+ ."\n"
+ .'- Minimum value: 40.'."\n"
+ .'- Maximum value: 90.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '90', 'minimum' => '40', 'example' => '40'."\n", 'title' => ''],
],
],
'responses' => [
@@ -6878,111 +6135,81 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-000c6hshwukkcfn****',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-0001xv7je357xr6q****', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA****', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the request is successful. Other values indicate that the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'The result of the request. The valid values are:'."\n"
+ ."\n"
+ .'- true: The request is successful.'."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyADUserName',
- 'errorMessage' => 'You must enter a valid username.',
- ],
- [
- 'errorCode' => 'EmptyADPassword',
- 'errorMessage' => 'You must enter a valid password.',
- ],
- [
- 'errorCode' => 'InvalidADServerIp',
- 'errorMessage' => 'The specified IP address for the server is invalid. You must enter a valid IP address.',
- ],
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
+ ['errorCode' => 'CacheNotExist', 'errorMessage' => 'The specified cache disk does not exist. You must specify a valid parameter.', 'description' => 'The specified cache disk does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xr6q****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ModifyGatewayFileShareWatermark',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGatewayFileShareWatermark'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyGatewayFileShareWatermark',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkcfn****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetGatewayADInfoResponse>\\n <TaskId>t-000c6hshwukkcfn****</TaskId>\\n <Message>successful</Message>\\n <RequestId>0F069495-0184-41B9-9D1E-6E4E921D2**</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SetGatewayADInfoResponse>","errorExample":""}]',
- 'title' => 'SetGatewayADInfo',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'DescribeGatewayADInfo' => [
- 'summary' => 'Queries information about the AD server configured for the gateway.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ModifyStorageBundle' => [
+ 'summary' => 'Modifies the basic information of a specified gateway cluster, such as its name and description.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwYT4X0O',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
- 'name' => 'GatewayId',
+ 'name' => 'StorageBundleId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sb-000ibk4xrlr03qrjr***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the gateway cluster. The name must be 1 to 60 characters in length. It can contain letters, Chinese characters, digits, periods (.), underscores (\\_), and hyphens (-). The name must start with a letter or a Chinese character.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex-123***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the gateway cluster. The description cannot exceed 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'For testing', 'title' => ''],
],
],
'responses' => [
@@ -6990,142 +6217,154 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1B0CA0B9-2B0F-478D-ADC5-474C45BF947F',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'DomainName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test***',
- ],
- 'IsEnabled' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Username' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alex***',
- ],
- 'ServerIp' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '47.101.59.199',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '70EACC9C-D07A-4A34-ADA4-77506C42777', 'title' => ''],
+ 'StorageBundleId' => ['description' => 'The ID of the gateway cluster.', 'type' => 'string', 'example' => 'sb-000ibk4xrlr03qr***', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInUpgrading',
- 'errorMessage' => 'The gateway is upgrading. Try again later.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
- [
- 'errorCode' => 'GatewayStatusRunningRequired',
- 'errorMessage' => 'The gateway is not in the Running state. Try again later.',
+ ['errorCode' => 'EmptyStorageBundleId', 'errorMessage' => 'You must enter a valid ID for the gateway cluster.', 'description' => 'You must enter a valid ID for the gateway cluster.'],
+ ['errorCode' => 'EmptyStorageBundleName', 'errorMessage' => 'You must enter a valid name for the gateway cluster.', 'description' => 'You must enter a valid name for the gateway cluster.'],
+ ['errorCode' => 'StorageBundleDescriptionOverLimit', 'errorMessage' => 'The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.', 'description' => 'The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.'],
+ ['errorCode' => 'InvalidStorageBundleName', 'errorMessage' => 'The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.', 'description' => 'The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.'],
+ ],
+ 404 => [
+ ['errorCode' => 'StorageBundleNotExist', 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', 'description' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"70EACC9C-D07A-4A34-ADA4-77506C42777\\",\\n \\"StorageBundleId\\": \\"sb-000ibk4xrlr03qr***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ModifyStorageBundle',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyStorageBundle'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyStorageBundle',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2D3121-8271-5DD7-9957-D52433FF****\\",\\n \\"Message\\": \\"successful\\",\\n \\"DomainName\\": \\"ad.aliyundoc.com\\",\\n \\"IsEnabled\\": true,\\n \\"Username\\": \\" administrator\\",\\n \\"ServerIp\\": \\"47.101.**.***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'DescribeGatewayADInfo',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'translator' => 'machine',
],
- 'CreateGatewayCacheDisk' => [
- 'summary' => 'Creates a cache disk for a gateway.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'OpenSgwService' => [
+ 'summary' => 'Activates the gateway service. The service must be activated before you can use the product.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
+ [
+ 'APP' => [],
+ ],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '17168',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwLTSLKH',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '开通接口,无法反复调用并返回200',
+ 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ECCBBC17-0C21-5272-9754-9C1AAF83****', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2410000000****', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OrderOpend', 'errorMessage' => 'You have already activated the service. Please go to the console to start using it.', 'description' => ''],
+ ['errorCode' => 'OrderNoRealNameAuthentication', 'errorMessage' => 'You have not completed real name authentication yet. Please complete the real-name authentication.', 'description' => 'You have not verified your real name. Please go to <a target = "_blank". href = "https://account.console.aliyun.com/v2/'],
+ ['errorCode' => 'NoAvailabePaymentMetthod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'Account is not bound to payment information'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.', 'description' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'The specified account has overdue payments. We recommend that you add funds to the account now.', 'description' => 'The specified account has overdue payments. We recommend that you add funds to the account now.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ECCBBC17-0C21-5272-9754-9C1AAF83****\\",\\n \\"OrderId\\": \\"2410000000****\\"\\n}","type":"json"}]',
+ 'title' => 'OpenSgwService',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenSgwService'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'CacheDiskCategory',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cloud_efficiency',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:OpenSgwService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'RemoveSharesFromExpressSync' => [
+ 'summary' => 'You can call the RemoveSharesFromExpressSync operation to delete multiple shares from an express synchronization group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CacheDiskSizeInGB',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '17259',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwNGMQUV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ExpressSyncId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '60',
- ],
+ 'schema' => ['description' => 'The ID of the express synchronization group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sync-0001xv7je357xn8tr***', 'title' => ''],
],
[
- 'name' => 'PerformanceLevel',
+ 'name' => 'GatewayShares',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The names of the gateway shares. You can delete multiple shares. The JSON format is:'."\n"
+ ."\n"
+ .'- {"Gateway ID 1":"Share 1,Share 2","Gateway ID 2":"Share 1,Share 2"}', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"gw-000gwgp0j3jp8cb3t***":"share1,share2","gw-0001b2otnkdzte62j***":"weekly"}', 'title' => ''],
],
],
'responses' => [
@@ -7133,114 +6372,79 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'BuyURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***","directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0001xv7je357xv4st***',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '8E69E1A1-9076-4C8C-8ADF-ACD253886E22',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-0001xv7je357xr6ql***', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA3B22', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'LocationCloudRequired',
- 'errorMessage' => 'You must specify a cloud gateway. Try again later.',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
- ],
- [
- 'errorCode' => 'GatewayOperationNotAllowed',
- 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.',
- ],
- [
- 'errorCode' => 'InvalidCacheDiskCategory',
- 'errorMessage' => 'The category that you specified for the cache disk is invalid. You must specify a valid category.',
- ],
- [
- 'errorCode' => 'CacheSizeLimitForBasic',
- 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Basic gateway is 4 TB.',
- ],
- [
- 'errorCode' => 'CacheSizeLimitForStandard',
- 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Standard gateway is 8 TB.',
- ],
- [
- 'errorCode' => 'CacheSizeLimit',
- 'errorMessage' => 'The maximum size of cache disks for the gateway is 32 TB.',
- ],
+ ['errorCode' => 'ExpressSyncNotExist', 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.', 'description' => 'The specified sync group does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'ExpressSyncInOperation', 'errorMessage' => 'The sync group is busy. Try again later.', 'description' => 'The sync group is busy. Try again later.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***\\\\\\",\\\\\\"directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}&regionId=cn-hangzhou#/buy\\",\\n \\"TaskId\\": \\"t-0001xv7je357xv4st***\\",\\n \\"RequestId\\": \\"8E69E1A1-9076-4C8C-8ADF-ACD253886E22\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateGatewayCacheDiskResponse>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&amp;request={\\"gateway_id\\":\\"gw-0007va9bnidei3s8a***\\",\\"directBuy\\":\\"false\\",\\"gateway_class\\":\\"standard\\",\\"cache_cloud_efficiency_size\\":0}&amp;regionId=cn-hangzhou#/buy</BuyURL>\\n <TaskId>t-0001xv7je357xv4st***</TaskId>\\n <RequestId>8E69E1A1-9076-4C8C-8ADF-ACD253886E22</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateGatewayCacheDiskResponse>","errorExample":""}]',
- 'title' => 'CreateGatewayCacheDisk',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xr6ql***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA3B22\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RemoveSharesFromExpressSync',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeGatewayCaches' => [
- 'summary' => 'Queries the information about cache disks of a gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveSharesFromExpressSync'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:RemoveSharesFromExpressSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RestartFileShares' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwLTSLKH',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', 'title' => ''],
+ ],
+ [
+ 'name' => 'ShareProtocol',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The file sharing protocol. Valid values:'."\n"
+ ."\n"
+ .'- SMB'."\n"
+ ."\n"
+ .'- NFS', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NFS', 'title' => ''],
],
],
'responses' => [
@@ -7248,201 +6452,125 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '40797B4D-09D9-482E-B163-CCB568BADE35',
- ],
- 'Caches' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Cache' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'PerformanceLevel' => [
- 'type' => 'string',
- ],
- 'SizeInGB' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '101',
- ],
- 'BuyURL' => [
- 'type' => 'string',
- ],
- 'Iops' => [
- 'description' => 'IOPS。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2605',
- ],
- 'CacheId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd-bp1dcnq8zldree6ok***',
- ],
- 'CacheType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'IsUsed' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ExpiredTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1532510649',
- ],
- 'LocalFilePath' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '/dev/vdb',
- ],
- 'IsNoPartition' => [
- 'type' => 'boolean',
- ],
- 'SubscriptionInstanceId' => [
- 'type' => 'string',
- ],
- 'ExpireStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RenewURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew',
- ],
- 'IsDirectExpand' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-000czaedx5koz578v***', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA** ', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true'."\n"
+ ."\n"
+ .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayInUpgrading',
- 'errorMessage' => 'The gateway is upgrading. Try again later.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
+ ['errorCode' => 'InvalidShareProtocol', 'errorMessage' => 'The specified file sharing type is invalid. Valid values include SMB and NFS. Try again later.', 'description' => 'The specified file sharing type is invalid. Valid values include SMB and NFS. Try again later.'],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'description' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"40797B4D-09D9-482E-B163-CCB568BADE35\\",\\n \\"Caches\\": {\\n \\"Cache\\": [\\n {\\n \\"PerformanceLevel\\": \\"PL1\\",\\n \\"SizeInGB\\": 100,\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy\\",\\n \\"Iops\\": 2605,\\n \\"CacheId\\": \\"d-bp1dcnq8zldree6ok***\\",\\n \\"CacheType\\": \\"cloud_efficiency\\",\\n \\"IsUsed\\": false,\\n \\"ExpiredTime\\": 1532510649,\\n \\"LocalFilePath\\": \\"/dev/vdb\\",\\n \\"IsNoPartition\\": true,\\n \\"SubscriptionInstanceId\\": \\"ca-000bq2fkzol56575***\\",\\n \\"ExpireStatus\\": 0,\\n \\"RenewURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew\\",\\n \\"IsDirectExpand\\": \\"true\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayCachesResponse>\\n <Message>successful</Message>\\n <RequestId>40797B4D-09D9-482E-B163-CCB568BADE35</RequestId>\\n <Caches>\\n <PerformanceLevel>PL1</PerformanceLevel>\\n <SizeInGB>100</SizeInGB>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&amp;orderType=RENEW&amp;instanceId=ca-0007va9bnideidnd***#/buy</BuyURL>\\n <Iops>2605</Iops>\\n <CacheId>d-bp1dcnq8zldree6ok***</CacheId>\\n <CacheType>cloud_efficiency</CacheType>\\n <IsUsed>false</IsUsed>\\n <ExpiredTime>1532510649</ExpiredTime>\\n <LocalFilePath>/dev/vdb</LocalFilePath>\\n <IsNoPartition>true</IsNoPartition>\\n <SubscriptionInstanceId>ca-000bq2fkzol56575***</SubscriptionInstanceId>\\n <ExpireStatus>0</ExpireStatus>\\n <RenewURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&amp;orderType=RENEW&amp;instanceId=ca-0007va9bnideidnd***#/renew</RenewURL>\\n <IsDirectExpand>true</IsDirectExpand>\\n </Caches>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayCachesResponse>","errorExample":""}]',
- 'title' => 'DescribeGatewayCaches',
+ 'title' => 'RestartFileShares',
+ 'summary' => 'Restarts file shares on a Cloud Storage Gateway.',
+ 'description' => '### Description'."\n"
+ ."\n"
+ .'><warning>'."\n"
+ ."\n"
+ .'Restarting file shares temporarily interrupts your services. Proceed with caution.'."\n"
+ ."\n"
+ .'></warning>',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ExpandCacheDisk' => [
- 'summary' => 'Increases the cache disk capacity.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:RestartFileShares',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-000czaedx5koz578v***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA** \\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'SetGatewayADInfo' => [
+ 'summary' => 'Sets or purges the AD server information for a gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '17242',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwLTSLKH',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwYT4X0O'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbv****', 'title' => ''],
],
[
- 'name' => 'NewSizeInGB',
+ 'name' => 'Username',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '101',
- ],
+ 'schema' => ['description' => 'The username that is used to connect to the AD server. Valid values:'."\n"
+ ."\n"
+ .'- If IsEnabled is set to false, you can leave this parameter empty.'."\n"
+ .'- If IsEnabled is set to true, this parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'ale****', 'title' => ''],
],
[
- 'name' => 'LocalFilePath',
+ 'name' => 'Password',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '/dev/vdb',
- ],
+ 'schema' => ['description' => 'The password that is used to connect to the AD server. Valid values:'."\n"
+ ."\n"
+ .'- If IsEnabled is set to false, you can leave this parameter empty.'."\n"
+ .'- If IsEnabled is set to true, this parameter is required.', 'type' => 'string', 'required' => false, 'example' => '12****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ServerIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IP address of the AD server. Valid values:'."\n"
+ ."\n"
+ .'- If IsEnabled is set to false, you can leave this parameter empty.'."\n"
+ .'- If IsEnabled is set to true, this parameter is required. You must enter a valid IP address that consists of digits and periods (.).', 'type' => 'string', 'required' => false, 'example' => '12.12.x.x', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsEnabled',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable the AD server. Valid values:'."\n"
+ ."\n"
+ .'- true: enables the AD server.'."\n"
+ .'- false (default): purges the AD server information.'."\n"
+ ."\n"
+ .'><notice>'."\n"
+ ."\n"
+ .'- If you want to enable the AD server, all parameters are required.'."\n"
+ .'- If you want to disable the AD server, you only need to set IsEnabled to false.'."\n"
+ ."\n"
+ .'</notice>', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
@@ -7450,104 +6578,64 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'BuyURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***”,”directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-000eg44nmxbsh3qk3***',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F8B59F29-453D-49BF-8673-EEB8F9F2D5C6',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-000c6hshwukkcfn****', 'title' => ''],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'GatewayOperationNotAllowed',
- 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.',
- ],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
- ],
- [
- 'errorCode' => 'CacheNotExist',
- 'errorMessage' => 'The specified cache disk does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'EmptyLocalFilePath',
- 'errorMessage' => 'You must enter an local file path for the cache disk.',
- ],
- [
- 'errorCode' => 'InvalidNewSizeInGB',
- 'errorMessage' => 'The scale-up size that you specified for the cache disk is invalid. You must specify a valid size.',
- ],
- [
- 'errorCode' => 'CacheSizeLimit',
- 'errorMessage' => 'The maximum size of cache disks for the gateway is 32 TB.',
- ],
- [
- 'errorCode' => 'CacheSizeLimitForBasic',
- 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Basic gateway is 4 TB.',
- ],
- [
- 'errorCode' => 'CacheSizeLimitForStandard',
- 'errorMessage' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Standard gateway is 8 TB.',
- ],
+ ['errorCode' => 'EmptyADUserName', 'errorMessage' => 'You must enter a valid username.', 'description' => 'You must enter a valid username.'],
+ ['errorCode' => 'EmptyADPassword', 'errorMessage' => 'You must enter a valid password.', 'description' => 'You must enter a valid password.'],
+ ['errorCode' => 'InvalidADServerIp', 'errorMessage' => 'The specified IP address for the server is invalid. You must enter a valid IP address.', 'description' => 'The specified IP address for the server is invalid. You must enter a valid IP address.'],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'description' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\\\\\\"gateway_id\\\\\\":\\\\\\"gw-0007va9bnidei3s8a***”,”directBuy\\\\\\":\\\\\\"false\\\\\\",\\\\\\"gateway_class\\\\\\":\\\\\\"standard\\\\\\",\\\\\\"cache_cloud_efficiency_size\\\\\\":0}&regionId=cn-hangzhou#/buy\\",\\n \\"TaskId\\": \\"t-000eg44nmxbsh3qk3***\\",\\n \\"RequestId\\": \\"F8B59F29-453D-49BF-8673-EEB8F9F2D5C6\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ExpandCacheDiskResponse>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&amp;request={\\"gateway_id\\":\\"gw-0007va9bnidei3s8a***”,”directBuy\\":\\"false\\",\\"gateway_class\\":\\"standard\\",\\"cache_cloud_efficiency_size\\":0}&amp;regionId=cn-hangzhou#/buy</BuyURL>\\n <TaskId>t-000eg44nmxbsh3qk3***</TaskId>\\n <RequestId>F8B59F29-453D-49BF-8673-EEB8F9F2D5C6</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ExpandCacheDiskResponse>","errorExample":""}]',
- 'title' => 'ExpandCacheDisk',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-000c6hshwukkcfn****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'SetGatewayADInfo',
+ 'description' => 'When you call this operation, note the following:'."\n"
+ ."\n"
+ .'- If you want to add an AD server, ensure that the AD server information is valid and the gateway can access the AD server using its DNS. You can call the SetGatewayDNS operation to set the DNS for the Cloud Storage Gateway.'."\n"
+ .'- If you add AD server information and information for another AD server already exists, the new information overwrites the existing information.'."\n"
+ .'- To purge the AD server information, set the IsEnabled parameter to false.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteGatewayCacheDisk' => [
- 'summary' => 'Deletes a cache disk from a gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetGatewayADInfo'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SetGatewayADInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'SetGatewayDNS' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7555,119 +6643,153 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwLTSLKH',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-0001xv7je3580031y***',
- ],
+ 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000c6hshwukkbryp****', 'title' => ''],
],
[
- 'name' => 'CacheId',
+ 'name' => 'DnsServer',
'in' => 'query',
+ 'schema' => ['description' => 'The IP addresses of the DNS servers. If you specify multiple IP addresses, separate them with commas.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100.100.XX.XX,100.100.XX.XX', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-000czaedx5koz578****', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'd-bp1dcnq8zldree6ok***',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidDNS', 'errorMessage' => 'The specified parameter includes one or more invalid IP addresses. You must specify a valid parameter.', 'description' => 'The specified parameter includes one or more invalid IP addresses. You must specify a valid parameter.'],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'description' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-000czaedx5koz578****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'SetGatewayDNS',
+ 'summary' => 'Adds DNS server information to a file gateway.',
+ 'description' => 'Before you call this operation, note the following:'."\n"
+ ."\n"
+ .'- If the Cloud Storage Gateway has existing DNS server information, it is overwritten by the information that you specify.'."\n"
+ .'- Ensure that the DNS server information that you specify is valid.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetGatewayDNS'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'LocalFilePath',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '/dev/vdb',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SetGatewayDNS',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
+ ],
+ 'SetGatewaySMBSecurityStrategy' => [
+ 'summary' => 'Sets the Server Message Block (SMB) security level for a gateway.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw64A0KV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'GatewayId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The gateway ID.', 'type' => 'string', 'required' => true, 'example' => 'gw-0001xv7je3580031***', 'title' => ''],
+ ],
+ [
+ 'name' => 'SecurityStrategy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The security level. Valid values:'."\n"
+ ."\n"
+ .'- ClientNegotiated: The client negotiates the security level.'."\n"
+ ."\n"
+ .'- EnforceSigning: Signing is enforced.', 'type' => 'string', 'required' => false, 'example' => 'EnforceSigning', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0001xv7je357xv4s***',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EEFC9927-B097-446D-8FDA-F848C8B2C9E3',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '735B642E-6564-4A87-99A0-3609F67C787E', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The request was successful.'."\n"
+ ."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'LocationCloudRequired',
- 'errorMessage' => 'You must specify a cloud gateway. Try again later.',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
- ],
- [
- 'errorCode' => 'GatewayOperationNotAllowed',
- 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.',
- ],
- [
- 'errorCode' => 'CacheInUse',
- 'errorMessage' => 'The cache disk is in use.',
+ 'title' => 'SetGatewaySMBSecurityStrategy',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SetGatewaySMBSecurityStrategy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xv4s***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EEFC9927-B097-446D-8FDA-F848C8B2C9E3\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGatewayCacheDiskResponse>\\n <Message>successful</Message>\\n <RequestId>EEFC9927-B097-446D-8FDA-F848C8B2C9E3</RequestId>\\n <TaskId>t-0001xv7je357xv4s***</TaskId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteGatewayCacheDiskResponse>","errorExample":""}]',
- 'title' => 'DeleteGatewayCacheDisk',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"735B642E-6564-4A87-99A0-3609F67C787E\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'TagResources' => [
'summary' => 'Creates tags and attaches the tags to resources.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7679,42 +6801,23 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw7Q12RI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw7Q12RI'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID. You can call the DescribeRegions operation to query region IDs.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the DescribeRegions operation to query region IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceRegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID of the resource.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the resource. Valid value: GATEWAY.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'GATEWAY',
- ],
+ 'schema' => ['description' => 'The type of the resource. Valid value: GATEWAY.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GATEWAY', 'title' => ''],
],
[
'name' => 'Tag',
@@ -7727,23 +6830,17 @@
'description' => 'The tags.'."\n",
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The key of the tag. You can create N tag keys for a gateway. Valid values of N: 1 to 20. This parameter cannot be an empty string.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testkey1',
- ],
- 'Value' => [
- 'description' => 'The tag value that is associated with the specified tag key. You can create N tag values for a gateway. Valid values of N: 1 to 20. This parameter can be an empty string.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testvalue1',
- ],
+ 'Key' => ['description' => 'The key of the tag. You can create N tag keys for a gateway. Valid values of N: 1 to 20. This parameter cannot be an empty string.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testkey1', 'title' => ''],
+ 'Value' => ['description' => 'The tag value that is associated with the specified tag key. You can create N tag values for a gateway. Valid values of N: 1 to 20. This parameter can be an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvalue1', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => true,
'maxItems' => 21,
+ 'title' => '',
+ 'example' => '',
],
],
[
@@ -7753,14 +6850,11 @@
'schema' => [
'description' => 'The list of gateway IDs. You can attach tags to N gateways at a time. Valid values of N: 1 to 50.'."\n",
'type' => 'array',
- 'items' => [
- 'description' => 'The gateway ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gw-uf6wjk5xxxxxxx',
- ],
+ 'items' => ['description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gw-uf6wjk5xxxxxxx', 'title' => ''],
'required' => true,
'maxItems' => 51,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -7769,106 +6863,41 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7',
- ],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'MissingParameter.ResourceIds',
- 'errorMessage' => 'The parameter - ResourceIds.N should not be null.',
- ],
- [
- 'errorCode' => 'MissingParameter.Tags',
- 'errorMessage' => 'The parameter - Tags should not be null.',
- ],
- [
- 'errorCode' => 'Missing.TagKey',
- 'errorMessage' => 'The Tag.N.Key parameter is blank.',
- ],
- [
- 'errorCode' => 'InvalidParameter.TagKey',
- 'errorMessage' => 'The Tag.N.Key parameter is invalid.',
- ],
- [
- 'errorCode' => 'InvalidParameter.TagValue',
- 'errorMessage' => 'The Tag.N.Value parameter is invalid.',
- ],
- [
- 'errorCode' => 'InvalidParameter.ResourceType',
- 'errorMessage' => 'The ResourceType parameter is invalid.',
- ],
- [
- 'errorCode' => 'Duplicate.TagKey',
- 'errorMessage' => 'The Tag.N.Key contain duplicate key.',
- ],
- [
- 'errorCode' => 'MissingParameter.TagOrResourceId',
- 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.',
- ],
- [
- 'errorCode' => 'NumberExceed.ResourceIds',
- 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50',
- ],
- [
- 'errorCode' => 'NumberExceed.Tags',
- 'errorMessage' => 'The Tags parameter\'s number is exceed , Valid : 20',
- ],
- [
- 'errorCode' => 'QuotaExceed.TagsPerResource',
- 'errorMessage' => 'The tags per resource number is exceed, Valid: 20',
- ],
+ ['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'The parameter - ResourceIds.N should not be null.', 'description' => ''],
+ ['errorCode' => 'MissingParameter.Tags', 'errorMessage' => 'The parameter - Tags should not be null.', 'description' => ''],
+ ['errorCode' => 'Missing.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is blank.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contain duplicate key.', 'description' => ''],
+ ['errorCode' => 'MissingParameter.TagOrResourceId', 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.', 'description' => ''],
+ ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50', 'description' => ''],
+ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter\'s number is exceed , Valid : 20', 'description' => ''],
+ ['errorCode' => 'QuotaExceed.TagsPerResource', 'errorMessage' => 'The tags per resource number is exceed, Valid: 20', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'PermissionDenied.Scope',
- 'errorMessage' => 'The specified operator not have permission to set Scope value.',
- ],
- [
- 'errorCode' => 'PermissionDenied.TagOwnerUid',
- 'errorMessage' => 'The specified operator not have permission to set TagOwnerUid value.',
- ],
- [
- 'errorCode' => 'PermissionDenied.TagOwnerBid',
- 'errorMessage' => 'The specified operator not have permission to set TagOwnerBid value.',
- ],
- [
- 'errorCode' => 'NoPermissionKey.Operator',
- 'errorMessage' => 'These keys are not permission for this operator.',
- ],
- [
- 'errorCode' => 'NoPermissionKey.Scope',
- 'errorMessage' => 'These keys are not permission for this scope.',
- ],
- [
- 'errorCode' => 'NoPermissionKey.Category',
- 'errorMessage' => 'These keys are not permission for this category.',
- ],
- [
- 'errorCode' => 'NoPermission.SystemTag',
- 'errorMessage' => 'The operator is not permission for the system tag.',
- ],
- [
- 'errorCode' => 'NoPermission.Operator',
- 'errorMessage' => 'The operator is not permission for this operate.',
- ],
+ ['errorCode' => 'PermissionDenied.Scope', 'errorMessage' => 'The specified operator not have permission to set Scope value.', 'description' => ''],
+ ['errorCode' => 'PermissionDenied.TagOwnerUid', 'errorMessage' => 'The specified operator not have permission to set TagOwnerUid value.', 'description' => ''],
+ ['errorCode' => 'PermissionDenied.TagOwnerBid', 'errorMessage' => 'The specified operator not have permission to set TagOwnerBid value.', 'description' => ''],
+ ['errorCode' => 'NoPermissionKey.Operator', 'errorMessage' => 'These keys are not permission for this operator.', 'description' => ''],
+ ['errorCode' => 'NoPermissionKey.Scope', 'errorMessage' => 'These keys are not permission for this scope.', 'description' => ''],
+ ['errorCode' => 'NoPermissionKey.Category', 'errorMessage' => 'These keys are not permission for this category.', 'description' => ''],
+ ['errorCode' => 'NoPermission.SystemTag', 'errorMessage' => 'The operator is not permission for the system tag.', 'description' => ''],
+ ['errorCode' => 'NoPermission.Operator', 'errorMessage' => 'The operator is not permission for this operate.', 'description' => ''],
],
[
- [
- 'errorCode' => 'InvalidResourceType.NotFound',
- 'errorMessage' => 'The ResourceType provided does not exist in our records.',
- ],
- [
- 'errorCode' => 'InvalidResourceId.NotFound',
- 'errorMessage' => 'The specified ResourceId is not found in our records.',
- ],
+ ['errorCode' => 'InvalidResourceType.NotFound', 'errorMessage' => 'The ResourceType provided does not exist in our records.', 'description' => ''],
+ ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceId is not found in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"224DB9F7-3100-4899-AB9C-C938BCCB43E7\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>224DB9F7-3100-4899-AB9C-C938BCCB43E7</RequestId>\\n</TagResourcesResponse>","errorExample":""}]',
@@ -7883,114 +6912,58 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListTagResources' => [
- 'summary' => 'Queries tags of one or more gateways.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:TagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'TriggerGatewayRemoteSync' => [
+ 'summary' => 'Actively triggers a file gateway to perform a reverse synchronization on the specified path.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '17247',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw7Q12RI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwSTR2C0'],
],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ResourceRegionId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'ResourceType',
+ 'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'GATEWAY',
- ],
+ 'schema' => ['description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-0004wacp5e4ll1542****', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'IndexId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '212db86sca4384811e0b5e8707ec21345',
- ],
+ 'schema' => ['description' => 'The ID of the share.'."\n", 'type' => 'string', 'required' => true, 'example' => 'NFSshare_12012112****', 'title' => ''],
],
[
- 'name' => 'ResourceId',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- 'required' => false,
- 'example' => 'gw-uf6wjk5xxxxxxx',
- 'maxItems' => 51,
- ],
- ],
- [
- 'name' => 'Tag',
+ 'name' => 'Path',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testkey1',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testvalue1',
- ],
- ],
- ],
- 'required' => false,
- 'maxItems' => 21,
- ],
+ 'schema' => ['description' => 'The path on which you want to trigger reverse synchronization.'."\n", 'type' => 'string', 'required' => false, 'example' => '/dirchild24120121****', 'title' => ''],
],
],
'responses' => [
@@ -7998,159 +6971,52 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '212db86sca4384811e0b5e8707ec21345',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '47A514A1-4B77-4E30-B4C5-2A880650B3FD',
- ],
- 'TagResources' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'TagResource' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ResourceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ALIYUN::HCS_SGW::GATEWAY',
- ],
- 'TagValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'testvalue1',
- ],
- 'ResourceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '47A514A1-4B77-4E30-B4C5-2A880650B3FD ',
- ],
- 'TagKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'testkey1 ',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '29BD52E7-CF30-418F-A240-E15A9351****', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 't-000avsri6tlyddgf****', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'MissingParameter.ResourceIds',
- 'errorMessage' => 'The parameter - ResourceIds.N should not be null.',
- ],
- [
- 'errorCode' => 'MissingParameter.Tags',
- 'errorMessage' => 'The parameter - Tags should not be null.',
- ],
- [
- 'errorCode' => 'Missing.TagKey',
- 'errorMessage' => 'The Tag.N.Key parameter is blank.',
- ],
- [
- 'errorCode' => 'InvalidParameter.TagKey',
- 'errorMessage' => 'The Tag.N.Key parameter is invalid.',
- ],
- [
- 'errorCode' => 'InvalidParameter.TagValue',
- 'errorMessage' => 'The Tag.N.Value parameter is invalid.',
- ],
- [
- 'errorCode' => 'InvalidParameter.ResourceType',
- 'errorMessage' => 'The ResourceType parameter is invalid.',
- ],
- [
- 'errorCode' => 'Duplicate.TagKey',
- 'errorMessage' => 'The Tag.N.Key contain duplicate key.',
- ],
- [
- 'errorCode' => 'MissingParameter.TagOrResourceId',
- 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.',
- ],
- [
- 'errorCode' => 'NumberExceed.ResourceIds',
- 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50',
- ],
- [
- 'errorCode' => 'NumberExceed.Tags',
- 'errorMessage' => 'The Tags parameter\'s number is exceed , Valid : 20',
- ],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
],
- 403 => [
- [
- 'errorCode' => 'PermissionDenied.Scope',
- 'errorMessage' => 'The specified operator not have permission to set Scope value.',
- ],
- [
- 'errorCode' => 'PermissionDenied.TagOwnerUid',
- 'errorMessage' => 'The specified operator not have permission to set TagOwnerUid value.',
- ],
- [
- 'errorCode' => 'PermissionDenied.TagOwnerBid',
- 'errorMessage' => 'The specified operator not have permission to set TagOwnerBid value.',
- ],
- [
- 'errorCode' => 'NoPermissionKey.Operator',
- 'errorMessage' => 'These keys are not permission for this operator.',
- ],
- [
- 'errorCode' => 'NoPermissionKey.Scope',
- 'errorMessage' => 'These keys are not permission for this scope.',
- ],
- [
- 'errorCode' => 'NoPermissionKey.Category',
- 'errorMessage' => 'These keys are not permission for this category.',
- ],
- [
- 'errorCode' => 'NoPermission.SystemTag',
- 'errorMessage' => 'The operator is not permission for the system tag.',
- ],
- [
- 'errorCode' => 'NoPermission.Operator',
- 'errorMessage' => 'The operator is not permission for this operate.',
- ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"29BD52E7-CF30-418F-A240-E15A9351****\\",\\n \\"TaskId\\": \\"t-000avsri6tlyddgf****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'TriggerGatewayRemoteSync',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TriggerGatewayRemoteSync'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidResourceType.NotFound',
- 'errorMessage' => 'The ResourceType provided does not exist in our records.',
- ],
- [
- 'errorCode' => 'InvalidResourceId.NotFound',
- 'errorMessage' => 'The specified ResourceId is not found in our records.',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:TriggerGatewayRemoteSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707ec21345\\",\\n \\"RequestId\\": \\"47A514A1-4B77-4E30-B4C5-2A880650B3FD\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::HCS_SGW::GATEWAY\\",\\n \\"TagValue\\": \\"testvalue1\\",\\n \\"ResourceId\\": \\"47A514A1-4B77-4E30-B4C5-2A880650B3FD\\\\t\\",\\n \\"TagKey\\": \\"testkey1\\\\t\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <NextToken>212db86sca4384811e0b5e8707ec21345</NextToken>\\n <RequestId>47A514A1-4B77-4E30-B4C5-2A880650B3FD</RequestId>\\n <TagResources>\\n <ResourceType>ALIYUN::HCS_SGW::GATEWAY</ResourceType>\\n <TagValue>testvalue1</TagValue>\\n <ResourceId>47A514A1-4B77-4E30-B4C5-2A880650B3FD\\t</ResourceId>\\n <TagKey>testkey1\\t</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]',
- 'title' => 'ListTagResources',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
'UntagResources' => [
- 'summary' => 'Removes tags from a gateway.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Detaches tags from a specified gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8162,63 +7028,45 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw7Q12RI',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw7Q12RI'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou ',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the DescribeRegions operation to query the region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceRegionId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => 'The region ID of the resource.', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'GATEWAY',
- ],
+ 'schema' => ['description' => 'The resource type. The value must be GATEWAY.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'GATEWAY'],
],
[
'name' => 'All',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to remove all tags from the instance. The default value is false. Valid values:'."\n"
+ ."\n"
+ .'- true.'."\n"
+ ."\n"
+ .'- false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The list of resource IDs.',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string', 'description' => 'The list of gateway IDs. You can detach tags from N instances at a time. N can be a value from 1 to 50.', 'required' => false, 'title' => '', 'example' => 'gw-uf6wjk5xxxxxxx'],
'required' => true,
'example' => 'gw-uf6wjk5xxxxxxx ',
'maxItems' => 51,
+ 'title' => '',
],
],
[
@@ -8226,14 +7074,15 @@
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The tag key.'."\n"
+ ."\n"
+ .'> - If the All parameter is not specified or is set to false, you must specify TagKey.',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string', 'description' => 'The tag key. You can remove N tag keys at a time. N can be a value from 1 to 20. An empty string is not allowed.', 'required' => false, 'title' => '', 'example' => 'testkey1'],
'required' => false,
'example' => 'testkey1',
'maxItems' => 21,
+ 'title' => '',
],
],
],
@@ -8242,116 +7091,73 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '601B6F25-21E7-4484-99D5-3EF2625C0088 ',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '601B6F25-21E7-4484-99D5-3EF2625C0088'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'MissingParameter.ResourceIds',
- 'errorMessage' => 'The parameter - ResourceIds.N should not be null.',
- ],
- [
- 'errorCode' => 'MissingParameter.Tags',
- 'errorMessage' => 'The parameter - Tags should not be null.',
- ],
- [
- 'errorCode' => 'Missing.TagKey',
- 'errorMessage' => 'The Tag.N.Key parameter is blank.',
- ],
- [
- 'errorCode' => 'InvalidParameter.TagKey',
- 'errorMessage' => 'The Tag.N.Key parameter is invalid.',
- ],
- [
- 'errorCode' => 'InvalidParameter.TagValue',
- 'errorMessage' => 'The Tag.N.Value parameter is invalid.',
- ],
- [
- 'errorCode' => 'InvalidParameter.ResourceType',
- 'errorMessage' => 'The ResourceType parameter is invalid.',
- ],
- [
- 'errorCode' => 'Duplicate.TagKey',
- 'errorMessage' => 'The Tag.N.Key contain duplicate key.',
- ],
- [
- 'errorCode' => 'The specified ResourceId is not found in our records.',
- 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.',
- ],
- [
- 'errorCode' => 'NumberExceed.ResourceIds',
- 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50',
- ],
- [
- 'errorCode' => 'NumberExceed.Tags',
- 'errorMessage' => 'The Tags parameter\'s number is exceed , Valid : 20',
- ],
+ ['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'The parameter - ResourceIds.N should not be null.', 'description' => ''],
+ ['errorCode' => 'MissingParameter.Tags', 'errorMessage' => 'The parameter - Tags should not be null.', 'description' => ''],
+ ['errorCode' => 'Missing.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is blank.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contain duplicate key.', 'description' => ''],
+ ['errorCode' => 'The specified ResourceId is not found in our records.', 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.', 'description' => ''],
+ ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50', 'description' => ''],
+ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter\'s number is exceed , Valid : 20', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'PermissionDenied.Scope',
- 'errorMessage' => 'The specified operator not have permission to set Scope value.',
- ],
- [
- 'errorCode' => 'PermissionDenied.TagOwnerUid',
- 'errorMessage' => 'The specified operator not have permission to set TagOwnerUid value.',
- ],
- [
- 'errorCode' => 'PermissionDenied.TagOwnerBid',
- 'errorMessage' => 'The specified operator not have permission to set TagOwnerBid value.',
- ],
- [
- 'errorCode' => 'NoPermissionKey.Operator',
- 'errorMessage' => 'These keys are not permission for this operator.',
- ],
- [
- 'errorCode' => 'NoPermissionKey.Scope',
- 'errorMessage' => 'These keys are not permission for this scope.',
- ],
- [
- 'errorCode' => 'NoPermissionKey.Category',
- 'errorMessage' => 'These keys are not permission for this category.',
- ],
- [
- 'errorCode' => 'NoPermission.SystemTag',
- 'errorMessage' => 'The operator is not permission for the system tag.',
- ],
- [
- 'errorCode' => 'NoPermission.Operator',
- 'errorMessage' => 'The operator is not permission for this operate.',
- ],
+ ['errorCode' => 'PermissionDenied.Scope', 'errorMessage' => 'The specified operator not have permission to set Scope value.', 'description' => ''],
+ ['errorCode' => 'PermissionDenied.TagOwnerUid', 'errorMessage' => 'The specified operator not have permission to set TagOwnerUid value.', 'description' => ''],
+ ['errorCode' => 'PermissionDenied.TagOwnerBid', 'errorMessage' => 'The specified operator not have permission to set TagOwnerBid value.', 'description' => ''],
+ ['errorCode' => 'NoPermissionKey.Operator', 'errorMessage' => 'These keys are not permission for this operator.', 'description' => ''],
+ ['errorCode' => 'NoPermissionKey.Scope', 'errorMessage' => 'These keys are not permission for this scope.', 'description' => ''],
+ ['errorCode' => 'NoPermissionKey.Category', 'errorMessage' => 'These keys are not permission for this category.', 'description' => ''],
+ ['errorCode' => 'NoPermission.SystemTag', 'errorMessage' => 'The operator is not permission for the system tag.', 'description' => ''],
+ ['errorCode' => 'NoPermission.Operator', 'errorMessage' => 'The operator is not permission for this operate.', 'description' => ''],
],
[
- [
- 'errorCode' => 'InvalidResourceType.NotFound',
- 'errorMessage' => 'The ResourceType provided does not exist in our records.',
- ],
- [
- 'errorCode' => 'InvalidResourceId.NotFound',
- 'errorMessage' => 'The specified ResourceId is not found in our records.',
- ],
+ ['errorCode' => 'InvalidResourceType.NotFound', 'errorMessage' => 'The ResourceType provided does not exist in our records.', 'description' => ''],
+ ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceId is not found in our records.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"601B6F25-21E7-4484-99D5-3EF2625C0088\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>601B6F25-21E7-4484-99D5-3EF2625C0088</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"601B6F25-21E7-4484-99D5-3EF2625C0088\\"\\n}","type":"json"}]',
'title' => 'UntagResources',
- ],
- 'CreateGatewayLogging' => [
- 'summary' => 'Create a gateway log monitoring task.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'description' => 'When you call this operation, note the following:'."\n"
+ ."\n"
+ .'- You can detach a maximum of 20 tags at a time.'."\n"
+ ."\n"
+ .'- After a tag is detached from an instance, the tag is automatically deleted if it is not attached to any other instances.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UntagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateGatewayBlockVolume' => [
+ 'summary' => 'Updates the configuration of a block volume on an iSCSI gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8360,171 +7166,359 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwR40N8S',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwJLV9QR'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'docRequired' => true, 'required' => true, 'type' => 'string', 'example' => 'gw-000eg44nmxbsfwbvq***', 'title' => ''],
],
[
- 'name' => 'SlsProject',
+ 'name' => 'IndexId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'alex***',
- ],
+ 'schema' => ['description' => 'The index ID. You can call the DescribeGatewayBlockVolumes operation to query the index ID.', 'docRequired' => true, 'required' => true, 'type' => 'string', 'example' => 'NFSalex***', 'title' => ''],
],
[
- 'name' => 'SlsLogstore',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'logs***',
- ],
+ 'schema' => ['description' => 'The size of the block volume. Unit: GB. Valid values: 1 to 262144. Default value: 100.'."\n"
+ ."\n"
+ .'> This parameter is invalid when recovery is enabled.', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'example' => '100', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChapEnabled',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable Challenge-Handshake Authentication Protocol (CHAP) authentication for the iSCSI volume. Inbound CHAP is supported. Valid values:'."\n"
+ ."\n"
+ .'- false (default): CHAP authentication is disabled.'."\n"
+ .'- true: CHAP authentication is enabled.', 'required' => false, 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChapInUser',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The username for inbound CHAP authentication when CHAP authentication is enabled for the iSCSI volume. The username must be 1 to 32 characters in length and can contain letters and digits.'."\n"
+ ."\n"
+ .'> This parameter is invalid when CHAP authentication is disabled.', 'required' => false, 'type' => 'string', 'example' => 'user', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChapInPassword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The password for inbound CHAP authentication when CHAP authentication is enabled for the iSCSI volume. The password must be 12 to 16 characters in length and can contain letters, digits, and the following special characters: !, @, #, $, %, ^, &, and \\*.'."\n"
+ ."\n"
+ .'> This parameter is invalid when CHAP authentication is disabled.', 'required' => false, 'type' => 'string', 'example' => 'ChapInPassword', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '76109369-5729-467D-D4A3-1131A8DA19XX',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-000avsri6tlyddgfe***', 'title' => ''],
+ 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EBAF769F-2E88-4D81-AF1E-A34FAACF9***', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'EmptySlsProject',
- 'errorMessage' => 'You must specify a valid project of Log Service.',
- ],
- [
- 'errorCode' => 'EmptySlsLogstore',
- 'errorMessage' => 'You must specify a valid Logstore of Log Service.',
- ],
- [
- 'errorCode' => 'GatewayVersionNotAllowed',
- 'errorMessage' => 'The specified version for the gateway is invalid. You must specify a valid version.',
- ],
- [
- 'errorCode' => 'GatewayLoggingStatusNotAllowed',
- 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'InvalidLogstore',
- 'errorMessage' => 'You must specify a valid project and Logstore of Log Service. The project and Logstore must reside in the same region as the gateway. You can use the project and Logstore to monitor logs.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.',
- ],
- [
- 'errorCode' => 'AssumeRoleFail',
- 'errorMessage' => 'Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.',
- ],
- ],
- [
- [
- 'errorCode' => 'StorageBundleNotExist',
- 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.',
- ],
- [
- 'errorCode' => 'RoleNotExist',
- 'errorMessage' => 'The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.',
- ],
+ ['errorCode' => 'InvalidParameter.BlockVolume.%s', 'errorMessage' => 'The specified field %s for block volume is invalid. Please check it again.', 'description' => 'The specified block volume parameter is invalid. You must specify a valid parameter.'],
+ ['errorCode' => 'VersionNotSupported.BlockVolume.%s', 'errorMessage' => 'The specified field %s for block volume is not supported by current gateway version. Please check it again.', 'description' => 'The specified block volume parameter for the gateway is not compatible with the gateway version. You must specify a valid parameter.'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"76109369-5729-467D-D4A3-1131A8DA****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'CreateGatewayLogging',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-000avsri6tlyddgfe***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EBAF769F-2E88-4D81-AF1E-A34FAACF9***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UpdateGatewayBlockVolume',
+ 'description' => 'Before you call this operation, note the following:'."\n"
+ ."\n"
+ .'- You have created and deployed an iSCSI gateway and configured a block volume.'."\n"
+ .'- This operation updates all exposed parameters of the block volume. If you do not want to update a specific parameter, you must specify its initial value in the request. Otherwise, the parameter is reset to its default value.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeGatewayLogging' => [
- 'summary' => 'Queries the logging configurations of a gateway, including the logging status, Simple Log Service (SLS) project name, and Logstore name.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateGatewayBlockVolume'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UpdateGatewayBlockVolume',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateGatewayFileShare' => [
+ 'summary' => 'This operation updates the configuration of a file share for a file gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwR40N8S',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgw1K8DWI'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The gateway ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwb***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'gw-000c6hshwukkbryp****'],
+ ],
+ [
+ 'name' => 'IndexId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the file share. Call the DescribeGatewayFileShares operation to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'NFStest'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the file share. Call the DescribeGatewayFileShares operation to obtain the name. This parameter cannot be modified.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'name'],
+ ],
+ [
+ 'name' => 'RemoteSync',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable remote sync for the file share. Valid values:'."\n"
+ ."\n"
+ .'- false (default): No.'."\n"
+ ."\n"
+ .'- true: Yes.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
+ ],
+ [
+ 'name' => 'RemoteSyncDownload',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to download file data in replication mode. This parameter is available for file gateways that run version 1.2.0 or later. Valid values:'."\n"
+ ."\n"
+ .'- false (default): No.'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ ."\n"
+ .'> This parameter is valid only when remote sync is enabled for the file share or the file share is added to an express synchronization group.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'PollingInterval',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The remote sync interval, in seconds. This parameter is required if you enable remote sync. Valid values: 15 to 36000.'."\n"
+ ."\n"
+ .'> If the file share is in replication mode and remote sync is enabled to download file data, the valid values are 3600 to 36000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '36000'],
+ ],
+ [
+ 'name' => 'IgnoreDelete',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to ignore file deletions. If this feature is enabled, deleting a file on the gateway does not delete the corresponding file in OSS. Valid values:'."\n"
+ ."\n"
+ .'- false (default): No.'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ ."\n"
+ .'> This parameter is available for file gateways that run version 1.0.40 or later.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
+ ],
+ [
+ 'name' => 'FrontendLimit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum write speed of the file share, in MB/s. Valid values: 0 to 1280. A value of 0 indicates no limit.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '0'],
+ ],
+ [
+ 'name' => 'BackendLimit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum upload speed of the file share, in MB/s. Valid values: 0 to 1280. A value of 0 indicates no limit.'."\n"
+ ."\n"
+ .'> If you also set FrontendLimit, the value of BackendLimit cannot be less than the value of FrontendLimit.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '0'],
+ ],
+ [
+ 'name' => 'DownloadLimit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum download speed of the file share, in MB/s. Valid values: 0 to 12800. A value of 0 indicates no limit. This parameter can be set only if the file share is in replication mode and file data download is enabled. This parameter is available for file gateways that run version 1.3.0 or later.'."\n"
+ ."\n"
+ .'> This parameter is valid only when remote sync is enabled for the file share or the file share is added to an express synchronization group.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '0'],
+ ],
+ [
+ 'name' => 'InPlace',
+ 'in' => 'query',
+ 'schema' => ['description' => 'This parameter is deprecated. Do not set this parameter.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'CacheMode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cache mode of the file share. Call the DescribeGatewayFileShares operation to obtain the cache mode. This parameter cannot be modified.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Cache'],
+ ],
+ [
+ 'name' => 'Browsable',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the file share is browsable over the SMB protocol. A browsable file share can be discovered in Network Neighborhood. Valid values:'."\n"
+ ."\n"
+ .'- true (default): Yes.'."\n"
+ ."\n"
+ .'- false: No.'."\n"
+ ."\n"
+ .'> * This parameter is invalid for the NFS protocol.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'Squash',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The user mapping for the file share over the NFS protocol. The default value is none. Valid values:'."\n"
+ ."\n"
+ .'- none'."\n"
+ ."\n"
+ .'- root\\_squash'."\n"
+ ."\n"
+ .'- all\\_squash'."\n"
+ ."\n"
+ .'- all\\_anonymous', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'none'],
+ ],
+ [
+ 'name' => 'ReadWriteUserList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The list of users who have read and write permissions on the file share over the SMB protocol. Separate multiple users with commas (,).'."\n"
+ ."\n"
+ .'> - This parameter is invalid for the NFS protocol.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'user1,user2'],
+ ],
+ [
+ 'name' => 'ReadOnlyUserList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The list of users who have read-only permissions on the file share over the SMB protocol. Separate multiple users with commas (,).'."\n"
+ ."\n"
+ .'> - This parameter is invalid for the NFS protocol.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'user1,user2'],
+ ],
+ [
+ 'name' => 'ReadWriteClientList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The list of clients that have read and write permissions on the file share over the NFS protocol. The clients can be IP addresses or IP address ranges. Separate multiple clients with commas (,).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '172.16.146.100'],
+ ],
+ [
+ 'name' => 'ReadOnlyClientList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The list of clients that have read-only permissions on the file share over the NFS protocol. The clients can be IP addresses or IP address ranges. Separate multiple clients with commas (,).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '172.16.146.100'],
+ ],
+ [
+ 'name' => 'LagPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The synchronization latency, in seconds. This is the delay for synchronizing the gateway\'s local cache with OSS. Valid values: 5 to 120. The default value is 5.'."\n"
+ ."\n"
+ .'> - This parameter is available for file gateways that run version 1.0.40 or later.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '5'],
+ ],
+ [
+ 'name' => 'DirectIO',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable Direct I/O (DirectIO) for data transfer on the file share. Valid values:'."\n"
+ ."\n"
+ .'- false (default): No.'."\n"
+ ."\n"
+ .'- true: Yes.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ServerSideEncryption',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ServerSideCmk',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'b1e08822-1e9c-4f8e-9dd1-a740cb200***'],
+ ],
+ [
+ 'name' => 'ClientSideEncryption',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ClientSideCmk',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'b1e08822-1e9c-4f8e-9dd1-a740cb200***'],
+ ],
+ [
+ 'name' => 'KmsRotatePeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '0'],
+ ],
+ [
+ 'name' => 'FastReclaim',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable upload optimization for the file share. This feature is suitable for scenarios where data is only backed up to the cloud. Valid values:'."\n"
+ ."\n"
+ .'- false (default): No.'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ ."\n"
+ .'> This parameter is available for file gateways that run version 1.0.39 or later.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
+ ],
+ [
+ 'name' => 'WindowsAcl',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable access control through a Windows access control list (ACL) over the SMB protocol. This feature requires an Active Directory (AD) domain. Valid values:'."\n"
+ ."\n"
+ .'- false (default): No.'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ ."\n"
+ .'> This parameter is available for file gateways that run version 1.0.45 or later.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'AccessBasedEnumeration',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable Windows access-based enumeration (ABE) over the SMB protocol. This parameter takes effect only when the \\`WindowsAcl\\` parameter is set to \\`true\\`. Valid values:'."\n"
+ ."\n"
+ .'- false (default): No.'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ ."\n"
+ .'> * This parameter is available for file gateways that run version 1.0.45 or later.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'NfsV4Optimization',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable NFSv4 optimization to improve mount and upload efficiency over the NFS protocol. Valid values:'."\n"
+ ."\n"
+ .'- false (default): No.'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ ."\n"
+ .'> * After you enable this feature, you cannot mount the file share using NFSv3. This parameter is available for file gateways that run version 1.2.0 or later.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
+ ],
+ [
+ 'name' => 'TransferAcceleration',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable transfer acceleration for the file share. The corresponding OSS bucket must also have transfer acceleration enabled.'."\n"
+ ."\n"
+ .'> - This parameter is available for file gateways that run version 1.3.0 or later.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'BypassCacheRead',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable direct OSS reads for the file share. If enabled, data is read directly from OSS without passing through the gateway cache. Valid values:'."\n"
+ ."\n"
+ .'- false (default): No.'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ ."\n"
+ .'> * This feature is not recommended for most use cases.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ServerSideAlgorithm',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => 'Deprecated.', 'required' => false, 'title' => '', 'example' => 'AES256'],
],
],
'responses' => [
@@ -8532,193 +7526,166 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'SlsProject' => [
- 'description' => 'The project name.'."\n",
- 'type' => 'string',
- 'example' => '123***',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '17D08346-BD08-4107-BFBC-01A6AAD5F5FB',
- ],
- 'Message' => [
- 'description' => 'The returned message.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'GatewayLoggingStatus' => [
- 'description' => 'The logging status of the gateway. Valid values:'."\n"
- ."\n"
- .'* None: Logging is not configured for the gateway.'."\n"
- .'* Enabled: Logging is enabled.'."\n"
- .'* Disabled: Logging is disabled.'."\n",
- 'type' => 'string',
- 'example' => 'Enabled',
- ],
- 'SlsLogstore' => [
- 'description' => 'The Logstore name.'."\n",
- 'type' => 'string',
- 'example' => 'alex***',
- ],
- 'Code' => [
- 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'title' => '', 'example' => 't-000avsri6tlyddgf****'],
+ 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'title' => '', 'example' => 'successful'],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'EBAF769F-2E88-4D81-AF1E-A34FAACF9***'],
+ 'Code' => ['description' => 'The HTTP status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
+ ['errorCode' => 'InvalidParameter.FileShare.%s', 'errorMessage' => 'The specified field %s for file share is invalid. Please check it again.', 'description' => 'The specified file sharing parameter for the gateway is invalid. You must specify a valid parameter.'],
+ ['errorCode' => 'VersionNotSupported.FileShare.%s', 'errorMessage' => 'The specified field %s for file share is not supported by current gateway version. Please check it again.', 'description' => 'The specified file sharing parameter for the gateway does not match the gateway version. You must specify a valid parameter.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"SlsProject\\": \\"123***\\",\\n \\"RequestId\\": \\"17D08346-BD08-4107-BFBC-01A6AAD5F5FB\\",\\n \\"Message\\": \\"successful\\",\\n \\"GatewayLoggingStatus\\": \\"Enabled\\",\\n \\"SlsLogstore\\": \\"alex***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayLoggingResponse>\\n <SlsProject>alex***</SlsProject>\\n <Message>successful</Message>\\n <RequestId>17D08346-BD08-4107-BFBC-01A6AAD5F5FB</RequestId>\\n <GatewayLoggingStatus>Enabled</GatewayLoggingStatus>\\n <SlsLogstore>123***</SlsLogstore>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeGatewayLoggingResponse>","errorExample":""}]',
- 'title' => 'DescribeGatewayLogging',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-000avsri6tlyddgf****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EBAF769F-2E88-4D81-AF1E-A34FAACF9***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UpdateGatewayFileShare',
+ 'description' => 'Before you call this operation, note the following:'."\n"
+ ."\n"
+ .'- You have created and deployed a file gateway, and configured a file share.'."\n"
+ ."\n"
+ .'- This operation updates all exposed parameters of the specified file share. If you do not want to change the value of a specific parameter, set it to its current value. Otherwise, it is reset to its default value.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'EnableGatewayLogging' => [
- 'summary' => 'Enables log monitoring for a gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateGatewayFileShare'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UpdateGatewayFileShare',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpgradeGateway' => [
+ 'summary' => 'Updates a gateway.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwR40N8S',
- ],
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwDLQA4J'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbv***',
- ],
+ 'schema' => ['description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031y***', 'title' => ''],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CAE39768-CE96-4E16-A9F7-1FF9AE8E3FBF',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 't-0001xv7je3580412***', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB300009-3850-4107-B291-59BDB4EDA183', 'title' => ''],
+ 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => 'Code', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayLoggingStatusNotAllowed',
- 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayOperationNotAllowed', 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', 'description' => 'You cannot perform the operation when the gateway is in the current state.'],
+ ['errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', 'description' => 'The gateway is busy. Try again later.'],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CAE39768-CE96-4E16-A9F7-1FF9AE8E3FBF\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<EnableGatewayLoggingResponse>\\n <Message>successful</Message>\\n <RequestId>CAE39768-CE96-4E16-A9F7-1FF9AE8E3FBF</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</EnableGatewayLoggingResponse>","errorExample":""}]',
- 'title' => 'EnableGatewayLogging',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je3580412***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CB300009-3850-4107-B291-59BDB4EDA183\\",\\n \\"Code\\": \\"Code\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpgradeGatewayResponse>\\n <TaskId>t-0001xv7je3580412***</TaskId>\\n <Message>successful</Message>\\n <RequestId>CB300009-3850-4107-B291-59BDB4EDA183</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpgradeGatewayResponse>","errorExample":""}]',
+ 'title' => 'UpgradeGateway',
+ 'description' => '### [](#)Usage notes'."\n"
+ ."\n"
+ .'When you call this operation, take note of the following items:'."\n"
+ ."\n"
+ .'* You can update a gateway that is only in the Running or Activated state.'."\n"
+ .'* During the update process, the gateway cannot respond to other requests.'."\n"
+ ."\n"
+ .'**'."\n"
+ ."\n"
+ .'**Warning** Updating gateways will cause temporary business interruptions. Exercise caution when performing this operation.'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DisableGatewayLogging' => [
- 'summary' => 'Disables log monitoring for a gateway.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeGateway'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UpgradeGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UploadGatewayLog' => [
+ 'summary' => 'Uploads gateway diagnostic information.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwR40N8S',
- ],
+ 'abilityTreeCode' => '17280',
+ 'abilityTreeNodes' => ['FEATUREhcs_sgwR40N8S'],
],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwb***',
- ],
+ 'schema' => ['description' => 'The ID of the gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3031yzun***', 'title' => ''],
],
],
'responses' => [
@@ -8726,2126 +7693,2297 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '25288205-A591-4AA9-ACF8-427E8727A9D3',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 't-0001xv7je3580412f***', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CB300009-3850-4107-B291-59BDB4EDA183', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayLoggingStatusNotAllowed',
- 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
- ],
+ ['errorCode' => 'EmptyGatewayId', 'errorMessage' => 'You must enter a valid ID for the gateway.', 'description' => 'You must enter a valid ID for the gateway.'],
+ ['errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['errorCode' => 'GatewayOperationNotAllowed', 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.', 'description' => 'You cannot perform the operation when the gateway is in the current state.'],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ', 'description' => 'Invalid request. You must specify valid parameters in the request. '],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"25288205-A591-4AA9-ACF8-427E8727A9D3\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DisableGatewayLoggingResponse>\\n <Message>successful</Message>\\n <RequestId>25288205-A591-4AA9-ACF8-427E8727A9D3</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DisableGatewayLoggingResponse>","errorExample":""}]',
- 'title' => 'DisableGatewayLogging',
+ 'title' => 'UploadGatewayLog',
+ 'description' => 'Note:'."\n"
+ ."\n"
+ .'- This operation is available only when the gateway is in the Running or Activated state.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteGatewayLogging' => [
- 'summary' => 'Deletes a log monitoring project for a gateway.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UploadGatewayLog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"t-0001xv7je3580412f***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CB300009-3850-4107-B291-59BDB4EDA183\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.ap-northeast-1.aliyuncs.com', 'endpoint' => 'sgw.ap-northeast-1.aliyuncs.com', 'vpc' => 'sgw-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.ap-northeast-2.aliyuncs.com', 'endpoint' => 'sgw.ap-northeast-2.aliyuncs.com', 'vpc' => 'sgw-vpc.ap-northeast-2.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.ap-southeast-1.aliyuncs.com', 'endpoint' => 'sgw.ap-southeast-1.aliyuncs.com', 'vpc' => 'sgw-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.ap-southeast-3.aliyuncs.com', 'endpoint' => 'sgw.ap-southeast-3.aliyuncs.com', 'vpc' => 'sgw-vpc.ap-southeast-3.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.ap-southeast-5.aliyuncs.com', 'endpoint' => 'sgw.ap-southeast-5.aliyuncs.com', 'vpc' => 'sgw-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.ap-southeast-6.aliyuncs.com', 'endpoint' => 'sgw.ap-southeast-6.aliyuncs.com', 'vpc' => 'sgw-vpc.ap-southeast-6.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-chengdu.aliyuncs.com'],
+ ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-guangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-heyuan.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-huhehaote.aliyuncs.com'],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-qingdao.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-wulanchabu.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sgw.cn-shanghai.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'sgw.us-west-1.aliyuncs.com', 'endpoint' => 'sgw.us-west-1.aliyuncs.com', 'vpc' => 'sgw-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'sgw.us-west-1.aliyuncs.com', 'endpoint' => 'sgw.us-west-1.aliyuncs.com', 'vpc' => 'sgw-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'sgw.eu-west-1.aliyuncs.com', 'endpoint' => 'sgw.eu-west-1.aliyuncs.com', 'vpc' => 'sgw-vpc.eu-west-1.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'sgw.eu-central-1.aliyuncs.com', 'endpoint' => 'sgw.eu-central-1.aliyuncs.com', 'vpc' => 'sgw-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'sgw.me-central-1.aliyuncs.com', 'endpoint' => 'sgw.me-central-1.aliyuncs.com', 'vpc' => 'sgw-vpc.me-central-1.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'sgw.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'sgw.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'sgw.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'sgw.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'sgw.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'sgw-vpc.cn-north-2-gov-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AssumeRoleFail', 'message' => 'Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'http_code' => 403, 'description' => 'Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
+ ['code' => 'BadPageNumber', 'message' => 'The specified page number is invalid. The page number must be greater than 0.', 'http_code' => 400, 'description' => 'The specified page number is invalid. The page number must be greater than 0.'],
+ ['code' => 'BadPageSize', 'message' => 'The specified number of pages is invalid. The number ranges from 1 to 50.', 'http_code' => 400, 'description' => 'The specified number of pages is invalid. The number ranges from 1 to 50.'],
+ ['code' => 'BadRequest', 'message' => 'Invalid request. You must specify valid parameters in the request. ', 'http_code' => 400, 'description' => 'Invalid request. You must specify valid parameters in the request. '],
+ ['code' => 'BetaTestNodeLimited', 'message' => 'The elastic gateway node count has exceeded the maximum quota.', 'http_code' => 400, 'description' => 'The elastic gateway node count has exceeded the maximum quota.'],
+ ['code' => 'CacheInUse', 'message' => 'The cache disk is in use.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CacheNotExist', 'message' => 'The specified cache disk does not exist. You must specify a valid parameter.', 'http_code' => 400, 'description' => 'The specified cache disk does not exist. You must specify a valid parameter.'],
+ ['code' => 'CacheNumOverLimit', 'message' => 'The number of cache disks exceeds the maximum limit.', 'http_code' => 400, 'description' => 'The number of cache disks exceeds the maximum limit.'],
+ ['code' => 'CacheSizeLimit', 'message' => 'The maximum size of cache disks for the gateway is 32 TB.', 'http_code' => 400, 'description' => 'The maximum cache disk size of the gateway is 32 TB.'],
+ ['code' => 'CacheSizeLimitForBasic', 'message' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Basic gateway is 4 TB.', 'http_code' => 400, 'description' => 'The expansion capacity exceeds the maximum cache disk limit. The maximum cache disk limit for Basic Gateway is 4 TB.'],
+ ['code' => 'CacheSizeLimitForStandard', 'message' => 'The specified scale-up size exceeds the maximum limit. The maximum scale-up size of cache disks for a Standard gateway is 8 TB.', 'http_code' => 400, 'description' => 'The expansion capacity exceeds the maximum cache disk limit. The standard gateway cache disk limit is 8 TB.'],
+ ['code' => 'ConflictExpressSyncConfig', 'message' => 'The parameter you specified for the sync group is invalid. Try again later after you specify a valid parameter.', 'http_code' => 400, 'description' => 'The parameter you specified for the sync group is invalid. Try again later after you specify a valid parameter.'],
+ ['code' => 'CouldNotCreateSMBUser', 'message' => 'The gateway has linked an AD or LDAP service. You cannot create an SMB user on the gateway. We recommend that you create an SMB user in the AD or LDAP service.', 'http_code' => 400, 'description' => 'The gateway has been configured with an AD service and does not support creating an SMB user from the gateway. Please perform user operations on the AD server.'],
+ ['code' => 'CouldNotCreateSMBUser', 'message' => 'The gateway has linked an AD service. You cannot create an SMB user on the gateway. We recommend that you create an SMB user in the AD service.', 'http_code' => 400, 'description' => 'The gateway has been configured with an AD service and does not support creating an SMB user from the gateway. Please perform user operations on the AD server.'],
+ ['code' => 'CouldNotDeleteSMBUser', 'message' => 'The gateway is already linked with an AD or LDAP service. You cannot delete an SMB user on the gateway. We recommend that you delete an SMB user in the AD or LDAP service.', 'http_code' => 400, 'description' => 'The gateway has been configured with an AD service and does not support deleting an SMB user from the gateway. Please perform user operations on the AD server.'],
+ ['code' => 'DescriptionOverLimit', 'message' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.', 'http_code' => 400, 'description' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.'],
+ ['code' => 'DuplicateBucketOnGateway', 'message' => 'The specified OssStorageBucket already exists on the elastic gateway. Please enter a new one.', 'http_code' => 400, 'description' => 'Specified parameter OssStorageBucket has existed on the Elastic Gateway, please input a new one.'],
+ ['code' => 'DuplicateExpressSyncName', 'message' => 'The specified name of the sync group already exists. Try again later after you specify a valid parameter.', 'http_code' => 400, 'description' => 'The specified name of the sync group already exists. Try again later after you specify a valid parameter.'],
+ ['code' => 'DuplicateGatewayName', 'message' => 'The specified name of the gateway already exists. You must specify a valid name.', 'http_code' => 400, 'description' => 'The specified name of the gateway already exists. You must specify a valid name.'],
+ ['code' => 'DuplicateStorageBundleName', 'message' => 'The name you specified for the gateway cluster already exists. You must specify a valid name.', 'http_code' => 400, 'description' => 'The name you specified for the gateway cluster already exists. You must specify a valid name.'],
+ ['code' => 'EmptyADPassword', 'message' => 'You must enter a valid password.', 'http_code' => 400, 'description' => 'You must enter a valid password.'],
+ ['code' => 'EmptyADUserName', 'message' => 'You must enter a valid username.', 'http_code' => 400, 'description' => 'You must enter a valid username.'],
+ ['code' => 'EmptyBucketEndpoint', 'message' => 'You must specify a valid endpoint for the bucket.', 'http_code' => 400, 'description' => 'You must specify a valid endpoint for the bucket.'],
+ ['code' => 'EmptyBucketName', 'message' => 'You must enter a valid name for the bucket.', 'http_code' => 400, 'description' => 'You must enter a valid name for the bucket.'],
+ ['code' => 'EmptyBucketRegion', 'message' => 'You must specify a valid region for the bucket.', 'http_code' => 400, 'description' => 'You must specify a valid region for the bucket.'],
+ ['code' => 'EmptyExpressSyncId', 'message' => 'You must specify a valid ID for the sync group.', 'http_code' => 400, 'description' => 'You must specify a valid ID for the sync group.'],
+ ['code' => 'EmptyExpressSyncName', 'message' => 'You must enter a valid name for the sync group.', 'http_code' => 400, 'description' => 'You must enter a valid name for the sync group.'],
+ ['code' => 'EmptyGatewayId', 'message' => 'You must enter a valid ID for the gateway.', 'http_code' => 400, 'description' => 'You must enter a valid ID for the gateway.'],
+ ['code' => 'EmptyGatewayName', 'message' => 'You must enter a valid name for the gateway.', 'http_code' => 400, 'description' => 'You must enter a valid name for the gateway.'],
+ ['code' => 'EmptyLDAPPassword', 'message' => 'You must enter a valid password.', 'http_code' => 400, 'description' => 'You must enter a valid password.'],
+ ['code' => 'EmptyLocalFilePath', 'message' => 'You must enter an local file path for the cache disk.', 'http_code' => 400, 'description' => 'You must enter an internal device name for the cache disk.'],
+ ['code' => 'EmptyShareIndexId', 'message' => 'You must enter a valid file sharing ID.', 'http_code' => 400, 'description' => 'You must enter a valid file sharing ID.'],
+ ['code' => 'EmptySlsLogstore', 'message' => 'You must specify a valid Logstore of Log Service.', 'http_code' => 400, 'description' => 'You must specify a valid Logstore of Log Service.'],
+ ['code' => 'EmptySlsProject', 'message' => 'You must specify a valid project of Log Service.', 'http_code' => 400, 'description' => 'You must specify a valid project of Log Service.'],
+ ['code' => 'EmptySMBPassword', 'message' => 'You must enter a valid SMB password.', 'http_code' => 400, 'description' => 'You must enter a valid SMB password.'],
+ ['code' => 'EmptySMBUserName', 'message' => 'You must enter a valid SMB username.', 'http_code' => 400, 'description' => 'You must enter a valid SMB username.'],
+ ['code' => 'EmptyStorageBundleId', 'message' => 'You must enter a valid ID for the gateway cluster.', 'http_code' => 400, 'description' => 'You must enter a valid ID for the gateway cluster.'],
+ ['code' => 'EmptyStorageBundleName', 'message' => 'You must enter a valid name for the gateway cluster.', 'http_code' => 400, 'description' => 'You must enter a valid name for the gateway cluster.'],
+ ['code' => 'EmptyTargetId', 'message' => 'You must enter a valid ID for the target gateway.', 'http_code' => 400, 'description' => 'You must enter a valid ID for the target gateway.'],
+ ['code' => 'EmptyVolumeIndexId', 'message' => 'You must enter an index ID for the block volume.', 'http_code' => 400, 'description' => 'You must enter an index ID for the block volume.'],
+ ['code' => 'EmptyVolumeName', 'message' => 'You must enter a valid name for the volume.', 'http_code' => 400, 'description' => 'You must enter a valid name for the volume.'],
+ ['code' => 'ExpressSyncInOperation', 'message' => 'The sync group is busy. Try again later.', 'http_code' => 400, 'description' => 'The sync group is busy. Try again later.'],
+ ['code' => 'ExpressSyncNotEmpty', 'message' => 'Failed to delete the express sync because a file share or a CSD mount point is attached. We recommend that you remove all attached before you delete the express sync.', 'http_code' => 400, 'description' => 'There are file shares in the extreme synchronization group or the mount point of the software version is bound. Please remove all bound file shares and mount points of the software version before deleting the extreme synchronization group.'],
+ ['code' => 'ExpressSyncNotExist', 'message' => 'The specified sync group does not exist. You must specify a valid parameter.', 'http_code' => 400, 'description' => 'The specified sync group does not exist. You must specify a valid parameter.'],
+ ['code' => 'ExpressSyncNotificationEventConflict', 'message' => 'The express sync configuration of bucket and prefix conflicts with existing notification events in MNS.', 'http_code' => 400, 'description' => 'The bucket and prefix configurations of the synchronization group conflict with the existing event rule configurations in the MNS.'],
+ ['code' => 'ExpressSyncNotificationEventLimitExceed', 'message' => 'The number of sync groups exceeds the maximum limit. If you want to add more sync groups, we recommend that you submit a ticket to apply for the whitelist permission.', 'http_code' => 400, 'description' => 'The number of sync groups exceeds the maximum limit. If you want to add more sync groups, we recommend that you submit a ticket to apply for the whitelist permission.'],
+ ['code' => 'ExpressSyncNotificationEventLimitExceed', 'message' => 'The number of mns event notification has reached the limit.', 'http_code' => 400, 'description' => 'Maximum number of mns event rules reached'],
+ ['code' => 'FileShareArchiveSupportConflict', 'message' => 'You can configure the ArchiveSupport parameter only with NFS protocol and when the user mapping value is "none".', 'http_code' => 400, 'description' => ''],
+ ['code' => 'GatewayActivationError', 'message' => 'You cannot enable the gateway when the gateway is in the current state.', 'http_code' => 400, 'description' => 'You cannot enable the gateway when the gateway is in the current state.'],
+ ['code' => 'GatewayBandwidthNotSupported', 'message' => 'You cannot decrease the public network bandwidth of a On Premise Gateway.', 'http_code' => 400, 'description' => 'You cannot decrease the public network bandwidth of a On Premise Gateway.'],
+ ['code' => 'GatewayBandwidthReduceNotSupported', 'message' => 'You cannot specify a public network bandwidth for an on-premises gateway.', 'http_code' => 400, 'description' => 'You cannot specify a public network bandwidth for an on-premises gateway.'],
+ ['code' => 'GatewayClassUpgradeOnly', 'message' => 'You can upgrade only the specification of the gateway.', 'http_code' => 400, 'description' => 'You can upgrade only the specification of the gateway.'],
+ ['code' => 'GatewayClientMismatch', 'message' => 'Failed to authenticate the client because the specified information is invalid.', 'http_code' => 400, 'description' => 'Failed to authenticate the client because the specified information is invalid.'],
+ ['code' => 'GatewayDeactivationError', 'message' => 'You cannot disable the gateway when the gateway is in the current state.', 'http_code' => 400, 'description' => 'You cannot disable the gateway when the gateway is in the current state.'],
+ ['code' => 'GatewayDeletionError', 'message' => 'You cannot delete the gateway when the gateway is in the current state.', 'http_code' => 400, 'description' => 'You cannot delete the gateway when the gateway is in the current state.'],
+ ['code' => 'GatewayExpired', 'message' => 'The specified gateway has expired. We recommend that you renew Cloud Storage Gateway.', 'http_code' => 400, 'description' => 'The specified gateway has expired. We recommend that you renew Cloud Storage Gateway.'],
+ ['code' => 'GatewayFailedToProvideService', 'message' => 'The status of the gateway is abnormal and cannot provide service. Please create a new one.', 'http_code' => 400, 'description' => 'Specified gateway is not in a good shape and could not provide the service. Please create a new one. '],
+ ['code' => 'GatewayInOperation', 'message' => 'The gateway is processing requests . Try again later.', 'http_code' => 400, 'description' => 'The gateway is busy. Try again later.'],
+ ['code' => 'GatewayInUpgrading', 'message' => 'The gateway is upgrading. Try again later.', 'http_code' => 400, 'description' => 'The gateway is upgrading. Try again later.'],
+ ['code' => 'GatewayLoggingStatusNotAllowed', 'message' => 'Failed to perform the operation because log monitoring is not enabled.', 'http_code' => 400, 'description' => 'Failed to perform the operation because log monitoring is not enabled.'],
+ ['code' => 'GatewayNotEmpty', 'message' => 'There are file shares or block volumes still under the gateway, please delete them first and then delete the gateway.', 'http_code' => 400, 'description' => 'There are file shares or block volumes still under the gateway, please delete them first and then delete the gateway.'],
+ ['code' => 'GatewayNotExist', 'message' => 'The specified gateway does not exist. You must specify a valid parameter.', 'http_code' => 400, 'description' => 'The specified gateway does not exist. You must specify a valid parameter.'],
+ ['code' => 'GatewayOperationNotAllowed', 'message' => 'You cannot perform the operation when the gateway is in the current state.', 'http_code' => 400, 'description' => 'You cannot perform the operation when the gateway is in the current state.'],
+ ['code' => 'GatewayStatusRunningRequired', 'message' => 'The gateway is not in the Running state. Try again later.', 'http_code' => 400, 'description' => 'The gateway is not in the Running state. Try again later.'],
+ ['code' => 'GatewayVersionNotAllowed', 'message' => 'The specified version for the gateway is invalid. You must specify a valid version.', 'http_code' => 400, 'description' => 'The specified version for the gateway is invalid. You must specify a valid version.'],
+ ['code' => 'InDebt', 'message' => 'The specified account has overdue payments. We recommend that you add funds to the account now.', 'http_code' => 403, 'description' => 'The specified account has overdue payments. We recommend that you add funds to the account now.'],
+ ['code' => 'InDebt', 'message' => 'The account is in debt.', 'http_code' => 400, 'description' => 'Account is overdue'],
+ ['code' => 'InDebtOverdue', 'message' => 'The specified account has overdue payments. We recommend that you add funds to the account now.', 'http_code' => 403, 'description' => 'The specified account has overdue payments. We recommend that you add funds to the account now.'],
+ ['code' => 'InternalError', 'message' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.', 'http_code' => 500, 'description' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.'],
+ ['code' => 'InvalidADServerIp', 'message' => 'The specified IP address for the server is invalid. You must enter a valid IP address.', 'http_code' => 400, 'description' => 'The specified IP address for the server is invalid. You must enter a valid IP address.'],
+ ['code' => 'InvalidBucketEndpoint', 'message' => 'The specified endpoint for the bucket is invalid. The Endpoint must start with oss- and end with .aliyuncs.com.', 'http_code' => 400, 'description' => 'The specified endpoint for the bucket is invalid. The Endpoint must start with oss- and end with .aliyuncs.com.'],
+ ['code' => 'InvalidBucketName', 'message' => 'The specified bucket name is invalid. You must enter a valid bucket name.', 'http_code' => 400, 'description' => 'The specified bucket name is invalid. You must enter a valid bucket name.'],
+ ['code' => 'InvalidCacheDiskCategory', 'message' => 'The category that you specified for the cache disk is invalid. You must specify a valid category.', 'http_code' => 400, 'description' => 'The category that you specified for the cache disk is invalid. You must specify a valid category.'],
+ ['code' => 'InvalidCapacity', 'message' => 'The specified Capacity is invalid. You must specify a valid Capacity.', 'http_code' => 400, 'description' => 'Specified parameter Capacity is invalid, You must specify a valid Capacity.'],
+ ['code' => 'InvalidDataLoadType', 'message' => 'The specified LoadType is invalid. Valid values are: never, once, and periodical.', 'http_code' => 400, 'description' => 'Specified parameter LoadType is not valid.The valid value should be: never, once or periodical.'],
+ ['code' => 'InvalidDNS', 'message' => 'The specified parameter includes one or more invalid IP addresses. You must specify a valid parameter.', 'http_code' => 400, 'description' => 'The specified parameter includes one or more invalid IP addresses. You must specify a valid parameter.'],
+ ['code' => 'InvalidExpressSyncId', 'message' => 'Invalid ExpressSyncId.', 'http_code' => 400, 'description' => 'Invalid ExpressSyncId'],
+ ['code' => 'InvalidExpressSyncName', 'message' => 'The specified name for the sync group is invalid. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.', 'http_code' => 400, 'description' => 'The specified name for the sync group is invalid. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.'],
+ ['code' => 'InvalidGatewayBandwidth', 'message' => 'The specified public network bandwidth for the gateway is invalid. The bandwidth ranges from 6 to 200 Mbit/s.', 'http_code' => 400, 'description' => 'The specified public network bandwidth for the gateway is invalid. The bandwidth ranges from 6 to 200 Mbit/s.'],
+ ['code' => 'InvalidGatewayCategory', 'message' => 'The specified model of the gateway is invalid.', 'http_code' => 400, 'description' => 'The specified model of the gateway is invalid.'],
+ ['code' => 'InvalidGatewayClass', 'message' => 'The specified specification of the gateway is invalid.', 'http_code' => 400, 'description' => 'The specified specification of the gateway is invalid.'],
+ ['code' => 'InvalidGatewayDeletionReason', 'message' => 'The specified gateway deletion reason type or detail is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidGatewayLocation', 'message' => 'The specified location of the gateway is invalid.', 'http_code' => 400, 'description' => 'The specified location of the gateway is invalid.'],
+ ['code' => 'InvalidGatewayName', 'message' => 'The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.', 'http_code' => 400, 'description' => 'The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.'],
+ ['code' => 'InvalidGatewayType', 'message' => 'The specified type of the gateway is invalid.', 'http_code' => 400, 'description' => 'The specified type of the gateway is invalid.'],
+ ['code' => 'InvalidInterval', 'message' => 'The specified Interval is invalid. The value must not be less than 5 seconds.', 'http_code' => 400, 'description' => 'Specified Interval is not valid. The interval value should not less than 5 seconds.'],
+ ['code' => 'InvalidLDAPBaseDN', 'message' => 'The specified Base DN is invalid. You must specify a valid Base DN.', 'http_code' => 400, 'description' => 'The specified Base DN is invalid. You must specify a valid Base DN.'],
+ ['code' => 'InvalidLDAPRootDN', 'message' => 'The specified Root DN is invalid. You must specify a valid Root DN.', 'http_code' => 400, 'description' => 'The specified Root DN is invalid. You must specify a valid Root DN.'],
+ ['code' => 'InvalidLDAPServerIp', 'message' => 'You must enter a valid IP address for the server.', 'http_code' => 400, 'description' => 'You must enter a valid IP address for the server.'],
+ ['code' => 'InvalidLogstore', 'message' => 'You must specify a valid project and Logstore of Log Service. The project and Logstore must reside in the same region as the gateway. You can use the project and Logstore to monitor logs.', 'http_code' => 400, 'description' => 'You must specify a valid project and Logstore of Log Service. The project and Logstore must reside in the same region as the gateway. You can use the project and Logstore to monitor logs.'],
+ ['code' => 'InvalidMaxThroughput', 'message' => 'The specified MaxThroughput is invalid. You must specify a valid throughput.', 'http_code' => 400, 'description' => 'Specified parameter MaxThroughput is invalid, You must specify a valid throughput.'],
+ ['code' => 'InvalidMountPointOnGateway', 'message' => 'The specified MountPoint is invalid. Please enter a mount point IP that exists on the elastic gateway.', 'http_code' => 400, 'description' => 'Specified parameter MountPoint is not valid.'],
+ ['code' => 'InvalidNewSizeInGB', 'message' => 'The scale-up size that you specified for the cache disk is invalid. You must specify a valid size.', 'http_code' => 400, 'description' => 'The scale-up size that you specified for the cache disk is invalid. You must specify a valid size.'],
+ ['code' => 'InvalidParameter.BlockVolume.%s', 'message' => 'The specified field %s for block volume is invalid. Please check it again.', 'http_code' => 400, 'description' => 'The specified block volume parameter is invalid. You must specify a valid parameter.'],
+ ['code' => 'InvalidParameter.FileShare.%s', 'message' => 'The specified field %s for file share is invalid. Please check it again.', 'http_code' => 400, 'description' => 'The specified file sharing parameter for the gateway is invalid. You must specify a valid parameter.'],
+ ['code' => 'InvalidRegionId', 'message' => 'The specified RegionId does not exist. You must specify a valid RegionId.', 'http_code' => 400, 'description' => 'The specified RegionId does not exist. You must specify a valid RegionId.'],
+ ['code' => 'InvalidRegionId', 'message' => 'The region id is invalid.', 'http_code' => 400, 'description' => 'Illegal geographical information'],
+ ['code' => 'InvalidShareProtocol', 'message' => 'The specified file sharing type is invalid. Valid values include SMB and NFS. Try again later.', 'http_code' => 400, 'description' => 'The specified file sharing type is invalid. Valid values include SMB and NFS. Try again later.'],
+ ['code' => 'InvalidSMBPassword', 'message' => 'The specified SMB password is invalid. You must enter a valid password.', 'http_code' => 400, 'description' => 'The specified SMB password is invalid. You must enter a valid password.'],
+ ['code' => 'InvalidSMBUserName', 'message' => 'You must enter a valid SMB username.', 'http_code' => 400, 'description' => 'You must enter a valid SMB username.'],
+ ['code' => 'InvalidStartTimeOrEndTime', 'message' => 'The specified StartTime or EndTime is invalid. Please make sure that the EndTime is later than the StartTime and the time span must not exceed 14 days.', 'http_code' => 400, 'description' => 'Specified parameter StartTime or EndTime is not valid.Pelease make sure that the Endtime is larger than the StarTime and the timespan should not larger than 14 days.'],
+ ['code' => 'InvalidStorageBundleName', 'message' => 'The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.', 'http_code' => 400, 'description' => 'The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.'],
+ ['code' => 'InvalidStorageTargetId', 'message' => 'The specified TargetId is invalid.', 'http_code' => 400, 'description' => 'Specified parameter TargetId is not valid.'],
+ ['code' => 'InvalidStorageTargetName', 'message' => 'The specified name of the Storage Target is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.', 'http_code' => 400, 'description' => 'The specified name of the Storage Target is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.'],
+ ['code' => 'InvalidStorageTargetType', 'message' => 'The specified StorageTargetType is invalid.', 'http_code' => 400, 'description' => 'Specified parameter StorageTargetType is not valid.'],
+ ['code' => 'InvalidVolumeName', 'message' => 'The specified volume name is invalid. The name must be a maximum of 32 characters in length and contain lower-case letters and digits.The name must start with a lower-case letter.', 'http_code' => 400, 'description' => 'The specified volume name is invalid. The name must be a maximum of 32 characters in length and contain lower-case letters and digits.The name must start with a lower-case letter.'],
+ ['code' => 'InvalidVSwitchId', 'message' => 'The specified VSwitch ID does not exist.', 'http_code' => 400, 'description' => 'The specified VSwitch ID does not exist.'],
+ ['code' => 'LocationCloudRequired', 'message' => 'You must specify a cloud gateway. Try again later.', 'http_code' => 400, 'description' => 'You must specify a cloud gateway. Try again later.'],
+ ['code' => 'MnsServiceInDebt', 'message' => 'Message Service is in arrears. You must pay all the overdue bills.', 'http_code' => 400, 'description' => 'Message Service is in arrears. You must pay all the overdue bills.'],
+ ['code' => 'MnsServiceNotEnabled', 'message' => 'Message Service is not activated. We recommend that you activate the server.', 'http_code' => 400, 'description' => 'Message Service is not activated. We recommend that you activate the server.'],
+ ['code' => 'NoAvailabePaymentMetthod', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'http_code' => 400, 'description' => 'Account is not bound to payment information'],
+ ['code' => 'NoAvailableOnlineResource', 'message' => 'There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.', 'http_code' => 400, 'description' => 'There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.'],
+ ['code' => 'NoBetaTestPermission', 'message' => 'Failed to create an elastic gateway due to insufficient permissions. Please apply for beta testing permissions.', 'http_code' => 403, 'description' => 'Failed to create an elastic gateway due to insufficient permissions. Please apply for beta testing permissions.'],
+ ['code' => 'NoPermission', 'message' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.', 'http_code' => 403, 'description' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.'],
+ ['code' => 'NotEnoughIpInUserSwitch', 'message' => 'The VSwitch does not have enough IP addresses.', 'http_code' => 400, 'description' => 'The VSwitch does not have enough IP addresses.'],
+ ['code' => 'NotEnoughNodesOnline', 'message' => 'Not enough elastic nodes are created. Delete the elastic gateway and try again.', 'http_code' => 400, 'description' => 'Not enough elastic nodes are created and online, please delete the elastic gateway and try again.'],
+ ['code' => 'OperationRequireElasticGateway', 'message' => 'This operation requires an elastic gateway.', 'http_code' => 400, 'description' => 'This operation requires elastic gateway.'],
+ ['code' => 'OrderNoRealNameAuthentication', 'message' => 'You have not completed real name authentication yet. Please complete the real-name authentication.', 'http_code' => 400, 'description' => 'You have not verified your real name. Please go to <a target = "_blank". href = "https://account.console.aliyun.com/v2/'],
+ ['code' => 'OrderOpend', 'message' => 'You have already activated the service. Please go to the console to start using it.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OSSResourceAccountAccessFail', 'message' => 'Failed to access OSS. We recommend that you submit a ticket in the Alibaba Cloud console.', 'http_code' => 500, 'description' => 'Failed to access OSS. We recommend that you submit a ticket in the Alibaba Cloud console.'],
+ ['code' => 'PERMISSION_DENIED', 'message' => 'Permission denied.', 'http_code' => 403, 'description' => 'Permission denied.'],
+ ['code' => 'PostPaidNotAllowed', 'message' => 'You can only use a subscription gateway to perform the operation. Try again later.', 'http_code' => 400, 'description' => 'You can only use a subscription gateway to perform the operation. Try again later.'],
+ ['code' => 'RiskControlProhibited', 'message' => 'The specified account is in the Risk Control Prohibited state. We recommend that you submit a ticket in the Alibaba Cloud console.', 'http_code' => 403, 'description' => 'The specified account is in the Risk Control Prohibited state. We recommend that you submit a ticket in the Alibaba Cloud console.'],
+ ['code' => 'RoleNotExist', 'message' => 'The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.', 'http_code' => 404, 'description' => 'The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.'],
+ ['code' => 'ServiceInUse', 'message' => 'Failed to disable Cloud Storage Gateway. We recommend that you delete all the attached gateway clusters and gateways.', 'http_code' => 400, 'description' => 'Failed to disable Cloud Storage Gateway. We recommend that you delete all the attached gateway clusters and gateways.'],
+ ['code' => 'ServiceNotActivated', 'message' => 'Cloud Storage Gateway is not activated.', 'http_code' => 403, 'description' => 'Cloud Storage Gateway is not activated.'],
+ ['code' => 'ServiceReleased', 'message' => 'Service is released, please open service again.', 'http_code' => 400, 'description' => 'Service is released, please open service again.'],
+ ['code' => 'ShareNameInUse', 'message' => 'The share name is in use.', 'http_code' => 400, 'description' => 'Share name in use'],
+ ['code' => 'StorageBundleDescriptionOverLimit', 'message' => 'The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.', 'http_code' => 400, 'description' => 'The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.'],
+ ['code' => 'StorageBundleNotEmpty', 'message' => 'Failed to delete the gateway cluster because a cloud gateway or an on-premises gateway exists. We recommend that you delete all attached gateways before you delete the gateway cluster.', 'http_code' => 400, 'description' => 'Failed to delete the gateway cluster because a cloud gateway or an on-premises gateway exists. We recommend that you delete all attached gateways before you delete the gateway cluster.'],
+ ['code' => 'StorageBundleNotExist', 'message' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', 'http_code' => 404, 'description' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.'],
+ ['code' => 'TargetCountLimitedOnGateway', 'message' => 'The maximum number of storage targets on the elastic gateway has exceeded the quota.', 'http_code' => 400, 'description' => 'The storage target count has exceeded the maximum quota on an Elasitc Gateway.'],
+ ['code' => 'TargetNameExistOnGateway', 'message' => 'The specified parameter name of Storage Target already exists on the elastic gateway. Please enter a new one.', 'http_code' => 400, 'description' => 'Specified parameter name of Storage Target has existed on the Elastic Gateway, please input a new one.'],
+ ['code' => 'TaskNotExist', 'message' => 'The specified task does not exist. You must specify a valid parameter.', 'http_code' => 404, 'description' => 'The specified task does not exist. You must specify a valid parameter.'],
+ ['code' => 'TaskOperationNotAllowed', 'message' => 'Failed to perform the task. Try again later.', 'http_code' => 400, 'description' => 'Failed to perform the task. Try again later.'],
+ ['code' => 'TokenExpired', 'message' => 'The specified token has expired. We recommend that you create a new token.', 'http_code' => 400, 'description' => 'The specified token has expired. We recommend that you create a new token.'],
+ ['code' => 'TokenInvalid', 'message' => 'The specified token is invalid. You must specify a valid parameter in the request.', 'http_code' => 400, 'description' => 'The specified token is invalid. You must specify a valid parameter in the request.'],
+ ['code' => 'VersionNotSupported.BlockVolume.%s', 'message' => 'The specified field %s for block volume is not supported by current gateway version. Please check it again.', 'http_code' => 400, 'description' => 'The specified block volume parameter for the gateway is not compatible with the gateway version. You must specify a valid parameter.'],
+ ['code' => 'VersionNotSupported.FileShare.%s', 'message' => 'The specified field %s for file share is not supported by current gateway version. Please check it again.', 'http_code' => 400, 'description' => 'The specified file sharing parameter for the gateway does not match the gateway version. You must specify a valid parameter.'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGateway'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAccountConfig'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenSgwService'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewaySMBUsers'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeGateway'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGatewayBlockVolumes'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeExpressSyncShares'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGatewaySMBUser'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayFileShares'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGateway'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddSharesToExpressSync'],
+ ['threshold' => '300', 'countWindow' => 30, 'regionId' => '*', 'api' => 'DisableGatewayLogging'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExpandGatewayFileShare'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeStorageBundles'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateStorageBundle'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayCaches'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateExpressSync'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExpandGatewayNetworkBandwidth'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGatewayFileShareWatermark'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateGatewayFileShare'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGatewayBlockVolume'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGateways'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGatewayFileShare'],
+ ['threshold' => '300', 'countWindow' => 30, 'regionId' => '*', 'api' => 'ExpandCacheDisk'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteStorageBundle'],
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayCategories'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayDNS'],
+ ['threshold' => '300', 'countWindow' => 30, 'regionId' => '*', 'api' => 'EnableGatewayLogging'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeExpressSyncs'],
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayFileStatus'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeployGateway'],
+ ['threshold' => '300', 'countWindow' => 30, 'regionId' => '*', 'api' => 'DescribeTasks'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayLogging'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGateway'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayBlockVolumes'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayTypes'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateGatewayBlockVolume'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyStorageBundle'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveSharesFromExpressSync'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetGatewayADInfo'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGatewayLogging'],
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetGatewayDNS'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGatewayCacheDisk'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGatewayFileShares'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGateway'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGatewaySMBUser'],
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayADInfo'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGatewayCacheDisk'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TriggerGatewayRemoteSync'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGatewayLogging'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteExpressSync'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayImages'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeStorageBundle'],
+ ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayClasses'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewayNFSClients'],
+ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGatewaysTags'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'CloudStorageGateway',
+ 'productName' => 'Cloud Storage Gateway',
+ 'ramCodes' => ['hcs-sgw'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DeleteGatewaySMBUser',
+ 'description' => '',
'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwR40N8S',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewaySMBUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'gw-0001xv7je3580031***',
- 'required' => true,
- 'type' => 'string',
+ [
+ 'apiName' => 'CheckSlrRole',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CheckSlrRole',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'properties' => [
- 'Message' => [
- 'description' => '',
- 'example' => 'successful',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E66BF56E-068D-4308-A2D8-7FBBCE22E812',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- ],
- 'type' => 'object',
+ [
+ 'apiName' => 'SetElasticGatewayDataPolicy',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SetElasticGatewayDataPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayLoggingStatusNotAllowed',
- 'errorMessage' => 'Failed to perform the operation because log monitoring is not enabled.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
+ [
+ 'apiName' => 'UpgradeGateway',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UpgradeGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"E66BF56E-068D-4308-A2D8-7FBBCE22E812\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGatewayLoggingResponse>\\n <Message>successful</Message>\\n <RequestId>E66BF56E-068D-4308-A2D8-7FBBCE22E812</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteGatewayLoggingResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'title' => 'DeleteGatewayLogging',
- ],
- 'CreateExpressSync' => [
- 'summary' => 'Creates an express synchronization group.',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'UpdateGatewayFileShare',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UpdateGatewayFileShare',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'DescribeGatewayStock',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayStock',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CreateElasticGateway',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateElasticGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwNGMQUV',
+ [
+ 'apiName' => 'DescribeExpireCaches',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeExpireCaches',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'alex-tb***',
+ [
+ 'apiName' => 'DeleteGatewayCacheDisk',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewayCacheDisk',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
+ ],
+ [
+ 'apiName' => 'CreateStorageBundle',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateStorageBundle',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'BucketRegion',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
+ ],
+ [
+ 'apiName' => 'DeleteGatewayBlockVolumes',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewayBlockVolumes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'BucketName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sgw-test***',
+ ],
+ [
+ 'apiName' => 'ValidateExpressSyncConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ValidateExpressSyncConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'BucketPrefix',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test***',
+ ],
+ [
+ 'apiName' => 'DescribeGatewayCapacityLimit',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayCapacityLimit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EEFC9927-B097-446D-8FDA-F848C8B2C9E0',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'ExpressSyncId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sync-0001xv7je357xn8tr***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'DeleteGateway',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EmptyExpressSyncName',
- 'errorMessage' => 'You must enter a valid name for the sync group.',
+ [
+ 'apiName' => 'DescribeGatewayMonitorData',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayMonitorData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'EmptyBucketName',
- 'errorMessage' => 'You must enter a valid name for the bucket.',
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeGatewaysForCms',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewaysForCms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'EmptyBucketRegion',
- 'errorMessage' => 'You must specify a valid region for the bucket.',
+ ],
+ ],
+ [
+ 'apiName' => 'SwitchCSGClientsReverseSyncConfiguration',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SwitchCSGClientsReverseSyncConfiguration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'InvalidExpressSyncName',
- 'errorMessage' => 'The specified name for the sync group is invalid. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.',
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCache',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateCache',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'DescriptionOverLimit',
- 'errorMessage' => 'The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.',
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDashboard',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeDashboard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'DuplicateExpressSyncName',
- 'errorMessage' => 'The specified name of the sync group already exists. Try again later after you specify a valid parameter.',
+ ],
+ ],
+ [
+ 'apiName' => 'CreateElasticGatewayPrivateZone',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateElasticGatewayPrivateZone',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'ConflictExpressSyncConfig',
- 'errorMessage' => 'The parameter you specified for the sync group is invalid. Try again later after you specify a valid parameter.',
+ ],
+ ],
+ [
+ 'apiName' => 'DisableGatewayNFSVersion',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DisableGatewayNFSVersion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'ExpressSyncNotificationEventLimitExceed',
- 'errorMessage' => 'The number of sync groups exceeds the maximum limit. If you want to add more sync groups, we recommend that you submit a ticket to apply for the whitelist permission.',
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeExpressSyncs',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeExpressSyncs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'InvalidRegionId',
- 'errorMessage' => 'The specified RegionId does not exist. You must specify a valid RegionId.',
+ ],
+ ],
+ [
+ 'apiName' => 'SetGatewayADInfo',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SetGatewayADInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'InvalidBucketName',
- 'errorMessage' => 'The specified bucket name is invalid. You must enter a valid bucket name.',
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateGatewayBlockVolume',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UpdateGatewayBlockVolume',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'ExpressSyncNotificationEventConflict',
- 'errorMessage' => 'The express sync configuration of bucket and prefix conflicts with existing notification events in MNS.',
+ ],
+ ],
+ [
+ 'apiName' => 'CheckUpgradeVersion',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CheckUpgradeVersion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.',
+ ],
+ [
+ 'apiName' => 'CreateGatewayBlockVolume',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewayBlockVolume',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'AssumeRoleFail',
- 'errorMessage' => 'Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.',
+ ],
+ ],
+ [
+ 'apiName' => 'CheckBlockVolumeName',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CheckBlockVolumeName',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'RoleNotExist',
- 'errorMessage' => 'The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.',
+ ],
+ [
+ 'apiName' => 'TriggerGatewayRemoteSync',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:TriggerGatewayRemoteSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.',
+ ],
+ [
+ 'apiName' => 'GenerateUntrustedEnvCredential',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:GenerateUntrustedEnvCredential',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EEFC9927-B097-446D-8FDA-F848C8B2C9E0\\",\\n \\"Code\\": \\"200\\",\\n \\"ExpressSyncId\\": \\"sync-0001xv7je357xn8tr***\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateExpressSyncResponse>\\n <Message>successful</Message>\\n <RequestId>EEFC9927-B097-446D-8FDA-F848C8B2C9E0</RequestId>\\n <ExpressSyncId>sync-0001xv7je357xn8tr***</ExpressSyncId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateExpressSyncResponse>","errorExample":""}]',
- 'title' => 'CreateExpressSync',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'AddSharesToExpressSync' => [
- 'summary' => 'Adds shares to an express synchronization group.',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'DescribeCSGClients',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeCSGClients',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'DescribeVpcs',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeVpcs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'HandleGatewayAutoPlan',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:HandleGatewayAutoPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'SetGatewayLDAPInfo',
+ 'description' => '',
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwNGMQUV',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SetGatewayLDAPInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'ExpressSyncId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sync-0001xv7je357xn8tr***',
+ [
+ 'apiName' => 'DescribeGatewayStorageTargets',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayStorageTargets',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'GatewayShares',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"gw-000gwgp0j3jp8cb3t***":"share1,share2","gw-0001b2otnkdzte62j***":"weekly"}',
+ ],
+ [
+ 'apiName' => 'CreateExpressSync',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateExpressSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0001xv7je357xr6ql***',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA3887',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'MnsTopic' => [
- 'type' => 'string',
- ],
- 'MnsQueues' => [
- 'type' => 'string',
- ],
- 'MnsFullSyncDelay' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'MnsPublicEndpoint' => [
- 'type' => 'string',
- ],
- 'MnsInnerEndpoint' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'ModifyGatewayFileShareWatermark',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyGatewayFileShareWatermark',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EmptyExpressSyncId',
- 'errorMessage' => 'You must specify a valid ID for the sync group.',
+ [
+ 'apiName' => 'CheckGatewayEssdSupport',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CheckGatewayEssdSupport',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'ExpressSyncNotExist',
- 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.',
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeGatewayCredential',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayCredential',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'ExpressSyncInOperation',
- 'errorMessage' => 'The sync group is busy. Try again later.',
+ ],
+ ],
+ [
+ 'apiName' => 'CreateGatewayFileShare',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewayFileShare',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xr6ql***\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA3887\\",\\n \\"Message\\": \\"successful\\",\\n \\"MnsTopic\\": \\"sgw-express-sync-topic-sync-0009e51kabuou08***\\",\\n \\"MnsQueues\\": \\"sgw-express-sync-queue-gw-0009e51kabuoty9***-341604\\",\\n \\"MnsFullSyncDelay\\": 719,\\n \\"MnsPublicEndpoint\\": \\"http://123.mns.cn-hangzhou.aliyuncs.com/\\",\\n \\"MnsInnerEndpoint\\": \\"http://123.mns.cn-hangzhou-internal.aliyuncs.com/\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddSharesToExpressSyncResponse>\\n <TaskId>t-0001xv7je357xr6ql***</TaskId>\\n <RequestId>1EDBC004-6B1C-4511-ACF5-0B4875BA3887</RequestId>\\n <Message>successful</Message>\\n <MnsTopic>sgw-express-sync-topic-sync-0009e51kabuou08***</MnsTopic>\\n <MnsQueues>sgw-express-sync-queue-gw-0009e51kabuoty9***-341604</MnsQueues>\\n <MnsFullSyncDelay>719</MnsFullSyncDelay>\\n <MnsPublicEndpoint>http://123.mns.cn-hangzhou.aliyuncs.com/</MnsPublicEndpoint>\\n <MnsInnerEndpoint>http://123.mns.cn-hangzhou-internal.aliyuncs.com/</MnsInnerEndpoint>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AddSharesToExpressSyncResponse>","errorExample":""}]',
- 'title' => 'AddSharesToExpressSync',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeExpressSyncs' => [
- 'summary' => 'Queries information about the express synchronization groups, including the name, ID, and associated Object Storage Service (OSS) bucket.',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'DescribeGatewayLogging',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayLogging',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'UploadCSGClientLog',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UploadCSGClientLog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ReportGatewayUsage',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ReportGatewayUsage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwNGMQUV',
+ [
+ 'apiName' => 'ExpandCacheDisk',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ExpandCacheDisk',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'BucketName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sgw***',
+ [
+ 'apiName' => 'FenceHANode',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:FenceHANode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'BucketPrefix',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test***',
+ ],
+ [
+ 'apiName' => 'TakeOverHANodeIp',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:TakeOverHANodeIp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'ExpressSyncs' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ExpressSync' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ExpressSyncId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sync-0002xetjdlxne2sdm***',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'BucketName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sgw-mns***',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'wptest***',
- ],
- 'BucketPrefix' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test***',
- ],
- 'MnsTopic' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sgw-express-sync-0002xetjdlxne2sdm***',
- ],
- 'BucketRegion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50DE1383-D4A1-433C-98A6-459C1830A888',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'DescribeExpressSyncShares',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeExpressSyncShares',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
+ [
+ 'apiName' => 'CreateGatewaySMBUser',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewaySMBUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"ExpressSyncs\\": {\\n \\"ExpressSync\\": [\\n {\\n \\"ExpressSyncId\\": \\"sync-0002xetjdlxne2sd****\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"BucketName\\": \\"sgw-mns****\\",\\n \\"Name\\": \\"wptest****\\",\\n \\"BucketPrefix\\": \\"test****\\",\\n \\"MnsTopic\\": \\"sgw-express-sync-0002xetjdlxne2sd****\\",\\n \\"BucketRegion\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"50DE1383-D4A1-433C-98A6-459C1830A888\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeExpressSyncsResponse>\\n <ExpressSyncs>\\n <ExpressSyncId>sync-0002xetjdlxne2sd****</ExpressSyncId>\\n <Description>测试使用</Description>\\n <BucketName>sgw-mns****</BucketName>\\n <Name>wptest****</Name>\\n <BucketPrefix>test****</BucketPrefix>\\n <MnsTopic>sgw-express-sync-0002xetjdlxne2sd****</MnsTopic>\\n <BucketRegion>cn-hangzhou</BucketRegion>\\n </ExpressSyncs>\\n <Message>successful</Message>\\n <RequestId>50DE1383-D4A1-433C-98A6-459C1830A888</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeExpressSyncsResponse>","errorExample":""}]',
- 'title' => 'DescribeExpressSyncs',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeExpressSyncShares' => [
- 'summary' => 'Queries the shares that are added or can be added to express synchronization groups. The returned information includes the gateway name, cluster ID, share name, and more.',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'AddSharesToExpressSync',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:AddSharesToExpressSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ModifyGateway',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DeployCacheDisk',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeployCacheDisk',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'SetGatewayDNS',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SetGatewayDNS',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeGatewayFileStatus',
+ 'description' => '',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwNGMQUV',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayFileStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'ExpressSyncIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sync-0002xetjdlxne2sd***,sync-0004agfrbke1l39p***',
+ [
+ 'apiName' => 'DescribeStorageBundles',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeStorageBundles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'IsExternal',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ ],
+ [
+ 'apiName' => 'DescribeAccountConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeAccountConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EA258616-36AD-4609-A0A6-2B17C28CBF88',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Shares' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Share' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'MnsQueue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sgw-express-sync-queue-gw-000245alq48e7ytgxq03***',
- ],
- 'ExpressSyncId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sb-0003c7qh5yuc1z6b8***',
- ],
- 'GatewayId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gw-000245alq48e7ytg***',
- ],
- 'ExpressSyncState' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MNSHealthy',
- ],
- 'GatewayName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'StorageBundleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sb-0003c7qh5yuc1z6b8***',
- ],
- 'SyncProgress' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'GatewayRegion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'ShareName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ji***',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'DescribeGatewaySMBSecurityStrategy',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewaySMBSecurityStrategy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EmptyExpressSyncId',
- 'errorMessage' => 'You must specify a valid ID for the sync group.',
+ [
+ 'apiName' => 'DescribeGatewayCaches',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayCaches',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'ExpressSyncNotExist',
- 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.',
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveSharesFromExpressSync',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:RemoveSharesFromExpressSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeGatewayDNS',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayDNS',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EA258616-36AD-4609-A0A6-2B17C28CBF88\\",\\n \\"Code\\": \\"200\\",\\n \\"Shares\\": {\\n \\"Share\\": [\\n {\\n \\"MnsQueue\\": \\"sgw-express-sync-queue-gw-000245alq48e7ytgxq03***\\",\\n \\"ExpressSyncId\\": \\"sb-0003c7qh5yuc1z6b8***\\",\\n \\"GatewayId\\": \\"gw-000245alq48e7ytg***\\",\\n \\"ExpressSyncState\\": \\"MNSHealthy\\",\\n \\"GatewayName\\": \\"file-升级***\\",\\n \\"StorageBundleId\\": \\"sb-0003c7qh5yuc1z6b8***\\",\\n \\"SyncProgress\\": 100,\\n \\"GatewayRegion\\": \\"cn-hangzhou\\",\\n \\"ShareName\\": \\"ji***\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeExpressSyncSharesResponse>\\n <Message>successful</Message>\\n <RequestId>EA258616-36AD-4609-A0A6-2B17C28CBF88</RequestId>\\n <Shares>\\n <Share>\\n <ExpressSyncState>MNSHealthy</ExpressSyncState>\\n <ShareName>ji***</ShareName>\\n <GatewayRegion>cn-hangzhou</GatewayRegion>\\n <StorageBundleId>sb-0003c7qh5yuc1z6b8***</StorageBundleId>\\n <GatewayName>file-升级***</GatewayName>\\n <GatewayId>gw-000245alq48e7ytg***</GatewayId>\\n <ExpressSyncId>sync-000ip92hqkvu0gbxi***</ExpressSyncId>\\n <SyncProgress>100</SyncProgress>\\n <MnsQueue>sgw-express-sync-queue-gw-000245alq48e7ytgxq03***</MnsQueue>\\n </Share>\\n <Share>\\n <ExpressSyncState>MNSHealthy</ExpressSyncState>\\n <ShareName>cifs12***</ShareName>\\n <GatewayRegion>cn-hangzhou</GatewayRegion>\\n <StorageBundleId>sb-000gxdrndxrm50gtl***</StorageBundleId>\\n <GatewayName>file122***</GatewayName>\\n <GatewayId>gw-000hqr50529yvycly***</GatewayId>\\n <ExpressSyncId>sync-000jf2sbjhfatey3***</ExpressSyncId>\\n <SyncProgress>100</SyncProgress>\\n <MnsQueue>sgw-express-sync-queue-gw-000hqr5052cly5xa***</MnsQueue>\\n </Share>\\n </Shares>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeExpressSyncSharesResponse>","errorExample":""}]',
- 'title' => 'DescribeExpressSyncShares',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteExpressSync' => [
- 'summary' => 'Deletes an express synchronization group.',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'DescribeMqttConfig',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeMqttConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'DescribeGatewayCacheDiskStock',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayCacheDiskStock',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CheckActivationKey',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CheckActivationKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '17175',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwNGMQUV',
+ [
+ 'apiName' => 'ModifyGatewayBlockVolume',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyGatewayBlockVolume',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'ExpressSyncId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sync-0001xv7je357xn8tr***',
+ [
+ 'apiName' => 'DescribeGatewayBucketCaches',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayBucketCaches',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0001xv7je357xv4st***',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A870C702-C3AC-4FC9-91E4-053D3E599A24',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'DescribeGatewaySMBUsers',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewaySMBUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EmptyExpressSyncId',
- 'errorMessage' => 'You must specify a valid ID for the sync group.',
+ [
+ 'apiName' => 'DescribeCSGClientTasks',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeCSGClientTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'ExpressSyncNotExist',
- 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.',
+ ],
+ ],
+ [
+ 'apiName' => 'SetHaGatewayBindIpAddresses',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SetHaGatewayBindIpAddresses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
+ ],
+ ],
+ [
+ 'apiName' => 'SetGatewaySMBSecurityStrategy',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SetGatewaySMBSecurityStrategy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'ExpressSyncInOperation',
- 'errorMessage' => 'The sync group is busy. Try again later.',
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeGatewayModificationClasses',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayModificationClasses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'ExpressSyncNotEmpty',
- 'errorMessage' => 'Failed to delete the express sync because a file share or a CSD mount point is attached. We recommend that you remove all attached before you delete the express sync.',
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteGatewayLogging',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewayLogging',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xv4st***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A870C702-C3AC-4FC9-91E4-053D3E599A24\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteExpressSyncResponse>\\n <TaskId>t-0001xv7je357xv4st***</TaskId>\\n <Message>successful</Message>\\n <RequestId>A870C702-C3AC-4FC9-91E4-053D3E599A24</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteExpressSyncResponse>","errorExample":""}]',
- 'title' => 'DeleteExpressSync',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'RemoveSharesFromExpressSync' => [
- 'summary' => 'Removes one or more shares from an express synchronization group.',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'ModifyGatewayClass',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyGatewayClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'SwitchGatewayExpirationPolicy',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SwitchGatewayExpirationPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DescribeGatewayActions',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayActions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '17259',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwNGMQUV',
+ [
+ 'apiName' => 'DescribeGatewaysTags',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewaysTags',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'ExpressSyncId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sync-0001xv7je357xn8tr***',
+ [
+ 'apiName' => 'DescribeStorageBundle',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeStorageBundle',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'GatewayShares',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"gw-000gwgp0j3jp8cb3t***":"share1,share2","gw-0001b2otnkdzte62j***":"weekly"}',
+ ],
+ [
+ 'apiName' => 'DeleteCSGClients',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteCSGClients',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0001xv7je357xr6ql***',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1EDBC004-6B1C-4511-ACF5-0B4875BA3B22',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'DescribePayAsYouGoPrice',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribePayAsYouGoPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ExpressSyncNotExist',
- 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.',
+ [
+ 'apiName' => 'AddTagsToGateway',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:AddTagsToGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'ExpressSyncInOperation',
- 'errorMessage' => 'The sync group is busy. Try again later.',
+ ],
+ ],
+ [
+ 'apiName' => 'CheckRole',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CheckRole',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je357xr6ql***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1EDBC004-6B1C-4511-ACF5-0B4875BA3B22\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RemoveSharesFromExpressSyncResponse>\\n <TaskId>t-0001xv7je357xr6ql***</TaskId>\\n <Message>successful</Message>\\n <RequestId>1EDBC004-6B1C-4511-ACF5-0B4875BA3B22</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</RemoveSharesFromExpressSyncResponse>","errorExample":""}]',
- 'title' => 'RemoveSharesFromExpressSync',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeGatewayLocations' => [
- 'summary' => '查询网关位置列表',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'ExpandGatewayNetworkBandwidth',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ExpandGatewayNetworkBandwidth',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'TagResources',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:TagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DescribeGatewayInfo',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'systemTags' => [
+ [
+ 'apiName' => 'DescribeGatewayAutoUpgradeConfiguration',
+ 'description' => '',
'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '17209',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayAutoUpgradeConfiguration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C85521C5-AB12-52E0-8541-76E582C1DA2C',
- ],
- 'Locations' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Cloud,On_Premise',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'ActivateCSGAgent',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ActivateCSGAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C85521C5-AB12-52E0-8541-76E582C1DA2C\\",\\n \\"Locations\\": \\"Cloud,On_Premise\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- ],
- 'DescribeGatewaySMBClients' => [
- 'summary' => '查询文件网关中SMB挂载客户端列表。',
- 'methods' => [
- 'get',
- 'post',
+ [
+ 'apiName' => 'ReportFileShares',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ReportFileShares',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'DescribeOssBuckets',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeOssBuckets',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DescribeSharesBucketInfoForExpressSync',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeSharesBucketInfoForExpressSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '219649',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
+ [
+ 'apiName' => 'DescribeVSwitches',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeVSwitches',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
+ [
+ 'apiName' => 'UploadGatewayLog',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UploadGatewayLog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
+ ],
+ [
+ 'apiName' => 'StartHANode',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:StartHANode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
+ ],
+ [
+ 'apiName' => 'UntagResources',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UntagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213A***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ClientInfoList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ClientInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Signing' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'required',
- ],
- 'ProtocolVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.1',
- ],
- 'Group' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'guest',
- ],
- 'Username' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'guest',
- ],
- 'ClientIpAddr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '192.168.xx.xx',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'ExpandGatewayFileShare',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ExpandGatewayFileShare',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213A***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"ClientInfoList\\": {\\n \\"ClientInfo\\": [\\n {\\n \\"Signing\\": \\"required\\",\\n \\"ProtocolVersion\\": \\"2.1\\",\\n \\"Group\\": \\"guest\\",\\n \\"Username\\": \\"guest\\",\\n \\"ClientIpAddr\\": \\"192.168.xx.xx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- ],
- 'DescribeGatewaySMBSecurityStrategy' => [
- 'summary' => '查询网关SMB安全策略配置',
- 'methods' => [
- 'get',
- 'post',
+ [
+ 'apiName' => 'EnableGatewayLogging',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:EnableGatewayLogging',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'RemoveTagsFromGateway',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:RemoveTagsFromGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DescribeGatewayLDAPInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayLDAPInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'systemTags' => [
+ [
+ 'apiName' => 'ValidateGatewayName',
+ 'description' => '',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ValidateGatewayName',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gw-000c6hshwukkbryp****',
+ [
+ 'apiName' => 'DescribeGateway',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '395B1136-982E-4F95-BDCE-7323FFEF499E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'SecurityStrategy' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ClientNegotiated',
- ],
- ],
+ [
+ 'apiName' => 'DescribeGatewayADInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayADInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"395B1136-982E-4F95-BDCE-7323FFEF499E\\",\\n \\"Success\\": true,\\n \\"SecurityStrategy\\": \\"ClientNegotiated\\"\\n}","type":"json"}]',
- ],
- 'ListAlertEvents' => [
- 'summary' => '列出告警事件',
- 'methods' => [
- 'get',
- 'post',
+ [
+ 'apiName' => 'DescribeBlockVolumeSnapshots',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeBlockVolumeSnapshots',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'UninstallCSGAgent',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:UninstallCSGAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DescribeSuggestedHaGatewayBindIpAddresses',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeSuggestedHaGatewayBindIpAddresses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'CheckMnsService',
+ 'description' => '',
'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '191531',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CheckMnsService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
+ [
+ 'apiName' => 'DescribeGatewaysRenewPolicy',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewaysRenewPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'ShareIndexId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'nfs_share',
+ ],
+ [
+ 'apiName' => 'DeleteGatewayStorageTarget',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewayStorageTarget',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
+ ],
+ [
+ 'apiName' => 'ListTagResources',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ListTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
+ ],
+ [
+ 'apiName' => 'DescribeKmsKey',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeKmsKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'FirstTriggerTimestampStartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1761559501337',
+ ],
+ [
+ 'apiName' => 'ModifyElasticGatewaySpec',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyElasticGatewaySpec',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'FirstTriggerTimestampEndTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1761570323090',
+ ],
+ [
+ 'apiName' => 'ResetGatewayPassword',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ResetGatewayPassword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'GatewayRegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
+ ],
+ [
+ 'apiName' => 'DisableGatewayLogging',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DisableGatewayLogging',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alerting',
+ ],
+ [
+ 'apiName' => 'DescribeHaGatewayBindIpAddresses',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeHaGatewayBindIpAddresses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '395B1136-982E-4F95-BDCE-7323FFEF499E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'AlertEvents' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'uploadQueueFull',
- ],
- 'FirstTriggerTimestamp' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1761559501337',
- ],
- 'GatewayId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gw-000dx594q3j5o663s8nx',
- ],
- 'LastTriggerTimestamp' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1761570323090',
- ],
- 'StorageBundleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sb-000iymnht76bdwsho0lm',
- ],
- 'ShareIndexId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NFSnfs_share',
- ],
- 'Level' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'warn',
- ],
- 'AccountId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '”“',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'alerting',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- 'Display' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => '”“',
- ],
- 'ShareStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '”“',
- ],
- 'GatewayStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '”“',
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'StartElasticGateway',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:StartElasticGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"395B1136-982E-4F95-BDCE-7323FFEF499E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 20,\\n \\"AlertEvents\\": [\\n {\\n \\"Type\\": \\"uploadQueueFull\\",\\n \\"FirstTriggerTimestamp\\": 1761559501337,\\n \\"GatewayId\\": \\"gw-000dx594q3j5o663s8nx\\",\\n \\"LastTriggerTimestamp\\": 1761570323090,\\n \\"StorageBundleId\\": \\"sb-000iymnht76bdwsho0lm\\",\\n \\"ShareIndexId\\": \\"NFSnfs_share\\",\\n \\"Level\\": \\"warn\\",\\n \\"AccountId\\": 0,\\n \\"Status\\": \\"alerting\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Display\\": true,\\n \\"ShareStatus\\": \\"”“\\",\\n \\"GatewayStatus\\": \\"”“\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'SetGatewaySMBSecurityStrategy' => [
- 'summary' => '设置smb网关共享安全策略',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GenerateStsToken',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:GenerateStsToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'systemTags' => [
+ [
+ 'apiName' => 'SwitchToSubscription',
+ 'description' => '',
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SwitchToSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gw-0001xv7je3580031***',
+ [
+ 'apiName' => 'GenerateGatewayToken',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:GenerateGatewayToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'SecurityStrategy',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'EnforceSigning',
+ ],
+ [
+ 'apiName' => 'CreateGatewayCacheDisk',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewayCacheDisk',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '735B642E-6564-4A87-99A0-3609F67C787E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'DeleteElasticGatewayPrivateZone',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteElasticGatewayPrivateZone',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"735B642E-6564-4A87-99A0-3609F67C787E\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- ],
- 'DescribeGatewayModificationClasses' => [
- 'summary' => '控制台UI查询网关可升配规格',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DescribeEcsInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeEcsInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DescribeGatewayAuthInfo',
+ 'description' => '',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwQHP82G',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayAuthInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-0001xv7je3580031***',
+ [
+ 'apiName' => 'CreateGatewayStorageTarget',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewayStorageTarget',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FA8951CC-A534-425D-8705-F9A5CF9FD555',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TargetGatewayClasses' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'TargetGatewayClass' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'GatewayClass' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Enhanced',
- ],
- 'IsAvailable' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'CreateGateway',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'LocationCloudRequired',
- 'errorMessage' => 'You must specify a cloud gateway. Try again later.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
+ [
+ 'apiName' => 'DescribeUntrustedEnvAvailableResources',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeUntrustedEnvAvailableResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"FA8951CC-A534-425D-8705-F9A5CF9FD555\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"TargetGatewayClasses\\": {\\n \\"TargetGatewayClass\\": [\\n {\\n \\"GatewayClass\\": \\"Enhanced\\",\\n \\"IsAvailable\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeGatewayModificationClassesResponse>\\n <Message>successful</Message>\\n <RequestId>FA8951CC-A534-425D-8705-F9A5CF9FD555</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n <TargetGatewayClasses>\\n <TargetGatewayClass>\\n <IsAvailable>true</IsAvailable>\\n <GatewayClass>Enhanced</GatewayClass>\\n </TargetGatewayClass>\\n <TargetGatewayClass>\\n <IsAvailable>true</IsAvailable>\\n <GatewayClass>Advanced</GatewayClass>\\n </TargetGatewayClass>\\n </TargetGatewayClasses>\\n</DescribeGatewayModificationClassesResponse>","errorExample":""}]',
- 'title' => 'DescribeGatewayModificationClasses',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ModifyGatewayClass' => [
- 'summary' => '更改网关规格',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'DeleteExpressSync',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteExpressSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'CreateCSGClientMountPoint',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateCSGClientMountPoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'OpenSgwService',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:OpenSgwService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DeployGateway',
+ 'description' => '',
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw1K8DWI',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeployGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-0001xv7580031yzun***',
+ [
+ 'apiName' => 'ModifyGatewayStorageTarget',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyGatewayStorageTarget',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'GatewayClass',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Enhanced',
+ ],
+ [
+ 'apiName' => 'ModifyStorageBundle',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyStorageBundle',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'BuyURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&instanceId=gw-000c6hshwukjwc7e1***#/upgrade',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0001xv7je3580bx6v***',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '395B1136-982E-4F95-BDCE-7323FFEF499E',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'ReportHaGatewayStatus',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ReportHaGatewayStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'InvalidGatewayClass',
- 'errorMessage' => 'The specified specification of the gateway is invalid.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
+ [
+ 'apiName' => 'DescribeSubscriptionPrice',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeSubscriptionPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'LocationCloudRequired',
- 'errorMessage' => 'You must specify a cloud gateway. Try again later.',
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyGatewayFileShare',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ModifyGatewayFileShare',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'GatewayStatusRunningRequired',
- 'errorMessage' => 'The gateway is not in the Running state. Try again later.',
+ ],
+ ],
+ [
+ 'apiName' => 'CreateGatewayLogging',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:CreateGatewayLogging',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'GatewayClassUpgradeOnly',
- 'errorMessage' => 'You can upgrade only the specification of the gateway.',
+ ],
+ ],
+ [
+ 'apiName' => 'StopElasticGateway',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:StopElasticGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'NoAvailableOnlineResource',
- 'errorMessage' => 'There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.',
+ ],
+ ],
+ [
+ 'apiName' => 'ActivateGateway',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ActivateGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeGatewayNFSClients',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayNFSClients',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"BuyURL\\": \\"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&instanceId=gw-000c6hshwukjwc7e1***#/upgrade\\",\\n \\"TaskId\\": \\"t-0001xv7je3580bx6v***\\",\\n \\"RequestId\\": \\"395B1136-982E-4F95-BDCE-7323FFEF499E\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyGatewayClassResponse>\\n <TaskId>t-0001xv7je3580bx6v***</TaskId>\\n <BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&amp;orderType=UPGRADE&amp;instanceId=gw-000c6hshwukjwc7e1***#/upgrade</BuyURL>\\n <Message>successful</Message>\\n <RequestId>395B1136-982E-4F95-BDCE-7323FFEF499E</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyGatewayClassResponse>","errorExample":""}]',
- 'title' => 'ModifyGatewayClass',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'RestartFileShares' => [
- 'summary' => '重启文件共享',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'DescribeTasks',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListAlertEvents',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ListAlertEvents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DeleteGatewayFileShares',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteGatewayFileShares',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ReportBlockVolumes',
+ 'description' => '',
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgw64A0KV',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ReportBlockVolumes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-000eg44nmxbsfwbvq***',
+ [
+ 'apiName' => 'DescribeUserBusinessStatus',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeUserBusinessStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'ShareProtocol',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'NFS',
+ ],
+ [
+ 'apiName' => 'DescribeGatewaySMBClients',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewaySMBClients',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-000czaedx5koz578v***',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89398CFB-4EB6-4C7E-BB3C-EF213AC8FA** ',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'DescribeGatewayBlockVolumes',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayBlockVolumes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidShareProtocol',
- 'errorMessage' => 'The specified file sharing type is invalid. Valid values include SMB and NFS. Try again later.',
+ [
+ 'apiName' => 'DescribeGatewayFileShares',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayFileShares',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
+ ],
+ ],
+ [
+ 'apiName' => 'OperateGateway',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:OperateGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateMqttToken',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:GenerateMqttToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'GatewayInOperation',
- 'errorMessage' => 'The gateway is processing requests . Try again later.',
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteStorageBundle',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeleteStorageBundle',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.',
+ ],
+ [
+ 'apiName' => 'SetGatewayAutoUpgradeConfiguration',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:SetGatewayAutoUpgradeConfiguration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-000czaedx5koz578v***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA** \\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RestartFileSharesResponse>\\n <TaskId>t-000czaedx5koz578v***</TaskId>\\n <Message>successful</Message>\\n <RequestId>89398CFB-4EB6-4C7E-BB3C-EF213AC8FA** </RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</RestartFileSharesResponse>","errorExample":""}]',
- 'title' => 'RestartFileShares',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'UploadGatewayLog' => [
- 'summary' => '控制台UI上传网关服务日志',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'DescribeGateways',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGateways',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'HeartbeatCSGAgent',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:HeartbeatCSGAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ReportMonitorData',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ReportMonitorData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DescribeOssBucketInfo',
+ 'description' => '',
'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '17280',
- 'abilityTreeNodes' => [
- 'FEATUREhcs_sgwR40N8S',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeOssBucketInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'GatewayId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'gw-0001xv7je3031yzun***',
+ [
+ 'apiName' => 'ReportGatewayInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:ReportGatewayInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 't-0001xv7je3580412f***',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CB300009-3850-4107-B291-59BDB4EDA183',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'DescribeGatewayAutoPlans',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DescribeGatewayAutoPlans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EmptyGatewayId',
- 'errorMessage' => 'You must enter a valid ID for the gateway.',
- ],
- [
- 'errorCode' => 'GatewayNotExist',
- 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.',
+ [
+ 'apiName' => 'EnableGatewayIpv6',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:EnableGatewayIpv6',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'GatewayOperationNotAllowed',
- 'errorMessage' => 'You cannot perform the operation when the gateway is in the current state.',
+ ],
+ ],
+ [
+ 'apiName' => 'RestartFileShares',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:RestartFileShares',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'Invalid request. You must specify valid parameters in the request. ',
+ ],
+ ],
+ [
+ 'apiName' => 'DeployCSGClients',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hcs-sgw:DeployCSGClients',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'CloudStorageGateway', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"t-0001xv7je3580412f***\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CB300009-3850-4107-B291-59BDB4EDA183\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UploadGatewayLogResponse>\\n <TaskId>t-0001xv7je3580412f***</TaskId>\\n <Message>successful</Message>\\n <RequestId>CB300009-3850-4107-B291-59BDB4EDA183</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadGatewayLogResponse>","errorExample":""}]',
- 'title' => 'UploadGatewayLog',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'sgw.us-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'sgw.ap-southeast-3.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'sgw.cn-shanghai-finance-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-6',
- 'endpoint' => 'sgw.ap-southeast-6.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'sgw.cn-shanghai-finance-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'sgw.ap-southeast-5.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'sgw.eu-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'sgw.us-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-heyuan',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'sgw.cn-north-2-gov-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'sgw.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'sgw.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'sgw.eu-central-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-central-1',
- 'endpoint' => 'sgw.me-central-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'sgw.ap-northeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-2',
- 'endpoint' => 'sgw.ap-northeast-2.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];