'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'sgw', 'version' => '2018-05-11', ], 'directories' => [ [ 'id' => 282066, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateStorageBundle', 'ModifyStorageBundle', 'DescribeStorageBundle', 'DeleteStorageBundle', 'DescribeStorageBundles', ], ], [ 'id' => 282072, 'title' => null, 'type' => 'directory', 'children' => [ 'OpenSgwService', 'CreateGateway', 'UpgradeGateway', 'DeleteGateway', 'DescribeGateway', 'ModifyGateway', 'DeployGateway', 'DescribeTasks', 'DescribeGateways', 'DescribeGatewayCategories', 'DescribeGatewayTypes', 'DescribeAccountConfig', 'DescribeGatewayImages', 'TriggerGatewayRemoteSync', 'DescribeRegions', 'DescribeGatewayClasses', 'ExpandGatewayNetworkBandwidth', ], ], [ 'id' => 282090, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateGatewayBlockVolume', 'DescribeGatewayBlockVolumes', 'UpdateGatewayBlockVolume', 'DeleteGatewayBlockVolumes', ], ], [ 'id' => 282095, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateGatewayFileShare', 'DescribeGatewayFileStatus', 'DescribeGatewayFileShares', 'UpdateGatewayFileShare', 'DeleteGatewayFileShares', 'DescribeGatewayNFSClients', 'ModifyGatewayFileShareWatermark', 'ExpandGatewayFileShare', 'CreateGatewaySMBUser', 'DeleteGatewaySMBUser', 'DescribeGatewaySMBUsers', 'SetGatewayDNS', 'DescribeGatewayDNS', 'SetGatewayADInfo', 'DescribeGatewayADInfo', ], ], [ 'id' => 282111, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateGatewayCacheDisk', 'DescribeGatewayCaches', 'ExpandCacheDisk', 'DeleteGatewayCacheDisk', ], ], [ 'id' => 282116, 'title' => null, 'type' => 'directory', 'children' => [ 'TagResources', 'ListTagResources', 'UntagResources', ], ], [ 'id' => 282120, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateGatewayLogging', 'DescribeGatewayLogging', 'EnableGatewayLogging', 'DisableGatewayLogging', 'DeleteGatewayLogging', ], ], [ 'id' => 282126, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateExpressSync', 'AddSharesToExpressSync', 'DescribeExpressSyncs', 'DescribeExpressSyncShares', 'DeleteExpressSync', 'RemoveSharesFromExpressSync', ], ], [ 'id' => 282133, 'title' => null, '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex-123***', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'BackendBucketRegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n successful\\n 2AD80BDC-E05C-4A77-BBAD-5EDAEDE6333\\n sb-000ibk4xrlr03qrjr***\\n 200\\n true\\n","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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'StorageBundleId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sb-000ibk4xrlr03qrjr***', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex-123***', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], 404 => [ [ 'errorCode' => 'StorageBundleNotExist', 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', ], ], ], '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":"\\n successful\\n 70EACC9C-D07A-4A34-ADA4-77506C42777\\n sb-000ibk4xrlr03qr***\\n 200\\n true\\n","errorExample":""}]', 'title' => 'ModifyStorageBundle', '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'StorageBundleId', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => true, 'example' => 'sb-0007y2889yyxkuqov***', 'required' => true, 'type' => 'string', ], ], ], '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', ], ], 'type' => 'object', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EmptyStorageBundleId', 'errorMessage' => 'You must enter a valid ID for the gateway cluster.', ], ], 404 => [ [ 'errorCode' => 'StorageBundleNotExist', 'errorMessage' => '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":"\\n 测试集群\\n 1657706998\\n 736C7733-FCED-4AFB-8407-C325F210CE03\\n successful\\n sb-000dt67z4ijqfocpy***\\n cn-shanghai\\n 200\\n true\\n sdfa***\\n","errorExample":""}]', 'extraInfo' => ' ', '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'StorageBundleId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sb-0001b2otnkdxrigeq***', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n successful\\n 28708A34-83AF-42B8-928B-40E7B3E1D719\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DeleteStorageBundle', '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'BackendBucketRegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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":"\\n 3\\n successful\\n 5\\n 0F96A15D-BA06-4A34-9587-AA8C9C230E80\\n 1\\n 200\\n \\n \\n 1568795768\\n sb-0007y2889yyxkuqov***\\n cn-shanghai\\n 测试使用\\n sgw1-test***\\n \\n \\n 1533283347\\n sb-000dai44c82bp6i32***\\n cn-shanghai\\n 测试使用\\n sgw2-test***\\n \\n \\n 1532663546\\n sb-000e9qyjn694q148r***\\n cn-shanghai\\n 测试使用\\n sgw3-test***\\n \\n \\n true\\n","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', ], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], '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****', ], ], ], ], ], '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.', ], ], 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 \\"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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '17166', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'StorageBundleId', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => false, 'example' => 'sb-0001b2otnkdxrigeq***', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => true, 'example' => 'alex***', 'required' => true, 'type' => 'string', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => '', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'docRequired' => true, ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => true, 'example' => 'File', 'required' => true, 'type' => 'string', ], ], [ 'name' => 'Location', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => true, 'example' => 'Cloud', 'required' => true, 'type' => 'string', ], ], [ 'name' => 'GatewayClass', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => 'Basic', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => false, 'example' => 'vsw-bp1krhkglx3nahkb9s***', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'PostPaid', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => 'true', 'required' => false, 'type' => 'boolean', ], ], [ 'name' => 'ReleaseAfterExpiration', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => 'true', 'required' => false, 'type' => 'boolean', ], ], [ 'name' => 'PublicNetworkBandwidth', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => '50', 'format' => 'int32', 'required' => false, 'type' => 'integer', ], ], [ 'name' => 'ResourceRegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => 'cn-hangzhou', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'UntrustedEnvInstanceType', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'UntrustedEnvId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'SecondaryVSwitchId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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}®ionId=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', ], ], 'type' => 'object', ], ], ], '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.', ], ], ], '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}®ionId=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":"\\n successful\\n 8E69E1A1-9076-4C8C-8ADF-ACD253886E22\\n gw-0001xv7je357zm9u6m0u\\n https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&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\\n 200\\n true\\n","errorExample":""}]', 'extraInfo' => ' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'title' => 'CreateGateway', ], 'UpgradeGateway' => [ 'summary' => 'Updates a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwDLQA4J', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031y***', ], ], ], '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', ], ], 'description' => '', ], ], ], '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.　', ], ], ], '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":"\\n t-0001xv7je3580412***\\n successful\\n CB300009-3850-4107-B291-59BDB4EDA183\\n Code\\n true\\n","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' => ' ', ], 'DeleteGateway' => [ 'summary' => 'Deletes a pay-as-you-go gateway from its cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031y***', ], ], [ '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', ], ], [ 'name' => 'ReasonDetail', 'in' => 'query', 'schema' => [ 'description' => 'The detailed reason why you want to delete the gateway.'."\n", 'type' => 'string', 'required' => false, 'example' => '""', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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.', ], ], ], '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":"\\n t-0000iwdggbhaordhk***\\n successful\\n 151BB31D-571D-4BB9-9A02-D4210E5BF5DB\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DeleteGateway', 'description' => '### [](#)Usage notes'."\n" ."\n" .'Take note of the following items:'."\n" ."\n" .'* You can delete only a pay-as-you-go gateway.'."\n" .'* You can delete a gateway that is only in the Initialized, Activated, Running, Unknown, Failed, or Stopped state.'."\n" .'* If you have deleted a gateway using the CSG console, but it still appears in the Resource Management console, this may be due to cached information or synchronization delays. Wait a moment for the system to automatically update the status. If it does not update after an extended period, try refreshing the page or allow the system to synchronize automatically.'."\n" ."\n" .'**Warning** Deleting a gateway will interrupt business activities and data synchronization tasks. Exercise caution when performing this action.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGateway' => [ 'summary' => 'Queries the information about a gateway, such as the status and type.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', 'required' => true, 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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', ], ], 'type' => 'object', ], ], ], '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.', ], ], ], '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":"\\n 测试使用\\n 1532099461\\n 50\\n once\\n Aliyun\\n t-0000iwdggbharrw6r***\\n successful\\n 0\\n 47.101.**.**\\n File\\n sb-000dt67z4ijqfocpy***\\n Basic\\n true\\n alex***\\n true\\n 500\\n 1532530021\\n 1.0.39\\n false\\n Initialized\\n https://expense.console.aliyun.com/?returnExpense=true#/order/list/\\n 30\\n 120\\n 172.19.55.65\\n 736C7733-FCED-4AFB-8407-C325F210CE03\\n vsw-bp1b3mvml55ziekq7e***\\n 172.16.0.23\\n gw-0000ewknguw5o96vn***\\n 200\\n i-uf62406gy5vyao4y8***\\n File\\n https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew\\n vpc-uf6j237kxmsw08auey***\\n 1578986214\\n false\\n i-uf6gjr3lnwhyrd6hu***\\n 2408:4004::ffff:ffff:ffff:ffff:ffff:ffff\\n InternalError\\n Cloud\\n cn-hangzhou\\n ecs.g6.large\\n oss-cn-hangzhou.aliyuncs.com\\n false\\n","errorExample":""}]', 'extraInfo' => ' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'title' => 'DescribeGateway', ], 'ModifyGateway' => [ 'summary' => 'Modifies the basic information of a gateway, including the name and description.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, '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-0001xv7je3580031y***', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex***', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n successful\\n 220E7407-DF77-428D-8955-B02CF8F82D07\\n gw-0001xv7je3580031***\\n 200\\n true\\n","errorExample":""}]', 'title' => 'ModifyGateway', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeployGateway' => [ 'summary' => 'Deploys a pay-as-you-go gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031y***', ], ], [ 'name' => 'GatewayClass', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Basic', ], ], ], '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n t-0001xv7je35800307***\\n successful\\n 8FEAFE9D-66C2-46AB-833B-35269EC7524C\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DeployGateway', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeTasks' => [ 'summary' => 'Queries task information, including task progress and name.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], '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', '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***', ], ], ], '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', ], ], 'description' => '', ], ], ], '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.', ], ], ], '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":"\\n 1\\n \\n task.state.completed\\n 100\\n 1578367230\\n xxx\\n task.name.operate_fast_sync.delete\\n 1578367229\\n t-0001xv7je357xl9n***\\n NFSnfstest\\n \\n 8E9C6D43-4603-4F05-BE76-677A05EDFB7A\\n successful\\n 10\\n 1\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DescribeTasks', ], 'DescribeGateways' => [ 'summary' => 'Queries a list of gateways. The returned information includes gateway IDs and names.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17215', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], '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', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10', ], ], [ 'name' => 'ResourceRegionId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ '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}®ionId=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', ], ], ], ], ], '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.', ], ], 404 => [ [ 'errorCode' => 'StorageBundleNotExist', 'errorMessage' => 'The name you specified for the gateway cluster does not exist. You must specify a valid parameter.', ], ], ], '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}®ionId=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":"\\n 2\\n 2C4A8287-66F4-45F9-84E3-866E4232C763\\n successful\\n 10\\n 1\\n \\n vpc-bp1p0usrgr5z9e7lwr***\\n Running\\n File\\n 500\\n gw-0001b2odzvl3b1mhi***\\n false\\n File\\n 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 gw-0001b2onkdzvl3b***\\n 30\\n Advanced\\n 172.16.0.21\\n 测试使用\\n fio-weekly***\\n 2408:4004:110:6000:4656:f88e:1c14:e578\\n 1577179604\\n 0\\n 120\\n https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew\\n true\\n 55\\n sb-0001b2otrigeqkso***\\n 47.111.145.66\\n InternalError\\n 172.16.0.23\\n vsw-bp1krhkgnahkb9stp0***\\n gw-0001b2onkdzvl3b***\\n 1532426471\\n 1.2.6\\n once\\n false\\n Aliyun\\n 1577179769\\n t-000978oflgrd8ah6p***\\n Cloud\\n cn-hangzhou\\n ecs.g6.large\\n false\\n vsw-bp1krhkgnahkb8stp0***\\n \\n 200\\n true\\n","errorExample":""}]', 'title' => 'DescribeGateways', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGatewayCategories' => [ 'summary' => 'Queries available gateway categories.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17200', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'GatewayLocation', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'On_Premise', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17222', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'GatewayLocation', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Cloud', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n 200\\n successful\\n 787ECFD0-5F30-44C0-BB8F-56A964F66D01\\n true\\n File,Iscsi\\n","errorExample":""}]', 'title' => 'DescribeGatewayTypes', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAccountConfig' => [ 'summary' => 'Queries account configurations.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'gw-000hy2wefifsxau8****', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17206', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => true, 'example' => 'File', 'required' => true, 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'properties' => [ 'Message' => [ 'description' => '', 'example' => 'successful', 'type' => 'string', ], 'RequestId' => [ 'description' => '', 'example' => '30DFF66156-3672-4204-B708-24389F01FC77', 'type' => 'string', ], 'Images' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Image' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', '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', ], ], 'type' => 'object', ], ], ], ], 'Code' => [ 'description' => '', 'example' => '200', 'type' => 'string', ], 'Success' => [ 'description' => '', 'example' => 'true', 'type' => 'boolean', ], ], 'type' => 'object', ], ], ], '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.', ], ], ], '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":"\\n successful\\n 6BF67960-7782-4542-98AF-1E4B3B6E514B\\n \\n \\n application/octet-stre**\\n sgw.file.kvm.description\\n 1.0.40\\n 1063744512\\n \\n 2019-07-24\\n http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAISMVqr8***&Signature=%2BoTNVCxis8GMpv5NIRkFvE***%3D\\n aliyun/file/1.0.40/image/sgw-file-1.0.40.qc***\\n 76069b6a745dd360cd54064b***\\n \\n \\n application/x-virtualbox-v***\\n sgw.file.vhd.description\\n 1.0.39\\n 1819893760\\n \\n 2019-07-24\\n http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.39.vhd?Expires=1564045229&OSSAccessKeyId=LTAINaSMVqr8***&Signature=MUfa0layij2ofNWzUAoSxg%3D***\\n aliyun/file/1.0.40/image/sgw-file-1.0.39.v***\\n 48f3ce6a906b30ec40d84bf***\\n \\n \\n 200\\n true\\n","errorExample":""}]', 'extraInfo' => ' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'title' => 'DescribeGatewayImages', ], '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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwSTR2C0', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gw-0004wacp5e4ll1542****', ], ], [ 'name' => 'IndexId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the share.'."\n", 'type' => 'string', 'required' => true, 'example' => 'NFSshare_12012112****', ], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => [ 'description' => 'The path on which you want to trigger reverse synchronization.'."\n", 'type' => 'string', 'required' => false, 'example' => '/dirchild24120121****', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17228', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], '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' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Region' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => '', 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], '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":"\\n 200\\n successful\\n \\n cn-hangzhou\\n \\n \\n cn-shanghai\\n \\n \\n cn-qingdao\\n \\n \\n cn-beijing\\n \\n \\n cn-zhangjiakou\\n \\n \\n cn-huhehaote\\n \\n \\n cn-shenzhen\\n \\n \\n cn-chengdu\\n \\n \\n cn-hongkong\\n \\n \\n ap-southeast-1\\n \\n \\n ap-southeast-2\\n \\n \\n ap-southeast-5\\n \\n \\n eu-central-1\\n \\n E09C421A-A175-4D21-8928-ADF5643D15F8\\n true\\n","errorExample":""}]', 'title' => 'DescribeRegions', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGatewayClasses' => [ 'summary' => 'Queries available gateway editions.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], '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', ], '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', ], ], 'description' => '', ], ], ], '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":"\\n Basic,Standard,Enhanced,Advanced\\n 200\\n successful\\n EC3D33E5-0F6B-4D1B-9B35-59A71EB3FA50\\n true\\n","errorExample":""}]', 'title' => 'DescribeGatewayClasses', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ExpandGatewayNetworkBandwidth' => [ 'summary' => 'Increases the public network bandwidth level for a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbv****', ], ], [ 'name' => 'NewNetworkBandwidth', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ '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' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwJLV9QR', ], ], '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', ], ], [ 'name' => 'Recovery', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'VolumeProtocol', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'iSCSI', ], ], [ 'name' => 'Size', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], ], [ 'name' => 'ChunkSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32768', ], ], [ 'name' => 'CacheMode', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Cache', ], ], [ 'name' => 'ChapEnabled', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ChapInUser', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'chapInUser', ], ], [ 'name' => 'ChapInPassword', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'chapInPassword', ], ], [ 'name' => 'OssBucketName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bucketName', ], ], [ 'name' => 'OssEndpoint', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'oss-cn-shanghai-internal.aliyuncs.com', ], ], [ 'name' => 'OssBucketSsl', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'LocalFilePath', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '/dev/vdb', ], ], [ 'name' => 'OssBucketRegionId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n t-000c6hshwukkbtxrb***\\n successful\\n 9083F167-95B1-4B40-B2CD-70DE068EC3**\\n 200\\n true\\n","errorExample":""}]', 'title' => 'CreateGatewayBlockVolume', '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwJLV9QR', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000dt67z4ijngqvh***', ], ], [ 'name' => 'IndexId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'alex-or2020010816***', ], ], [ 'name' => 'Refresh', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'BlockVolumes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BlockVolume' => [ 'description' => '', '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', ], ], ], ], ], ], '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n \\n \\n 0\\n

172.16.0.40

\\n 0\\n \\n 0\\n 107374182400\\n false\\n 0\\n Cache\\n /dev/vdb\\n alex\\n cloud_efficiency\\n \\n oss-cn-hangzhou-internal.aliyuncs.com\\n iSCSI\\n 0\\n alex-or20200108161***\\n false\\n 1\\n true\\n 32768\\n clean\\n random***\\n \\n d-bp1a8athxvwbja18h***\\n \\n \\n successful\\n 787D4AD4-5536-4C36-9FB0-D74C0554D185\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DescribeGatewayBlockVolumes', 'description' => '****', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdateGatewayBlockVolume' => [ 'summary' => 'Updates the configuration of a volume for an Internet Small Computer System Interface (iSCSI) gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwJLV9QR', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', 'required' => true, 'type' => 'string', ], ], [ 'name' => 'IndexId', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => true, 'example' => 'NFSalex***', 'required' => true, 'type' => 'string', ], ], [ 'name' => 'Size', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => '100', 'format' => 'int64', 'required' => false, 'type' => 'integer', ], ], [ 'name' => 'ChapEnabled', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => 'false', 'required' => false, 'type' => 'boolean', ], ], [ 'name' => 'ChapInUser', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => 'user', 'required' => false, 'type' => 'string', ], ], [ 'name' => 'ChapInPassword', 'in' => 'query', 'schema' => [ 'description' => '', 'example' => 'ChapInPassword', 'required' => false, 'type' => 'string', ], ], ], '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' => [ 'description' => '', 'example' => 'true', 'type' => 'boolean', ], ], 'type' => 'object', ], ], ], '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.', ], ], ], '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":"\\n t-000avsri6tlyddgfe***\\n successful\\n EBAF769F-2E88-4D81-AF1E-A34FAACF9***\\n 200\\n true\\n","errorExample":""}]', 'extraInfo' => ' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'title' => 'UpdateGatewayBlockVolume', ], 'DeleteGatewayBlockVolumes' => [ 'summary' => 'Deletes a volume from an Internet Small Computer System Interface (iSCSI) gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwJLV9QR', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwb***', ], ], [ 'name' => 'IndexId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NFSalex-gx***', ], ], [ 'name' => 'IsSourceDeletion', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"t-0000iwdggbhaordhk***\\n151BB31D-571D-4BB9-9A02-D4210E5BF5DB\\nsuccesssful\\n200\\ntrue","errorExample":""}]', 'title' => 'DeleteGatewayBlockVolumes', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateGatewayFileShare' => [ 'summary' => 'Creates a share for a file gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17169', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], [ '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', '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'ServerSideEncryption', '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', ], ], [ 'name' => 'ServerSideCmk', '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', ], ], [ 'name' => 'ClientSideEncryption', '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', ], ], [ 'name' => 'ClientSideCmk', 'in' => 'query', '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'WindowsAcl', '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', ], ], [ 'name' => 'AccessBasedEnumeration', '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', ], ], [ 'name' => 'NfsV4Optimization', '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', ], ], [ 'name' => 'TransferAcceleration', 'in' => 'query', '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'PartialSyncPaths', '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', ], ], [ 'name' => 'ServerSideAlgorithm', 'in' => 'query', 'schema' => [ 'description' => 'The encryption algorithm. Valid values:'."\n" ."\n" .'* AES256 (default)'."\n" .'* SM4'."\n", 'type' => 'string', 'required' => false, 'example' => 'AES256', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'OssBucketRegionId', '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', ], ], [ 'name' => 'BucketInfos', '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, ], ], [ 'name' => 'BucketStub', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ '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***', ], ], 'description' => '', ], ], ], '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".', ], ], ], '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":"\\n t-000eg44nmxbsh3qk***\\n successful\\n F8B59F29-453D-49BF-8673-EEB8F9F2D5C6\\n 200\\n true\\n","errorExample":""}]', 'title' => 'CreateGatewayFileShare', 'description' => 'Before you call the operation, take note of the following items:'."\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", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGatewayFileStatus' => [ 'summary' => 'Queries the status of a file in a share of a file gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17205', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], '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', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sub/cptestfile****', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BadRequest', 'errorMessage' => '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', ], 'DescribeGatewayFileShares' => [ 'summary' => 'Queries shares for a file gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17204', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], [ 'name' => 'IndexId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'NFSd-million', ], ], [ 'name' => 'Refresh', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'FileShares' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FileShare' => [ 'description' => '', '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' => [ 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'OssBucketRegionId' => [ 'type' => 'string', ], ], ], ], ], ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '9A3C3C32-3F37-4658-9D38-945D0799CA0E', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], '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.', ], ], ], '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":"\\n successful\\n 9A3C3C32-3F37-4658-9D38-945D0799CA0E\\n \\n xxx\\n xxx\\n testprefix\\n false\\n 5\\n d-bp1cvy8o2569jij31***\\n 0\\n 5\\n 0\\n NFSale***\\n MNSNotEnabled\\n false\\n 0\\n 0\\n false\\n oss-cn-hangzhou-internal.aliyuncs.com\\n BucketHealthy\\n 0\\n xxx\\n 1.1.1.1\\n clean\\n SMB\\n false\\n 0\\n false\\n false\\n 10200202\\n root_squash\\n 21308227584\\n false\\n 85899345920\\n false\\n false\\n false\\n false\\n [{\\\\\\"Endpoint\\\\\\":\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"bucket1\\\\\\",\\\\\\"PathPrefix\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"Endpoint\\\\\\":\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"bucket2\\\\\\",\\\\\\"PathPrefix\\\\\\":\\\\\\"\\\\\\"}]\\n false\\n 0\\n cloud_efficiency\\n 0\\n false\\n user1\\n 70368744177664\\n 0\\n true\\n 80\\n 0\\n

172.16.0.44

\\n 900\\n alex***\\n bucketA\\n sync-0001xv7je357xn8tr***\\n 5\\n false\\n Cache\\n 0\\n 60\\n -2\\n AES256\\n bucket1\\n 0\\n /dev/vdb\\n 1.1.1.1\\n user2\\n false\\n true\\n false\\n false\\n true\\n started\\n 192.0.0.0\\n \\n 200\\n true\\n","errorExample":""}]', 'title' => 'DescribeGatewayFileShares', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdateGatewayFileShare' => [ 'summary' => 'Updates the configuration of a share for a file gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, '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****', ], ], [ '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', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'CacheMode', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Cache', ], ], [ 'name' => 'Browsable', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Squash', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'none', ], ], [ 'name' => 'ReadWriteUserList', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'user1,user2', ], ], [ 'name' => 'ReadOnlyUserList', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'user1,user2', ], ], [ 'name' => 'ReadWriteClientList', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '172.16.146.100', ], ], [ 'name' => 'ReadOnlyClientList', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '172.16.146.100', ], ], [ 'name' => 'LagPeriod', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', ], ], [ 'name' => 'DirectIO', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ServerSideEncryption', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ServerSideCmk', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'b1e08822-1e9c-4f8e-9dd1-a740cb200***', ], ], [ 'name' => 'ClientSideEncryption', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ClientSideCmk', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'b1e08822-1e9c-4f8e-9dd1-a740cb200***', ], ], [ 'name' => 'KmsRotatePeriod', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], ], [ 'name' => 'FastReclaim', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'WindowsAcl', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AccessBasedEnumeration', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'NfsV4Optimization', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'TransferAcceleration', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'BypassCacheRead', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ServerSideAlgorithm', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ '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' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], '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.', ], ], ], '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":"\\n t-000avsri6tlyddgf****\\n successful\\n EBAF769F-2E88-4D81-AF1E-A34FAACF9***\\n 200\\n true\\n","errorExample":""}]', 'title' => 'UpdateGatewayFileShare', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteGatewayFileShares' => [ 'summary' => 'Deletes a share from a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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.', ], ], ], '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":"\\n t-000c6hshwukkcfn****\\n successful\\n D3205DCC-D32B-497D-BB49-E212C608AD**\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DeleteGatewayFileShares', 'description' => '### [](#)Usage notes'."\n" ."\n" .'**'."\n" ."\n" .'**Warning** Deleting shares will interrupt your business continuity and data synchronization tasks. Exercise caution when performing this action.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGatewayNFSClients' => [ 'summary' => 'Queries the NFS clients of a file gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], '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', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031****', ], ], [ 'name' => 'IndexId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NFSalex****', ], ], [ 'name' => 'Watermark', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '90', 'minimum' => '40', 'example' => '40'."\n", ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.　', ], ], ], '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', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '22312', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], 'autoTest' => false, 'notSupportAutoTestReason' => '仅线下网关(用户idc环境)支持该操作', ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => false, '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' => false, 'example' => 'SMBpapcn', ], ], ], 'responses' => [ 200 => [ '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***', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"TaskId\\": \\"t-0001xv7je357xv4s***\\"\\n}","type":"json"}]', 'title' => 'ExpandGatewayFileShare', '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], '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', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123***', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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' => '[{"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":"\\n t-000c6hshwukkbtxrb***\\n successful\\n 9083F167-95B1-4B40-B2CD-70DE068EC3**\\n 200\\n true\\n","errorExample":""}]', 'title' => 'CreateGatewaySMBUser', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteGatewaySMBUser' => [ 'summary' => 'Deletes a Server Message Block (SMB) user from a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000c6hshwukkbrypj***', ], ], [ 'name' => 'Username', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n t-000c6hshwukkcfn3k**\\n successful\\n 89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DeleteGatewaySMBUser', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGatewaySMBUsers' => [ 'summary' => 'Queries the SMB users of a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbv***', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ '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' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'User' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Username' => [ 'description' => '', 'type' => 'string', 'example' => 'alex***', ], ], ], ], ], ], 'Code' => [ 'description' => '', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'ActiveDirectory' => [ 'type' => 'boolean', ], ], ], ], ], '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.', ], ], ], '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":"\\n 1\\n 4C02F482-FC2E-45BF-88C5-8D40134D11**\\n successful\\n 10\\n 1\\n \\n alex***\\n \\n 200\\n true\\n false\\n","errorExample":""}]', 'title' => 'DescribeGatewaySMBUsers', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SetGatewayDNS' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000c6hshwukkbryp****', ], ], [ 'name' => 'DnsServer', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100.100.XX.XX,100.100.XX.XX', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n t-000czaedx5koz578****\\n C5A78764-05A4-4E57-87E6-70C6657698**\\n successful\\n 200\\n true\\n","errorExample":""}]', 'title' => 'SetGatewayDNS', 'summary' => 'Configures a DNS server for a gateway.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGatewayDNS' => [ 'summary' => 'Queries DNS servers configured for a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwYT4X0O', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n ACB4BBBB-9046-4D46-BA93-0737DE78B735\\n successful\\n 200\\n true\\n 100.100.2.136,100.100.2.188\\n","errorExample":""}]', 'title' => 'DescribeGatewayDNS', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SetGatewayADInfo' => [ 'summary' => 'Enables or disables an Active Directory (AD) domain for a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwYT4X0O', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbv****', ], ], [ 'name' => 'Username', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ale****', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '12****', ], ], [ 'name' => 'ServerIp', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '12.12.x.x', ], ], [ 'name' => 'IsEnabled', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => '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-000c6hshwukkcfn****\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n t-000c6hshwukkcfn****\\n successful\\n 0F069495-0184-41B9-9D1E-6E4E921D2**\\n 200\\n true\\n","errorExample":""}]', 'title' => 'SetGatewayADInfo', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGatewayADInfo' => [ 'summary' => 'Queries information about the AD server configured for the gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwYT4X0O', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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' => ' ', ], 'CreateGatewayCacheDisk' => [ 'summary' => 'Creates a cache disk for a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '17168', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwLTSLKH', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], [ 'name' => 'CacheDiskCategory', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cloud_efficiency', ], ], [ 'name' => 'CacheDiskSizeInGB', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '60', ], ], [ 'name' => 'PerformanceLevel', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ '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}®ionId=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', ], ], ], ], ], '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.', ], ], ], '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}®ionId=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":"\\n 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 t-0001xv7je357xv4st***\\n 8E69E1A1-9076-4C8C-8ADF-ACD253886E22\\n successful\\n 200\\n true\\n","errorExample":""}]', 'title' => 'CreateGatewayCacheDisk', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGatewayCaches' => [ 'summary' => 'Queries the information about cache disks of a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwLTSLKH', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => '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":"\\n successful\\n 40797B4D-09D9-482E-B163-CCB568BADE35\\n \\n PL1\\n 100\\n https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy\\n 2605\\n d-bp1dcnq8zldree6ok***\\n cloud_efficiency\\n false\\n 1532510649\\n /dev/vdb\\n true\\n ca-000bq2fkzol56575***\\n 0\\n https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew\\n true\\n \\n 200\\n true\\n","errorExample":""}]', 'title' => 'DescribeGatewayCaches', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ExpandCacheDisk' => [ 'summary' => 'Increases the cache disk capacity.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '17242', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwLTSLKH', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], [ 'name' => 'NewSizeInGB', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '101', ], ], [ 'name' => 'LocalFilePath', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/dev/vdb', ], ], ], 'responses' => [ 200 => [ '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}®ionId=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', ], ], ], ], ], '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.', ], ], ], '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}®ionId=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":"\\n 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 t-000eg44nmxbsh3qk3***\\n F8B59F29-453D-49BF-8673-EEB8F9F2D5C6\\n successful\\n 200\\n true\\n","errorExample":""}]', 'title' => 'ExpandCacheDisk', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteGatewayCacheDisk' => [ 'summary' => 'Deletes a cache disk from a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwLTSLKH', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031y***', ], ], [ 'name' => 'CacheId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-bp1dcnq8zldree6ok***', ], ], [ 'name' => 'LocalFilePath', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/dev/vdb', ], ], ], '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n successful\\n EEFC9927-B097-446D-8FDA-F848C8B2C9E3\\n t-0001xv7je357xv4s***\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DeleteGatewayCacheDisk', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'TagResources' => [ 'summary' => 'Creates tags and attaches the tags to resources.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', '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', ], ], [ 'name' => 'ResourceRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the resource. Valid value: GATEWAY.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GATEWAY', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tag information.'."\n", 'type' => 'array', 'items' => [ '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', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 21, ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', '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', ], 'required' => true, 'maxItems' => 51, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7', ], ], 'description' => '', ], ], ], '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', ], ], 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' => '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.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"224DB9F7-3100-4899-AB9C-C938BCCB43E7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 224DB9F7-3100-4899-AB9C-C938BCCB43E7\\n","errorExample":""}]', 'title' => 'TagResources', 'description' => 'If you have a large number of instances, you can create multiple tags and add these tags to the instances. Then, you can query instances by tag.'."\n" ."\n" .'* A tag consists of a key and a value. Each key must be unique in a region within an Alibaba Cloud account. Different keys can be mapped to the same value.'."\n" .'* If you specify a tag that does not exist, the tag is automatically created and added to the specified gateway.'."\n" .'* If the key of the tag that you want to add to a gateway is the same as the key of an existing tag that is added to the gateway, the tag that you want to add overwrites the existing tag.'."\n" .'* You can attach up to 20 tags to each gateway.'."\n" .'* You can attach tags to up to 50 gateways in an API request.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListTagResources' => [ 'summary' => 'Queries tags of one or more gateways.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17247', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw7Q12RI', ], ], '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', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GATEWAY', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707ec21345', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => false, 'example' => 'gw-uf6wjk5xxxxxxx', 'maxItems' => 51, ], ], [ 'name' => 'Tag', '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, ], ], ], 'responses' => [ 200 => [ '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 ', ], ], ], ], ], ], ], ], ], ], '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', ], ], 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' => '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.', ], ], ], '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":"\\n 212db86sca4384811e0b5e8707ec21345\\n 47A514A1-4B77-4E30-B4C5-2A880650B3FD\\n \\n ALIYUN::HCS_SGW::GATEWAY\\n testvalue1\\n 47A514A1-4B77-4E30-B4C5-2A880650B3FD\\t\\n testkey1\\t\\n \\n","errorExample":""}]', 'title' => 'ListTagResources', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UntagResources' => [ 'summary' => 'Removes tags from a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw7Q12RI', ], ], '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', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GATEWAY', ], ], [ 'name' => 'All', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => true, 'example' => 'gw-uf6wjk5xxxxxxx ', 'maxItems' => 51, ], ], [ 'name' => 'TagKey', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => false, 'example' => 'testkey1', 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '601B6F25-21E7-4484-99D5-3EF2625C0088 ', ], ], ], ], ], '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', ], ], 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' => '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.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"601B6F25-21E7-4484-99D5-3EF2625C0088\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 601B6F25-21E7-4484-99D5-3EF2625C0088\\n","errorExample":""}]', 'title' => 'UntagResources', ], 'CreateGatewayLogging' => [ 'summary' => 'Create a gateway log monitoring task.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwR40N8S', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], [ 'name' => 'SlsProject', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex***', ], ], [ 'name' => 'SlsLogstore', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'logs***', ], ], ], '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', ], ], ], ], ], '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.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"76109369-5729-467D-D4A3-1131A8DA****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'CreateGatewayLogging', '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwR40N8S', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => 'The gateway ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwb***', ], ], ], 'responses' => [ 200 => [ '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', ], ], 'description' => '', ], ], ], '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.', ], ], ], '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":"\\n alex***\\n successful\\n 17D08346-BD08-4107-BFBC-01A6AAD5F5FB\\n Enabled\\n 123***\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DescribeGatewayLogging', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'EnableGatewayLogging' => [ 'summary' => 'Enables log monitoring for a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwR40N8S', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbv***', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n successful\\n CAE39768-CE96-4E16-A9F7-1FF9AE8E3FBF\\n 200\\n true\\n","errorExample":""}]', 'title' => 'EnableGatewayLogging', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DisableGatewayLogging' => [ 'summary' => 'Disables log monitoring for a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwR40N8S', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwb***', ], ], ], 'responses' => [ 200 => [ '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', ], ], ], ], ], '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.', ], ], ], '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":"\\n successful\\n 25288205-A591-4AA9-ACF8-427E8727A9D3\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DisableGatewayLogging', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteGatewayLogging' => [ 'summary' => 'Deletes a log monitoring project for a gateway.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwR40N8S', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'docRequired' => true, 'example' => 'gw-0001xv7je3580031***', 'required' => true, 'type' => 'string', ], ], ], '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', ], ], ], '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.', ], ], ], '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":"\\n successful\\n E66BF56E-068D-4308-A2D8-7FBBCE22E812\\n 200\\n true\\n","errorExample":""}]', 'extraInfo' => ' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'title' => 'DeleteGatewayLogging', ], 'CreateExpressSync' => [ 'summary' => 'Creates an express synchronization group.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwNGMQUV', ], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alex-tb***', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'BucketRegion', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'BucketName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sgw-test***', ], ], [ 'name' => 'BucketPrefix', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test***', ], ], ], '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EmptyExpressSyncName', 'errorMessage' => 'You must enter a valid name for the sync group.', ], [ 'errorCode' => 'EmptyBucketName', 'errorMessage' => 'You must enter a valid name for the bucket.', ], [ 'errorCode' => 'EmptyBucketRegion', 'errorMessage' => '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.', ], [ 'errorCode' => 'DescriptionOverLimit', 'errorMessage' => '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.', ], [ 'errorCode' => 'ConflictExpressSyncConfig', 'errorMessage' => '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.', ], [ 'errorCode' => 'InvalidRegionId', 'errorMessage' => '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.', ], [ 'errorCode' => 'ExpressSyncNotificationEventConflict', 'errorMessage' => 'The express sync configuration of bucket and prefix conflicts with existing notification events in MNS.', ], ], 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' => '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.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => '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\\": \\"EEFC9927-B097-446D-8FDA-F848C8B2C9E0\\",\\n \\"Code\\": \\"200\\",\\n \\"ExpressSyncId\\": \\"sync-0001xv7je357xn8tr***\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n successful\\n EEFC9927-B097-446D-8FDA-F848C8B2C9E0\\n sync-0001xv7je357xn8tr***\\n 200\\n true\\n","errorExample":""}]', 'title' => 'CreateExpressSync', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'AddSharesToExpressSync' => [ 'summary' => 'Adds shares to an express synchronization group.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwNGMQUV', ], ], 'parameters' => [ [ 'name' => 'ExpressSyncId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sync-0001xv7je357xn8tr***', ], ], [ 'name' => 'GatewayShares', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"gw-000gwgp0j3jp8cb3t***":"share1,share2","gw-0001b2otnkdzte62j***":"weekly"}', ], ], ], '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EmptyExpressSyncId', 'errorMessage' => '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.', ], [ 'errorCode' => 'ExpressSyncInOperation', 'errorMessage' => 'The sync group is busy. Try again later.', ], ], ], '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":"\\n t-0001xv7je357xr6ql***\\n 1EDBC004-6B1C-4511-ACF5-0B4875BA3887\\n successful\\n sgw-express-sync-topic-sync-0009e51kabuou08***\\n sgw-express-sync-queue-gw-0009e51kabuoty9***-341604\\n 719\\n http://123.mns.cn-hangzhou.aliyuncs.com/\\n http://123.mns.cn-hangzhou-internal.aliyuncs.com/\\n 200\\n true\\n","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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwNGMQUV', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'BucketName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'sgw***', ], ], [ 'name' => 'BucketPrefix', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test***', ], ], ], '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request.　', ], ], ], '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":"\\n \\n sync-0002xetjdlxne2sd****\\n 测试使用\\n sgw-mns****\\n wptest****\\n test****\\n sgw-express-sync-0002xetjdlxne2sd****\\n cn-hangzhou\\n \\n successful\\n 50DE1383-D4A1-433C-98A6-459C1830A888\\n 200\\n true\\n","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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwNGMQUV', ], ], 'parameters' => [ [ 'name' => 'ExpressSyncIds', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sync-0002xetjdlxne2sd***,sync-0004agfrbke1l39p***', ], ], [ 'name' => 'IsExternal', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EmptyExpressSyncId', 'errorMessage' => '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.', ], [ 'errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', ], ], ], '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":"\\n successful\\n EA258616-36AD-4609-A0A6-2B17C28CBF88\\n \\n \\n MNSHealthy\\n ji***\\n cn-hangzhou\\n sb-0003c7qh5yuc1z6b8***\\n file-升级***\\n gw-000245alq48e7ytg***\\n sync-000ip92hqkvu0gbxi***\\n 100\\n sgw-express-sync-queue-gw-000245alq48e7ytgxq03***\\n \\n \\n MNSHealthy\\n cifs12***\\n cn-hangzhou\\n sb-000gxdrndxrm50gtl***\\n file122***\\n gw-000hqr50529yvycly***\\n sync-000jf2sbjhfatey3***\\n 100\\n sgw-express-sync-queue-gw-000hqr5052cly5xa***\\n \\n \\n 200\\n true\\n","errorExample":""}]', 'title' => 'DescribeExpressSyncShares', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteExpressSync' => [ 'summary' => 'Deletes an express synchronization group.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17175', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwNGMQUV', ], ], 'parameters' => [ [ 'name' => 'ExpressSyncId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sync-0001xv7je357xn8tr***', ], ], ], '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EmptyExpressSyncId', 'errorMessage' => '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.', ], [ 'errorCode' => 'GatewayNotExist', 'errorMessage' => 'The specified gateway does not exist. You must specify a valid parameter.', ], [ 'errorCode' => 'ExpressSyncInOperation', 'errorMessage' => '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.', ], ], ], '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":"\\n t-0001xv7je357xv4st***\\n successful\\n A870C702-C3AC-4FC9-91E4-053D3E599A24\\n 200\\n true\\n","errorExample":""}]', 'title' => 'DeleteExpressSync', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveSharesFromExpressSync' => [ 'summary' => 'Removes one or more shares from an express synchronization group.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ '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' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sync-0001xv7je357xn8tr***', ], ], [ 'name' => 'GatewayShares', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"gw-000gwgp0j3jp8cb3t***":"share1,share2","gw-0001b2otnkdzte62j***":"weekly"}', ], ], ], '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ExpressSyncNotExist', 'errorMessage' => 'The specified sync group does not exist. You must specify a valid parameter.', ], [ 'errorCode' => 'ExpressSyncInOperation', 'errorMessage' => 'The sync group is busy. Try again later.', ], ], ], '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":"\\n t-0001xv7je357xr6ql***\\n successful\\n 1EDBC004-6B1C-4511-ACF5-0B4875BA3B22\\n 200\\n true\\n","errorExample":""}]', 'title' => 'RemoveSharesFromExpressSync', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGatewayLocations' => [ 'summary' => '查询网关位置列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17209', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '219649', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], [ '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', ], ], ], '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', ], ], ], ], ], ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'gw-000c6hshwukkbryp****', ], ], ], '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', ], ], ], ], ], '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', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191531', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], [ 'name' => 'ShareIndexId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'nfs_share', ], ], [ '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', ], ], [ 'name' => 'FirstTriggerTimestampStartTime', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1761559501337', ], ], [ 'name' => 'FirstTriggerTimestampEndTime', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1761570323090', ], ], [ 'name' => 'GatewayRegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'alerting', ], ], ], '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' => '”“', ], ], ], ], ], ], ], ], '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' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'gw-0001xv7je3580031***', ], ], [ 'name' => 'SecurityStrategy', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'EnforceSigning', ], ], ], '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', ], ], ], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwQHP82G', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3580031***', ], ], ], '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', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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":"\\n successful\\n FA8951CC-A534-425D-8705-F9A5CF9FD555\\n 200\\n true\\n \\n \\n true\\n Enhanced\\n \\n \\n true\\n Advanced\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeGatewayModificationClasses', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyGatewayClass' => [ 'summary' => '更改网关规格', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw1K8DWI', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7580031yzun***', ], ], [ 'name' => 'GatewayClass', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Enhanced', ], ], ], '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', ], ], ], ], ], '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.', ], [ 'errorCode' => 'LocationCloudRequired', 'errorMessage' => 'You must specify a cloud gateway. Try again later.', ], [ 'errorCode' => 'GatewayStatusRunningRequired', 'errorMessage' => 'The gateway is not in the Running state. Try again later.', ], [ 'errorCode' => 'GatewayClassUpgradeOnly', 'errorMessage' => '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.', ], [ 'errorCode' => 'GatewayInOperation', 'errorMessage' => 'The gateway is processing requests . Try again later.', ], ], ], '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":"\\n t-0001xv7je3580bx6v***\\n https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&instanceId=gw-000c6hshwukjwc7e1***#/upgrade\\n successful\\n 395B1136-982E-4F95-BDCE-7323FFEF499E\\n 200\\n true\\n","errorExample":""}]', 'title' => 'ModifyGatewayClass', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RestartFileShares' => [ 'summary' => '重启文件共享', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREhcs_sgw64A0KV', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-000eg44nmxbsfwbvq***', ], ], [ 'name' => 'ShareProtocol', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NFS', ], ], ], '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidShareProtocol', 'errorMessage' => '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.', ], [ '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.', ], ], ], '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":"\\n t-000czaedx5koz578v***\\n successful\\n 89398CFB-4EB6-4C7E-BB3C-EF213AC8FA** \\n 200\\n true\\n","errorExample":""}]', 'title' => 'RestartFileShares', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UploadGatewayLog' => [ 'summary' => '控制台UI上传网关服务日志', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '17280', 'abilityTreeNodes' => [ 'FEATUREhcs_sgwR40N8S', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0001xv7je3031yzun***', ], ], ], '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', ], ], ], ], ], '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' => 'BadRequest', 'errorMessage' => 'Invalid request. You must specify valid parameters in the request.　', ], ], ], '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":"\\n t-0001xv7je3580412f***\\n successful\\n CB300009-3850-4107-B291-59BDB4EDA183\\n 200\\n true\\n","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', ], ], ];